amareleo-chain-api 2.5.0

API for a lite Aleo development node
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# amareleo-chain-api

[![Crates.io](https://img.shields.io/crates/v/amareleo-chain-api.svg?color=neon)](https://crates.io/crates/amareleo-chain-api)
[![Authors](https://img.shields.io/badge/authors-Amareleo-orange.svg)](https://amareleo.com)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE.md)

The `amareleo-chain-api` crate provides the interface for Rust applications to programmatically control node instances.

## AmareleoApi

The `AmareleoApi` struct is the main object for interacting with the Amareleo node. It provides methods to configure, start and stop the node.

`AmareleoApi` is a singleton, which means that there can only be one instance per process. This results from a limitation in snarkVM that is described [here](https://github.com/kaxxa123/amareleo-chain/issues/19). 

It is possible to launch multiple nodes and run them in parallel from different processes. To do this one needs to avoid port conflicts and use different ledger storage directories.

`AmareleoApi` is driven by a state engine defined by the `AmareleoApiState` enumeration and depicted in the following diagram:

![AmareleoApiState](./docs/state_engine.png "AmareleoApi State Engine")