pub type Module<T> = Pallet<T>;
Pallet
insteadExpand description
Type alias to Pallet
, to be used by construct_runtime
.
Generated by pallet
attribute macro.
Aliased Type§
struct Module<T>(/* private fields */);
Implementations
Source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
Sourcepub fn ensure_personal_identity(
origin: T::RuntimeOrigin,
) -> Result<PersonalId, DispatchError>
pub fn ensure_personal_identity( origin: T::RuntimeOrigin, ) -> Result<PersonalId, DispatchError>
Ensure that the origin o
represents a person.
Returns Ok
with the base identity of the person on success.
Sourcepub fn ensure_personal_alias(
origin: T::RuntimeOrigin,
) -> Result<ContextualAlias, DispatchError>
pub fn ensure_personal_alias( origin: T::RuntimeOrigin, ) -> Result<ContextualAlias, DispatchError>
Ensure that the origin o
represents a person.
Returns Ok
with the alias of the person together with the context in which it can
be used on success.
Sourcepub fn ensure_revised_personal_alias(
origin: T::RuntimeOrigin,
) -> Result<RevisedContextualAlias, DispatchError>
pub fn ensure_revised_personal_alias( origin: T::RuntimeOrigin, ) -> Result<RevisedContextualAlias, DispatchError>
Ensure that the origin o
represents a person.
On success returns Ok
with the revised alias of the person together with the context
in which it can be used and the revision of the ring the person is in.
pub fn available_ring() -> (RingIndex, BoundedVec<MemberOf<T>, T::MaxRingSize>)
pub fn do_insert_key(who: PersonalId, key: MemberOf<T>) -> DispatchResult
pub fn queue_personhood_suspensions( suspensions: &[PersonalId], ) -> DispatchResult
pub fn resume_personhood(who: PersonalId) -> DispatchResult
Sourcepub fn ring_keys_and_info(
ring_index: RingIndex,
) -> (BoundedVec<MemberOf<T>, T::MaxRingSize>, RingStatus)
pub fn ring_keys_and_info( ring_index: RingIndex, ) -> (BoundedVec<MemberOf<T>, T::MaxRingSize>, RingStatus)
Fetch the keys in a ring along with stored inclusion information.
Source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
Sourcepub fn account_setup_time_tolerance() -> BlockNumberFor<T>
pub fn account_setup_time_tolerance() -> BlockNumberFor<T>
The amount of block number tolerance we allow for a setup account transaction.
set_alias_account
and set_personal_id_account
calls contains
call_valid_at
as a parameter, those calls are valid if the block number is within
the tolerance period.
Source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
Sourcepub fn build_ring_manual(
origin: OriginFor<T>,
ring_index: RingIndex,
limit: Option<u32>,
) -> DispatchResultWithPostInfo
pub fn build_ring_manual( origin: OriginFor<T>, ring_index: RingIndex, limit: Option<u32>, ) -> DispatchResultWithPostInfo
Build a ring root by including registered people.
This task is performed automatically by the pallet through the on_idle
hook whenever
there is leftover weight in a block. This call is meant to be a backup in case of
extreme congestion and should be submitted by signed origins.
Sourcepub fn onboard_people_manual(origin: OriginFor<T>) -> DispatchResultWithPostInfo
pub fn onboard_people_manual(origin: OriginFor<T>) -> DispatchResultWithPostInfo
Onboard people into a ring by taking their keys from the onboarding queue and
registering them into the ring. This does not compute the root, that is done using
build_ring
.
This task is performed automatically by the pallet through the on_idle
hook whenever
there is leftover weight in a block. This call is meant to be a backup in case of
extreme congestion and should be submitted by signed origins.
Sourcepub fn merge_rings(
origin: OriginFor<T>,
base_ring_index: RingIndex,
target_ring_index: RingIndex,
) -> DispatchResultWithPostInfo
pub fn merge_rings( origin: OriginFor<T>, base_ring_index: RingIndex, target_ring_index: RingIndex, ) -> DispatchResultWithPostInfo
Merge the people in two rings into a single, new ring. In order for the rings to be eligible for merging, they must be below 1/2 of max capacity, have no pending suspensions and not be the top ring used for onboarding.
Sourcepub fn under_alias(
origin: OriginFor<T>,
call: Box<<T as Config>::RuntimeCall>,
) -> DispatchResultWithPostInfo
pub fn under_alias( origin: OriginFor<T>, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResultWithPostInfo
Dispatch a call under an alias using the account <-> alias
mapping.
This is a call version of the transaction extension AsPersonalAliasWithAccount
.
It is recommended to use the transaction extension instead when suitable.
Sourcepub fn set_alias_account(
origin: OriginFor<T>,
account: T::AccountId,
call_valid_at: BlockNumberFor<T>,
) -> DispatchResultWithPostInfo
pub fn set_alias_account( origin: OriginFor<T>, account: T::AccountId, call_valid_at: BlockNumberFor<T>, ) -> DispatchResultWithPostInfo
This transaction is refunded if successful and no alias was previously set.
The call is valid from call_valid_at
until
call_valid_at + account_setup_time_tolerance
.
account_setup_time_tolerance
is a constant available in the metadata.
Parameters:
account
: The account to set the alias for.call_valid_at
: The block number when the call becomes valid.
Sourcepub fn unset_alias_account(origin: OriginFor<T>) -> DispatchResult
pub fn unset_alias_account(origin: OriginFor<T>) -> DispatchResult
Remove the mapping from a particular alias to its registered account.
Sourcepub fn force_recognize_personhood(
origin: OriginFor<T>,
people: Vec<MemberOf<T>>,
) -> DispatchResultWithPostInfo
pub fn force_recognize_personhood( origin: OriginFor<T>, people: Vec<MemberOf<T>>, ) -> DispatchResultWithPostInfo
Recognize a set of people without any additional checks.
The people are identified by the provided list of keys and will each be assigned, in order, the next available personal ID.
The origin for this call must have root privileges.
Sourcepub fn set_personal_id_account(
origin: OriginFor<T>,
account: T::AccountId,
call_valid_at: BlockNumberFor<T>,
) -> DispatchResultWithPostInfo
pub fn set_personal_id_account( origin: OriginFor<T>, account: T::AccountId, call_valid_at: BlockNumberFor<T>, ) -> DispatchResultWithPostInfo
Set a personal id account.
The account can then be used to sign transactions on behalf of the personal id, and provide replay protection with the nonce.
This transaction is refunded if successful and no account was previously set for the personal id.
The call is valid from call_valid_at
until
call_valid_at + account_setup_time_tolerance
.
account_setup_time_tolerance
is a constant available in the metadata.
Parameters:
account
: The account to set the alias for.call_valid_at
: The block number when the call becomes valid.
Sourcepub fn unset_personal_id_account(
origin: OriginFor<T>,
) -> DispatchResultWithPostInfo
pub fn unset_personal_id_account( origin: OriginFor<T>, ) -> DispatchResultWithPostInfo
Unset the personal id account.
Sourcepub fn migrate_included_key(
origin: OriginFor<T>,
new_key: MemberOf<T>,
) -> DispatchResultWithPostInfo
pub fn migrate_included_key( origin: OriginFor<T>, new_key: MemberOf<T>, ) -> DispatchResultWithPostInfo
Migrate the key for a person who was onboarded and is currently included in a ring. The migration is not instant as the key replacement and subsequent inclusion in a new ring root will happen only after the next mutation session.
Sourcepub fn migrate_onboarding_key(
origin: OriginFor<T>,
new_key: MemberOf<T>,
) -> DispatchResultWithPostInfo
pub fn migrate_onboarding_key( origin: OriginFor<T>, new_key: MemberOf<T>, ) -> DispatchResultWithPostInfo
Migrate the key for a person who is currently onboarding. The operation is instant, replacing the old key in the onboarding queue.
Sourcepub fn set_onboarding_size(
origin: OriginFor<T>,
onboarding_size: u32,
) -> DispatchResultWithPostInfo
pub fn set_onboarding_size( origin: OriginFor<T>, onboarding_size: u32, ) -> DispatchResultWithPostInfo
Force set the onboarding size for new people. This call requires root privileges.
Trait Implementations
Source§impl<T: Config> AddOnlyPeopleTrait for Pallet<T>
impl<T: Config> AddOnlyPeopleTrait for Pallet<T>
type Member = <<T as Config>::Crypto as GenerateVerifiable>::Member
type Secret = <<T as Config>::Crypto as GenerateVerifiable>::Secret
Source§fn reserve_new_id() -> PersonalId
fn reserve_new_id() -> PersonalId
Source§fn cancel_id_reservation(personal_id: PersonalId) -> Result<(), DispatchError>
fn cancel_id_reservation(personal_id: PersonalId) -> Result<(), DispatchError>
Source§fn renew_id_reservation(personal_id: PersonalId) -> Result<(), DispatchError>
fn renew_id_reservation(personal_id: PersonalId) -> Result<(), DispatchError>
Source§fn recognize_personhood(
who: PersonalId,
maybe_key: Option<MemberOf<T>>,
) -> Result<(), DispatchError>
fn recognize_personhood( who: PersonalId, maybe_key: Option<MemberOf<T>>, ) -> Result<(), DispatchError>
fn mock_key(who: PersonalId) -> (Self::Member, Self::Secret)
Source§impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
Source§fn before_all_runtime_migrations() -> Weight
fn before_all_runtime_migrations() -> Weight
Source§impl<T> Benchmarking for Pallet<T>
impl<T> Benchmarking for Pallet<T>
Source§impl<T: Config> GetStorageVersion for Pallet<T>
impl<T: Config> GetStorageVersion for Pallet<T>
Source§type InCodeStorageVersion = NoStorageVersionSet
type InCodeStorageVersion = NoStorageVersionSet
Source§fn in_code_storage_version() -> Self::InCodeStorageVersion
fn in_code_storage_version() -> Self::InCodeStorageVersion
storage_version
attribute, or
[NoStorageVersionSet
] if the attribute is missing.Source§fn on_chain_storage_version() -> StorageVersion
fn on_chain_storage_version() -> StorageVersion
§fn current_storage_version() -> Self::InCodeStorageVersion
fn current_storage_version() -> Self::InCodeStorageVersion
in_code_storage_version
and will be removed after March 2024.Self::current_storage_version
] instead. Read moreSource§impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§fn integrity_test()
fn integrity_test()
Source§fn on_poll(_: BlockNumberFor<T>, weight_meter: &mut WeightMeter)
fn on_poll(_: BlockNumberFor<T>, weight_meter: &mut WeightMeter)
Source§fn on_idle(_block: BlockNumberFor<T>, limit: Weight) -> Weight
fn on_idle(_block: BlockNumberFor<T>, limit: Weight) -> Weight
Hooks::on_finalize
]). Read more§fn on_initialize(_n: BlockNumber) -> Weight
fn on_initialize(_n: BlockNumber) -> Weight
§fn on_finalize(_n: BlockNumber)
fn on_finalize(_n: BlockNumber)
§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Executive
pallet. Read more§fn try_state(_n: BlockNumber) -> Result<(), DispatchError>
fn try_state(_n: BlockNumber) -> Result<(), DispatchError>
§fn pre_upgrade() -> Result<Vec<u8>, DispatchError>
fn pre_upgrade() -> Result<Vec<u8>, DispatchError>
§fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>
fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>
§fn offchain_worker(_n: BlockNumber)
fn offchain_worker(_n: BlockNumber)
Source§impl<T: Config> IntegrityTest for Pallet<T>
impl<T: Config> IntegrityTest for Pallet<T>
Source§fn integrity_test()
fn integrity_test()
Hooks::integrity_test
].Source§impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§fn offchain_worker(n: BlockNumberFor<T>)
fn offchain_worker(n: BlockNumberFor<T>)
Source§impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§fn on_finalize(n: BlockNumberFor<T>)
fn on_finalize(n: BlockNumberFor<T>)
Hooks::on_finalize
].Source§impl<T: Config> OnGenesis for Pallet<T>
impl<T: Config> OnGenesis for Pallet<T>
Source§fn on_genesis()
fn on_genesis()
Source§impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§fn on_initialize(n: BlockNumberFor<T>) -> Weight
fn on_initialize(n: BlockNumberFor<T>) -> Weight
Hooks::on_initialize
].Source§impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§impl<T: Config> OnRuntimeUpgrade for Pallet<T>
impl<T: Config> OnRuntimeUpgrade for Pallet<T>
Source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Hooks::on_runtime_upgrade
].§fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
pre_upgrade
->
on_runtime_upgrade
-> post_upgrade
hooks for a migration. Read moreSource§impl<T: Config> PalletInfoAccess for Pallet<T>
impl<T: Config> PalletInfoAccess for Pallet<T>
Source§fn module_name() -> &'static str
fn module_name() -> &'static str
Source§fn crate_version() -> CrateVersion
fn crate_version() -> CrateVersion
Source§impl<T: Config> PeopleTrait for Pallet<T>
impl<T: Config> PeopleTrait for Pallet<T>
Source§fn suspend_personhood(suspensions: &[PersonalId]) -> DispatchResult
fn suspend_personhood(suspensions: &[PersonalId]) -> DispatchResult
Source§fn start_people_set_mutation_session() -> DispatchResult
fn start_people_set_mutation_session() -> DispatchResult
Source§fn end_people_set_mutation_session() -> DispatchResult
fn end_people_set_mutation_session() -> DispatchResult
Source§impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
Source§impl<T: Config> WhitelistedStorageKeys for Pallet<T>
impl<T: Config> WhitelistedStorageKeys for Pallet<T>
Source§fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
Vec<TrackedStorageKey>
indicating the storage keys that
should be whitelisted during benchmarking. This means that those keys
will be excluded from the benchmarking performance calculation.