Struct TransactionApi

pub struct TransactionApi;

Implementations

impl TransactionApi

pub fn add_registrar(&self, account: Account) -> StaticPayload<AddRegistrar>

Add a registrar to the system.

The dispatch origin for this call must be T::RegistrarOrigin.

• account: the account of the registrar.

Emits RegistrarAdded if successful.

pub fn set_identity(&self, info: Info) -> StaticPayload<SetIdentity>

Set an account’s identity information and reserve the appropriate deposit.

If the account already has identity information, the deposit is taken as part payment for the new deposit.

The dispatch origin for this call must be Signed.

• info: The identity information.

Emits IdentitySet if successful.

pub fn set_subs(&self, subs: Subs) -> StaticPayload<SetSubs>

Set the sub-accounts of the sender.

Payment: Any aggregate balance reserved by previous set_subs calls will be returned and an amount SubAccountDeposit will be reserved for each item in subs.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• subs: The identity’s (new) sub-accounts.

pub fn clear_identity(&self) -> StaticPayload<ClearIdentity>

Clear an account’s identity info and all sub-accounts and return all deposits.

Payment: All reserved balances on the account are returned.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

Emits IdentityCleared if successful.

pub fn request_judgement( &self, reg_index: RegIndex, max_fee: MaxFee, ) -> StaticPayload<RequestJudgement>

Request a judgement from a registrar.

Payment: At most max_fee will be reserved for payment to the registrar if judgement given.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• reg_index: The index of the registrar whose judgement is requested.
• max_fee: The maximum fee that may be paid. This should just be auto-populated as:

Self::registrars().get(reg_index).unwrap().fee

Emits JudgementRequested if successful.

pub fn cancel_request( &self, reg_index: RegIndex, ) -> StaticPayload<CancelRequest>

Cancel a previous request.

Payment: A previously reserved deposit is returned on success.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• reg_index: The index of the registrar whose judgement is no longer requested.

Emits JudgementUnrequested if successful.

pub fn set_fee(&self, index: Index, fee: Fee) -> StaticPayload<SetFee>

Set the fee required for a judgement to be requested from a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• fee: the new fee.

pub fn set_account_id( &self, index: Index, new: New, ) -> StaticPayload<SetAccountId>

Change the account associated with a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• new: the new account ID.

pub fn set_fields( &self, index: Index, fields: Fields, ) -> StaticPayload<SetFields>

Set the field information for a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• fields: the fields that the registrar concerns themselves with.

pub fn provide_judgement( &self, reg_index: RegIndex, target: Target, judgement: Judgement, identity: Identity, ) -> StaticPayload<ProvideJudgement>

Provide a judgement for an account’s identity.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is reg_index.

• reg_index: the index of the registrar whose judgement is being made.
• target: the account whose identity the judgement is upon. This must be an account with a registered identity.
• judgement: the judgement of the registrar of index reg_index about target.
• identity: The hash of the [IdentityInformationProvider] for that the judgement is provided.

Note: Judgements do not apply to a username.

Emits JudgementGiven if successful.

pub fn kill_identity(&self, target: Target) -> StaticPayload<KillIdentity>

Remove an account’s identity and sub-account information and slash the deposits.

Payment: Reserved balances from set_subs and set_identity are slashed and handled by Slash. Verification request deposits are not returned; they should be cancelled manually using cancel_request.

The dispatch origin for this call must match T::ForceOrigin.

• target: the account whose identity the judgement is upon. This must be an account with a registered identity.

Emits IdentityKilled if successful.

pub fn add_sub(&self, sub: Sub, data: Data) -> StaticPayload<AddSub>

Add the given account to the sender’s subs.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

pub fn rename_sub(&self, sub: Sub, data: Data) -> StaticPayload<RenameSub>

Alter the associated name of the given sub-account.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

pub fn remove_sub(&self, sub: Sub) -> StaticPayload<RemoveSub>

Remove the given account from the sender’s subs.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

pub fn quit_sub(&self) -> StaticPayload<QuitSub>

Remove the sender as a sub-account.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender (not the original depositor).

The dispatch origin for this call must be Signed and the sender must have a registered super-identity.

NOTE: This should not normally be used, but is provided in the case that the non- controller of an account is maliciously registered as a sub-account.

pub fn add_username_authority( &self, authority: Authority, suffix: Suffix, allocation: Allocation, ) -> StaticPayload<AddUsernameAuthority>

Add an AccountId with permission to grant usernames with a given suffix appended.

The authority can grant up to allocation usernames. To top up their allocation, they should just issue (or request via governance) a new add_username_authority call.

pub fn remove_username_authority( &self, authority: Authority, ) -> StaticPayload<RemoveUsernameAuthority>

Remove authority from the username authorities.

pub fn set_username_for( &self, who: Who, username: Username, signature: Signature, ) -> StaticPayload<SetUsernameFor>

Set the username for who. Must be called by a username authority.

The authority must have an allocation. Users can either pre-sign their usernames or accept them later.

Usernames must:

• Only contain lowercase ASCII characters or digits.
• When combined with the suffix of the issuing authority be less than the MaxUsernameLength.

pub fn accept_username( &self, username: Username, ) -> StaticPayload<AcceptUsername>

Accept a given username that an authority granted. The call must include the full username, as in username.suffix.

pub fn remove_expired_approval( &self, username: Username, ) -> StaticPayload<RemoveExpiredApproval>

Remove an expired username approval. The username was approved by an authority but never accepted by the user and must now be beyond its expiration. The call must include the full username, as in username.suffix.

pub fn set_primary_username( &self, username: Username, ) -> StaticPayload<SetPrimaryUsername>

Set a given username as the primary. The username should include the suffix.

pub fn remove_dangling_username( &self, username: Username, ) -> StaticPayload<RemoveDanglingUsername>

Remove a username that corresponds to an account with no identity. Exists when a user gets a username but then calls clear_identity.