Numbers Protocol
Search
⌃K

Getting Started

Use Nit Module

A step-by-step guide for how to run the Nit command line tool is provided below.

Step 1: Install Nit

Install Nit if it is not yet installed
yarn global add @numbersprotocol/nit
If it is your first time running Nit, let us initialize with the default configuration
nit init
The configuration allows users to input their personal information. If you would like to edit the configurations, run the following command
nit config -e
And, create a working directory for the targeting asset
mkdir ~/temp && cd ~/temp

Step 2: Create assetTree

Run nit add to create the assetTree of the media file
nit add <asset-filepath> -m "Initializing assetTree."
You can check to see if the information you hope to commit meet your expectations by running
nit status
To access the assetTree file, you can use browser to open the URL: https://<Nid of the assetTree file>.ipfs.dweb.link

Step 3: Commit

nit commit -m "My first commit for the asset."
Now, you can check the Commit on the blockchain by following the explorer URL returned by Nit. For more details and how to get on-chain information such as block numbers, please visit Nit repository.

Use Nit API

A step-by-step guide for how to call the Nit APIs is provided below.

Step 1: Create Your Capture Account and Wallets

Following Capture Account & Wallet, you will learn how to
  1. 1.
    Create your Capture account
  2. 2.
    Get your Capture Token
  3. 3.
    Verify your Capture Token
  4. 4.
    Retrieve your wallets

Step 2: Commit to Numbers Networks

Following Commit via API, you will learn how to
  1. 1.
    Commit to Numbers testnet (Snow)
  2. 2.
    Commit to Numbers mainnet (Jade)

Step 3: Read Commits on Numbers Networks

Following Read commits via API, you will learn how to
  1. 1.
    Read commits on testnet
  2. 2.
    Read commits on mainnet
​