ASPNonMembership

asp_non_membership

Struct ASPNonMembership 

Source 
pub struct ASPNonMembership;

Implementations§

Source§

impl ASPNonMembership

Source

pub fn __constructor(env: Env, admin: Address) -> Result<(), Error>

Constructor: initialize the contract with an admin address and an empty tree

Sets up the contract with the specified admin and initializes an empty Sparse Merkle Tree with root = 0. This function can only be called once.

§Arguments
  • env - The Soroban environment
  • admin - Address that will have permission to modify the tree
§Returns

Returns Ok(()) on success

Source

pub fn update_admin(env: Env, 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
Source

pub fn find_key(env: Env, key: U256) -> Result<FindResult, Error>

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
Source

pub fn insert_leaf(env: Env, key: U256, value: U256) -> Result<(), Error>

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
Source

pub fn delete_leaf(env: Env, key: U256) -> Result<(), Error>

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
Source

pub fn update_leaf(env: Env, key: U256, new_value: U256) -> Result<(), Error>

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
Source

pub fn verify_non_membership( env: Env, key: U256, siblings: Vec<U256>, not_found_key: U256, not_found_value: U256, ) -> Result<bool, Error>

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.

Source

pub fn get_root(env: Env) -> Result<U256, Error>

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

Source§

impl ASPNonMembership

Source

pub const fn spec_xdr___constructor() -> [u8; 444]

Constructor: initialize the contract with an admin address and an empty tree

Sets up the contract with the specified admin and initializes an empty Sparse Merkle Tree with root = 0. This function can only be called once.

§Arguments
  • env - The Soroban environment
  • admin - Address that will have permission to modify the tree
§Returns

Returns Ok(()) on success

Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_update_admin() -> [u8; 300]

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
Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_find_key() -> [u8; 660]

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
Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_insert_leaf() -> [u8; 680]

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
Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_delete_leaf() -> [u8; 636]

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
Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_update_leaf() -> [u8; 620]

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
Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_verify_non_membership() -> [u8; 868]

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.

Source§

impl ASPNonMembership

Source

pub const fn spec_xdr_get_root() -> [u8; 312]

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

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
§

impl<T, C> Compare<&T> for C
where C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

§

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

§

impl<T, U, E, C> Compare<(T, U)> for C
where C: Compare<T, Error = E, Error = E> + Compare<U>,

§

type Error = E

§

fn compare( &self, a: &(T, U), b: &(T, U), ) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

§

impl<T, U, V, E, C> Compare<(T, U, V)> for C
where C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

§

type Error = E

§

fn compare( &self, a: &(T, U, V), b: &(T, U, V), ) -> Result<Ordering, <C as Compare<(T, U, V)>>::Error>

§

impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,

§

type Error = E

§

fn compare( &self, a: &(T, U, V, W), b: &(T, U, V, W), ) -> Result<Ordering, <C as Compare<(T, U, V, W)>>::Error>

§

impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,

§

type Error = E

§

fn compare( &self, a: &(T, U, V, W, X), b: &(T, U, V, W, X), ) -> Result<Ordering, <C as Compare<(T, U, V, W, X)>>::Error>

§

impl<T, C> Compare<Box<T>> for C
where C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

§

fn compare( &self, a: &Box<T>, b: &Box<T>, ) -> Result<Ordering, <C as Compare<Box<T>>>::Error>

§

impl<T, C> Compare<Option<T>> for C
where C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

§

fn compare( &self, a: &Option<T>, b: &Option<T>, ) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

§

impl<T, C> Compare<Rc<T>> for C
where C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

§

fn compare( &self, a: &Rc<T>, b: &Rc<T>, ) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

§

impl<T, C> Compare<Vec<T>> for C
where C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

§

fn compare( &self, a: &Vec<T>, b: &Vec<T>, ) -> Result<Ordering, <C as Compare<Vec<T>>>::Error>

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<E, T, U> IntoVal<E, T> for U
where E: Env, T: FromVal<E, U>,

§

fn into_val(&self, e: &E) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<C> Register for C
where C: ContractFunctionSet + 'static,

§

fn register<'i, I, A>(self, env: &Env, id: I, args: A) -> Address
where I: Into<Option<&'i Address>>, A: ConstructorArgs,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<E, T, U> TryIntoVal<E, T> for U
where E: Env, T: TryFromVal<E, U>,

§

type Error = <T as TryFromVal<E, U>>::Error

§

fn try_into_val(&self, env: &E) -> Result<T, <U as TryIntoVal<E, T>>::Error>

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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