Skip to main content

nimble miner api

Project description

Nimble Miner API

It provides CLI, wallet and other APIs for the miners.

Development

Install

# installer option
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/nimble-technology/nimble-miner-api/master/scripts/install.sh)"

# pip install option
$ pip3 install nimble-miner-api

# from source
$ git clone https://github.com/nimble-technology/nimble-miner-api.git
$ cd nimble-miner-api
$ python3 -m pip install -e ./

# test install from command line
# usage: nbcli <command> <command args>
# commands:
#   subnets (s, subnet) - Commands for managing and viewing subnetworks.
#   root (r, roots) - Commands for managing and viewing the root network.
#   wallet (w, wallets) - Commands for managing and viewing wallets.
#   stake (st, stakes) - Commands for staking and removing stake from hotkey accounts.
#   sudo (su, sudos) - Commands for subnet management.
#   legacy (l) - Miscellaneous commands.
$ nbcli --help

# test install from python
import nimble-miner-api as nimble

# cuda dependency for cubit install - python 3.10 example
pip install https://github.com/nimble-technology/cubit/releases/download/v1.1.2/cubit-1.1.2-cp310-cp310-linux_x86_64.whl

Wallet

Each wallet has a coldkey. Each coldkey may contain multiple hotkeys and each hotkey belong to a single coldkey. Coldkeys are for secure fund management like transfer, staking, and fund storage. Hotkeys are for all online operations like signing, mining and validating.

# wallet creation in python
import nimble-miner-api as nimble
wallet = nimble.wallet()
wallet.create_new_coldkey()
wallet.create_new_hotkey()
# Sign data with the keypair.
wallet.coldkey.sign( data )

# use nbcli with wallet subcommand or alias w.
$ nbcli wallet new_coldkey
$ nbcli wallet new_hotkey

$ nbcli wallet regen_coldkey --mnemonic **** *** **** **** ***** **** *** **** **** **** ***** *****

# keys are available here: ~/.nimble/wallets
$ nbcli wallet list

# more commands
$ nbcli wallet list
$ nbcli wallet transfer

Release (Admin Only)

Run the following command to create dist folder

python setup.py sdist

Then use the following command to publish to pypi

twine upload dist/nimble-miner-api-{version}.tar.gz

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nimble-miner-api-0.0.20.tar.gz (173.9 kB view details)

Uploaded Source

File details

Details for the file nimble-miner-api-0.0.20.tar.gz.

File metadata

  • Download URL: nimble-miner-api-0.0.20.tar.gz
  • Upload date:
  • Size: 173.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for nimble-miner-api-0.0.20.tar.gz
Algorithm Hash digest
SHA256 8eb5311fd67ca95aa18083d57c51c0ef6041be5cd87a9f8711ba7721dee77160
MD5 e727e09ebf27637809f36e29501bd19c
BLAKE2b-256 b80f41347aa7468a3bfde47af20337f1e5029cc6b7f110fd5f1477788ad24fc1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page