Skip to main content

Node API

Compile from Source

Install OS dependencies and Rust​

Clone the Node API​

git clone https://github.com/functionland/sugarfunge-api.git

Run the Node API​

Requires a Node running.

cargo run --release

Using Docker

Install Docker​

Build the image​

docker build -t sugarfunge-api:local -f docker/Dockerfile .

Edit the .env​

sudo nano .ev.example

Save it and then:

sudo mv .env.example /var/lib/.sugarfunge-node/.env

Run the Node API​

Requires a Node running.

docker run --rm -d --name MyNode03API --network host -v /var/lib/.sugarfunge-node/.env:/.env -v /var/lib/.sugarfunge-node/data/node03:/data sugarfunge-api:local --db-uri=/data --node-server ws://127.0.0.1:9946

Available arguments

sugarfunge-api 0.1.0

USAGE:
    sugarfunge-api [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -d, --db-uri <db>                  
    -l, --listen <listen>               [default: http://127.0.0.1:4000]
    -s, --node-server <node-server>     [default: ws://127.0.0.1:9944]

Subscriptions

Basic support for WebSockets subscriptions is available. Any tool that offers features for WebSockets connections and subscriptions will apply. For example, websocat

websocat ws://127.0.0.1:4000/ws

API Metadata Generation

If you update the Node manually and added pallets, it's required to generate the metadata with the SugarFunge fork of subxt to access the new state of the chain using the API.

cargo install subxt-cli

subxt-cli metadata -f bytes > sugarfunge_metadata.scale --url http://localhost:9934/