amareleo-chain-api
| Crates.io | amareleo-chain-api |
| lib.rs | amareleo-chain-api |
| version | 2.5.0 |
| created_at | 2025-03-22 12:15:11.704289+00 |
| updated_at | 2025-06-19 19:53:39.004214+00 |
| description | API for a lite Aleo development node |
| homepage | https://amareleo.com |
| repository | https://github.com/kaxxa123/amareleo-chain |
| max_upload_size | |
| id | 1601760 |
| size | 143,875 |
Alex Zammit (kaxxa123)
documentation
README
amareleo-chain-api
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.
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:
