Struct pallet_handles::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn get_next_suffix_index_for_canonical_handle( canonical_base: CanonicalBase ) -> Result<SequenceIndex, DispatchError>

Gets the next suffix index for a canonical base.

This function takes a canonical base as input and returns the next available suffix index for that handle. If no current suffix index is found for the handle, it starts from 0. If a current suffix index is found, it increments it by 1 to get the next suffix index. If the increment operation fails due to overflow, it returns an error indicating that the suffixes are exhausted.

Arguments

canonical_base - The canonical base to get the next suffix index for.

Returns

Ok(SequenceIndex) - The next suffix index for the canonical base.
Err(DispatchError) - The suffixes are exhausted.

pub fn verify_signature_mortality( signature_expires_at: BlockNumberFor<T> ) -> DispatchResult

Verifies that the signature is not expired.

This function takes a signature expiration block as input and verifies that the signature is not expired. It returns an error if the signature is expired.

Arguments

signature_expires_at - The block number at which the signature expires.

Returns

Ok(()) - The signature is not expired.
Err(DispatchError) - The signature is expired.

pub fn verify_signed_payload( signature: &MultiSignature, signer: &T::AccountId, payload: Vec<u8> ) -> DispatchResult

Verifies the signature of a given payload, using the provided signature and signer information.

Arguments

signature - The MultiSignature to verify against the payload.
signer - The T::AccountId of the signer that signed the payload.
payload - The payload to verify the signature against.

Errors

Error::InvalidSignature

pub fn verify_max_handle_byte_length(handle: Vec<u8>) -> DispatchResult

Verifies max user handle size in bytes to address potential panic condition

Arguments

handle - The user handle.

Errors

Error::InvalidHandleByteLength

pub fn generate_suffix_for_canonical_handle( canonical_base: &str, cursor: usize ) -> Result<u16, DispatchError>

Generates a suffix for a canonical base, using the provided canonical_base and cursor information.

Arguments

canonical_base - The canonical base to generate a suffix for.
cursor - The cursor position in the sequence of suffixes to use for generation.

Returns

The generated suffix as a u16.

impl<T: Config> Pallet<T>

pub fn claim_handle( origin: OriginFor<T>, msa_owner_key: T::AccountId, proof: MultiSignature, payload: ClaimHandlePayload<BlockNumberFor<T>> ) -> DispatchResult

Claims a handle for a caller’s MSA (Message Source Account) based on the provided payload. This function performs several validations before claiming the handle, including checking the size of the base_handle, ensuring the caller have valid MSA keys, verifying the payload signature, and finally calling the internal do_claim_handle function to claim the handle.

Arguments

origin - The origin of the caller.
msa_owner_key - The public key of the MSA owner.
proof - The multi-signature proof for the payload.
payload - The payload containing the information needed to claim a new handle.

Errors

This function may return an error as part of DispatchResult if any of the following validations fail:

Error::InvalidHandleByteLength - The base_handle size exceeds the maximum allowed size.
Error::InvalidMessageSourceAccount - The caller does not have a valid MessageSourceId.
Error::InvalidSignature - The payload signature verification fails.

Events

Event::HandleClaimed

pub fn retire_handle(origin: OriginFor<T>) -> DispatchResult

Retire a handle for a given DisplayHandle owner.

Arguments

origin - The origin of the call.

Errors

This function can return the following errors:

InvalidHandleByteLength - If the length of the payload.display_handle exceeds the maximum allowed size.
InvalidMessageSourceAccount - If caller of this extrinsic does not have a valid MSA (Message Source Account) ID.

Events

Event::HandleRetired

pub fn change_handle( origin: OriginFor<T>, msa_owner_key: T::AccountId, proof: MultiSignature, payload: ClaimHandlePayload<BlockNumberFor<T>> ) -> DispatchResult

Changes the handle for a caller’s MSA (Message Source Account) based on the provided payload. This function performs several validations before claiming the handle, including checking the size of the base_handle, ensuring the caller has valid MSA keys, verifying the payload signature, and finally calling the internal do_retire_handle and do_claim_handle functions to retire the current handle and claim the new one.

Arguments

origin - The origin of the caller.
msa_owner_key - The public key of the MSA owner.
proof - The multi-signature proof for the payload.
payload - The payload containing the information needed to change an existing handle.

Errors

This function may return an error as part of DispatchResult if any of the following validations fail:

Error::InvalidHandleByteLength - The base_handle size exceeds the maximum allowed size.
Error::InvalidMessageSourceAccount - The caller does not have a valid MessageSourceId.
Error::InvalidSignature - The payload signature verification fails.

Events

impl<T: Config> Pallet<T>

pub fn get_handle_for_msa(msa_id: MessageSourceId) -> Option<HandleResponse>

Retrieves a handle for a given MSA (MessageSourceId).

Arguments

msa_id - The MSA ID to retrieve the handle for.

Returns

Option<HandleResponse> - The handle response if the MSA ID is valid.

pub fn get_next_suffixes( base_handle: BaseHandle, count: u16 ) -> PresumptiveSuffixesResponse

Get the next available suffixes for a given handle.

This function takes a Vec<u8> handle and generates the next available suffixes for that handle. The number of suffixes to generate is determined by the count parameter, which is of type u16.

Arguments

handle - The handle to generate the next available suffixes for.
count - The number of suffixes to generate.

Returns

PresumptiveSuffixesResponse - The response containing the next available suffixes.

pub fn check_handle(base_handle: Vec<u8>) -> CheckHandleResponse

Check a base handle for validity and collect information on it

This function takes a Vec<u8> handle and checks to make sure it is:

Valid
Has suffixes remaining

It also returns the original input as well as the canonical version

Arguments

handle - The handle to check.

Returns

CheckHandleResponse

pub fn get_msa_id_for_handle( display_handle: DisplayHandle ) -> Option<MessageSourceId>

Retrieve a MessageSourceId for a given handle.

Arguments

display_handle - The full display handle to retrieve the MessageSourceId for.

Returns

Option<MessageSourceId> - The MessageSourceId if the handle is valid.

pub fn do_claim_handle( msa_id: MessageSourceId, payload: ClaimHandlePayload<BlockNumberFor<T>> ) -> Result<Vec<u8>, DispatchError>

Claims a handle for a given MSA (MessageSourceId) by validating and storing the base handle, generating a canonical base, generating a suffix, and composing the full display handle.

Arguments

msa_id - The MSA (MessageSourceId) to claim the handle for.
payload - The payload containing the base handle to claim.

Returns

DisplayHandle - The full display handle.

pub fn build_full_display_handle( base_handle: &str, suffix: HandleSuffix ) -> Result<DisplayHandle, DispatchError>

Creates a full display handle by combining a base handle string with supplied suffix

Arguments

base_handle_str - The base handle string.
suffix - The numeric suffix .

Returns

DisplayHandle - The full display handle.

pub fn do_retire_handle( msa_id: MessageSourceId ) -> Result<Vec<u8>, DispatchError>

Retires a handle associated with a given MessageSourceId (MSA) in the dispatch module.

Arguments

msa_id - The MSA (MessageSourceId) to retire the handle for.

Returns

DispatchResult - Returns Ok if the handle was successfully retired.

pub fn validate_handle(handle: Vec<u8>) -> bool

Checks whether the supplied handle passes all the checks performed by a claim_handle call.

Returns

true if it is valid or false if invalid

Trait Implementations§

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead. Read more

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

fn get_handle_for_msa(msa_id: MessageSourceId) -> Option<HandleResponse>

Validate a handle for a given MessageSourceAccount

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]). Read more

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet. Read more

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

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

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

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

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application. Read more

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

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

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 name_hash() -> [u8; 16]

Two128 hash of name.

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: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

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

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

1.0.0 · source§

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: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

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

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a 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.

impl<T> Eq for Pallet<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

impl<T> Send for Pallet<T>
where T: Send,

impl<T> Sync for Pallet<T>
where T: Sync,

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

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

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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