Crate snarkos_rpc[][src]

Modules

error
gen_client

The generated client module.

rpc_impl

Implementation of public RPC endpoints.

rpc_impl_protected

Implementation of private RPC endpoints that require authentication.

rpc_server

Logic for instantiating the RPC server.

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

Meta

RPC metadata for encoding authentication

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

RpcFunctionsClient

The Client.

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

Traits

ProtectedRpcFunctions

Definition of private RPC endpoints that require authentication.

RpcFunctions

Definition of public RPC endpoints.

Functions

start_rpc_server

Starts a local JSON-RPC HTTP server at rpc_port in a new thread. Rpc failures will error on the thread level but not affect the main network server. This may be changed in the future to give the node more control of the rpc server.