Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
358 lines (258 sloc) 18.6 KB

SLPDB

SLPDB Readme

Last Updated: 2019-04-26

Current SLPDB Version: 0.11.0 (beta)

What is SLPDB?

SLPDB is a node.js application that stores all token data for the Simple Ledger Protocol to MongoDB. SLPDB requires MongoDB and a Bitcoin Cash full node to fetch, listen for, and store SLP data. The application allows other processes to subscribe to real-time SLP events via ZeroMQ.

Do you need to install SLPDB?

Most likely you do not need to install SLPDB. Most users will be better off using someone else's public SLPDB instance like https://slpdb.bitcoin.com or https://slpdb.fountainhead.cash. You only need to install SLPDB, SlpServe, and/or SlpSockServe projects if any of the following is true:

  • You cannot rely on a third-party for your SLP data.
  • SLP data query API offered at slpdb.bitcoin.com does not meet your needs.
  • Realtime SLP data event notifications available at slpsocket.fountainhead.cash does not meet your needs.

NOTE: If you are going to operate a SLPDB instance you should join the telegram group for help and updates: https://t.me/slpdb

How do I query for SLP data?

Queries into SLP data use the jq query language. If you are not familiar with jq we recommend that you examine some of the examples below to get started:

Here are some example SLPDB queries:

  • List all token details and usage information example
  • List all tokens as a summary of token supply example
  • List all tokens sorted by burn amount example
  • Token details and usage information by token ID example
  • List all address balances by token ID example
  • List all token balances by address example
  • List all token utxos by token ID example
  • List transaction history by token ID example
  • List transaction history by address example
  • List transaction history by address and token ID example
  • Show invalid token transactions example
  • List transaction counts for each token example
  • List SLP usage per day example

Users should utilize the SlpServe and SlpSockServer projects in order to conveniently query for the SLP data produced by SLPDB.

WARNING: Working with Large Numbers (Decimal128 and BigNumber)

Some of the values used in SLP require 64 or more bits of precision, which is more precision than number type can provide. To ensure value precision is maintained values are stored in collections using the Decimal128 type. Decimal128 allows users to make database queries using query comparison operators like $gte.

The services SlpServe and SlpSockServer return query results as a JSON object with Decimal128 values converted to string type so that readability is improved for the query consumer, as opposed to being returned as an awqward $DecimalNumber JSON object. The string type also maintains the original value precision. If a user wants to perform math operations on these string values the user will need to first convert them to a large number type like BigNumber or Decimal128 (e.g., Decimal128.fromString("1000.123124") or using bignumber.js npm library via new BigNumber("1000.00000001")).

Installation Instructions

Prerequisites

  • Node.js 8.15+
  • TypeScript 3+ (npm install -g typescript)
  • MongoDB 4.0+
  • BCHD (recommended with "fastsync"), BitcoinABC, BitcoinUnlimited or other Bitcoin Cash full node with:
    • RPC-JSON and
    • ZeroMQ event notifications

Full Node Settings for bitcoin.conf

The following settings should be applied to your full node's configuration. NOTE: The settings presented here are matched up with the default settings presented in config.ts, you should modify these settings and use environment variables (shown in config.ts) if you need a custom setup.

  • server=1
  • rpcuser=bitcoin
  • rpcpassword=password
  • rpcport=8332
  • rpcworkqueue=10000
  • rpcthreads=8
  • zmqpubhashtx=tcp://127.0.0.1:28332
  • zmqpubrawtx=tcp://127.0.0.1:28332
  • zmqpubhashblock=tcp://127.0.0.1:28332
  • zmqpubrawblock=tcp://127.0.0.1:28332
  • Optional: testnet=1

Testnet Support

To use SLPDB with Testnet simply set your full node to the testnet network (e.g., set testnet=1 within bitcoin.conf) and SLPDB will automatically instantiate using proper databases names according to the network. For informational purposes the database names are as follows:

  • Mainnet
    • Mongo db name = slpdb
    • LevelDB directory = ./_leveldb
  • Testnet
    • Mongo db name = slpdb_testnet
    • Testnet diectory = ./_leveldb_testnet

Running SLPDB

1) Run MongoDB (config.ts default port is 27017)

2) Run Bitcoin Cash full node using bitcoin.conf settings from above.

3) Install SLPDB dependencies using npm install at the command-line

4) Start SLPDB using npm start at the command-line and wait for sync process to complete (monitor status in the console).

  • SLPDB will need to crawl the blockchain to save all previous SLP transaction data to MongoDB

  • After crawling SLPDB will build token graphs for each token using either the raw transaction data or a previously saved token graph state.

5) Install and run slpserve and/or slpsocket to access SLP token data and statistics

Updating SLPDB

1) Execute git pull origin master to update to latest version.

2) Execute npm install to update packages

3) Execute npm run migrate up to run latest migrations.

4) Restart SLPDB.

Token Stats

The following properties are maintained and updated for each token in real-time to provide state and usage information:

Supply Stats

  • qty_token_minted - Total token quantity created in GENESIS and MINT transactions
  • qty_token_burned - Total token quantity burned in invalid SLP transactions or in transactions having lower token outputs than inputs.
  • qty_token_circulating_supply - Total quantity of tokens circulating (i.e., Genesis + Minting - Burned = Circulating Supply).
  • minting_baton_status - State of the minting baton (possible baton status: ALIVE, NEVER_CREATED, DEAD_BURNED, or DEAD_ENDED).
  • mint_baton_address (NOT YET IMPLEMENTED) - Address holding the minting baton or last address to hold.
  • mint_baton_txid (NOT YET IMPLEMENTED) - TXID where the minting baton exists or existed before being destroyed.

Summarized Usage Stats

  • qty_valid_txns_since_genesis - Number of valid SLP transactions made since Genesis (Includes GENESIS, SEND and MINT transactions)
  • qty_valid_token_utxos - Number of current unspent & valid SLP UTXOs
  • qty_valid_token_addresses - Number of unique address holders
  • qty_satoshis_locked_up - Quantity of BCH that is locked up in SLP UTXOs
  • block_last_active_mint - The block containing the token's MINT transaction
  • block_last_active_send - The block containing the token's SEND transaction
  • block_created - The block containing the token's GENESIS transaction
  • block_last_burn (NOT YET IMPLEMENTED) - The block containing the last burn event

Supply Event Stats

  • events_mint (NOT YET IMPLEMENTED) - Events when the minting baton was moved and new tokens were created
  • events_burn (NOT YET IMPLEMENTED) - Events when tokens were burned (possible type of burn: OUTS_LESS_THAN_INS or UTXO_DESTROYED)

Real-time Notifications

ZeroMQ (ZMQ)

SLPDB publishes the following notifications via ZMQ and can be subscribed to by binding to http://0.0.0.0:28339. The following events can be subscribed to:

  • mempool
  • block

Each notification is published in the following data format:

{
    "tx": {
		h: string; 
	};
    "in": Xput[];
    "out": Xput[];
    "blk": { 
		h: string; 
		i: number; 
		t: number; 
	};
    "slp": {
        valid: boolean|null;
        detail: {
			transactionType: SlpTransactionType;
			tokenIdHex: string;
			versionType: number;
			symbol: string;
			name: string;
			documentUri: string; 
			documentSha256Hex: string|null;
			decimals: number;
			txnContainsBaton: boolean;
			txnBatonVout: number|null;
		} | null;
		outputs: { address: string|null, amount: Decimal128|null }[]|null;|null;
        invalidReason: string|null;
        schema_version: number;
    };
}

MongoDB Collections & Data Schema

Three categories of information are stored in MongoDB:

  1. Valid and invalid SLP token transactions,
  2. Statistical calculations about each token, and
  3. Token graph state

DB Collections

Six MongoDB collections used to store these three categories of data, they are as follows:

  • confirmed = c and unconfirmed = u

    • Purpose: These two collections include any Bitcoin Cash transaction containing the "SLP" Lokad ID. The collection used depends on the transaction's confirmation status . Both valid and invalid SLP transactions are included. Whenever new SLP transactions are added to the Bitcoin Cash network they are immediately added to one of these collections.

    • Schema:

    {
        "tx": {
    		h: string; 
    	};
        "in": Xput[];
        "out": Xput[];
        "blk": { 
    		h: string; 
    		i: number; 
    		t: number; 
    	};
        "slp": {
            valid: boolean|null;
            detail: {
    			transactionType: SlpTransactionType;
    			tokenIdHex: string;
    			versionType: number;
    			symbol: string;
    			name: string;
    			documentUri: string; 
    			documentSha256Hex: string|null;
    			decimals: number;
    			txnContainsBaton: boolean;
    			txnBatonVout: number|null;
    		} | null;
            invalidReason: string|null;
            schema_version: number;
        };
    }
  • tokens = t

    • Purpose: This collection includes metadata and statistics about each token. Each time SLPDB has finished updating a token graph the associated items in this collection are updated.

    • Schema:

    {
        "tokenDetails": {
    		transactionType: SlpTransactionType;
    		tokenIdHex: string;
    		versionType: number;
    		timestamp: string|null;
    		timestamp_unix: number|null;
    		symbol: string;
    		name: string;
    		documentUri: string; 
    		documentSha256Hex: string|null;
    		decimals: number;
    		containsBaton: boolean;
    		batonVout: number|null;
    		genesisOrMintQuantity: Decimal128|null;
    		sendOutputs: Decimal128[]|null;
    	};
        "tokenStats": {
            block_created: number|null;
            block_last_active_send: number|null;
            block_last_active_mint: number|null;
            qty_valid_txns_since_genesis: number;
            qty_valid_token_utxos: number;
            qty_valid_token_addresses: number;
            qty_token_minted: Decimal128;
            qty_token_burned: Decimal128;
            qty_token_circulating_supply: Decimal128;
            qty_satoshis_locked_up: number;
            minting_baton_status: TokenBatonStatus;
    	}
        "lastUpdatedBlock": number;
        "schema_version": number;
    }
  • utxos = x

    • Purpose: This collection contains an item for each valid UTXO holding a token (does not include mint baton UTXOs).

    • Schema:

    {
        "tokenDetails": { 
    		tokenIdHex: string;
    	};
        "utxo": string; // formatted as <txid>:<vout>
    }
  • addresses = a

    • Purpose: This collection contains an item for each addresses holding a valid token balance, for each token.

    • Schema:

    {
        "tokenDetails": { 
    		tokenIdHex: string 
    	};
        "address": cashAddr;
        "satoshis_balance": number;
        "token_balance": Decimal128;
    }
  • graphs = g

    • Purpose: This collection contains an item for each valid SLP transaction (can be GENESIS, MINT, or SEND)

    • Schema:

    {
        "tokenDetails": { 
    		tokenIdHex: string 
    	};
        "graphTxn": {
    		txid: string;
    		details: SlpTransactionDetailsDbo;
    		outputs: GraphTxnOutputDbo[];
    	};
    }

Future Updates & Features

TokenID Filtering

SLPDB will soon include a filtering configuration so that only user specified tokens (or ranges of tokens) will be included or excluded in the SLPDB instance.

Make compatible with other Lokad IDs

We want to make SLPDB more easily forkable for other OP_RETURN projects which may be unrelated to SLP tokens.

You can’t perform that action at this time.