Struct pallet_msa::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

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

Creates an MSA for the Origin (sender of the transaction). Origin is assigned an MSA ID.

Events

• Event::MsaCreated

Errors

• Error::KeyAlreadyRegistered - MSA is already registered to the Origin.

pub fn create_sponsored_account_with_delegation( origin: OriginFor<T>, delegator_key: T::AccountId, proof: MultiSignature, add_provider_payload: AddProvider ) -> DispatchResult

Origin MSA creates an MSA on behalf of delegator_key, creates a Delegation with the delegator_key’s MSA as the Delegator and origin as Provider. Deposits events MsaCreated and DelegationGranted.

Remarks

• Origin MUST be the provider
• Signatures should be over the AddProvider struct

Events

• Event::MsaCreated
• Event::DelegationGranted

Errors

• Error::UnauthorizedProvider - payload’s MSA does not match given provider MSA.
• Error::InvalidSignature - proof verification fails; delegator_key must have signed add_provider_payload
• Error::NoKeyExists - there is no MSA for origin.
• Error::KeyAlreadyRegistered - there is already an MSA for delegator_key.
• Error::ProviderNotRegistered - the a non-provider MSA is used as the provider
• Error::ProofNotYetValid - add_provider_payload expiration is too far in the future
• Error::ProofHasExpired - add_provider_payload expiration is in the past
• Error::SignatureAlreadySubmitted - signature has already been used

pub fn create_provider( origin: OriginFor<T>, provider_name: Vec<u8> ) -> DispatchResult

Adds an association between MSA id and ProviderRegistryEntry. As of now, the only piece of metadata we are recording is provider name.

Events

• Event::ProviderCreated

Errors

• Error::NoKeyExists - origin does not have an MSA
• Error::ExceedsMaxProviderNameSize - Too long of a provider name
• Error::DuplicateProviderRegistryEntry - a ProviderRegistryEntry associated with the given MSA id already exists.

pub fn grant_delegation( origin: OriginFor<T>, delegator_key: T::AccountId, proof: MultiSignature, add_provider_payload: AddProvider ) -> DispatchResult

Creates a new Delegation for an existing MSA, with origin as the Provider and delegator_key is the delegator. Since it is being sent on the Delegator’s behalf, it requires the Delegator to authorize the new Delegation.

Remarks

• Origin MUST be the provider
• Signatures should be over the AddProvider struct

Events

• Event::DelegationGranted

Errors

• Error::AddProviderSignatureVerificationFailed - origin’s MSA ID does not equal add_provider_payload.authorized_msa_id.
• Error::DuplicateProvider - there is already a Delegation for origin MSA and delegator_key MSA.
• Error::UnauthorizedProvider - add_provider_payload.authorized_msa_id does not match MSA ID of delegator_key.
• Error::InvalidSelfProvider - Cannot delegate to the same MSA
• Error::InvalidSignature - proof verification fails; delegator_key must have signed add_provider_payload
• Error::NoKeyExists - there is no MSA for origin or delegator_key.
• Error::ProviderNotRegistered - the a non-provider MSA is used as the provider
• Error::UnauthorizedDelegator - Origin attempted to add a delegate for someone else’s MSA

pub fn revoke_delegation_by_delegator( origin: OriginFor<T>, provider_msa_id: MessageSourceId ) -> DispatchResult

Delegator (Origin) MSA terminates a delegation relationship with the Provider MSA. Deposits eventDelegationRevoked.

Events

• Event::DelegationRevoked

Errors

• Error::NoKeyExists - origin does not have an MSA
• Error::DelegationRevoked - the delegation has already been revoked.
• Error::DelegationNotFound - there is not delegation relationship between Origin and Delegator or Origin and Delegator are the same.

pub fn add_public_key_to_msa( origin: OriginFor<T>, msa_owner_public_key: T::AccountId, msa_owner_proof: MultiSignature, new_key_owner_proof: MultiSignature, add_key_payload: AddKeyData<T> ) -> DispatchResult

Adds a new public key to an existing Message Source Account (MSA). This functionality enables the MSA owner to manage multiple keys for their account or rotate keys for enhanced security.

The origin parameter represents the account from which the function is called and can be either the MSA owner’s account or a delegated provider’s account, depending on the intended use.

The function requires two signatures: msa_owner_proof and new_key_owner_proof, which serve as proofs of ownership for the existing MSA and the new public key account, respectively. This ensures that a new key cannot be added without permission of both the MSA owner and the owner of the new key.

The necessary information for the key addition, the new public key and the MSA ID, is contained in the add_key_payload parameter of type AddKeyData. It also contains an expiration block number for both proofs, ensuring they are valid and must be greater than the current block.

Events

• Event::PublicKeyAdded

Errors

• Error::MsaOwnershipInvalidSignature - key is not a valid signer of the provided add_key_payload.
• Error::NewKeyOwnershipInvalidSignature - key is not a valid signer of the provided add_key_payload.
• Error::NoKeyExists - the MSA id for the account in add_key_payload does not exist.
• Error::NotMsaOwner - Origin’s MSA is not the same as ’add_key_payload` MSA. Essentially you can only add a key to your own MSA.
• Error::ProofHasExpired - the current block is less than the expired block number set in AddKeyData.
• Error::ProofNotYetValid - the expired block number set in AddKeyData is greater than the current block number plus mortality_block_limit().
• Error::SignatureAlreadySubmitted - signature has already been used.

pub fn delete_msa_public_key( origin: OriginFor<T>, public_key_to_delete: T::AccountId ) -> DispatchResult

Remove a key associated with an MSA by expiring it at the current block.

Remarks

• Removal of key deletes the association of the key with the MSA.
• The key can be re-added to same or another MSA if needed.

Events

• Event::PublicKeyDeleted

Errors

• Error::InvalidSelfRemoval - origin and key are the same.
• Error::NotKeyOwner - origin does not own the MSA ID associated with key.
• Error::NoKeyExists - origin or key are not associated with origin’s MSA ID.

pub fn revoke_delegation_by_provider( origin: OriginFor<T>, delegator: MessageSourceId ) -> DispatchResult

Provider MSA terminates Delegation with a Delegator MSA by expiring the Delegation at the current block.

Events

• Event::DelegationRevoked

Errors

• Error::NoKeyExists - provider_key does not have an MSA key.
• Error::DelegationRevoked - delegation is already revoked
• Error::DelegationNotFound - no Delegation found between origin MSA and delegator MSA.

pub fn revoke_schema_permissions( origin: OriginFor<T>, provider_msa_id: MessageSourceId, schema_ids: Vec<SchemaId> ) -> DispatchResult

👎Deprecated since 1.3.0: revoke_schema_permissions() has been deprecated.

Revokes a list of schema permissions to a provider. Attempting to revoke a Schemas that have already been revoked are ignored.

Events

• DelegationUpdated

Errors

• NoKeyExists - If there is not MSA for origin.
• DelegationNotFound - If there is not delegation relationship between Origin and Delegator or Origin and Delegator are the same.
• SchemaNotGranted - If attempting to revoke a schema that has not previously been granted.

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

Retires a MSA

When a user wants to disassociate themselves from Frequency, they can retire their MSA for free provided that: (1) They own the MSA (2) The MSA is not a registered provider. (3) They retire their user handle (if they have one) (4) There is only one account key (5) The user has already deleted all delegations to providers

This does not currently remove any messages related to the MSA.

Events

• Event::PublicKeyDeleted
• Event::MsaRetired

Errors

• Error::NoKeyExists - delegator does not have an MSA key.

pub fn propose_to_be_provider( origin: OriginFor<T>, provider_name: Vec<u8> ) -> DispatchResult

Propose to be a provider. Creates a proposal for council approval to create a provider from a MSA

Errors

• NoKeyExists - If there is not MSA for origin.

pub fn create_provider_via_governance( origin: OriginFor<T>, provider_key: T::AccountId, provider_name: Vec<u8> ) -> DispatchResult

Create a provider by means of governance approval

Events

• Event::ProviderCreated

Errors

• Error::NoKeyExists - account does not have an MSA
• Error::ExceedsMaxProviderNameSize - Too long of a provider name
• Error::DuplicateProviderRegistryEntry - a ProviderRegistryEntry associated with the given MSA id already exists.

impl<T: Config> Pallet<T>

pub fn create_account<F>( key: T::AccountId, on_success: F ) -> Result<(MessageSourceId, T::AccountId), DispatchError>

where F: FnOnce(MessageSourceId) -> DispatchResult,

Create the account for the key

Errors

• Error::MsaIdOverflow
• Error::KeyLimitExceeded
• Error::KeyAlreadyRegistered

pub fn get_next_msa_id() -> Result<MessageSourceId, DispatchError>

Generate the next MSA Id

Errors

• Error::MsaIdOverflow

pub fn set_msa_identifier(identifier: MessageSourceId) -> DispatchResult

Set the current identifier in storage

pub fn create_registered_provider( provider_id: ProviderId, name: BoundedVec<u8, T::MaxProviderNameSize> ) -> DispatchResult

Create Register Provider

pub fn grant_permissions_for_schemas( delegator_id: DelegatorId, provider_id: ProviderId, schema_ids: Vec<SchemaId> ) -> DispatchResult

Adds a list of schema permissions to a delegation relationship.

pub fn revoke_permissions_for_schemas( delegator_id: DelegatorId, provider_id: ProviderId, schema_ids: Vec<SchemaId> ) -> DispatchResult

Revokes a list of schema permissions from a delegation relationship.

pub fn add_key<F>( msa_id: MessageSourceId, key: &T::AccountId, on_success: F ) -> DispatchResult

where F: FnOnce(MessageSourceId) -> DispatchResult,

Add a new key to the MSA

Errors

• Error::KeyLimitExceeded
• Error::KeyAlreadyRegistered

pub fn ensure_all_schema_ids_are_valid( schema_ids: &Vec<SchemaId> ) -> DispatchResult

Check that schema ids are all valid

Errors

• Error::InvalidSchemaId
• Error::ExceedsMaxSchemaGrantsPerDelegation

pub fn is_registered_provider(msa_id: MessageSourceId) -> bool

Returns if provider is registered by checking if the ProviderToRegistryEntry contains the MSA id

pub fn ensure_valid_registered_provider( delegator_key: &T::AccountId, provider_key: &T::AccountId ) -> Result<(ProviderId, DelegatorId), DispatchError>

Checks that a provider and delegator keys are valid and that a provider and delegator are not the same and that a provider has authorized a delegator to create a delegation relationship.

Errors

• Error::ProviderNotRegistered
• Error::InvalidSelfProvider
• Error::NoKeyExists

pub fn ensure_msa_owner( who: &T::AccountId, msa_id: MessageSourceId ) -> DispatchResult

Checks that the MSA for who is the same as msa_id

Errors

• Error::NotMsaOwner
• Error::NoKeyExists

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

Verify the signature was signed by signer on payload by a wallet Note the wrap_binary_data follows the Polkadot wallet pattern of wrapping with <Byte> tags.

Errors

• Error::InvalidSignature

pub fn add_provider( provider_id: ProviderId, delegator_id: DelegatorId, schema_ids: Vec<SchemaId> ) -> DispatchResult

Add a provider to a delegator with the default permissions

Errors

• Error::ExceedsMaxSchemaGrantsPerDelegation

pub fn upsert_schema_permissions( provider_id: ProviderId, delegator_id: DelegatorId, schema_ids: Vec<SchemaId> ) -> DispatchResult

Modify delegation’s schema permissions

Errors

• Error::ExceedsMaxSchemaGrantsPerDelegation

pub fn create_provider_for( provider_msa_id: MessageSourceId, provider_name: Vec<u8> ) -> DispatchResult

Adds an association between MSA id and ProviderRegistryEntry. As of now, the only piece of metadata we are recording is provider name.

Events

• Event::ProviderCreated

Errors

• Error::NoKeyExists - account does not have an MSA
• Error::ExceedsMaxProviderNameSize - Too long of a provider name
• Error::DuplicateProviderRegistryEntry - a ProviderRegistryEntry associated with the given MSA id already exists.

pub fn try_mutate_delegation<R, E: From<DispatchError>>( delegator_id: DelegatorId, provider_id: ProviderId, f: impl FnOnce(&mut Delegation<SchemaId, BlockNumberFor<T>, T::MaxSchemaGrantsPerDelegation>, bool) -> Result<R, E> ) -> Result<R, E>

Mutates the delegation relationship storage item only when the supplied function returns an ‘Ok()’ result. The callback function ‘f’ takes the value (a delegation) and a reference to a boolean variable. This callback sets the boolean variable to ‘true’ if the value is to be inserted and to ‘false’ if it is to be updated.

pub fn delete_key_for_msa( msa_id: MessageSourceId, key: &T::AccountId ) -> DispatchResult

Deletes a key associated with a given MSA

Errors

• Error::NoKeyExists

pub fn revoke_provider( provider_id: ProviderId, delegator_id: DelegatorId ) -> DispatchResult

Revoke the grant for permissions from the delegator to the provider

Errors

• Error::DelegationRevoked
• Error::DelegationNotFound

pub fn get_owner_of(key: &T::AccountId) -> Option<MessageSourceId>

Retrieves the MSA Id for a given AccountId

pub fn ensure_valid_msa_key( key: &T::AccountId ) -> Result<MessageSourceId, DispatchError>

Retrieve MSA Id associated with key or return NoKeyExists

pub fn get_granted_schemas_by_msa_id( delegator: DelegatorId, provider: Option<ProviderId> ) -> Result<Vec<DelegationResponse<SchemaId, BlockNumberFor<T>>>, DispatchError>

Get a list of Schema Ids that a provider has been granted access to

Errors

• Error::DelegationNotFound
• Error::SchemaNotGranted

pub fn register_signature( signature: &MultiSignature, signature_expires_at: BlockNumberFor<T> ) -> DispatchResult

Adds a signature to the PayloadSignatureRegistryList Check that mortality_block is within bounds. If so, proceed and add the new entry. Raises SignatureAlreadySubmitted if the signature exists in the registry. Raises SignatureRegistryLimitExceeded if the oldest signature of the list has not yet expired.

Example list:

• 1,2 (oldest)
• 2,3
• 3,4
• 4 (newest in pointer storage)`

Errors

• Error::ProofNotYetValid
• Error::ProofHasExpired
• Error::SignatureAlreadySubmitted
• Error::SignatureRegistryLimitExceeded

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Type of BlockNumber to provide.

fn current_block_number() -> Self::BlockNumber

Returns the current block number.

fn set_block_number(_block: Self::BlockNumber)

Utility function only to be used in benchmarking scenarios or tests, to be implemented optionally, else a noop.

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

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

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

Formats the value using the given formatter.

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

fn ensure_valid_delegation( provider_id: ProviderId, delegator_id: DelegatorId, block_number: Option<BlockNumberFor<T>> ) -> Result<Delegation<SchemaId, BlockNumberFor<T>, T::MaxSchemaGrantsPerDelegation>, DispatchError>

Check that the delegator has an active delegation to the provider. block_number: Provide None to know if the delegation is active at the current block. Provide Some(N) to know if the delegation was or will be active at block N.

Errors

• Error::DelegationNotFound
• Error::DelegationRevoked
• Error::CannotPredictValidityPastCurrentBlock

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Type for block number.

type MaxSchemaGrantsPerDelegation = <T as Config>::MaxSchemaGrantsPerDelegation

Type for maximum number of schemas that can be granted to a provider.

type SchemaId = u16

Schema Id is the unique identifier for a Schema

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

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.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

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

fn offchain_worker(block_number: BlockNumberFor<T>)

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.

fn on_finalize(_n: BlockNumber)

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

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]).

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

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

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

type AccountId = <T as Config>::AccountId

The association between key and MSA

fn get_msa_id(key: &Self::AccountId) -> Option<MessageSourceId>

Gets the MSA Id associated with this AccountId if any

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

type AccountId = <T as Config>::AccountId

The association between key and MSA

fn ensure_valid_msa_key( key: &T::AccountId ) -> Result<MessageSourceId, DispatchError>

Check that a key is associated to an MSA and returns key information. Returns a [DispatchError] if there is no MSA associated with the key

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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.

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.

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 ==.

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> ProviderLookup for Pallet<T>

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Type for block number.

type MaxSchemaGrantsPerDelegation = <T as Config>::MaxSchemaGrantsPerDelegation

Type for maximum number of schemas that can be granted to a provider.

type SchemaId = u16

Schema Id is the unique identifier for a Schema

fn get_delegation_of( delegator: DelegatorId, provider: ProviderId ) -> Option<Delegation<SchemaId, Self::BlockNumber, Self::MaxSchemaGrantsPerDelegation>>

Gets the relationship information for this delegator, provider pair

impl<T: Config> SchemaGrantValidator<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn ensure_valid_schema_grant( provider: ProviderId, delegator: DelegatorId, schema_id: SchemaId, block_number: BlockNumberFor<T> ) -> DispatchResult

Check if provider is allowed to publish for a given schema_id for a given delegator

Errors

• Error::DelegationNotFound
• Error::DelegationRevoked
• Error::SchemaNotGranted
• Error::CannotPredictValidityPastCurrentBlock

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

fn storage_info() -> Vec<StorageInfo>

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

fn validate(target: MessageSourceId) -> bool

Checks if an MSA is a valid target.

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>