ASPMembership

asp_membership

Struct ASPMembership 

Source 
pub struct ASPMembership;
Expand description

ASP Membership contract

Implementations§

Source§

impl ASPMembership

Source

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

Constructor: initialize the ASP Membership contract

Creates a new Merkle tree with the specified number of levels and sets the admin address. The tree is initialized with zero hashes at each level.

§Arguments
  • env - The Soroban environment
  • admin - Address of the contract administrator
  • levels - Number of levels in the Merkle tree (must be in range [1..32])
§Returns

Returns Ok(()) on success, or an error if already initialized

§Panics

Panics if levels is 0 or greater than 32

Source

pub fn update_admin(env: Env, new_admin: Address) -> Result<(), Error>

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
Source

pub fn set_admin_insert_only(env: Env, admin_only: bool) -> Result<(), Error>

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
Source

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

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

Source

pub fn hash_pair(env: &Env, 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

Source

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

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

Source§

impl ASPMembership

Source

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

Constructor: initialize the ASP Membership contract

Creates a new Merkle tree with the specified number of levels and sets the admin address. The tree is initialized with zero hashes at each level.

§Arguments
  • env - The Soroban environment
  • admin - Address of the contract administrator
  • levels - Number of levels in the Merkle tree (must be in range [1..32])
§Returns

Returns Ok(()) on success, or an error if already initialized

§Panics

Panics if levels is 0 or greater than 32

Source§

impl ASPMembership

Source

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

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

impl ASPMembership

Source

pub const fn spec_xdr_set_admin_insert_only() -> [u8; 408]

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

impl ASPMembership

Source

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

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

Source§

impl ASPMembership

Source

pub const fn spec_xdr_hash_pair() -> [u8; 412]

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

Source§

impl ASPMembership

Source

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

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

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