Flare Rosetta

[Rosetta][1] server implementation for the [Flare][2] Network.

Requirements

In order to run the Flare Rosetta server you will need access to a Flare node's JSON RPC API.

Please check out the Flare repository to learn how to run a Flare node.

Installation

Clone the repository, then build the Rosetta server by running the following commands:

make setup
make build

If successful, you will find the rosetta-server binary in your current directory.

Usage

Before you start running the server you need to create a configuration file:

{
  "rpc_endpoint": "http://localhost:9650",
  "mode": "online",
  "listen_addr": "0.0.0.0:8080"
}

Start the server by running the following command:

./rosetta-server -config=./config.json

Configuration

Full configuration example:

{
  "mode": "online",
  "rpc_endpoint": "http://localhost:9650",
  "listen_addr": "0.0.0.0:8080",
  "network_name": "Songbird",
  "chain_id": 19,
  "log_requests": true
}

Where:

Name	Type	Default	Description
mode	string	online	Mode of operations. One of: online, offline.
rpc_endpoint	string	http://localhost:9650	Flare RPC endpoint.
listen_addr	string	http://localhost:8080	Rosetta server listen address (host/port).
network_name	string	-	Flare network name. Should be Songbird.
chain_id	integer	-	Flare chain ID. 19 for Songbird.
log_requests	bool	false	Enable request body logging.

RPC Endpoints

List of all available Rosetta RPC server endpoints

Method	Path	Status	Description
POST	/network/list	Y	Get List of Available Networks
POST	/network/status	Y	Get Network Status
POST	/network/options	Y	Get Network Options
POST	/block	Y	Get a Block
POST	/block/transaction	Y	Get a Block Transaction
POST	/account/balance	Y	Get an Account Balance
POST	/mempool	Y	Get All Mempool Transactions counts
POST	/mempool/transaction	N/A	Get a Mempool Transaction
POST	/construction/combine	Y	Create Network Transaction from Signatures
POST	/construction/derive	Y	Derive an AccountIdentifier from a PublicKey
POST	/construction/hash	Y	Get the Hash of a Signed Transaction
POST	/construction/metadata	Y	Get Transaction Construction Metadata
POST	/construction/parse	Y	Parse a Transaction
POST	/construction/payloads	Y	Generate an Unsigned Transaction and Signing Payloads
POST	/construction/preprocess	Y	Create a Request to Fetch Metadata
POST	/construction/submit	Y	Submit a Signed Transaction
POST	/call	Y	Perform a Blockchain Call

Development

Available commands:

• make build - Build the development version of the binary
• make test - Run the test suite
• make dist - Build distribution binaries
• make docker-build - Build a Docker image
• make docker-push - Push a Docker image to the registry
• make run-testnet - Run node and rosetta testnet server
• make run-testnet-offline - Run node and rosetta testnet server
• make run-mainnet - Run node and rosetta mainnet server
• make run-mainnet-offline - Run node and rosetta mainnet server

Testing Rosetta

The Rosetta implementation can be tested using the Rosetta CLI.

Before we can start the service, we need to build the docker image:

make docker-build

Next, start the Testnet service by running:

make run-testnet

Wait until the node is done bootstrapping, then start the data check:

make check-testnet-data

Run the construction check:

make check-testnet-construction

License

BSD 3-Clause