This is an implementation of Coinbase's Rosetta API for the Nimiq PoW Blockchain (1.x). It acts as a proxy between the client and the Nimiq node's RPC server.

The easiest way to run nimiq-rosetta is via docker, for this a container image needs to be created from this directory:

docker build -t rosetta-nimiq:latest .

After which a container instance can be started via:

docker run -e MODE=online -p 8080:8080 rosetta-nimiq:latest

Where the online MODE implies that a nimiq node should be automatically started so that nimiq-rosetta can connect to it and 8080 is the port where nimiq-rosetta will be listening. The container also stores all its state in the /data directory which is defined as a volume.

You can copy the file src/config.default.json into a new location and adapt it to your needs. Remove options that don't need changing to use their default.

Then pass the file location as the first argument to the command:

deno run --allow-net --allow-read src/mod.ts path/to/config.json

To run the server for a testnet or mainnet node, change the network in your config to "testnet" or "mainnet" respectively.

This server is written in Typescript for Deno >= v1.17.0.

To run:

deno run --allow-net --watch src/mod.ts

This will start a Rosetta server at http://localhost:8080.

Add the --allow-read flag when using a config file.

This Rosetta implementation can be tested with the Rosetta CLI, which you need to have installed.

Additionally, you need to have access to a devnet or testnet Nimiq node with enabled RPC server. You can run your own devnet locally with the following config:

{
    network: "dev",     // Start a devnet
    type: "full",       // Rosetta requires a full node
    protocol: "dumb",   // So we don't have to worry about a domain or TLS
    passive: "yes",     // So the node starts working without peers
    statistics: 5,      // To notice when transactions are in the mempool

    // We need the miner to produce a chain
    miner: {
        enabled: "yes",
        threads: 1,
    },

    // Enable the RPC Server, the access point for the Rosetta server
    rpcServer: {
        enabled: "yes",

        // If you change the port of the RPC server from the default,
        // you need to update the port in the Rosetta server config
        // at (src/config.ts).
    },
}

When both the Nimiq node and the Rosetta server (see Development) are running, run the CLI tests. It is recommended to run the construction test first, so the subsequent data test has some transactions to validate. In a fresh devnet, the construction test takes around 5 minutes, the data test less than 30 seconds.

# Construction test (only available for devnet)
rosetta-cli check:construction --configuration-file rosetta-cli-conf/devnet/config.json

# Data test
rosetta-cli check:data --configuration-file rosetta-cli-conf/devnet/config.json

The construction test checks if valid transactions can be created via the API and that those transactions get included into the blockchain.

The data test checks for data format correctness and that all relevant blockchain data can be retrieved from the API, also validating that the chain and balance states are consistent.

This Rosetta API implementation was developed with the help and inspiration of the following sources:

• Rosetta API documentation
• Rosetta-Ethereum reference implementation
• Zilliqa-Rosetta implementation