Enum pallet_msa::pallet::Call

pub enum Call<T: Config> {
    create {},
    create_sponsored_account_with_delegation {
        delegator_key: T::AccountId,
        proof: MultiSignature,
        add_provider_payload: AddProvider,
    },
    create_provider {
        provider_name: Vec<u8>,
    },
    grant_delegation {
        delegator_key: T::AccountId,
        proof: MultiSignature,
        add_provider_payload: AddProvider,
    },
    revoke_delegation_by_delegator {
        provider_msa_id: MessageSourceId,
    },
    add_public_key_to_msa {
        msa_owner_public_key: T::AccountId,
        msa_owner_proof: MultiSignature,
        new_key_owner_proof: MultiSignature,
        add_key_payload: AddKeyData<T>,
    },
    delete_msa_public_key {
        public_key_to_delete: T::AccountId,
    },
    revoke_delegation_by_provider {
        delegator: MessageSourceId,
    },
    revoke_schema_permissions {
        provider_msa_id: MessageSourceId,
        schema_ids: Vec<SchemaId>,
    },
    retire_msa {},
    propose_to_be_provider {
        provider_name: Vec<u8>,
    },
    create_provider_via_governance {
        provider_key: T::AccountId,
        provider_name: Vec<u8>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

create

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.

create_sponsored_account_with_delegation

Fields

delegator_key: T::AccountId

proof: MultiSignature

add_provider_payload: AddProvider

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

create_provider

Fields

provider_name: Vec<u8>

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.

grant_delegation

Fields

delegator_key: T::AccountId

proof: MultiSignature

add_provider_payload: AddProvider

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

revoke_delegation_by_delegator

Fields

provider_msa_id: MessageSourceId

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.

add_public_key_to_msa

Fields

msa_owner_public_key: T::AccountId

msa_owner_proof: MultiSignature

new_key_owner_proof: MultiSignature

add_key_payload: AddKeyData<T>

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.

delete_msa_public_key

Fields

public_key_to_delete: T::AccountId

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.

revoke_delegation_by_provider

Fields

delegator: MessageSourceId

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.

revoke_schema_permissions

Fields

provider_msa_id: MessageSourceId

schema_ids: Vec<SchemaId>

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.

retire_msa

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.

propose_to_be_provider

Fields

provider_name: Vec<u8>

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.

create_provider_via_governance

Fields

provider_key: T::AccountId

provider_name: Vec<u8>

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.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_create() -> Self

Create a call with the variant create.

pub fn new_call_variant_create_sponsored_account_with_delegation( delegator_key: T::AccountId, proof: MultiSignature, add_provider_payload: AddProvider ) -> Self

Create a call with the variant create_sponsored_account_with_delegation.

pub fn new_call_variant_create_provider(provider_name: Vec<u8>) -> Self

Create a call with the variant create_provider.

pub fn new_call_variant_grant_delegation( delegator_key: T::AccountId, proof: MultiSignature, add_provider_payload: AddProvider ) -> Self

Create a call with the variant grant_delegation.

pub fn new_call_variant_revoke_delegation_by_delegator( provider_msa_id: MessageSourceId ) -> Self

Create a call with the variant revoke_delegation_by_delegator.

pub fn new_call_variant_add_public_key_to_msa( msa_owner_public_key: T::AccountId, msa_owner_proof: MultiSignature, new_key_owner_proof: MultiSignature, add_key_payload: AddKeyData<T> ) -> Self

Create a call with the variant add_public_key_to_msa.

pub fn new_call_variant_delete_msa_public_key( public_key_to_delete: T::AccountId ) -> Self

Create a call with the variant delete_msa_public_key.

pub fn new_call_variant_revoke_delegation_by_provider( delegator: MessageSourceId ) -> Self

Create a call with the variant revoke_delegation_by_provider.

pub fn new_call_variant_revoke_schema_permissions( provider_msa_id: MessageSourceId, schema_ids: Vec<SchemaId> ) -> Self

Create a call with the variant revoke_schema_permissions.

pub fn new_call_variant_retire_msa() -> Self

Create a call with the variant retire_msa.

pub fn new_call_variant_propose_to_be_provider(provider_name: Vec<u8>) -> Self

Create a call with the variant propose_to_be_provider.

pub fn new_call_variant_create_provider_via_governance( provider_key: T::AccountId, provider_name: Vec<u8> ) -> Self

Create a call with the variant create_provider_via_governance.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<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> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, AddKeyData<T>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike for Call<T>

impl<T: Config> Eq for Call<T>