rosetta-bitclout

README

rosetta-bitclout

Overview

rosetta-bitclout provides an implementation of the Rosetta API for BitClout in Golang. If you haven't heard of the Rosetta API, you can find more information here.

Usage

As specified in the Rosetta API Principles, all Rosetta implementations must be deployable via Docker and support running via either an online or offline mode.

You must install docker. You can download Docker here.

Build

Running the following commands will create a Docker image called rosetta-bitclout:latest.

1. Checkout rosetta-bitclout and core in the same directory

2. In the rosetta-bitclout repo, run the following (you may need sudo):

docker build -t rosetta-bitclout -f Dockerfile ..

Run

You may need sudo:

docker run -it rosetta-bitclout /bitclout/bin/rosetta-bitclout run

Specify --network=TESTNET --miner-public-keys=publickey to get free testnet money. You can easily generate a key on bitclout.com and copy it from your wallet page (starts with BC).

Testnet Example

Scripts in the scripts/testnet folder demonstrate how to run an online node, offline node, and construct transactions.

1. cd scripts/testnet
2. Start an online node using ./online.sh
3. Start an online node using ./offline.sh
4. Construct and submit transactions using ./send.sh

Rosetta-cli checks

To run checks with rosetta-cli, first install the rosetta-cli:

curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-cli/master/scripts/install.sh | sh -s

To run the data checks, execute:

bin/rosetta-cli check:data --configuration-file rosetta-cli-conf/testnet/bitclout.conf

To run the construction checks, execute:

bin/rosetta-cli check:construction --configuration-file rosetta-cli-conf/testnet/bitclout.conf