Struct ASPMembershipClient 

pub struct ASPMembershipClient<'a> {
    pub env: Env,
    pub address: Address,
    /* private fields */
}

ASPMembershipClient is a client for calling the contract defined in “ASPMembership”.

Fields

env: Env

address: Address

Implementations

impl<'a> ASPMembershipClient<'a>

pub fn new(env: &Env, address: &Address) -> Self

pub fn set_auths(&self, auths: &'a [SorobanAuthorizationEntry]) -> Self

Set authorizations in the environment which will be consumed by contracts when they invoke Address::require_auth or Address::require_auth_for_args functions.

Requires valid signatures for the authorization to be successful. To mock auth without requiring valid signatures, use mock_auths.

See soroban_sdk::Env::set_auths for more details and examples.

pub fn mock_auths(&self, mock_auths: &'a [MockAuth<'a>]) -> Self

Mock authorizations in the environment which will cause matching invokes of Address::require_auth and Address::require_auth_for_args to pass.

See soroban_sdk::Env::set_auths for more details and examples.

pub fn mock_all_auths(&self) -> Self

Mock all calls to the Address::require_auth and Address::require_auth_for_args functions in invoked contracts, having them succeed as if authorization was provided.

See soroban_sdk::Env::mock_all_auths for more details and examples.

pub fn mock_all_auths_allowing_non_root_auth(&self) -> Self

A version of mock_all_auths that allows authorizations that are not present in the root invocation.

Refer to mock_all_auths documentation for details and prefer using mock_all_auths unless non-root authorization is required.

See soroban_sdk::Env::mock_all_auths_allowing_non_root_auth for more details and examples.

impl<'a> ASPMembershipClient<'a>

pub fn update_admin(&self, new_admin: &Address)

Update the contract administrator

Changes the admin address to a new address. Only the current admin can call this function.

Arguments

• env - The Soroban environment
• new_admin - Address of the new administrator

pub fn try_update_admin( &self, new_admin: &Address, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Update the contract administrator

Changes the admin address to a new address. Only the current admin can call this function.

Arguments

• env - The Soroban environment
• new_admin - Address of the new administrator

pub fn set_admin_insert_only(&self, admin_only: &bool)

Set whether admin permission is required to insert a leaf

When admin_only is true (default), only the admin can insert leaves. When false, anyone can insert leaves. Only the admin can change this setting.

Arguments

• env - The Soroban environment
• admin_only - Whether admin permission is required for leaf insertion

pub fn try_set_admin_insert_only( &self, admin_only: &bool, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Set whether admin permission is required to insert a leaf

When admin_only is true (default), only the admin can insert leaves. When false, anyone can insert leaves. Only the admin can change this setting.

Arguments

• env - The Soroban environment
• admin_only - Whether admin permission is required for leaf insertion

pub fn get_root(&self) -> U256

Get the current Merkle root

Returns the current root hash of the Merkle tree.

Arguments

• env - The Soroban environment

Returns

The current Merkle root as U256

Panics

Panics if the contract has not been initialized

pub fn try_get_root( &self, ) -> Result<Result<U256, <U256 as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Get the current Merkle root

Returns the current root hash of the Merkle tree.

Arguments

• env - The Soroban environment

Returns

The current Merkle root as U256

Panics

Panics if the contract has not been initialized

pub fn hash_pair(&self, left: &U256, right: &U256) -> U256

Hash two U256 values using Poseidon2 compression

Computes the Poseidon2 hash of two field elements in compression mode. This is the core hashing function used for Merkle tree operations.

Arguments

• env - The Soroban environment
• left - Left input value
• right - Right input value

Returns

The Poseidon2 hash result as U256

pub fn try_hash_pair( &self, left: &U256, right: &U256, ) -> Result<Result<U256, <U256 as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Hash two U256 values using Poseidon2 compression

Computes the Poseidon2 hash of two field elements in compression mode. This is the core hashing function used for Merkle tree operations.

Arguments

• env - The Soroban environment
• left - Left input value
• right - Right input value

Returns

The Poseidon2 hash result as U256

pub fn insert_leaf(&self, leaf: &U256)

Insert a new leaf into the Merkle tree

Adds a new member to the Merkle tree and updates the root. The leaf is inserted at the next available index and the tree is updated efficiently by only recomputing the hashes along the path to the root. If admin_insert_only is enabled (the default), only the admin can insert leaves; otherwise, anyone can call this function.

Arguments

• env - The Soroban environment
• leaf - The leaf value to insert (typically a commitment or hash)

Returns

Returns Ok(()) on success, or MerkleTreeFull if the tree is at capacity

pub fn try_insert_leaf( &self, leaf: &U256, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Insert a new leaf into the Merkle tree

Adds a new member to the Merkle tree and updates the root. The leaf is inserted at the next available index and the tree is updated efficiently by only recomputing the hashes along the path to the root. If admin_insert_only is enabled (the default), only the admin can insert leaves; otherwise, anyone can call this function.

Arguments

• env - The Soroban environment
• leaf - The leaf value to insert (typically a commitment or hash)

Returns

Returns Ok(()) on success, or MerkleTreeFull if the tree is at capacity