Sign inSign up

electrumsvsdk/whatsonchain_api

By electrumsvsdk

•Updated over 5 years ago

a very basic mock api

Image
0

244

electrumsvsdk/whatsonchain_api repository overview

⁠ElectrumSV Software Development Kit

This project provides a consolidated set of resources that together can allow a developer, whether working on ElectrumSV directly or on an application based on ElectrumSV, to develop, run and test while offline (and is especially aimed at facilitating rigourous CI/CD functional testing).

Licence: The Open BSV License
Maintainers: Roger Taylor, AustEcon
Project Lead: Roger Taylor
Language: Python (>=3.7)
Homepage: https://electrumsv.io/

PyPI version Build Status Platforms Platforms

⁠Documentation

Detailed documentation is hosted here⁠

⁠Basic Instructions

To install from pypi⁠:

> pip install --upgrade electrumsv-sdk

Now you have global access to a script called 'electrumsv-sdk.exe' from any console window.

For help:

> electrumsv-sdk --help

Note: You must run electrumsv-sdk install <component type> first for each component type. This may require system dependencies you also need - please read the documentation.

If you want help for one of the subcommands (e.g. 'start') do:

> electrumsv-sdk start --help

Which will show:

usage: electrumsv-sdk start [-h] [--new] [--gui] [--background] [--inline] [--new-terminal] [--id ID] [--repo REPO] [--branch BRANCH] {electrumsv,electrumx,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api} ...

positional arguments:
  {electrumsv,electrumx,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api}
                        subcommand
    electrumsv          start electrumsv
    electrumx           start electrumx
    merchant_api        start merchant_api
    node                start node
    status_monitor      start status_monitor
    whatsonchain        start whatsonchain
    whatsonchain_api    start whatsonchain_api

optional arguments:
  -h, --help            show this help message and exit
  --new                 run a new instance with unique 'id'
  --gui                 run in gui mode (electrumsv only)
  --background          spawn in background
  --inline              spawn in current shell
  --new-terminal        spawn in a new terminal window
  --id ID               human-readable identifier for component (e.g. 'worker1_esv')
  --repo REPO           git repo as either an https://github.com url or a local git repo path e.g. G:/electrumsv (optional)
  --branch BRANCH       git repo branch (optional)

Note: The "optional arguments" come before specifying the component_type e.g.:

> electrumsv-sdk start --new --id=myspecialnode node

Tag summary

Content type

Image

Digest

Size

572.8 MB

Last updated

over 5 years ago

docker pull electrumsvsdk/whatsonchain_api