Crate snarkos_rpc

On Aleo, full nodes run a JSON-RPC server to enable API calls for fetching data and interacting with peers connected to the network.

RPC Port

snarkos --rpc-port 3030

The default RPC port is 3030. A custom RPC port may be specified using the --rpc-port flag when starting a node.

Authentication for Private RPC Endpoints

snarkos --rpc-username {USERNAME} --rpc-password {PASSWORD}

The RPC server exposes protected RPC endpoints for account specific operations, such as creating an account, creating a transaction, and fetching record commitments. RPC requests to protected RPC endpoints can be optionally guarded with an authentication header.

To enable this authentication layer, provide the authentication credentials to the --rpc-username and --rpc-password flags when booting up a full node.

Modules

custom_rpc_server

Logic for instantiating the RPC server.

error

rpc_impl

Implementation of public RPC endpoints.

rpc_impl_protected

Implementation of private RPC endpoints that require authentication.

rpc_trait

Definition of the public and private RPC endpoints.

rpc_types

Structures for RPC endpoint requests and responses.

Structs

BlockInfo

Returned value for the getblock rpc call

BlockTemplate

Returned value for the getblocktemplate rpc call

CreateRawTransactionOuput

Output for the createrawtransaction rpc call

DecryptRecordInput

Input for the decryptrecord rpc call

Edge

A connection in the graph of the known network.

Meta

RPC metadata for encoding authentication

NetworkGraph

The crawled known network and measurements.

NodeInfo

Returned value for the getnodeinfo rpc call

PeerInfo

Returned value for the getpeerinfo rpc call

RPCRecordPayload

Record payload data

RecordInfo

Returned value for the decoderawrecord rpc call

RpcAccount

Output for the createaccount rpc call

RpcCredentials

Defines the authentication format for accessing private endpoints on the RPC server

RpcImpl

Implements JSON-RPC HTTP endpoint functions for a node. The constructor is given Arc::clone() copies of all needed node components.

RpcInner

TransactionInfo

Returned value for the gettransaction rpc call

TransactionInputs

Input for the createrawtransaction rpc call

TransactionMetadata

Additional metadata included with a transaction response

TransactionRecipient

Recipient of a transaction

Vertice

Metadata and measurements pertaining to a node in the graph of the known network.

Traits

ProtectedRpcFunctions

Definition of private RPC endpoints that require authentication.

RpcFunctions

Definition of public RPC endpoints.

Functions

start_rpc_server