https://github.com/monadicus/mentat
A Rust-based implementation of the Coinbase Rosetta SDK
https://github.com/monadicus/mentat
blockchain coinbase rosetta rust
Last synced: 2 months ago
JSON representation
A Rust-based implementation of the Coinbase Rosetta SDK
- Host: GitHub
- URL: https://github.com/monadicus/mentat
- Owner: monadicus
- License: mit
- Created: 2022-02-18T16:55:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T23:58:25.000Z (over 2 years ago)
- Last Synced: 2025-04-05T18:52:00.202Z (6 months ago)
- Topics: blockchain, coinbase, rosetta, rust
- Language: Rust
- Homepage:
- Size: 12.8 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Mentat
# Overview
`Mentat` is a zero dependency framework that makes implementing and calling the Rosetta API for a myriad of Blockchains easier.
It is written in Rust for high performance, and genercism such that it could be used for any Blockchain.
# Features
- Server.
- Default Not Implemented Routes
- Logging.
- Default support for Offline and Online mode.
- Easily run your Blockchain node with proper logging.
- Client.
- Keys(Different signature schemes are supported).
- Aleo/Snarkos
- Easy To Containerize.
# System Requirements
`Mentat` itself is lightweight and easy to integrate anywhere.
However, please refer to each Blockchain implementation using `Mentat` to see more requirements.
# Usage
As specified in the [Rosetta API Principles](https://www.rosetta-api.org/docs/automated_deployment.html),
all Rosetta implementations must be deployable via Docker and support running via either an
[`online` or `offline` mode](https://www.rosetta-api.org/docs/node_deployment.html#multiple-modes).
**YOU MUST INSTALL DOCKER FOR THE FOLLOWING INSTRUCTIONS TO WORK. YOU CAN DOWNLOAD
DOCKER [HERE](https://www.docker.com/get-started).**
## Install
Running the following commands will create a Docker image called `rosetta-snaroks:latest`.
Change `rosetta-snarkos` with any other Mentat supported Blockchain.
### From GitHub
To build the Docker image from the latest release, run:
```text
docker build -t mentat-rosetta-snarkos:latest https://github.com/monadicus/mentat.git --build-arg SERVICE=rosetta-snarkos
```
Replace `rosetta-snarkos` with whatever service we offer.
### From Source
After cloning this repository, and changing directory to a service run:
```text
make build-local
```
#### Run
Running the following commands will start a Docker container in
[detached mode](https://docs.docker.com/engine/reference/run/#detached--d) with
a data directory at `/service-data` and the Rosetta API accessible
at port `8080`.
##### Configuration Environment Variables
MAY VARY BETWEEN IMPLEMENTATIONS OF ROSETTA USING MENTAT.
- `MODE` (optional) - Determines if Rosetta can make outbound connections. Options: `ONLINE` or `OFFLINE` (which defaults to `ONLINE`).
- `NETWORK` (optional) - Service network to launch and/or communicate with. Options: `MAINNET` or `TESTNET` (which defaults to `MAINNET`).
- `PORT` (required) - Which port to use for the Rosetta service.
##### Mainnet:Online
```text
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/snarkos-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-mainnet-online`._
##### Mainnet:Online (Remote)
```text
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-mainnet-remote`._
##### Mainnet:Offline
```text
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-mainnet-offline`._
##### Testnet:Online
```text
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/snarkos-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-testnet-online`._
##### Testnet:Online (Remote)
```text
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-testnet-remote`._
##### Testnet:Offline
```text
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-snarkos:latest
```
_If you cloned the repository, you can run `make run-testnet-offline`._
# Testing
TODO @MACS-J1149
# Issues
Interested in helping fix issues in this repository? You can find to-dos in the [Issues](https://github.com/monadicus/mentat/issues) section.
# Development
- `cargo +nightly fmt --check --all` To check the formatting of the source code and all rosetta implementations.
- `cargo clippy --all` To lint the formatting of the source code and all rosetta implementations.
- `make build-local SERVICE=rosetta-snarkos BRANCH=main` To build the local docker image. The arguments are optional and default to shown values.
# License
This project is available open source under the terms of the MIT License.
© 2022 Monadicus