Struct ASPNonMembershipClient 

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

ASPNonMembershipClient is a client for calling the contract defined in “ASPNonMembership”.

Fields

env: Env

address: Address

Implementations

impl<'a> ASPNonMembershipClient<'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> ASPNonMembershipClient<'a>

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

Update the admin address

Transfers administrative control to a new address. Requires authorization from the current admin.

Arguments

• env - The Soroban environment
• new_admin - New address that will have permission to modify the tree

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

Update the admin address

Transfers administrative control to a new address. Requires authorization from the current admin.

Arguments

• env - The Soroban environment
• new_admin - New address that will have permission to modify the tree

pub fn find_key(&self, key: &U256) -> FindResult

Find a key in the tree

Public entry point for searching the tree. Returns comprehensive information about the key including whether it exists, its value, and the Merkle path siblings required for proof generation.

Arguments

• env - The Soroban environment
• key - Key to search for in the tree

Returns

Returns Ok(FindResult) containing whether the key was found, siblings along the path, and collision information for non-membership proofs, or an error if database operations fail.

Errors

• Error::KeyNotFound - Database operations failed or invalid node structure

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

Find a key in the tree

Public entry point for searching the tree. Returns comprehensive information about the key including whether it exists, its value, and the Merkle path siblings required for proof generation.

Arguments

• env - The Soroban environment
• key - Key to search for in the tree

Returns

Returns Ok(FindResult) containing whether the key was found, siblings along the path, and collision information for non-membership proofs, or an error if database operations fail.

Errors

• Error::KeyNotFound - Database operations failed or invalid node structure

pub fn insert_leaf(&self, key: &U256, value: &U256)

Insert a new key-value pair into the tree

Adds a new leaf to the Sparse Merkle tree, building any missing intermediate nodes. Handles collision cases where a new key shares a path prefix with an existing leaf by extending the tree depth. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to insert
• value - Value to associate with the key

Returns

Returns Ok(()) on success, emitting a LeafInsertedEvent with the new root.

Errors

• Error::KeyAlreadyExists - Key already exists in the tree
• Error::KeyNotFound - Database operations failed

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

Insert a new key-value pair into the tree

Adds a new leaf to the Sparse Merkle tree, building any missing intermediate nodes. Handles collision cases where a new key shares a path prefix with an existing leaf by extending the tree depth. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to insert
• value - Value to associate with the key

Returns

Returns Ok(()) on success, emitting a LeafInsertedEvent with the new root.

Errors

• Error::KeyAlreadyExists - Key already exists in the tree
• Error::KeyNotFound - Database operations failed

pub fn delete_leaf(&self, key: &U256)

Delete a key from the tree

Removes a leaf from the Sparse Merkle tree, handling both sparse branches (single child) and mixed branches (two populated children). When a leaf is deleted, its sibling may be promoted to replace the parent node, collapsing the tree structure. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to delete from the tree

Returns

Returns Ok(()) on success, emitting a LeafDeletedEvent with the new root.

Errors

• Error::KeyNotFound - Key does not exist in the tree or database operations failed

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

Delete a key from the tree

Removes a leaf from the Sparse Merkle tree, handling both sparse branches (single child) and mixed branches (two populated children). When a leaf is deleted, its sibling may be promoted to replace the parent node, collapsing the tree structure. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to delete from the tree

Returns

Returns Ok(()) on success, emitting a LeafDeletedEvent with the new root.

Errors

• Error::KeyNotFound - Key does not exist in the tree or database operations failed

pub fn update_leaf(&self, key: &U256, new_value: &U256)

Update a key-value pair in the tree

Changes the value associated with an existing key. Recomputes all nodes along the path from the leaf to the root, removing old nodes and creating new ones. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to update
• new_value - New value to associate with the key

Returns

Returns Ok(()) on success, emitting a LeafUpdatedEvent with the new root.

Errors

• Error::KeyNotFound - Key does not exist in the tree or database operations failed

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

Update a key-value pair in the tree

Changes the value associated with an existing key. Recomputes all nodes along the path from the leaf to the root, removing old nodes and creating new ones. Requires admin authorization.

Arguments

• env - The Soroban environment
• key - Key to update
• new_value - New value to associate with the key

Returns

Returns Ok(()) on success, emitting a LeafUpdatedEvent with the new root.

Errors

• Error::KeyNotFound - Key does not exist in the tree or database operations failed

pub fn verify_non_membership( &self, key: &U256, siblings: &Vec<U256>, not_found_key: &U256, not_found_value: &U256, ) -> bool

Verify non-membership proof for a key

Verifies that a key is NOT in the tree by checking the provided Merkle proof. The proof includes siblings along the path and collision information (not_found_key/value at the leaf). Reconstructs the root from the proof and compares it with the stored root.

Arguments

• env - The Soroban environment
• key - Key to verify is not in the tree
• siblings - Sibling hashes along the path from root to leaf
• not_found_key - Key at the collision point (or queried key if empty path)
• not_found_value - Value at the collision point (or zero if empty path)

Returns

Returns Ok(true) if non-membership is verified, Ok(false) if the key actually exists in the tree.

pub fn try_verify_non_membership( &self, key: &U256, siblings: &Vec<U256>, not_found_key: &U256, not_found_value: &U256, ) -> Result<Result<bool, <bool as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Verify non-membership proof for a key

Verifies that a key is NOT in the tree by checking the provided Merkle proof. The proof includes siblings along the path and collision information (not_found_key/value at the leaf). Reconstructs the root from the proof and compares it with the stored root.

Arguments

• env - The Soroban environment
• key - Key to verify is not in the tree
• siblings - Sibling hashes along the path from root to leaf
• not_found_key - Key at the collision point (or queried key if empty path)
• not_found_value - Value at the collision point (or zero if empty path)

Returns

Returns Ok(true) if non-membership is verified, Ok(false) if the key actually exists in the tree.

pub fn get_root(&self) -> U256

Get the current root of the tree

Returns the root hash of the Sparse Merkle tree. Returns zero if the tree is empty or hasn’t been initialized yet.

Arguments

• env - The Soroban environment

Returns

Returns the current root hash as a U256 value, or zero if empty

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

Get the current root of the tree

Returns the root hash of the Sparse Merkle tree. Returns zero if the tree is empty or hasn’t been initialized yet.

Arguments

• env - The Soroban environment

Returns

Returns the current root hash as a U256 value, or zero if empty