Struct AleoAPIClient

pub struct AleoAPIClient<N: Network> { /* private fields */ }

Aleo API client for interacting with the Aleo Beacon API

Implementations

impl<N: Network> AleoAPIClient<N>

pub fn latest_height(&self) -> Result<u32>

Get the latest block height

pub fn latest_hash(&self) -> Result<N::BlockHash>

Get the latest block hash

pub fn latest_block(&self) -> Result<Block<N>>

Get the latest block

pub fn get_block(&self, height: u32) -> Result<Block<N>>

Get the block matching the specific height from the network

pub fn get_blocks( &self, start_height: u32, end_height: u32, ) -> Result<Vec<Block<N>>>

Get a range of blocks from the network (limited 50 blocks at a time)

pub fn get_transaction(&self, transaction_id: &str) -> Result<Transaction<N>>

Retrieve a transaction by via its transaction id

pub fn get_memory_pool_transactions(&self) -> Result<Vec<Transaction<N>>>

Get pending transactions currently in the mempool.

pub fn get_program( &self, program_id: impl TryInto<ProgramID<N>>, ) -> Result<Program<N>>

Get a program from the network by its ID. This method will return an error if it does not exist.

pub fn get_program_imports( &self, program_id: impl TryInto<ProgramID<N>>, ) -> Result<IndexMap<ProgramID<N>, Program<N>>>

Resolve imports of a program in a depth-first-search order from a program id

pub fn get_program_imports_from_source( &self, program: &Program<N>, ) -> Result<IndexMap<ProgramID<N>, Program<N>>>

Resolve imports of a program in a depth-first-search order from program source code

pub fn get_program_mappings( &self, program_id: impl TryInto<ProgramID<N>>, ) -> Result<Vec<Identifier<N>>>

Get all mappings associated with a program.

pub fn get_mapping_value( &self, program_id: impl TryInto<ProgramID<N>>, mapping_name: impl TryInto<Identifier<N>>, key: impl TryInto<Plaintext<N>>, ) -> Result<Value<N>>

Get the current value of a mapping given a specific program, mapping name, and mapping key

pub fn find_block_hash( &self, transaction_id: N::TransactionID, ) -> Result<N::BlockHash>

pub fn find_transition_id( &self, input_or_output_id: Field<N>, ) -> Result<N::TransitionID>

Returns the transition ID that contains the given input ID or output ID.

pub fn scan( &self, view_key: impl TryInto<ViewKey<N>>, block_heights: Range<u32>, max_records: Option<usize>, ) -> Result<Vec<(Field<N>, Record<N, Ciphertext<N>>)>>

Scans the ledger for records that match the given view key.

pub fn get_program_records( &self, private_key: &PrivateKey<N>, program_id: impl TryInto<ProgramID<N>>, block_heights: Range<u32>, unspent_only: bool, max_records: Option<usize>, ) -> Result<Vec<(Field<N>, Record<N, Ciphertext<N>>)>>

Search for records that belong to a specific program

pub fn get_unspent_records( &self, private_key: &PrivateKey<N>, block_heights: Range<u32>, max_gates: Option<u64>, specified_amounts: Option<&Vec<u64>>, ) -> Result<Vec<(Field<N>, Record<N, Plaintext<N>>)>>

Search for unspent records in the ledger

pub fn transaction_broadcast( &self, transaction: Transaction<N>, ) -> Result<String>

Broadcast a deploy or execute transaction to the Aleo network

impl<N: Network> AleoAPIClient<N>

pub fn new(base_url: &str, chain: &str) -> Result<Self>

pub fn testnet3() -> Self

pub fn local_testnet3(port: &str) -> Self

pub fn base_url(&self) -> &str

Get base URL

pub fn network_id(&self) -> &str

Get network ID being interacted with

Trait Implementations

impl<N: Clone + Network> Clone for AleoAPIClient<N>

fn clone(&self) -> AleoAPIClient<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + Network> Debug for AleoAPIClient<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.