Skip to main content

AleoClient

Struct AleoClient 

Source
pub struct AleoClient {
    pub network: AleoHttpClient,
    /* private fields */
}
Expand description

High-level Aleo client that orchestrates the full lifecycle.

Fields§

§network: AleoHttpClient

Implementations§

Source§

impl AleoClient

Source

pub fn new(node_url: &str) -> Result<Self>

Create a new client pointing at an Aleo node.

Source

pub fn new_with_rpc(rest_url: &str, rpc_url: &str) -> Result<Self>

Create a client with a custom RPC URL (for testing with wiremock).

Source

pub fn set_account_from_private_key_str(&mut self, pk_str: &str) -> Result<()>

Set the account from a private key string.

Source

pub fn require_account(&self) -> Result<&AleoAccount>

Get a reference to the current account, or error if not set.

Source

pub fn load_program_from_source(&mut self, source: &str) -> Result<()>

Load a program from source string and store it.

Source

pub fn set_program(&mut self, program: AleoProgram)

Directly set a program (e.g. from AleoProgram::credits()).

Source

pub fn require_program(&self) -> Result<&AleoProgram>

Get a reference to the stored program, or error if not set.

Source

pub fn execute_local( &self, program_id: &str, function_name: &str, inputs: &[String], ) -> Result<String>

Execute a function locally without proving or broadcasting.

This is a dry-run: it authorizes and executes the function call using a temporary process with the loaded program, but does NOT generate proofs or submit anything to the network.

If a program has been loaded via load_program_from_source(), it will be registered automatically. For built-in programs (credits.aleo), no pre-loading is needed.

Source

pub async fn prove_execution( &self, private_key: &PrivateKey<TestnetV0>, program_id: &ProgramID<TestnetV0>, function_name: &str, inputs: Vec<&str>, base_fee: u64, priority_fee: u64, ) -> Result<String>

Full pipeline: authorize → execute → prove → return Transaction JSON (no broadcast).

Equivalent to JS SDK run(_, _, _, proveExecution=true) without the broadcast step. Returns the serialized transaction as a JSON string.

Source

pub async fn execute_and_broadcast( &self, private_key: &PrivateKey<TestnetV0>, program_id: &ProgramID<TestnetV0>, function_name: &str, inputs: Vec<&str>, base_fee: u64, priority_fee: u64, ) -> Result<String>

Full pipeline: authorize → execute → prove → broadcast.

Returns the transaction ID on success.

Source

pub async fn execute_and_broadcast_with_values( &self, private_key: &PrivateKey<TestnetV0>, program_id: &ProgramID<TestnetV0>, function_name: &str, values: Vec<Value<TestnetV0>>, base_fee: u64, priority_fee: u64, ) -> Result<String>

Full pipeline with pre-parsed snarkVM Value inputs.

Use this when inputs include record ciphertexts — decrypt them first, wrap as Value::Record, and pass here instead of raw strings. Otherwise behaves identically to execute_and_broadcast.

Source

pub async fn deploy_program( &self, program_source: &str, priority_fee_in_microcredits: u64, ) -> Result<String>

Full deployment pipeline: parse → prove → compute fee → fetch state root → build tx → broadcast.

This is the equivalent of JS SDK’s ProgramManager.deploy().

program_source is the raw .aleo program source code. priority_fee_in_microcredits adds priority over the minimum deployment cost.

Returns the transaction ID on success.

Source

pub async fn get_balance(&self) -> Result<Option<u64>>

Query the public balance of the current account from credits.aleo.

Returns None if the account has never received credits (no mapping entry).

Source

pub async fn fetch_unspent_records(&self) -> Result<String>

Fetch unspent records for the current account’s view key.

Source

pub async fn find_private_credits_records(&self) -> Result<Vec<(String, u64)>>

Find unspent private credits records owned by the current account’s view key.

Source

pub async fn get_block_height(&self) -> Result<u32>

Fetch the current block height.

Source

pub async fn get_state_root(&self) -> Result<<TestnetV0 as Network>::StateRoot>

Fetch latest state root.

Source

pub async fn verify_execution(&self, tx_id: &str) -> Result<String>

Fetch a transaction from the network and verify its proof.

Equivalent to JS SDK’s verifyExecution() — deserializes the on-chain transaction and runs the snarkVM proof verifier locally.

  • Execute transactions: verifies the execution proof.
  • Deploy transactions: verifies the deployment proof.

Trait Implementations§

Source§

impl Clone for AleoClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more