Struct pallet_merkle::pallet::Pallet

pub struct Pallet<T>(_);

Implementations

impl<T: Config> Pallet<T>

pub fn create_group(
    origin: OriginFor<T>,
    r_is_mgr: bool,
    _depth: Option<u8>
) -> DispatchResultWithPostInfo

Creates a new group and sets a new manager for that group. The initial manager is the sender. Also increments the mixer id counter in the storage. If _depth is not provided, max tree depth is assumed.

Weights:

• Dependent on arguments: _depth

• Base weight: 8_356_000

• DB weights: 1 read, 3 writes

• Additional weights: 151_000 * _depth

pub fn set_manager_required(
    origin: OriginFor<T>,
    group_id: T::GroupId,
    manager_required: bool
) -> DispatchResultWithPostInfo

Sets if a manager is required for specific actions like adding nullifiers or leaves into the tree.

Can only be called by the root or the current manager.

Weights:

• Independend of the arguments.

• Base weight: 7_000_000

• DB weights: 1 read, 1 write

pub fn set_manager(
    origin: OriginFor<T>,
    group_id: T::GroupId,
    new_manager: T::AccountId
) -> DispatchResultWithPostInfo

Sets manager account id.

Can only be called by the root or the current manager.

Weights:

• Independent of the arguments.

• Base weight: 8_000_000

• DB weights: 1 read, 1 write

pub fn set_stopped(
    origin: OriginFor<T>,
    group_id: T::GroupId,
    stopped: bool
) -> DispatchResultWithPostInfo

Set stopped flag inside the storage.

Can only be called by the root or the current manager.

Weights:

• Independent of the arguments.

• Base weight: 8_000_000

• DB weights: 1 read, 1 write

pub fn add_members(
    origin: OriginFor<T>,
    group_id: T::GroupId,
    members: Vec<ScalarData>
) -> DispatchResultWithPostInfo

Adds an array of leaf data into the tree and adds calculated root to the cache.

Can only be called by the manager if a manager is set.

Weights:

• Dependent on argument: members

• Base weight: 384_629_956_000

• DB weights: 3 reads, 2 writes

• Additional weights: 20_135_984_000 * members.len()

pub fn verify(
    origin: OriginFor<T>,
    group_id: T::GroupId,
    leaf: ScalarData,
    path: Vec<(bool, ScalarData)>
) -> DispatchResultWithPostInfo

Verification stub for testing, these verification functions should not need to be used directly as extrinsics. Rather, higher-order modules should use the module functions to verify and execute further logic.

Verifies the membership proof.

Weights:

• Dependent on the argument: path
• Base weight: 383_420_867_000
• DB weights: 1 read
• Additional weights: 814_291_000 * path.len()

impl<T: Config> Pallet<T>

pub fn next_group_id() -> T::GroupId

Old name generated by decl_event. The next group identifier up for grabs

impl<T: Config> Pallet<T>

pub fn groups<KArg>(k: KArg) -> Option<GroupTree> where
    KArg: EncodeLike<T::GroupId>, 

The map of groups to their metadata

impl<T: Config> Pallet<T>

pub fn cached_roots<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Vec<ScalarData> where
    KArg1: EncodeLike<T::BlockNumber>,
    KArg2: EncodeLike<T::GroupId>, 

Map of cached/past Merkle roots at each block number and group. There can be more than one root update in a single block. Allows for easy pruning since we can remove all keys of the first map past a certain point.

impl<T: Config> Pallet<T>

pub fn get_manager<KArg>(k: KArg) -> Option<Manager<T>> where
    KArg: EncodeLike<T::GroupId>, 

Maps tree id to the manager of the tree

impl<T: Config> Pallet<T>

pub fn lowest_cached_block() -> T::BlockNumber

Block number of the oldest set of roots that we are caching

impl<T: Config> Pallet<T>

pub fn highest_cached_block() -> T::BlockNumber

Block number of the newest set of roots that we are caching

impl<T: Config> Pallet<T>

pub fn used_nullifiers<KArg>(k: KArg) -> bool where
    KArg: EncodeLike<(T::GroupId, ScalarData)>, 

Map of used nullifiers for each tree.

impl<T: Config> Pallet<T>

pub fn stopped<KArg>(k: KArg) -> bool where
    KArg: EncodeLike<T::GroupId>, 

Indicates whether the group tree is stopped or not

impl<T: Config> Pallet<T>

pub fn get_cache(
    group_id: T::GroupId,
    block_number: T::BlockNumber
) -> Vec<ScalarData>

pub fn get_merkle_root(
    group_id: T::GroupId
) -> Result<ScalarData, DispatchError>

pub fn add_root_to_cache(
    group_id: T::GroupId,
    block_number: T::BlockNumber
) -> Result<(), DispatchError>

pub fn get_group(group_id: T::GroupId) -> Result<GroupTree, DispatchError>

pub fn is_manager_required(sender: T::AccountId, manager: &Manager<T>) -> bool

pub fn add_leaf(
    tree: &mut GroupTree,
    data: ScalarData,
    zero_tree: &Vec<[u8; 32]>,
    h: &Poseidon
)

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T> Eq for Pallet<T>

impl<T: Config> GetPalletVersion for Pallet<T>

fn current_version() -> PalletVersion

Returns the current version of the pallet.

fn storage_version() -> Option<PalletVersion>

Returns the version of the pallet that is stored in storage.

impl<T: Config> Group<<T as Config>::AccountId, <T as Config>::BlockNumber, <T as Config>::GroupId> for Pallet<T>

fn create_group(
    sender: T::AccountId,
    is_manager_required: bool,
    depth: u8
) -> Result<T::GroupId, DispatchError>

Creates a new group tree, including a manager for that tree

fn set_stopped(
    sender: T::AccountId,
    id: T::GroupId,
    stopped: bool
) -> Result<(), DispatchError>

Sets stopped flag in storage. This flag doesn’t do much by itself, it is up to higher-level pallet to find the use for it Can only be called by the manager, regardless if the manager is required

fn set_manager_required(
    sender: T::AccountId,
    id: T::GroupId,
    manager_required: bool
) -> Result<(), DispatchError>

Sets whether the manager is required for guarded calls. Can only be called by the current manager

fn set_manager(
    sender: T::AccountId,
    id: T::GroupId,
    new_manager: T::AccountId
) -> Result<(), DispatchError>

Sets manager account id Can only be called by the current manager

fn add_members(
    sender: T::AccountId,
    id: T::GroupId,
    members: Vec<ScalarData>
) -> Result<(), DispatchError>

Adds members/leaves to the tree

fn add_nullifier(
    sender: T::AccountId,
    id: T::GroupId,
    nullifier_hash: ScalarData
) -> Result<(), DispatchError>

Adds a nullifier to the storage Can only be called by the manager if the manager is required

fn has_used_nullifier(
    id: T::GroupId,
    nullifier: ScalarData
) -> Result<(), DispatchError>

Check if nullifier is already used, in which case return an error

fn verify(
    id: T::GroupId,
    leaf: ScalarData,
    path: Vec<(bool, ScalarData)>
) -> Result<(), DispatchError>

Verify membership proof

fn verify_zk_membership_proof(
    group_id: T::GroupId,
    cached_block: T::BlockNumber,
    cached_root: ScalarData,
    comms: Vec<Commitment>,
    nullifier_hash: ScalarData,
    proof_bytes: Vec<u8>,
    leaf_index_commitments: Vec<Commitment>,
    proof_commitments: Vec<Commitment>,
    recipient: ScalarData,
    relayer: ScalarData
) -> Result<(), DispatchError>

Verify zero-knowladge membership proof

fn verify_zk(
    pc_gens: PedersenGens,
    m_root: ScalarData,
    depth: u8,
    comms: Vec<Commitment>,
    nullifier_hash: ScalarData,
    proof_bytes: Vec<u8>,
    leaf_index_commitments: Vec<Commitment>,
    proof_commitments: Vec<Commitment>,
    recipient: ScalarData,
    relayer: ScalarData
) -> Result<(), DispatchError>

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(_n: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(n: T::BlockNumber)

The block is being finalized. Implement to have something happen.

pub fn on_runtime_upgrade() -> u64

Perform a module upgrade.

pub fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

pub fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> ModuleErrorMetadata for Pallet<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.