Struct dock_runtime::accumulator::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T> Pallet<T>where T: Config,

pub fn public_key_with_params( _: &AccumPublicKeyStorageKey ) -> Option<(AccumulatorPublicKey<T>, Option<AccumulatorParameters<T>>)>

pub fn get_accumulator_with_public_key_and_params( id: &AccumulatorId ) -> Option<(Vec<u8, Global>, Option<(AccumulatorPublicKey<T>, Option<AccumulatorParameters<T>>)>)>

Get accumulated value with public key and params.

impl<T> Pallet<T>where T: Config,

pub fn add_params( origin: <T as Config>::Origin, params: AddAccumulatorParams<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

pub fn add_public_key( origin: <T as Config>::Origin, public_key: AddAccumulatorPublicKey<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

pub fn remove_params( origin: <T as Config>::Origin, remove: RemoveAccumulatorParams<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

pub fn remove_public_key( origin: <T as Config>::Origin, remove: RemoveAccumulatorPublicKey<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

pub fn add_accumulator( origin: <T as Config>::Origin, add_accumulator: AddAccumulator<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

Add a new accumulator with the initial accumulated value. Each accumulator has a unique id and it refers to a public key. It is assumed that the accumulator is owned by the DID that owns the public key. It logs an event with the accumulator id and accumulated value. For each new accumulator, its creation block is recorded in state to indicate from which block, the chain should be scanned for the accumulator’s updates. Note: Weight is same for both kinds of accumulator even when universal takes a bit more space

pub fn update_accumulator( origin: <T as Config>::Origin, update: UpdateAccumulator<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

Update an existing accumulator. The update contains the new accumulated value, the updates themselves and the witness updated info. The updates and witness update info are optional as the owner might be privately communicating the updated witnesses. It logs an event with the accumulator id and the new accumulated value which is sufficient for a verifier. But the prover (who has a witness to update) needs the updates and the witness update info and is expected to look into the corresponding extrinsic arguments.

pub fn remove_accumulator( origin: <T as Config>::Origin, remove: RemoveAccumulator<T>, signature: DidOrDidMethodKeySignature<AccumulatorOwner> ) -> Result<(), DispatchError>

impl<T> Pallet<T>where T: Config,

pub fn did_counters<KArg>(k: KArg) -> StoredAccumulatorOwnerCounterswhere KArg: EncodeLike<AccumulatorOwner>,

impl<T> Pallet<T>where T: Config,

pub fn accumulator_params<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<AccumulatorParameters<T>>where KArg1: EncodeLike<AccumulatorOwner>, KArg2: EncodeLike<IncId>,

impl<T> Pallet<T>where T: Config,

pub fn accumulator_key<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<AccumulatorPublicKey<T>>where KArg1: EncodeLike<AccumulatorOwner>, KArg2: EncodeLike<IncId>,

Public key storage is kept separate from accumulator storage and a single key can be used to manage several accumulators. It is assumed that whoever (DID) owns the public key, owns the accumulator as well and only that DID can update accumulator.

impl<T> Pallet<T>where T: Config,

pub fn accumulator<KArg>(k: KArg) -> Option<AccumulatorWithUpdateInfo<T>>where KArg: EncodeLike<AccumulatorId>,

Stores latest accumulator as key value: accumulator id -> (created_at, last_updated_at, Accumulator) created_at is the block number when the accumulator was created and is intended to serve as a starting point for anyone looking for all updates to the accumulator. last_updated_at is the block number when the last update was sent. created_at and last_updated_at together indicate which blocks should be considered for finding accumulator updates. Historical values and updates are persisted as events indexed with the accumulator id. The reason for not storing past values is to save storage in chain state. Another option could have been to store block numbers for the updates so that each block from created_at doesn’t need to be scanned but even that requires large storage as we expect millions of updates. Just keeping the latest accumulated value allows for any potential on chain verification as well.

impl<T> Pallet<T>where T: Config,

pub fn version() -> StorageVersion

Trait Implementations

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

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

Returns a copy of the value.

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<(), Error>

Formats the value using the given formatter.

impl From<<Pallet<Runtime> as Callable<Runtime>>::Call> for Call

fn from(call: CallableCallFor<Accumulator, Runtime>) -> Self

Converts to this type from the input type.

impl<T> GetStorageVersion for Pallet<T>where T: Config,

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

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

fn on_finalize(_n: BlockNumber)

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

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl IsSubType<<Pallet<Runtime> as Callable<Runtime>>::Call> for Call

fn is_sub_type(&self) -> Option<&CallableCallFor<Accumulator, Runtime>>

Returns Some(_) if self is an instance of sub type T.

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

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

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

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

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

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T> OnIdle<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

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

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

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

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T> PalletInfoAccess for Pallet<T>where T: Config,

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T> PalletsInfoAccess for Pallet<T>where T: Config,

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData, Global>

All of the pallets’ information that this type represents.

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

fn eq(&self, other: &Pallet<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StorageInfoTrait for Pallet<T>where T: Config,

fn storage_info() -> Vec<StorageInfo, Global>

impl<T> Eq for Pallet<T>