Cardano Rosetta

An implementation of Rosetta 1.4.1 for Cardano.

Build

From anywhere

docker build -t cardano-rosetta:0.2.2 https://github.com/input-output-hk/cardano-rosetta.git#0.2.2

With local source code

docker build -t cardano-rosetta .

Optionally specify a network name, other than mainnet, using a build argument:

  --build-arg NETWORK=testnet

Optionally use cached build layers to reduce the initialization time. Suits dev and demo use-cases:

export DOCKER_BUILDKIT=1
docker build \
    --build-arg BUILDKIT_INLINE_CACHE=1 \
    --cache-from=inputoutput/cardano-rosetta:master \
    -t cardano-rosetta:0.2.2 \
    https://github.com/input-output-hk/cardano-rosetta.git#0.2.2

Run

Mount a single volume into the standard storage location, mapping the server port to the host, and allocating a suitably-sized /dev/shm. See the complete Docker run reference for full control.

docker run \
  --name cardano-rosetta \
  -p 8080:8080 \
  -v cardano-rosetta:/data \
  --shm-size=2g \
  cardano-rosetta:0.2.2

Configuration

Set ENVs for optional runtime configuration

-e MODE=offline

MODE

See Rosetta docs for information on modes

• online - default
• offline

DEFAULT_RELATIVE_TTL

Specify the TTL without needing to access an online method. Default: 1000

LOGGER_MIN_SEVERITY

• trace
• debug
• info - default
• warn
• error
• fatal

PAGE_SIZE

Default: 25

Upgrading

As per the release notes, you may be required to refresh the state managed by cardano-db-sync. This can be achieved without requiring a network re-sync using the following command:

docker stop cardano-rosetta && \
docker rm cardano-rosetta && \
docker run --rm -v cardano-rosetta:/data ubuntu rm -rf /data/postgresql /data/db-sync

Progress will be logged by the new container.

Documentation