2 unstable releases

0.4.0 Jun 29, 2023
0.1.0 Mar 30, 2023

#2386 in Magic Beans

Download history 49/week @ 2024-03-17 59/week @ 2024-03-24 101/week @ 2024-03-31 36/week @ 2024-04-07 38/week @ 2024-04-14 55/week @ 2024-04-21 38/week @ 2024-04-28 45/week @ 2024-05-05 49/week @ 2024-05-12 43/week @ 2024-05-19 53/week @ 2024-05-26 39/week @ 2024-06-02 28/week @ 2024-06-09 44/week @ 2024-06-16 51/week @ 2024-06-23 12/week @ 2024-06-30

137 downloads per month
Used in 16 crates (via rosetta-core)

MIT license

125KB
1.5K SLoC

Rosetta SDK Documentation

The Rosetta is a set of tools for blockchain integration, it's goal is make blockchain integration simpler, faster, and more reliable. This repo provides a framework for Analog’s chronicles — special nodes hosted by time node operators — to simplify their interactions with Analog-connected chains in a manner compliant with the Analog Network’s protocol.

Repository structure

This repo contains the following modules:

  • rosetta-core. Provides traits and definitions shared by the server and client crates.
  • rosetta-server. This is a generic implementation of the Rosetta Server. The Rosetta Server is a standalone server that a connector on any Analog-supported chain can connect to and listen to the port specified in the settings.
  • rosetta-client. This is a standard client that interacts with the Rosetta Server.
  • rosetta-types. It contains the request and response structs used by the client and server. It is initially autogenerated using the openapi-generator.
  • rosetta-crypto. It has cryptographic primitives used by the rosetta-client.
  • rosetta-wallet. This is a command line interface (CLI) built with the rosetta-client.
  • rosetta-cli. This is a CLI built with the rosetta-client.
  • rosetta-docker. This is a generic Rosetta Server testing infrastructure.
  • chains. These are chain-specific client/server components.

Getting started

To get started with the Rosetta SDK, ensure you have following dependencies installed:

Build

$ cargo build -p rosetta-client

Lint

$ cargo +nightly fmt --all -- --check
$ cargo clippy --locked --workspace --examples --tests --all-features -- \
  -Dwarnings \
  -Dclippy::unwrap_used \
  -Dclippy::expect_used \
  -Dclippy::nursery \
  -Dclippy::pedantic \
  -Aclippy::module_name_repetitions
$ dprint check
$ cargo deny check

Run unit tests

$ cargo test --workspace --all-features \
  --exclude rosetta-testing-arbitrum \
  --exclude rosetta-server-astar \
  --exclude rosetta-server-ethereum \
  --exclude rosetta-server-polkadot \
  --exclude rosetta-client

Run integration tests

# Pull docker images
./scripts/pull_nodes.sh

# Run tests
$ cargo test \
  -p rosetta-server-astar \
  -p rosetta-server-ethereum \
  -p rosetta-server-polkadot \
  -p rosetta-client

Run arbitrum integration tests

# Setup arbitrum local testnet
git clone -b release --depth=1 --no-tags --recurse-submodules https://github.com/ManojJiSharma/nitro-testnode.git
cd nitro-testnode
./test-node.bash --detach
cd ..

# Run tests
cargo test --locked -p rosetta-testing-arbitrum

Contributing

You can contribute to this repo in a number of ways, including:

Dependencies

~0.7–1.4MB
~33K SLoC