melmccann / rosetta-cli Goto Github PK

go get github.com/coinbase/rosetta-cli

CLI for the Rosetta API

Usage:
  rosetta-cli [command]

Available Commands:
  check                Check the correctness of a Rosetta Node API Server
  create:configuration Generate a static configuration file for the Asserter
  help                 Help about any command
  version              Print rosetta-cli version
  view:account         View an account balance
  view:block           View a block

Flags:
  -h, --help                help for rosetta-cli
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

Use "rosetta-cli [command] --help" for more information about a command.

Print rosetta-cli version

Usage:
  rosetta-cli version [flags]

Flags:
  -h, --help   help for version

Global Flags:
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

Check all server responses are properly constructed, that
there are no duplicate blocks and transactions, that blocks can be processed
from genesis to the current block (re-orgs handled automatically), and that
computed balance changes are equal to balance changes reported by the node.

When re-running this command, it will start where it left off if you specify
some --data-dir. Otherwise, it will create a new temporary directory and start
again from the genesis block. If you want to discard some number of blocks
populate the --start flag with some block index. Starting from a given index
can be useful to debug a small range of blocks for issues but it is highly
recommended you sync from start to finish to ensure all correctness checks
are performed.

By default, account balances are looked up at specific heights (instead of
only at the current block). If your node does not support this functionality
set --lookup-balance-by-block to false. This will make reconciliation much
less efficient but it will still work.

If check fails due to an INACTIVE reconciliation error (balance changed without
any corresponding operation), the cli will automatically try to find the block
missing an operation. If --lookup-balance-by-block is not enabled, this automatic
debugging tool does not work.

To debug an INACTIVE account reconciliation error without --lookup-balance-by-block, set the
--interesting-accounts flag to the absolute path of a JSON file containing
accounts that will be actively checked for balance changes at each block. This
will return an error at the block where a balance change occurred with no
corresponding operations.

If your blockchain has a genesis allocation of funds and you set
--lookup-balance-by-block to false, you must provide an
absolute path to a JSON file containing initial balances with the
--bootstrap-balances flag. You can look at the examples folder for an example
of what one of these files looks like.

Usage:
  rosetta-cli check [flags]

Flags:
      --active-reconciliation-concurrency uint     concurrency to use while fetching accounts during active reconciliation (default 8)
      --block-concurrency uint                     concurrency to use while fetching blocks (default 8)
      --bootstrap-balances string                  Absolute path to a file used to bootstrap balances before starting syncing.
                                                   Populating this value after beginning syncing will return an error.
      --data-dir string                            folder used to store logs and any data used to perform validation
      --end int                                    block index to stop syncing (default -1)
      --exempt-accounts string                     Absolute path to a file listing all accounts to exempt from balance
                                                   tracking and reconciliation. Look at the examples directory for an example of
                                                   how to structure this file.
      --halt-on-reconciliation-error               Determines if block processing should halt on a reconciliation
                                                   error. It can be beneficial to collect all reconciliation errors or silence
                                                   reconciliation errors during development. (default true)
  -h, --help                                       help for check
      --inactive-reconciliation-concurrency uint   concurrency to use while fetching accounts during inactive reconciliation (default 4)
      --interesting-accounts string                Absolute path to a file listing all accounts to check on each block. Look
                                                   at the examples directory for an example of how to structure this file.
      --log-balance-changes                        log balance changes
      --log-blocks                                 log processed blocks
      --log-reconciliations                        log balance reconciliations
      --log-transactions                           log processed transactions
      --lookup-balance-by-block                    When set to true, balances are looked up at the block where a balance
                                                   change occurred instead of at the current block. Blockchains that do not support
                                                   historical balance lookup should set this to false. (default true)
      --start int                                  block index to start syncing (default -1)
      --transaction-concurrency uint               concurrency to use while fetching transactions (if required) (default 16)

Global Flags:
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

In production deployments, it is useful to initialize the response
Asserter (https://github.com/coinbase/rosetta-sdk-go/tree/master/asserter) using
a static configuration instead of intializing a configuration dynamically
from the node. This allows a client to error on new types/statuses that may
have been added in an update instead of silently erroring.

To use this command, simply provide an absolute path as the argument for where
the configuration file should be saved (in JSON). Populate the optional
--server-url flag with the url of the server to generate the configuration
from.

Usage:
  rosetta-cli create:configuration [flags]

Flags:
  -h, --help   help for create:configuration

Global Flags:
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

While debugging, it is often useful to inspect the state
of an account at a certain block. This command allows you to look up
any account by providing a JSON representation of a types.AccountIdentifier
(and optionally a height to perform the query).

For example, you could run view:account '{"address":"interesting address"}' 1000
to lookup the balance of an interesting address at block 1000. Allowing the
address to specified as JSON allows for querying by SubAccountIdentifier.

Usage:
  rosetta-cli view:account [flags]

Flags:
  -h, --help   help for view:account

Global Flags:
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

While debugging a Node API implementation, it can be very
useful to inspect block contents. This command allows you to fetch any
block by index to inspect its contents. It uses the
fetcher (https://github.com/coinbase/rosetta-sdk-go/tree/master/fetcher) package
to automatically get all transactions in the block and assert the format
of the block is correct before printing.

If this command errors, it is likely because the block you are trying to
fetch is formatted incorrectly.

Usage:
  rosetta-cli view:block [flags]

Flags:
  -h, --help   help for view:block

Global Flags:
      --server-url string   base URL for a Rosetta server (default "http://localhost:8080")

cmd
examples // examples of different config files
internal
  logger // logic to write syncing information to stdout/files
  processor // Helper/Handler implementations for reconciler, storage, and syncer
  storage // persists block to temporary storage and allows for querying balances
  utils // useful functions