MerkleTree

Struct MerkleTree 

Source
#[repr(C)]
pub struct MerkleTree { pub root: [u8; 32], /* private fields */ }
Expand description

Merkle tree creation result containing the root and proof generation capabilities.

This structure provides everything needed for off-chain processors to:

  1. Generate the merkle root for snapshot updates
  2. Generate merkle proofs for individual claims
  3. Verify merkle proofs for validation

§Security

  • Deterministic: Same input data always produces the same merkle root
  • Cryptographic: Uses Solana hashv for collision resistance
  • Efficient: O(n) construction time, O(log n) proof generation
  • Verifiable: All proofs can be verified on-chain

Fields§

§root: [u8; 32]

The merkle root hash (32 bytes) - used for snapshot updates

Implementations§

Source§

impl MerkleTree

Source

pub fn new(participants: Vec<DailyParticipantData>) -> Self

Create a new merkle tree from participant data.

§Parameters
  • participants: Vector of daily participant data
§Returns
  • MerkleTree instance with root and proof generation capabilities
§Panics
  • If participants vector is empty
§Example
use miracle_api::{sdk, prelude::{DailyParticipantData, MerkleTree}};

let participants = vec![
    DailyParticipantData::new([1u8; 32], 1723680000, 1723766400, [1u8; 8], [2u8; 8], 5, 0),
    DailyParticipantData::new([2u8; 32], 1723680000, 1723766400, [3u8; 8], [4u8; 8], 10, 1),
];

let merkle_tree = MerkleTree::new(participants);
println!("Merkle root: {:?}", merkle_tree.root());
Source

pub fn root(&self) -> [u8; 32]

Get the merkle root hash.

§Returns
  • 32-byte merkle root hash for snapshot updates
Source

pub fn generate_proof(&self, participant_index: usize) -> MerkleProof

Generate a merkle proof for a specific participant.

§Parameters
  • participant_index: Index of the participant in the original data
§Returns
  • MerkleProof containing path and indices for verification
§Panics
  • If participant_index is out of bounds
§Example
use miracle_api::{sdk, prelude::{DailyParticipantData, MerkleTree, EpochClaimData}};
use solana_program::pubkey::Pubkey;

let participants = vec![
    DailyParticipantData::new([1u8; 32], 1723680000, 1723766400, [1u8; 8], [2u8; 8], 5, 0),
    DailyParticipantData::new([2u8; 32], 1723680000, 1723766400, [3u8; 8], [4u8; 8], 10, 1),
];

let merkle_tree = MerkleTree::new(participants);
let payment_proof = merkle_tree.generate_proof(0);
let seal_proof = sdk::SealProof::new_for_verification(vec![[2u8; 32]], vec![true], merkle_tree.root());

// Use proof for claim instruction using dual merkle tree
let customer_wallet = Pubkey::new_unique();
let beneficiary = Pubkey::new_unique();
let epoch = 0u64;
let participant_type = 0u8;
let claim_ix = sdk::claim(
    customer_wallet,
    beneficiary,
    epoch,
    DailyParticipantData::new([1u8; 32], 1723680000, 1723766400, [1u8; 8], [2u8; 8], 5, 0),
    payment_proof.path,
    payment_proof.indices,
    seal_proof.path,
    seal_proof.indices,
    seal_proof.payment_root,
    EpochClaimData {
        customer_reward_pool: 1000000u64.to_le_bytes(),
        merchant_reward_pool: 500000u64.to_le_bytes(),
        total_customer_activity: 0u64.to_le_bytes(),
        total_merchant_activity: 0u64.to_le_bytes(),
    },
    participant_type,
    None, // social_data (no social claim)
);
Source

pub fn find_and_generate_proof( &self, participant_id: [u8; 32], ) -> Option<MerkleProof>

Find participant by ID and generate proof.

§Parameters
  • participant_id: The participant ID to find
§Returns
  • Some(MerkleProof) if participant found
  • None if participant not found
§Example
use miracle_api::{sdk, prelude::{DailyParticipantData, MerkleTree}};

let participants = vec![
    DailyParticipantData::new([1u8; 32], 1723680000, 1723766400, [1u8; 8], [2u8; 8], 5, 0),
    DailyParticipantData::new([2u8; 32], 1723680000, 1723766400, [3u8; 8], [4u8; 8], 10, 1),
];

let merkle_tree = MerkleTree::new(participants);

if let Some(payment_proof) = merkle_tree.find_and_generate_proof([1u8; 32]) {
    // Use payment proof for dual merkle tree claim
}
Source

pub fn participant_count(&self) -> usize

Get the number of participants in the tree.

§Returns
  • Number of participants
Source

pub fn get_participant(&self, index: usize) -> Option<&DailyParticipantData>

Get participant data by index.

§Parameters
  • index: Participant index
§Returns
  • Some(&DailyParticipantData) if index is valid
  • None if index is out of bounds
Source

pub fn participants(&self) -> &[DailyParticipantData]

Get all participant data.

§Returns
  • Reference to all participant data

Trait Implementations§

Source§

impl Clone for MerkleTree

Source§

fn clone(&self) -> MerkleTree

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MerkleTree

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MerkleTree

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MerkleTree

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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, 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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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 = 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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,