Skip to main content

Extrinsics

The following sections contain Extrinsics methods are part of the default Substrate runtime. On the api, these are exposed via api.tx.<module>.<method>.

(NOTE: These were generated from a static/snapshot view of a recent Substrate master node. Some items may not be available in older nodes, or in any customized implementations.)

assets#

approveTransfer(id: Compact<AssetId>, delegate: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.approveTransfer

  • summary: Approve an amount of asset for transfer by a delegated third-party account.

    Origin must be Signed.

    Ensures that ApprovalDeposit worth of Currency is reserved from signing account for the purpose of holding the approval. If some non-zero amount of assets is already approved from signing account to delegate, then it is topped up or unreserved to meet the right value.

    NOTE: The signing account does not need to own amount of assets at the point of making this call.

    • id: The identifier of the asset.

    • delegate: The account to delegate permission to transfer asset.

    • amount: The amount of asset that may be transferred by delegate. If there is already an approval in place, then this acts additively.

      Emits ApprovedTransfer on success.

      Weight: O(1)

burn(id: Compact<AssetId>, who: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.burn

  • summary: Reduce the balance of who by as much as possible up to amount assets of id.

    Origin must be Signed and the sender should be the Manager of the asset id.

    Bails with BalanceZero if the who is already dead.

    • id: The identifier of the asset to have some amount burned.

    • who: The account to be debited from.

    • amount: The maximum amount by which who's balance should be reduced.

      Emits Burned with the actual amount burned. If this takes the balance to below the minimum for the asset, then the amount burned is increased to take it to zero.

      Weight: O(1) Modes: Post-existence of who; Pre & post Zombie-status of who.

cancelApproval(id: Compact<AssetId>, delegate: LookupSource)#

  • interface: api.tx.assets.cancelApproval

  • summary: Cancel all of some asset approved for delegated transfer by a third-party account.

    Origin must be Signed and there must be an approval in place between signer and delegate.

    Unreserves any deposit previously reserved by approve_transfer for the approval.

    • id: The identifier of the asset.

    • delegate: The account delegated permission to transfer asset.

      Emits ApprovalCancelled on success.

      Weight: O(1)

clearMetadata(id: Compact<AssetId>)#

  • interface: api.tx.assets.clearMetadata

  • summary: Clear the metadata for an asset.

    Origin must be Signed and the sender should be the Owner of the asset id.

    Any deposit is freed for the asset owner.

    • id: The identifier of the asset to clear.

      Emits MetadataCleared.

      Weight: O(1)

create(id: Compact<AssetId>, admin: LookupSource, min_balance: TAssetBalance)#

  • interface: api.tx.assets.create

  • summary: Issue a new class of fungible assets from a public origin.

    This new asset class has no assets initially and its owner is the origin.

    The origin must be Signed and the sender must have sufficient funds free.

    Funds of sender are reserved by AssetDeposit.

    Parameters:

    • id: The identifier of the new asset. This must not be currently in use to identify an existing asset.

    • admin: The admin of this class of assets. The admin is the initial address of each member of the asset class's admin team.

    • min_balance: The minimum balance of this new asset that any single account must have. If an account's balance is reduced below this, then it collapses to zero.

      Emits Created event when successful.

      Weight: O(1)

destroy(id: Compact<AssetId>, witness: AssetDestroyWitness)#

  • interface: api.tx.assets.destroy

  • summary: Destroy a class of fungible assets.

    The origin must conform to ForceOrigin or must be Signed and the sender must be the owner of the asset id.

    • id: The identifier of the asset to be destroyed. This must identify an existing asset.

      Emits Destroyed event when successful.

      NOTE: It can be helpful to first freeze an asset before destroying it so that you can provide accurate witness information and prevent users from manipulating state in a way that can make it harder to destroy.

      Weight: O(c + p + a) where:

    • c = (witness.accounts - witness.sufficients)

    • s = witness.sufficients

    • a = witness.approvals

forceAssetStatus(id: Compact<AssetId>, owner: LookupSource, issuer: LookupSource, admin: LookupSource, freezer: LookupSource, min_balance: Compact<TAssetBalance>, is_sufficient: bool, is_frozen: bool)#

  • interface: api.tx.assets.forceAssetStatus

  • summary: Alter the attributes of a given asset.

    Origin must be ForceOrigin.

    • id: The identifier of the asset.

    • owner: The new Owner of this asset.

    • issuer: The new Issuer of this asset.

    • admin: The new Admin of this asset.

    • freezer: The new Freezer of this asset.

    • min_balance: The minimum balance of this new asset that any single account must have. If an account's balance is reduced below this, then it collapses to zero.

    • is_sufficient: Whether a non-zero balance of this asset is deposit of sufficient value to account for the state bloat associated with its balance storage. If set to true, then non-zero balances may be stored without a consumer reference (and thus an ED in the Balances pallet or whatever else is used to control user-account state growth).

    • is_frozen: Whether this asset class is frozen except for permissioned/admin instructions.

      Emits AssetStatusChanged with the identity of the asset.

      Weight: O(1)

forceCancelApproval(id: Compact<AssetId>, owner: LookupSource, delegate: LookupSource)#

  • interface: api.tx.assets.forceCancelApproval

  • summary: Cancel all of some asset approved for delegated transfer by a third-party account.

    Origin must be either ForceOrigin or Signed origin with the signer being the Admin account of the asset id.

    Unreserves any deposit previously reserved by approve_transfer for the approval.

    • id: The identifier of the asset.

    • delegate: The account delegated permission to transfer asset.

      Emits ApprovalCancelled on success.

      Weight: O(1)

forceClearMetadata(id: Compact<AssetId>)#

  • interface: api.tx.assets.forceClearMetadata

  • summary: Clear the metadata for an asset.

    Origin must be ForceOrigin.

    Any deposit is returned.

    • id: The identifier of the asset to clear.

      Emits MetadataCleared.

      Weight: O(1)

forceCreate(id: Compact<AssetId>, owner: LookupSource, is_sufficient: bool, min_balance: Compact<TAssetBalance>)#

  • interface: api.tx.assets.forceCreate

  • summary: Issue a new class of fungible assets from a privileged origin.

    This new asset class has no assets initially.

    The origin must conform to ForceOrigin.

    Unlike create, no funds are reserved.

    • id: The identifier of the new asset. This must not be currently in use to identify an existing asset.

    • owner: The owner of this class of assets. The owner has full superuser permissions over this asset, but may later change and configure the permissions using transfer_ownership and set_team.

    • min_balance: The minimum balance of this new asset that any single account must have. If an account's balance is reduced below this, then it collapses to zero.

      Emits ForceCreated event when successful.

      Weight: O(1)

forceSetMetadata(id: Compact<AssetId>, name: Bytes, symbol: Bytes, decimals: u8, is_frozen: bool)#

  • interface: api.tx.assets.forceSetMetadata

  • summary: Force the metadata for an asset to some value.

    Origin must be ForceOrigin.

    Any deposit is left alone.

    • id: The identifier of the asset to update.

    • name: The user friendly name of this asset. Limited in length by StringLimit.

    • symbol: The exchange symbol for this asset. Limited in length by StringLimit.

    • decimals: The number of decimals this asset uses to represent one unit.

      Emits MetadataSet.

      Weight: O(N + S) where N and S are the length of the name and symbol respectively.

forceTransfer(id: Compact<AssetId>, source: LookupSource, dest: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.forceTransfer

  • summary: Move some assets from one account to another.

    Origin must be Signed and the sender should be the Admin of the asset id.

    • id: The identifier of the asset to have some amount transferred.

    • source: The account to be debited.

    • dest: The account to be credited.

    • amount: The amount by which the source's balance of assets should be reduced and dest's balance increased. The amount actually transferred may be slightly greater in the case that the transfer would otherwise take the source balance above zero but below the minimum balance. Must be greater than zero.

      Emits Transferred with the actual amount transferred. If this takes the source balance to below the minimum for the asset, then the amount transferred is increased to take it to zero.

      Weight: O(1) Modes: Pre-existence of dest; Post-existence of source; Account pre-existence of dest.

freeze(id: Compact<AssetId>, who: LookupSource)#

  • interface: api.tx.assets.freeze

  • summary: Disallow further unprivileged transfers from an account.

    Origin must be Signed and the sender should be the Freezer of the asset id.

    • id: The identifier of the asset to be frozen.

    • who: The account to be frozen.

      Emits Frozen.

      Weight: O(1)

freezeAsset(id: Compact<AssetId>)#

  • interface: api.tx.assets.freezeAsset

  • summary: Disallow further unprivileged transfers for the asset class.

    Origin must be Signed and the sender should be the Freezer of the asset id.

    • id: The identifier of the asset to be frozen.

      Emits Frozen.

      Weight: O(1)

mint(id: Compact<AssetId>, beneficiary: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.mint

  • summary: Mint assets of a particular class.

    The origin must be Signed and the sender must be the Issuer of the asset id.

    • id: The identifier of the asset to have some amount minted.

    • beneficiary: The account to be credited with the minted assets.

    • amount: The amount of the asset to be minted.

      Emits Issued event when successful.

      Weight: O(1) Modes: Pre-existing balance of beneficiary; Account pre-existence of beneficiary.

setMetadata(id: Compact<AssetId>, name: Bytes, symbol: Bytes, decimals: u8)#

  • interface: api.tx.assets.setMetadata

  • summary: Set the metadata for an asset.

    Origin must be Signed and the sender should be the Owner of the asset id.

    Funds of sender are reserved according to the formula: MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len) taking into account any already reserved funds.

    • id: The identifier of the asset to update.

    • name: The user friendly name of this asset. Limited in length by StringLimit.

    • symbol: The exchange symbol for this asset. Limited in length by StringLimit.

    • decimals: The number of decimals this asset uses to represent one unit.

      Emits MetadataSet.

      Weight: O(1)

setTeam(id: Compact<AssetId>, issuer: LookupSource, admin: LookupSource, freezer: LookupSource)#

  • interface: api.tx.assets.setTeam

  • summary: Change the Issuer, Admin and Freezer of an asset.

    Origin must be Signed and the sender should be the Owner of the asset id.

    • id: The identifier of the asset to be frozen.

    • issuer: The new Issuer of this asset.

    • admin: The new Admin of this asset.

    • freezer: The new Freezer of this asset.

      Emits TeamChanged.

      Weight: O(1)

thaw(id: Compact<AssetId>, who: LookupSource)#

  • interface: api.tx.assets.thaw

  • summary: Allow unprivileged transfers from an account again.

    Origin must be Signed and the sender should be the Admin of the asset id.

    • id: The identifier of the asset to be frozen.

    • who: The account to be unfrozen.

      Emits Thawed.

      Weight: O(1)

thawAsset(id: Compact<AssetId>)#

  • interface: api.tx.assets.thawAsset

  • summary: Allow unprivileged transfers for the asset again.

    Origin must be Signed and the sender should be the Admin of the asset id.

    • id: The identifier of the asset to be thawed.

      Emits Thawed.

      Weight: O(1)

transfer(id: Compact<AssetId>, target: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.transfer

  • summary: Move some assets from the sender account to another.

    Origin must be Signed.

    • id: The identifier of the asset to have some amount transferred.

    • target: The account to be credited.

    • amount: The amount by which the sender's balance of assets should be reduced and target's balance increased. The amount actually transferred may be slightly greater in the case that the transfer would otherwise take the sender balance above zero but below the minimum balance. Must be greater than zero.

      Emits Transferred with the actual amount transferred. If this takes the source balance to below the minimum for the asset, then the amount transferred is increased to take it to zero.

      Weight: O(1) Modes: Pre-existence of target; Post-existence of sender; Account pre-existence of target.

transferApproved(id: Compact<AssetId>, owner: LookupSource, destination: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.transferApproved

  • summary: Transfer some asset balance from a previously delegated account to some third-party account.

    Origin must be Signed and there must be an approval in place by the owner to the signer.

    If the entire amount approved for transfer is transferred, then any deposit previously reserved by approve_transfer is unreserved.

    • id: The identifier of the asset.

    • owner: The account which previously approved for a transfer of at least amount and from which the asset balance will be withdrawn.

    • destination: The account to which the asset balance of amount will be transferred.

    • amount: The amount of assets to transfer.

      Emits TransferredApproved on success.

      Weight: O(1)

transferKeepAlive(id: Compact<AssetId>, target: LookupSource, amount: Compact<TAssetBalance>)#

  • interface: api.tx.assets.transferKeepAlive

  • summary: Move some assets from the sender account to another, keeping the sender account alive.

    Origin must be Signed.

    • id: The identifier of the asset to have some amount transferred.

    • target: The account to be credited.

    • amount: The amount by which the sender's balance of assets should be reduced and target's balance increased. The amount actually transferred may be slightly greater in the case that the transfer would otherwise take the sender balance above zero but below the minimum balance. Must be greater than zero.

      Emits Transferred with the actual amount transferred. If this takes the source balance to below the minimum for the asset, then the amount transferred is increased to take it to zero.

      Weight: O(1) Modes: Pre-existence of target; Post-existence of sender; Account pre-existence of target.

transferOwnership(id: Compact<AssetId>, owner: LookupSource)#

  • interface: api.tx.assets.transferOwnership

  • summary: Change the Owner of an asset.

    Origin must be Signed and the sender should be the Owner of the asset id.

    • id: The identifier of the asset.

    • owner: The new Owner of this asset.

      Emits OwnerChanged.

      Weight: O(1)

authorship#

setUncles(new_uncles: Vec<Header>)#

  • interface: api.tx.authorship.setUncles

  • summary: Provide a set of uncles.

    If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, a new phragmen election is started.

    Note that this does not affect the designated block number of the next election.

planConfigChange(config: NextConfigDescriptor)#

  • interface: api.tx.babe.planConfigChange
  • summary: Plan an epoch config change. The epoch config change is recorded and will be enacted on the next call to enact_epoch_change. The config will be activated one epoch after. Multiple calls to this method will replace any existing planned config change that had not been enacted yet.

reportEquivocation(equivocation_proof: BabeEquivocationProof, key_owner_proof: KeyOwnerProof)#

  • interface: api.tx.babe.reportEquivocation
  • summary: Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

reportEquivocationUnsigned(equivocation_proof: BabeEquivocationProof, key_owner_proof: KeyOwnerProof)#

  • interface: api.tx.babe.reportEquivocationUnsigned

  • summary: Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported. This extrinsic must be called unsigned and it is expected that only block authors will call it (validated in ValidateUnsigned), as such if the block author is defined it will be defined as the equivocation reporter.

    • origin is a candidate and not elected in any set. In this case, the bond is unreserved, returned and origin is removed as a candidate.

    • origin is a current runner-up. In this case, the bond is unreserved, returned and origin is removed as a runner-up.

balances#

forceTransfer(source: LookupSource, dest: LookupSource, value: Compact<Balance>)#

  • interface: api.tx.balances.forceTransfer
  • summary: Exactly as transfer, except the origin must be root and the source account may be specified.

setBalance(who: LookupSource, new_free: Compact<Balance>, new_reserved: Compact<Balance>)#

  • interface: api.tx.balances.setBalance

  • summary: Set the balances of a given account.

    This will alter FreeBalance and ReservedBalance in storage. it will also decrease the total issuance of the system (TotalIssuance). If the new free or reserved balance is below the existential deposit, it will reset the account nonce (frame_system::AccountNonce).

    The dispatch origin for this call is root.

transfer(dest: LookupSource, value: Compact<Balance>)#

  • interface: api.tx.balances.transfer

  • summary: Transfer some liquid free balance to another account.

    transfer will set the FreeBalance of the sender and receiver. It will decrease the total issuance of the system by the TransferFee. If the sender's account is below the existential deposit as a result of the transfer, the account will be reaped.

    The dispatch origin for this call must be Signed by the transactor.

transferAll(dest: LookupSource, keep_alive: bool)#

  • interface: api.tx.balances.transferAll

  • summary: Transfer the entire transferable balance from the caller account.

    NOTE: This function only attempts to transfer transferable balances. This means that any locked, reserved, or existential deposits (when keep_alive is true), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc...

    The dispatch origin of this call must be Signed.

    • dest: The recipient of the transfer.

    • keep_alive: A boolean to determine if the transfer_all operation should send all of the funds the account has, causing the sender account to be killed (false), or transfer everything except at least the existential deposit, which will guarantee to keep the sender account alive (true). #

transferKeepAlive(dest: LookupSource, value: Compact<Balance>)#

  • interface: api.tx.balances.transferKeepAlive

  • summary: Same as the transfer call, but with a check that the transfer will not kill the origin account.

    99% of the time you want transfer instead.

bounties#

acceptCurator(bounty_id: Compact<BountyIndex>)#

  • interface: api.tx.bounties.acceptCurator

  • summary: Accept the curator role for a bounty. A deposit will be reserved from curator and refund upon successful payout.

    May only be called from the curator.

approveBounty(bounty_id: Compact<BountyIndex>)#

  • interface: api.tx.bounties.approveBounty

  • summary: Approve a bounty proposal. At a later time, the bounty will be funded and become active and the original deposit will be returned.

    May only be called from T::ApproveOrigin.

awardBounty(bounty_id: Compact<BountyIndex>, beneficiary: LookupSource)#

  • interface: api.tx.bounties.awardBounty

  • summary: Award bounty to a beneficiary account. The beneficiary will be able to claim the funds after a delay.

    The dispatch origin for this call must be the curator of this bounty.

    • bounty_id: Bounty ID to award.

    • beneficiary: The beneficiary account whom will receive the payout.

claimBounty(bounty_id: Compact<BountyIndex>)#

  • interface: api.tx.bounties.claimBounty

  • summary: Claim the payout from an awarded bounty after payout delay.

    The dispatch origin for this call must be the beneficiary of this bounty.

    • bounty_id: Bounty ID to claim.

closeBounty(bounty_id: Compact<BountyIndex>)#

  • interface: api.tx.bounties.closeBounty

  • summary: Cancel a proposed or active bounty. All the funds will be sent to treasury and the curator deposit will be unreserved if possible.

    Only T::RejectOrigin is able to cancel a bounty.

    • bounty_id: Bounty ID to cancel.

extendBountyExpiry(bounty_id: Compact<BountyIndex>, _remark: Bytes)#

  • interface: api.tx.bounties.extendBountyExpiry

  • summary: Extend the expiry time of an active bounty.

    The dispatch origin for this call must be the curator of this bounty.

    • bounty_id: Bounty ID to extend.

    • remark: additional information.

proposeBounty(value: Compact<BalanceOf>, description: Bytes)#

  • interface: api.tx.bounties.proposeBounty

  • summary: Propose a new bounty.

    The dispatch origin for this call must be Signed.

    Payment: TipReportDepositBase will be reserved from the origin account, as well as DataDepositPerByte for each byte in reason. It will be unreserved upon approval, or slashed when rejected.

    • curator: The curator account whom will manage this bounty.

    • fee: The curator fee.

    • value: The total payment amount of this bounty, curator fee included.

    • description: The description of this bounty.

proposeCurator(bounty_id: Compact<BountyIndex>, curator: LookupSource, fee: Compact<BalanceOf>)#

  • interface: api.tx.bounties.proposeCurator

  • summary: Assign a curator to a funded bounty.

    May only be called from T::ApproveOrigin.

unassignCurator(bounty_id: Compact<BountyIndex>)#

  • interface: api.tx.bounties.unassignCurator

  • summary: Unassign curator from a bounty.

    This function can only be called by the RejectOrigin a signed origin.

    If this function is called by the RejectOrigin, we assume that the curator is malicious or inactive. As a result, we will slash the curator when possible.

    If the origin is the curator, we take this as a sign they are unable to do their job and they willingly give up. We could slash them, but for now we allow them to recover their deposit and exit without issue. (We may want to change this if it is abused.)

    Finally, the origin can be anyone if and only if the curator is "inactive". This allows anyone in the community to call out that a curator is not doing their due diligence, and we should pick a new curator. In this case the curator should also be slashed.

emergencyShutdown#

call(dest: LookupSource, value: Compact<BalanceOf>, gas_limit: Compact<Weight>, data: Bytes)#

  • interface: api.tx.contracts.call

  • summary: Makes a call to an account, optionally transferring some balance.

    • If the account is a smart-contract account, the associated code will be executed and any value will be transferred.

    The dispatch origin of this call must be ShutdownOrigin.

    • If no account exists and the call value is not less than existential_deposit, a regular account will be created and any value will be transferred.

claimSurcharge(dest: AccountId, aux_sender: Option<AccountId>)#

  • interface: api.tx.contracts.claimSurcharge

  • summary: Allows block producers to claim a small reward for evicting a contract. If a block producer fails to do so, a regular users will be allowed to claim the reward.

    In case of a successful eviction no fees are charged from the sender. However, the reward is capped by the total amount of rent that was paid by the contract while it was alive.

    If contract is not evicted as a result of this call, [Error::ContractNotEvictable] is returned and the sender is not eligible for the reward.

instantiate(endowment: Compact<BalanceOf>, gas_limit: Compact<Weight>, code_hash: CodeHash, data: Bytes, salt: Bytes)#

  • interface: api.tx.contracts.instantiate

  • summary: Instantiates a contract from a previously deployed wasm binary.

    This function is identical to [Self::instantiate_with_code] but without the code deployment step. Instead, the code_hash of an on-chain deployed wasm binary must be supplied.

instantiateWithCode(endowment: Compact<BalanceOf>, gas_limit: Compact<Weight>, code: Bytes, data: Bytes, salt: Bytes)#

  • interface: api.tx.contracts.instantiateWithCode

  • summary: Instantiates a new contract from the supplied code optionally transferring some balance.

    This is the only function that can deploy new code to the chain.

    Parameters#

    • endowment: The balance to transfer from the origin to the newly created contract.

    • gas_limit: The gas limit enforced when executing the constructor.

    • code: The contract code to deploy in raw bytes.

    • data: The input data to pass to the contract constructor.

    • salt: Used for the address derivation. See [Pallet::contract_address].

      Instantiation is executed as follows:

    • The supplied code is instrumented, deployed, and a code_hash is created for that code.

    • If the code_hash already exists on the chain the underlying code will be shared.

    • The destination address is computed based on the sender, code_hash and the salt.

    • The smart-contract account is created at the computed address.

    • The endowment is transferred to the new account.

    • The deploy function is executed in the context of the newly-created account.

generalCouncil#

close(proposal_hash: Hash, index: Compact<ProposalIndex>, proposal_weight_bound: Compact<Weight>, length_bound: Compact<u32>)#

  • interface: api.tx.council.close

  • summary: Close a vote that is either approved, disapproved or whose voting period has ended.

    May be called by any signed account in order to finish voting and close the proposal.

    If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.

    If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

    If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.

    • proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal. + length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

disapproveProposal(proposal_hash: Hash)#

  • interface: api.tx.council.disapproveProposal

  • summary: Disapprove a proposal, close, and remove it from the system, regardless of its current state.

    Must be called by the Root origin.

    Parameters:

    • proposal_hash: The hash of the proposal that should be disapproved.

execute(proposal: Proposal, length_bound: Compact<u32>)#

  • interface: api.tx.council.execute

  • summary: Dispatch a proposal from a member using the Member origin.

    Origin must be a member of the collective.

propose(threshold: Compact<MemberCount>, proposal: Proposal, length_bound: Compact<u32>)#

  • interface: api.tx.council.propose

  • summary: Add a new proposal to either be voted on or executed directly.

    Requires the sender to be member.

    threshold determines whether proposal is executed directly (threshold < 2) or put up for voting.

setMembers(new_members: Vec<AccountId>, prime: Option<AccountId>, old_count: MemberCount)#

  • interface: api.tx.council.setMembers

  • summary: Set the collective's membership.

    • new_members: The new member list. Be nice to the chain and provide it sorted.

    • prime: The prime member whose vote sets the default.

    • old_count: The upper bound for the previous number of members in storage. Used for weight estimation.

      Requires root origin.

      NOTE: Does not enforce the expected MaxMembers limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.

vote(proposal: Hash, index: Compact<ProposalIndex>, approve: bool)#

  • interface: api.tx.council.vote

  • summary: Add an aye or nay vote for the sender to the given proposal.

    Requires the sender to be a member.

    Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.

generalCouncilMembership#

blacklist(proposal_hash: Hash, maybe_ref_index: Option<ReferendumIndex>)#

  • interface: api.tx.democracy.blacklist

  • summary: Permanently place a proposal into the blacklist. This prevents it from ever being proposed again.

    If called on a queued public or external proposal, then this will result in it being removed. If the ref_index supplied is an active referendum with the proposal hash, then it will be cancelled.

    The dispatch origin of this call must be BlacklistOrigin.

    • proposal_hash: The proposal hash to blacklist permanently.

    • ref_index: An ongoing referendum whose hash is proposal_hash, which will be cancelled.

      Weight: O(p) (though as this is an high-privilege dispatch, we assume it has a reasonable value).

cancelProposal(prop_index: Compact<PropIndex>)#

  • interface: api.tx.democracy.cancelProposal

  • summary: Remove a proposal.

    The dispatch origin of this call must be CancelProposalOrigin.

    • prop_index: The index of the proposal to cancel.

      Weight: O(p) where p = PublicProps::<T>::decode_len()

cancelQueued(which: ReferendumIndex)#

  • interface: api.tx.democracy.cancelQueued

  • summary: Cancel a proposal queued for enactment.

    The dispatch origin of this call must be Root.

    • which: The index of the referendum to cancel.

      Weight: O(D) where D is the items in the dispatch queue. Weighted as D = 10.

cancelReferendum(ref_index: Compact<ReferendumIndex>)#

  • interface: api.tx.democracy.cancelReferendum

  • summary: Remove a referendum.

    The dispatch origin of this call must be Root.

    • ref_index: The index of the referendum to cancel.

      Weight: O(1).

clearPublicProposals()#

  • interface: api.tx.democracy.clearPublicProposals

  • summary: Clears all public proposals.

    The dispatch origin of this call must be Root.

    Weight: O(1).

delegate(to: AccountId, conviction: Conviction, balance: BalanceOf)#

  • interface: api.tx.democracy.delegate

  • summary: Delegate the voting power (with some given conviction) of the sending account.

    The balance delegated is locked for as long as it's delegated, and thereafter for the time appropriate for the conviction's lock period.

    The dispatch origin of this call must be Signed, and the signing account must either:

    • be delegating already; or

    • have no voting activity (if there is, then it will need to be removed/consolidated through reap_vote or unvote).

    • to: The account whose voting the target account's voting power will follow.

    • conviction: The conviction that will be attached to the delegated votes. When the account is undelegated, the funds will be locked for the corresponding period.

    • balance: The amount of the account's balance to be used in delegating. This must not be more than the account's current balance.

      Emits Delegated.

      Weight: O(R) where R is the number of referendums the voter delegating to has voted on. Weight is charged as if maximum votes.

emergencyCancel(ref_index: ReferendumIndex)#

  • interface: api.tx.democracy.emergencyCancel

  • summary: Schedule an emergency cancellation of a referendum. Cannot happen twice to the same referendum.

    The dispatch origin of this call must be CancellationOrigin.

    -ref_index: The index of the referendum to cancel.

    Weight: O(1).

enactProposal(proposal_hash: Hash, index: ReferendumIndex)#

  • interface: api.tx.democracy.enactProposal
  • summary: Enact a proposal from a referendum. For now we just make the weight be the maximum.

externalPropose(proposal_hash: Hash)#

  • interface: api.tx.democracy.externalPropose

  • summary: Schedule a referendum to be tabled once it is legal to schedule an external referendum.

    The dispatch origin of this call must be ExternalOrigin.

    • proposal_hash: The preimage hash of the proposal.

      Weight: O(V) with V number of vetoers in the blacklist of proposal. Decoding vec of length V. Charged as maximum

externalProposeDefault(proposal_hash: Hash)#

  • interface: api.tx.democracy.externalProposeDefault

  • summary: Schedule a negative-turnout-bias referendum to be tabled next once it is legal to schedule an external referendum.

    The dispatch of this call must be ExternalDefaultOrigin.

    • proposal_hash: The preimage hash of the proposal.

      Unlike external_propose, blacklisting has no effect on this and it may replace a pre-scheduled external_propose call.

      Weight: O(1)

externalProposeMajority(proposal_hash: Hash)#

  • interface: api.tx.democracy.externalProposeMajority

  • summary: Schedule a majority-carries referendum to be tabled next once it is legal to schedule an external referendum.

    The dispatch of this call must be ExternalMajorityOrigin.

    • proposal_hash: The preimage hash of the proposal.

      Unlike external_propose, blacklisting has no effect on this and it may replace a pre-scheduled external_propose call.

      Weight: O(1)

fastTrack(proposal_hash: Hash, voting_period: BlockNumber, delay: BlockNumber)#

  • interface: api.tx.democracy.fastTrack

  • summary: Schedule the currently externally-proposed majority-carries referendum to be tabled immediately. If there is no externally-proposed referendum currently, or if there is one but it is not a majority-carries referendum then it fails.

    The dispatch of this call must be FastTrackOrigin.

    • proposal_hash: The hash of the current external proposal.

    • voting_period: The period that is allowed for voting on this proposal. Increased to FastTrackVotingPeriod if too low.

    • delay: The number of block after voting has ended in approval and this should be enacted. This doesn't have a minimum amount.

      Emits Started.

      Weight: O(1)

noteImminentPreimage(encoded_proposal: Bytes)#

  • interface: api.tx.democracy.noteImminentPreimage

  • summary: Register the preimage for an upcoming proposal. This requires the proposal to be in the dispatch queue. No deposit is needed. When this call is successful, i.e. the preimage has not been uploaded before and matches some imminent proposal, no fee is paid.

    The dispatch origin of this call must be Signed.

    • encoded_proposal: The preimage of a proposal.

      Emits PreimageNoted.

      Weight: O(E) with E size of encoded_proposal (protected by a required deposit).

noteImminentPreimageOperational(encoded_proposal: Bytes)#

  • interface: api.tx.democracy.noteImminentPreimageOperational
  • summary: Same as note_imminent_preimage but origin is OperationalPreimageOrigin.

notePreimage(encoded_proposal: Bytes)#

  • interface: api.tx.democracy.notePreimage

  • summary: Register the preimage for an upcoming proposal. This doesn't require the proposal to be in the dispatch queue but does require a deposit, returned once enacted.

    The dispatch origin of this call must be Signed.

    • encoded_proposal: The preimage of a proposal.

      Emits PreimageNoted.

      Weight: O(E) with E size of encoded_proposal (protected by a required deposit).

notePreimageOperational(encoded_proposal: Bytes)#

  • interface: api.tx.democracy.notePreimageOperational
  • summary: Same as note_preimage but origin is OperationalPreimageOrigin.

propose(proposal_hash: Hash, value: Compact<BalanceOf>)#

  • interface: api.tx.democracy.propose

  • summary: Propose a sensitive action to be taken.

    The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit.

    • proposal_hash: The hash of the proposal preimage.

    Requires the sender to be member.

    Emits Proposed.

    Weight: O(p)

reapPreimage(proposal_hash: Hash, proposal_len_upper_bound: Compact<u32>)#

  • interface: api.tx.democracy.reapPreimage

  • summary: Remove an expired proposal preimage and collect the deposit.

    The dispatch origin of this call must be Signed.

    • proposal_hash: The preimage hash of a proposal.

    • proposal_length_upper_bound: an upper bound on length of the proposal. Extrinsic is weighted according to this value with no refund.

      This will only work after VotingPeriod blocks from the time that the preimage was noted, if it's the same account doing it. If it's a different account, then it'll only work an additional EnactmentPeriod later.

      Emits PreimageReaped.

      Weight: O(D) where D is length of proposal.

removeOtherVote(target: AccountId, index: ReferendumIndex)#

  • interface: api.tx.democracy.removeOtherVote

  • summary: Remove a vote for a referendum.

    If the target is equal to the signer, then this function is exactly equivalent to remove_vote. If not equal to the signer, then the vote must have expired, either because the referendum was cancelled, because the voter lost the referendum or because the conviction period is over.

    The dispatch origin of this call must be Signed.

    • target: The account of the vote to be removed; this account must have voted for referendum index.

homaCouncilMembership#

addMember(who: AccountId)#

  • interface: api.tx.homaCouncilMembership.addMember

  • summary: Add a member who to the set.

    Weight: O(R + log R) where R is the number of referenda that target has voted on. Weight is calculated for the maximum number of vote.

removeVote(index: ReferendumIndex)#

  • interface: api.tx.democracy.removeVote

  • summary: Remove a vote for a referendum.

    If:

    Prime membership is passed from the origin account to new, if extant.

clearPrime()#

  • interface: api.tx.homaCouncilMembership.clearPrime

  • summary: Remove the prime member if it exists.

    May only be called from T::PrimeOrigin.

removeMember(who: AccountId)#

  • interface: api.tx.homaCouncilMembership.removeMember

  • summary: Remove a member who from the set.

    May only be called from T::RemoveOrigin.

resetMembers(members: Vec<AccountId>)#

  • interface: api.tx.homaCouncilMembership.resetMembers

  • summary: Change the membership to a new set, disregarding the existing membership. Be nice and pass members pre-sorted.

    May only be called from T::ResetOrigin.

setPrime(who: AccountId)#

  • interface: api.tx.homaCouncilMembership.setPrime

  • summary: Set the prime member. Must be a current member.

    May only be called from T::PrimeOrigin.

swapMember(remove: AccountId, add: AccountId)#

  • interface: api.tx.homaCouncilMembership.swapMember

  • summary: Swap out one member remove for another add.

    • the account made a split vote ...then the vote is removed cleanly and a following call to unlock may result in more funds being available.

      If, however, the referendum has ended and:

  • the lock period of the conviction is not over ...then the lock will be aggregated into the overall account's lock, which may involve

    overlocking (where the two locks are combined into a single lock that is the maximum of both the amount locked and the time is it locked for).

    The dispatch origin of this call must be Signed, and the signer must have a vote registered for referendum index.

  • index: The index of referendum of the vote to be removed.

    Weight: O(R + log R) where R is the number of referenda that target has voted on. Weight is calculated for the maximum number of vote.

second(proposal: Compact<PropIndex>, seconds_upper_bound: Compact<u32>)#

  • interface: api.tx.democracy.second

  • summary: Signals agreement with a particular proposal.

    The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit, equal to the original deposit.

    • proposal: The index of the proposal to second.

    • seconds_upper_bound: an upper bound on the current number of seconds on this proposal. Extrinsic is weighted according to this value with no refund.

      Weight: O(S) where S is the number of seconds a proposal already has.

undelegate()#

  • interface: api.tx.democracy.undelegate

  • summary: Undelegate the voting power of the sending account.

    Tokens may be unlocked following once an amount of time consistent with the lock period of the conviction with which the delegation was issued.

    The dispatch origin of this call must be Signed and the signing account must be currently delegating.

    Emits Undelegated.

    Weight: O(R) where R is the number of referendums the voter delegating to has voted on. Weight is charged as if maximum votes.

unlock(target: AccountId)#

  • interface: api.tx.democracy.unlock

  • summary: Unlock tokens that have an expired lock.

    The dispatch origin of this call must be Signed.

    • target: The account to remove the lock on.

      Weight: O(R) with R number of vote of target.

vetoExternal(proposal_hash: Hash)#

  • interface: api.tx.democracy.vetoExternal

  • summary: Veto and blacklist the external proposal hash.

    The dispatch origin of this call must be VetoOrigin.

    • proposal_hash: The preimage hash of the proposal to veto and blacklist.

      Emits Vetoed.

      Weight: O(V + log(V)) where V is number of existing vetoers

vote(ref_index: Compact<ReferendumIndex>, vote: AccountVote)#

  • interface: api.tx.democracy.vote

  • summary: Vote in a referendum. If vote.is_aye(), the vote is to enact the proposal; otherwise it is a vote to keep the status quo.

    The dispatch origin of this call must be Signed.

    • ref_index: The index of the referendum to vote for.

    May be called by any signed account in order to finish voting and close the proposal.

    Weight: O(R) where R is the number of referendums the voter has voted on.

electionProviderMultiPhase#

setEmergencyElectionResult(solution: ReadySolution)#

  • interface: api.tx.electionProviderMultiPhase.setEmergencyElectionResult

  • summary: Set a solution in the queue, to be handed out to the client of this pallet in the next call to ElectionProvider::elect.

    This can only be set by T::ForceOrigin, and only when the phase is Emergency.

    The solution is not checked for any feasibility and is assumed to be trustworthy, as any feasibility check itself can in principle cause the election process to fail (due to memory/weight constrains).

setMinimumUntrustedScore(maybe_next_score: Option<ElectionScore>)#

  • interface: api.tx.electionProviderMultiPhase.setMinimumUntrustedScore

  • summary: Set a new value for MinimumUntrustedScore.

    Dispatch origin must be aligned with T::ForceOrigin.

    This check can be turned off by setting the value to None.

submitUnsigned(solution: RawSolution, witness: SolutionOrSnapshotSize)#

  • interface: api.tx.electionProviderMultiPhase.submitUnsigned

  • summary: Submit a solution for the unsigned phase.

    The dispatch origin fo this call must be none.

    This submission is checked on the fly. Moreover, this unsigned solution is only validated when submitted to the pool from the local node. Effectively, this means that only active validators can submit this transaction when authoring a block (similar to an inherent).

    To prevent any incorrect solution (and thus wasted time/weight), this transaction will panic if the solution submitted by the validator is invalid in any way, effectively putting their authoring reward at risk.

    No deposit or reward is associated with this submission.

    If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

    • proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal. + length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

cleanDefunctVoters(_num_voters: u32, _num_defunct: u32)#

  • interface: api.tx.elections.cleanDefunctVoters

  • summary: Clean all voters who are defunct (i.e. they do not serve any purpose at all). The deposit of the removed voters are returned.

    This is an root function to be used only for cleaning the state.

    The dispatch origin of this call must be root.

removeMember(who: LookupSource, has_replacement: bool)#

  • interface: api.tx.elections.removeMember

  • summary: Remove a particular member from the set. This is effective immediately and the bond of the outgoing member is slashed.

    If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, a new phragmen election is started.

    The dispatch origin of this call must be root.

    Note that this does not affect the designated block number of the next election.

removeVoter()#

  • interface: api.tx.elections.removeVoter

  • summary: Remove origin as a voter.

    This removes the lock and returns the deposit.

    The dispatch origin of this call must be signed and be a voter.

renounceCandidacy(renouncing: Renouncing)#

  • interface: api.tx.elections.renounceCandidacy

  • summary: Renounce one's intention to be a candidate for the next election round. 3 potential outcomes exist:

    • origin is a candidate and not elected in any set. In this case, the deposit is unreserved, returned and origin is removed as a candidate.

    • origin is a current runner-up. In this case, the deposit is unreserved, returned and origin is removed as a runner-up.

    • origin is a current member. In this case, the deposit is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar to [remove_members], if replacement runners exists, they are immediately used. If the prime is renouncing, then no prime will exist until the next round.

      The dispatch origin of this call must be signed, and have one of the above roles.

submitCandidacy(candidate_count: Compact<u32>)#

  • interface: api.tx.elections.submitCandidacy

  • summary: Submit oneself for candidacy. A fixed amount of deposit is recorded.

    All candidates are wiped at the end of the term. They either become a member/runner-up, or leave the system while their deposit is slashed.

    The dispatch origin of this call must be signed.

    Warning#

    Even if a candidate ends up being a member, they must call [Call::renounce_candidacy] to get their deposit back. Losing the spot in an election will always lead to a slash.

vote(votes: Vec<AccountId>, value: Compact<BalanceOf>)#

  • interface: api.tx.elections.vote

  • summary: Vote for a set of candidates for the upcoming round of election. This can be called to set the initial votes, or update already existing votes.

    Upon initial voting, value units of who's balance is locked and a deposit amount is reserved. The deposit is based on the number of votes and can be updated over time.

    The votes should:

    Prime membership is passed from the origin account to new, if extant.

clearPrime()#

  • interface: api.tx.honzonCouncilMembership.clearPrime

  • summary: Remove the prime member if it exists.

    • be less than the number of possible candidates. Note that all current members and runners-up are also automatically candidates for the next round.

      If value is more than who's total balance, then the maximum of the two is used.

      The dispatch origin of this call must be signed.

      Warning#

      It is the responsibility of the caller to NOT place all of their balance into the lock and keep some for further operations.

gilt#

placeBid(amount: Compact<BalanceOf>, duration: u32)#

  • interface: api.tx.gilt.placeBid

  • summary: Place a bid for a gilt to be issued.

    Origin must be Signed, and account must have at least amount in free balance.

    • amount: The amount of the bid; these funds will be reserved. If the bid is successfully elevated into an issued gilt, then these funds will continue to be reserved until the gilt expires. Must be at least MinFreeze.

    • duration: The number of periods for which the funds will be locked if the gilt is issued. It will expire only after this period has elapsed after the point of issuance. Must be greater than 1 and no more than QueueCount.

      Complexities:

    • Queues[duration].len() (just take max).

retractBid(amount: Compact<BalanceOf>, duration: u32)#

  • interface: api.tx.gilt.retractBid

  • summary: Retract a previously placed bid.

    Origin must be Signed, and the account should have previously issued a still-active bid of amount for duration.

    • amount: The amount of the previous bid.

    • duration: The duration of the previous bid.

setTarget(target: Compact<Perquintill>)#

  • interface: api.tx.gilt.setTarget

  • summary: Set target proportion of gilt-funds.

    Origin must be AdminOrigin.

    • target: The target proportion of effective issued funds that should be under gilts at any one time.

thaw(index: Compact<ActiveIndex>)#

  • interface: api.tx.gilt.thaw

  • summary: Remove an active but expired gilt. Reserved funds under gilt are freed and balance is adjusted to ensure that the funds grow or shrink to maintain the equivalent proportion of effective total issued funds.

    Origin must be Signed and the account must be the owner of the gilt of the given index.

    • index: The index of the gilt to be thawed.

incentives#

noteStalled(delay: BlockNumber, best_finalized_block_number: BlockNumber)#

  • interface: api.tx.grandpa.noteStalled
  • summary: Note that the current authority set of the GRANDPA finality gadget has stalled. This will trigger a forced authority set change at the beginning of the next session, to be enacted delay blocks after that. The delay should be high enough to safely assume that the block signalling the forced change will not be re-orged (e.g. 1000 blocks). The GRANDPA voters will start the new authority set using the given finalized block as base. Only callable by root.

reportEquivocation(equivocation_proof: GrandpaEquivocationProof, key_owner_proof: KeyOwnerProof)#

  • interface: api.tx.grandpa.reportEquivocation
  • summary: Report voter equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

reportEquivocationUnsigned(equivocation_proof: GrandpaEquivocationProof, key_owner_proof: KeyOwnerProof)#

  • interface: api.tx.grandpa.reportEquivocationUnsigned

  • summary: Report voter equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

    This extrinsic must be called unsigned and it is expected that only block authors will call it (validated in ValidateUnsigned), as such if the block author is defined it will be defined as the equivocation reporter.

indices#

addRegistrar(account: AccountId)#

  • interface: api.tx.identity.addRegistrar

  • summary: 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.

addSub(sub: LookupSource, data: Data)#

  • interface: api.tx.identity.addSub

  • summary: 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.

cancelRequest(reg_index: RegistrarIndex)#

  • interface: api.tx.identity.cancelRequest

  • summary: 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.

clearIdentity()#

  • interface: api.tx.identity.clearIdentity

  • summary: 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.

killIdentity(target: LookupSource)#

  • interface: api.tx.identity.killIdentity

  • summary: 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.

provideJudgement(reg_index: Compact<RegistrarIndex>, target: LookupSource, judgement: IdentityJudgement)#

  • interface: api.tx.identity.provideJudgement

  • summary: 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.

    • new: the new owner of the index. This function is a no-op if it is equal to sender.

      Emits JudgementGiven if successful.

quitSub()#

  • interface: api.tx.identity.quitSub

  • summary: 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.

removeSub(sub: LookupSource)#

  • interface: api.tx.identity.removeSub

  • summary: 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.

renameSub(sub: LookupSource, data: Data)#

  • interface: api.tx.identity.renameSub

  • summary: 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.

requestJudgement(reg_index: Compact<RegistrarIndex>, max_fee: Compact<BalanceOf>)#

  • interface: api.tx.identity.requestJudgement

  • summary: 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.

    • maybe_timepoint: If this is the first approval, then this must be None. If it isnot the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.

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

      Emits JudgementRequested if successful.

setAccountId(index: Compact<RegistrarIndex>, new: AccountId)#

  • interface: api.tx.identity.setAccountId

  • summary: 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.

    If there are enough, then dispatch the call.

setFee(index: Compact<RegistrarIndex>, fee: Compact<BalanceOf>)#

  • interface: api.tx.identity.setFee

  • summary: 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.

    • other_signatories: The accounts (other than the sender) who can approve thisdispatch. May not be empty.

setFields(index: Compact<RegistrarIndex>, fields: IdentityFields)#

  • interface: api.tx.identity.setFields

  • summary: 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.

    Result is equivalent to the dispatched result if threshold is exactly 1. Otherwise on success, result is Ok and the result from the interior call, if it was executed, may be found in the deposited MultisigExecuted event.

setIdentity(info: IdentityInfo)#

  • interface: api.tx.identity.setIdentity

  • summary: 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.

setSubs(subs: Vec<(AccountId,Data)>)#

  • interface: api.tx.identity.setSubs

  • summary: 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.

  • timepoint: The timepoint (block number and transaction index) of the first approvaltransaction for this dispatch.

  • call_hash: The hash of the call to be executed.

imOnline#

heartbeat(heartbeat: Heartbeat, _signature: Signature)#

  • interface: api.tx.imOnline.heartbeat
  • summary:

nft#

claim(index: AccountIndex)#

  • interface: api.tx.indices.claim

  • summary: Assign an previously unassigned index.

    Payment: Deposit is reserved from the sender account.

    The dispatch origin for this call must be Signed.

    • index: the index to be claimed. This must not be in use.

      Emits IndexAssigned if successful.

forceTransfer(new: AccountId, index: AccountIndex, freeze: bool)#

  • interface: api.tx.indices.forceTransfer

  • summary: Force an index to an account. This doesn't require a deposit. If the index is already held, then any deposit is reimbursed to its current owner.

    The dispatch origin for this call must be Root.

    • index: the index to be (re-)assigned.

    • new: the new owner of the index. This function is a no-op if it is equal to sender.

    • metadata: external metadata

      Emits IndexAssigned if successful.

free(index: AccountIndex)#

  • interface: api.tx.indices.free

  • summary: Free up an index owned by the sender.

    Payment: Any previous deposit placed for the index is unreserved in the sender account.

    The dispatch origin for this call must be Signed and the sender must own the index.

    • index: the index to be freed. This must be owned by the sender.

      Emits IndexFreed if successful.

freeze(index: AccountIndex)#

  • interface: api.tx.indices.freeze

  • summary: Freeze an index so it will always point to the sender account. This consumes the deposit.

    The dispatch origin for this call must be Signed and the signing account must have a non-frozen account index.

    • index: the index to be frozen in place.

      Emits IndexFrozen if successful.

transfer(new: AccountId, index: AccountIndex)#

  • interface: api.tx.indices.transfer

  • summary: Assign an index already owned by the sender to another account. The balance reservation is effectively transferred to the new account.

    The dispatch origin for this call must be Signed.

    • index: the index to be re-assigned. This must be owned by the sender.

    • new: the new owner of the index. This function is a no-op if it is equal to sender.

      Emits IndexAssigned if successful.

lottery#

buyTicket(call: Call)#

  • interface: api.tx.lottery.buyTicket

  • summary: Buy a ticket to enter the lottery.

    This extrinsic acts as a passthrough function for call. In all situations where call alone would succeed, this extrinsic should succeed.

    If call is successful, then we will attempt to purchase a ticket, which may fail silently. To detect success of a ticket purchase, you should listen for the TicketBought event.

    This extrinsic must be called by a signed origin.

setCalls(calls: Vec<Call>)#

  • interface: api.tx.lottery.setCalls

  • summary: Set calls in storage which can be used to purchase a lottery ticket.

    This function only matters if you use the ValidateCall implementation provided by this pallet, which uses storage to determine the valid calls.

    This extrinsic must be called by the Manager origin.

startLottery(price: BalanceOf, length: BlockNumber, delay: BlockNumber, repeat: bool)#

  • interface: api.tx.lottery.startLottery

  • summary: Start a lottery using the provided configuration.

    This extrinsic must be called by the ManagerOrigin.

    Parameters:

    • price: The cost of a single ticket.

    • length: How long the lottery should run for starting at the current block.

    • delay: How long after the lottery end we should wait before picking a winner.

    • repeat: If the lottery should repeat when completed.

stopRepeat()#

  • interface: api.tx.lottery.stopRepeat

  • summary: If a lottery is repeating, you can use this to stop the repeat. The lottery will continue to run to completion.

    This extrinsic must be called by the ManagerOrigin.

nomineesElection#

approveAsMulti(threshold: u16, other_signatories: Vec<AccountId>, maybe_timepoint: Option<Timepoint>, call_hash: [u8;32], max_weight: Weight)#

  • interface: api.tx.multisig.approveAsMulti

  • summary: Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

    Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

    The dispatch origin for this call must be Signed.

    • threshold: The total number of approvals for this dispatch before it is executed.

    • other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.

    • maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.

    Prime membership is passed from the origin account to new, if extant.

clearPrime()#

  • interface: api.tx.operatorMembershipAcala.clearPrime

  • summary: Remove the prime member if it exists.

    NOTE: If this is the final approval, you will want to use as_multi instead.

asMulti(threshold: u16, other_signatories: Vec<AccountId>, maybe_timepoint: Option<Timepoint>, call: OpaqueCall, store_call: bool, max_weight: Weight)#

  • interface: api.tx.multisig.asMulti

  • summary: Register approval for a dispatch to be made from a deterministic composite account if approved by a total of threshold - 1 of other_signatories.

    If there are enough, then dispatch the call.

    Payment: DepositBase will be reserved if this is the first approval, plus threshold times DepositFactor. It is returned once this dispatch happens or is cancelled.

    The dispatch origin for this call must be Signed.

    • threshold: The total number of approvals for this dispatch before it is executed.

    • other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.

    • maybe_timepoint: If this is the first approval, then this must be None. If it is not the first approval, then it must be Some, with the timepoint (block number and transaction index) of the first approval transaction.

operatorMembershipBand#

addMember(who: AccountId)#

  • interface: api.tx.operatorMembershipBand.addMember

  • summary: Add a member who to the set.

    NOTE: Unless this is the final approval, you will generally want to use approve_as_multi instead, since it only requires a hash of the call.

    Result is equivalent to the dispatched result if threshold is exactly 1. Otherwise on success, result is Ok and the result from the interior call, if it was executed, may be found in the deposited MultisigExecuted event.

asMultiThreshold1(other_signatories: Vec<AccountId>, call: Call)#

  • interface: api.tx.multisig.asMultiThreshold1

  • summary: Immediately dispatch a multi-signature call using a single approval from the caller.

    The dispatch origin for this call must be Signed.

    • other_signatories: The accounts (other than the sender) who are part of the multi-signature, but do not participate in the approval process.

    May only be called from T::ResetOrigin.

setPrime(who: AccountId)#

  • interface: api.tx.operatorMembershipBand.setPrime

  • summary: Set the prime member. Must be a current member.

    Result is equivalent to the dispatched result.

cancelAsMulti(threshold: u16, other_signatories: Vec<AccountId>, timepoint: Timepoint, call_hash: [u8;32])#

  • interface: api.tx.multisig.cancelAsMulti

  • summary: Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously for this operation will be unreserved on success.

    The dispatch origin for this call must be Signed.

    • threshold: The total number of approvals for this dispatch before it is executed.

    • other_signatories: The accounts (other than the sender) who can approve this dispatch. May not be empty.

    • timepoint: The timepoint (block number and transaction index) of the first approval transaction for this dispatch.

    • currency_id: currency type.

unlockPrice(currency_id: CurrencyId)#

  • interface: api.tx.prices.unlockPrice
  • summary: Unlock the price and get the price from PriceProvider again

proxy#

addProxy(delegate: AccountId, proxy_type: ProxyType, delay: BlockNumber)#

  • interface: api.tx.proxy.addProxy

  • summary: Register a proxy account for the sender that is able to make calls on its behalf.

    The dispatch origin for this call must be Signed.

    Parameters:

    • proxy: The account that the caller would like to make a proxy.

    • proxy_type: The permissions allowed for this proxy account.

    • delay: The announcement period required of the initial proxy. Will generally be zero.

announce(real: AccountId, call_hash: CallHashOf)#

  • interface: api.tx.proxy.announce

  • summary: Publish the hash of a proxy-call that will be made in the future.

    This must be called some number of blocks before the corresponding proxy is attempted if the delay associated with the proxy relationship is greater than zero.

    No more than MaxPending announcements may be made at any one time.

    This will take a deposit of AnnouncementDepositFactor as well as AnnouncementDepositBase if there are no other pending announcements.

    The dispatch origin for this call must be Signed and a proxy of real.

    Parameters:

    • real: The account that the proxy will make a call on behalf of.

    • call_hash: The hash of the call to be made by the real account.

anonymous(proxy_type: ProxyType, delay: BlockNumber, index: u16)#

  • interface: api.tx.proxy.anonymous

  • summary: Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and initialize it with a proxy of proxy_type for origin sender.

    Requires a Signed origin.

    • proxy_type: The type of the proxy that the sender will be registered as over the new account. This will almost always be the most permissive ProxyType possible to allow for maximum flexibility.

    • index: A disambiguation index, in case this is called multiple times in the same transaction (e.g. with utility::batch). Unless you're using batch you probably just want to use 0.

    • delay: The announcement period required of the initial proxy. Will generally be zero.

      Fails with Duplicate if this has already been called in this transaction, from the same sender, with the same parameters.

      Fails if there are insufficient funds to pay for deposit.

      TODO: Might be over counting 1 read

killAnonymous(spawner: AccountId, proxy_type: ProxyType, index: u16, height: Compact<BlockNumber>, ext_index: Compact<u32>)#

  • interface: api.tx.proxy.killAnonymous

  • summary: Removes a previously spawned anonymous proxy.

    WARNING: All access to this account will be lost. Any funds held in it will be inaccessible.

    Requires a Signed origin, and the sender account must have been created by a call to anonymous with corresponding parameters.

    • spawner: The account that originally called anonymous to create this account.

    • index: The disambiguation index originally passed to anonymous. Probably 0.

    • proxy_type: The proxy type originally passed to anonymous.

    • height: The height of the chain when the call to anonymous was processed.

    • ext_index: The extrinsic index in which the call to anonymous was processed.

      Fails with NoPermission in case the caller is not a previously created anonymous account whose anonymous call has corresponding parameters.

proxy(real: AccountId, force_proxy_type: Option<ProxyType>, call: Call)#

  • interface: api.tx.proxy.proxy

  • summary: Dispatch the given call from an account that the sender is authorised for through add_proxy.

    Removes any corresponding announcement(s).

    The dispatch origin for this call must be Signed.

    Parameters:

    • real: The account that the proxy will make a call on behalf of.

    • force_proxy_type: Specify the exact proxy type to be used and checked for this call.

    • call: The call to be made by the real account.

proxyAnnounced(delegate: AccountId, real: AccountId, force_proxy_type: Option<ProxyType>, call: Call)#

  • interface: api.tx.proxy.proxyAnnounced

  • summary: Dispatch the given call from an account that the sender is authorized for through add_proxy.

    Removes any corresponding announcement(s).

    The dispatch origin for this call must be Signed.

    Parameters:

    • real: The account that the proxy will make a call on behalf of.

    • force_proxy_type: Specify the exact proxy type to be used and checked for this call.

    • call: The call to be made by the real account.

rejectAnnouncement(delegate: AccountId, call_hash: CallHashOf)#

  • interface: api.tx.proxy.rejectAnnouncement

  • summary: Remove the given announcement of a delegate.

    May be called by a target (proxied) account to remove a call that one of their delegates (delegate) has announced they want to execute. The deposit is returned.

    The dispatch origin for this call must be Signed.

    Parameters:

    • delegate: The account that previously announced the call.

    • call_hash: The hash of the call to be made.

removeAnnouncement(real: AccountId, call_hash: CallHashOf)#

  • interface: api.tx.proxy.removeAnnouncement

  • summary: Remove a given announcement.

    May be called by a proxy account to remove a call they previously announced and return the deposit.

    The dispatch origin for this call must be Signed.

    Parameters:

    • real: The account that the proxy will make a call on behalf of.

    • call_hash: The hash of the call to be made by the real account.

removeProxies()#

  • interface: api.tx.proxy.removeProxies

  • summary: Unregister all proxy accounts for the sender.

    The dispatch origin for this call must be Signed.

    WARNING: This may be called on accounts created by anonymous, however if done, then the unreserved fees will be inaccessible. All access to this account will be lost.

removeProxy(delegate: AccountId, proxy_type: ProxyType, delay: BlockNumber)#

  • interface: api.tx.proxy.removeProxy

  • summary: Unregister a proxy account for the sender.

    The dispatch origin for this call must be Signed.

    Parameters:

    • proxy: The account that the caller would like to remove as a proxy.

    • proxy_type: The permissions currently enabled for the removed proxy account.

recovery#

asRecovered(account: AccountId, call: Call)#

  • interface: api.tx.recovery.asRecovered

  • summary: Send a call through a recovered account.

    The dispatch origin for this call must be Signed and registered to be able to make calls on behalf of the recovered account.

    Parameters:

    • account: The recovered account you want to make a call on-behalf-of.

    • call: The call you want to make with the recovered account.

cancelRecovered(account: AccountId)#

  • interface: api.tx.recovery.cancelRecovered

  • summary: Cancel the ability to use as_recovered for account.

    The dispatch origin for this call must be Signed and registered to be able to make calls on behalf of the recovered account.

    Parameters:

    • account: The recovered account you are able to call on-behalf-of.

claimRecovery(account: AccountId)#

  • interface: api.tx.recovery.claimRecovery

  • summary: Allow a successful rescuer to claim their recovered account.

    The dispatch origin for this call must be Signed and must be a "rescuer" who has successfully completed the account recovery process: collected threshold or more vouches, waited delay_period blocks since initiation.

    Parameters:

    • account: The lost account that you want to claim has been successfully recovered by you.

closeRecovery(rescuer: AccountId)#

  • interface: api.tx.recovery.closeRecovery

  • summary: As the controller of a recoverable account, close an active recovery process for your account.

    Payment: By calling this function, the recoverable account will receive the recovery deposit RecoveryDeposit placed by the rescuer.

    The dispatch origin for this call must be Signed and must be a recoverable account with an active recovery process for it.

    Parameters:

    • rescuer: The account trying to rescue this recoverable account.

createRecovery(friends: Vec<AccountId>, threshold: u16, delay_period: BlockNumber)#

  • interface: api.tx.recovery.createRecovery

  • summary: Create a recovery configuration for your account. This makes your account recoverable.

    Payment: ConfigDepositBase + FriendDepositFactor * #_of_friends balance will be reserved for storing the recovery configuration. This deposit is returned in full when the user calls remove_recovery.

    The dispatch origin for this call must be Signed.

    Parameters:

    • friends: A list of friends you trust to vouch for recovery attempts. Should be ordered and contain no duplicate values.

    • threshold: The number of friends that must vouch for a recovery attempt before the account can be recovered. Should be less than or equal to the length of the list of friends.

    • delay_period: The number of blocks after a recovery attempt is initialized that needs to pass before the account can be recovered.

initiateRecovery(account: AccountId)#

  • interface: api.tx.recovery.initiateRecovery

  • summary: Initiate the process for recovering a recoverable account.

    Payment: RecoveryDeposit balance will be reserved for initiating the recovery process. This deposit will always be repatriated to the account trying to be recovered. See close_recovery.

    The dispatch origin for this call must be Signed.

    Parameters:

    • account: The lost account that you want to recover. This account needs to be recoverable (i.e. have a recovery configuration).

removeRecovery()#

  • interface: api.tx.recovery.removeRecovery

  • summary: Remove the recovery process for your account. Recovered accounts are still accessible.

    NOTE: The user must make sure to call close_recovery on all active recovery attempts before calling this function else it will fail.

    Payment: By calling this function the recoverable account will unreserve their recovery configuration deposit. (ConfigDepositBase + FriendDepositFactor * #_of_friends)

    The dispatch origin for this call must be Signed and must be a recoverable account (i.e. has a recovery configuration).

setRecovered(lost: AccountId, rescuer: AccountId)#

  • interface: api.tx.recovery.setRecovered

  • summary: Allow ROOT to bypass the recovery process and set an a rescuer account for a lost account directly.

    The dispatch origin for this call must be ROOT.

    Parameters:

    • lost: The "lost account" to be recovered.

    • rescuer: The "rescuer account" which can call as the lost account.

vouchRecovery(lost: AccountId, rescuer: AccountId)#

  • interface: api.tx.recovery.vouchRecovery

  • summary: Allow a "friend" of a recoverable account to vouch for an active recovery process for that account.

    The dispatch origin for this call must be Signed and must be a "friend" for the recoverable account.

    Parameters:

    • lost: The lost account that you want to recover.

    • rescuer: The account trying to rescue the lost account that you want to vouch for.

      The combination of these two parameters must point to an active recovery process.

scheduler#

cancel(when: BlockNumber, index: u32)#

  • interface: api.tx.scheduler.cancel
  • summary: Cancel an anonymously scheduled task.

cancelNamed(id: Bytes)#

  • interface: api.tx.scheduler.cancelNamed
  • summary: Cancel a named scheduled task.

schedule(when: BlockNumber, maybe_periodic: Option<Period>, priority: Priority, call: Call)#

  • interface: api.tx.scheduler.schedule
  • summary: Anonymously schedule a task.

scheduleAfter(after: BlockNumber, maybe_periodic: Option<Period>, priority: Priority, call: Call)#

  • interface: api.tx.scheduler.scheduleAfter
  • summary: Anonymously schedule a task after a delay.

scheduleNamed(id: Bytes, when: BlockNumber, maybe_periodic: Option<Period>, priority: Priority, call: Call)#

  • interface: api.tx.scheduler.scheduleNamed
  • summary: Schedule a named task.

scheduleNamedAfter(id: Bytes, after: BlockNumber, maybe_periodic: Option<Period>, priority: Priority, call: Call)#

  • interface: api.tx.scheduler.scheduleNamedAfter
  • summary: Schedule a named task after a delay.

session#

purgeKeys()#

  • interface: api.tx.session.purgeKeys

  • summary: Removes any session key(s) of the function caller. This doesn't take effect until the next session.

    The dispatch origin of this function must be signed.

setKeys(keys: Keys, proof: Bytes)#

  • interface: api.tx.session.setKeys

  • summary: Sets the session key(s) of the function caller to keys. Allows an account to set its session key prior to becoming a validator. This doesn't take effect until the next session.

    The dispatch origin of this function must be signed.

society#

bid(value: BalanceOf)#

  • interface: api.tx.society.bid

  • summary: A user outside of the society can make a bid for entry.

    Payment: CandidateDeposit will be reserved for making a bid. It is returned when the bid becomes a member, or if the bid calls unbid.

    The dispatch origin for this call must be Signed.

    Parameters:

    • value: A one time payment the bid would like to receive when joining the society.

defenderVote(approve: bool)#

  • interface: api.tx.society.defenderVote

  • summary: As a member, vote on the defender.

    The dispatch origin for this call must be Signed and a member.

    Parameters:

    • approve: A boolean which says if the candidate should be approved (true) or rejected (false).

found(founder: AccountId, max_members: u32, rules: Bytes)#

  • interface: api.tx.society.found

  • summary: Found the society.

    This is done as a discrete action in order to allow for the module to be included into a running chain and can only be done once.

    The dispatch origin for this call must be from the FounderSetOrigin.

    Parameters:

    • founder - The first member and head of the newly founded society.

    • max_members - The initial max number of members for the society.

    • rules - The rules of this society concerning membership.

judgeSuspendedCandidate(who: AccountId, judgement: SocietyJudgement)#

  • interface: api.tx.society.judgeSuspendedCandidate

  • summary: Allow suspended judgement origin to make judgement on a suspended candidate.

    If the judgement is Approve, we add them to society as a member with the appropriate payment for joining society.

    If the judgement is Reject, we either slash the deposit of the bid, giving it back to the society treasury, or we ban the voucher from vouching again.

    If the judgement is Rebid, we put the candidate back in the bid pool and let them go through the induction process again.

    The dispatch origin for this call must be from the SuspensionJudgementOrigin.

    Parameters:

    • who - The suspended candidate to be judged.

    • judgement - Approve, Reject, or Rebid.

judgeSuspendedMember(who: AccountId, forgive: bool)#

  • interface: api.tx.society.judgeSuspendedMember

  • summary: Allow suspension judgement origin to make judgement on a suspended member.

    If a suspended member is forgiven, we simply add them back as a member, not affecting any of the existing storage items for that member.

    If a suspended member is rejected, remove all associated storage items, including their payouts, and remove any vouched bids they currently have.

    The dispatch origin for this call must be from the SuspensionJudgementOrigin.

    Parameters:

    • who - The suspended member to be judged.

    • forgive - A boolean representing whether the suspension judgement origin forgives (true) or rejects (false) a suspended member.

payout()#

  • interface: api.tx.society.payout

  • summary: Transfer the first matured payout for the sender and remove it from the records.

    NOTE: This extrinsic needs to be called multiple times to claim multiple matured payouts.

    Payment: The member will receive a payment equal to their first matured payout to their free balance.

    The dispatch origin for this call must be Signed and a member with payouts remaining.

setMaxMembers(max: u32)#

  • interface: api.tx.society.setMaxMembers

  • summary: Allows root origin to change the maximum number of members in society. Max membership count must be greater than 1.

    The dispatch origin for this call must be from ROOT.

    Parameters:

    • max - The maximum number of members for the society.

unbid(pos: u32)#

  • interface: api.tx.society.unbid

  • summary: A bidder can remove their bid for entry into society. By doing so, they will have their candidate deposit returned or they will unvouch their voucher.

    Payment: The bid deposit is unreserved if the user made a bid.

    The dispatch origin for this call must be Signed and a bidder.

    Parameters:

    • pos: Position in the Bids vector of the bid who wants to unbid.

unfound()#

  • interface: api.tx.society.unfound

  • summary: Annul the founding of the society.

    The dispatch origin for this call must be Signed, and the signing account must be both the Founder and the Head. This implies that it may only be done when there is one member.

unvouch(pos: u32)#

  • interface: api.tx.society.unvouch

  • summary: As a vouching member, unvouch a bid. This only works while vouched user is only a bidder (and not a candidate).

    The dispatch origin for this call must be Signed and a vouching member.

    Parameters:

    • pos: Position in the Bids vector of the bid who should be unvouched.

vote(candidate: LookupSource, approve: bool)#

  • interface: api.tx.society.vote

  • summary: As a member, vote on a candidate.

    The dispatch origin for this call must be Signed and a member.

    Parameters:

    • candidate: The candidate that the member would like to bid on.

    • approve: A boolean which says if the candidate should be approved (true) or rejected (false).

vouch(who: AccountId, value: BalanceOf, tip: BalanceOf)#

  • interface: api.tx.society.vouch

  • summary: As a member, vouch for someone to join society by placing a bid on their behalf.

    There is no deposit required to vouch for a new bid, but a member can only vouch for one bid at a time. If the bid becomes a suspended candidate and ultimately rejected by the suspension judgement origin, the member will be banned from vouching again.

    As a vouching member, you can claim a tip if the candidate is accepted. This tip will be paid as a portion of the reward the member will receive for joining the society.

    The dispatch origin for this call must be Signed and a member.

    Parameters:

    The dispatch origin of this function must be signed.

    • value: The total reward to be paid between you and the candidate if they become a member in the society.

    • tip: Your cut of the total value payout when the candidate is inducted into the society. Tips larger than value will be saturated upon payout.

staking#

bond(controller: LookupSource, value: Compact<BalanceOf>, payee: RewardDestination)#

  • interface: api.tx.staking.bond

  • summary: Take the origin account as a stash and lock up value of its balance. controller will be the account that controls it.

    value must be more than the minimum_balance specified by T::Currency.

    The dispatch origin for this call must be Signed by the stash account.

    Emits Bonded.

bondExtra(max_additional: Compact<BalanceOf>)#

  • interface: api.tx.staking.bondExtra

  • summary: Add some extra amount that have appeared in the stash free_balance into the balance up for staking.

    Use this if there are additional funds in your stash account that you wish to bond. Unlike [bond] or [unbond] this function does not impose any limitation on the amount that can be added.

    The dispatch origin for this call must be Signed by the stash, not the controller and it can be only called when [EraElectionStatus] is Closed.

    Emits Bonded.

cancelDeferredSlash(era: EraIndex, slash_indices: Vec<u32>)#

  • interface: api.tx.staking.cancelDeferredSlash

  • summary: Cancel enactment of a deferred slash.

    Can be called by the T::SlashCancelOrigin.

    Parameters: era and indices of the slashes for that era to kill.

chill()#

  • interface: api.tx.staking.chill

  • summary: Declare no desire to either validate or nominate.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed.

chillOther(controller: AccountId)#

  • interface: api.tx.staking.chillOther

  • summary: Declare a controller as having no desire to either validator or nominate.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed, but can be called by anyone.

    If the caller is the same as the controller being targeted, then no further checks are enforced. However, this call can also be made by an third party user who witnesses that this controller does not satisfy the minimum bond requirements to be in their role.

    This can be helpful if bond requirements are updated, and we need to remove old users who do not satisfy these requirements.

forceNewEra()#

  • interface: api.tx.staking.forceNewEra

  • summary: Force there to be a new era at the end of the next session. After this, it will be reset to normal (non-forced) behaviour.

    The dispatch origin must be Root.

    Warning#

    The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

forceNewEraAlways()#

  • interface: api.tx.staking.forceNewEraAlways

  • summary: Force there to be a new era at the end of sessions indefinitely.

    The dispatch origin must be Root.

    Warning#

    The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

forceNoEras()#

  • interface: api.tx.staking.forceNoEras

  • summary: Force there to be no new eras indefinitely.

    The dispatch origin must be Root.

    Warning#

    The election process starts multiple blocks before the end of the era. Thus the election process may be ongoing when this is called. In this case the election will continue until the next era is triggered.

forceUnstake(stash: AccountId, num_slashing_spans: u32)#

  • interface: api.tx.staking.forceUnstake

  • summary: Force a current staker to become completely unstaked, immediately.

    The dispatch origin must be Root.

increaseValidatorCount(additional: Compact<u32>)#

  • interface: api.tx.staking.increaseValidatorCount

  • summary: Increments the ideal number of validators.

    The dispatch origin must be Root.

kick(who: Vec<LookupSource>)#

  • interface: api.tx.staking.kick

  • summary: Remove the given nominations from the calling validator.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed. The controller account should represent a validator.

    • who: A list of nominator stash accounts who are nominating this validator which should no longer be nominating this validator.

      Note: Making this call only makes sense if you first set the validator preferences to block any further nominations.

nominate(targets: Vec<LookupSource>)#

  • interface: api.tx.staking.nominate

  • summary: Declare the desire to nominate targets for the origin controller.

    Effects will be felt at the beginning of the next era. This can only be called when [EraElectionStatus] is Closed.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed.

payoutStakers(validator_stash: AccountId, era: EraIndex)#

  • interface: api.tx.staking.payoutStakers

  • summary: Pay out all the stakers behind a single validator for a single era.

    • validator_stash is the stash account of the validator. Their nominators, up to T::MaxNominatorRewardedPerValidator, will also receive their rewards.

    • era may be any era between [current_era - history_depth; current_era].

      The origin of this call must be Signed. Any account can call this function, even if it is not one of the stakers.

      This can only be called when [EraElectionStatus] is Closed.

reapStash(stash: AccountId, num_slashing_spans: u32)#

  • interface: api.tx.staking.reapStash

  • summary: Remove all data structure concerning a staker/stash once its balance is at the minimum. This is essentially equivalent to withdraw_unbonded except it can be called by anyone and the target stash must have no funds left beyond the ED.

    This can be called from any origin.

    • stash: The stash account to reap. Its balance must be zero.

rebond(value: Compact<BalanceOf>)#

  • interface: api.tx.staking.rebond

  • summary: Rebond a portion of the stash scheduled to be unlocked.

    The dispatch origin must be signed by the controller, and it can be only called when [EraElectionStatus] is Closed.

scaleValidatorCount(factor: Percent)#

  • interface: api.tx.staking.scaleValidatorCount

  • summary: Scale up the ideal number of validators by a factor.

    The dispatch origin must be Root.

setController(controller: LookupSource)#

  • interface: api.tx.staking.setController

  • summary: (Re-)set the controller of a stash.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed by the stash, not the controller.

setHistoryDepth(new_history_depth: Compact<EraIndex>, _era_items_deleted: Compact<u32>)#

  • interface: api.tx.staking.setHistoryDepth

  • summary: Set HistoryDepth value. This function will delete any history information when HistoryDepth is reduced.

    Parameters:

    • new_history_depth: The new history depth you would like to set.

    • era_items_deleted: The number of items that will be deleted by this dispatch. This should report all the storage items that will be deleted by clearing old era history. Needed to report an accurate weight for the dispatch. Trusted by Root to report an accurate number.

      Origin must be root.

setInvulnerables(invulnerables: Vec<AccountId>)#

  • interface: api.tx.staking.setInvulnerables

  • summary: Set the validators who cannot be slashed (if any).

    The dispatch origin must be Root.

setPayee(payee: RewardDestination)#

  • interface: api.tx.staking.setPayee

  • summary: (Re-)set the payment target for a controller.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed by the controller, not the stash.

setValidatorCount(new: Compact<u32>)#

  • interface: api.tx.staking.setValidatorCount

  • summary: Sets the ideal number of validators.

    The dispatch origin must be Root.

unbond(value: Compact<BalanceOf>)#

  • interface: api.tx.staking.unbond

  • summary: Schedule a portion of the stash to be unlocked ready for transfer out after the bond period ends. If this leaves an amount actively bonded less than T::Currency::minimum_balance(), then it is increased to the full amount.

    Once the unlock period is done, you can call withdraw_unbonded to actually move the funds out of management ready for transfer.

    No more than a limited number of unlocking chunks (see MAX_UNLOCKING_CHUNKS) can co-exists at the same time. In that case, [Call::withdraw_unbonded] need to be called first to remove some of the chunks (if possible).

    If a user encounters the InsufficientBond error when calling this extrinsic, they should call chill first in order to free up their bonded funds.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed.

    Emits Unbonded.

    See also [Call::withdraw_unbonded].

updateStakingLimits(min_nominator_bond: BalanceOf, min_validator_bond: BalanceOf, max_nominator_count: Option<u32>, max_validator_count: Option<u32>)#

  • interface: api.tx.staking.updateStakingLimits

  • summary: Update the various staking limits this pallet.

    • min_nominator_bond: The minimum active bond needed to be a nominator.

    • min_validator_bond: The minimum active bond needed to be a validator.

    • max_nominator_count: The max number of users who can be a nominator at once. When set to None, no limit is enforced.

    • max_validator_count: The max number of users who can be a validator at once. When set to None, no limit is enforced.

      Origin must be Root to call this function.

      NOTE: Existing nominators and validators will not be affected by this update. to kick people under the new limits, chill_other should be called.

validate(prefs: ValidatorPrefs)#

  • interface: api.tx.staking.validate

  • summary: Declare the desire to validate for the origin controller.

    Effects will be felt at the beginning of the next era.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed.

withdrawUnbonded(num_slashing_spans: u32)#

  • interface: api.tx.staking.withdrawUnbonded

  • summary: Remove any unlocked chunks from the unlocking queue from our management.

    This essentially frees up that balance to be used by the stash account to do whatever it wants.

    The dispatch origin for this call must be Signed by the controller, not the stash. And, it can be only called when [EraElectionStatus] is Closed.

    Emits Withdrawn.

    See also [Call::unbond].

stakingPool#

setStakingPoolParams(target_max_free_unbonded_ratio: ChangeRatio, target_min_free_unbonded_ratio: ChangeRatio, target_unbonding_to_free_ratio: ChangeRatio, unbonding_to_free_adjustment: ChangeRate, base_fee_rate: ChangeRate)#

  • interface: api.tx.stakingPool.setStakingPoolParams

  • summary: Update params related to staking pool

    The dispatch origin of this call must be UpdateOrigin.

sudo#

setKey(new: LookupSource)#

  • interface: api.tx.sudo.setKey

  • summary: Authenticates the current sudo key and sets the given AccountId (new) as the new sudo key.

    The dispatch origin for this call must be Signed.

sudo(call: Call)#

  • interface: api.tx.sudo.sudo

  • summary: Authenticates the sudo key and dispatches a function call with Root origin.

    The dispatch origin for this call must be Signed.

sudoAs(who: LookupSource, call: Call)#

  • interface: api.tx.sudo.sudoAs

  • summary: Authenticates the sudo key and dispatches a function call with Signed origin from a given account.

    The dispatch origin for this call must be Signed.

sudoUncheckedWeight(call: Call, _weight: Weight)#

  • interface: api.tx.sudo.sudoUncheckedWeight

  • summary: Authenticates the sudo key and dispatches a function call with Root origin. This function does not check the weight of the call, and instead allows the Sudo user to specify the weight of the call.

    The dispatch origin for this call must be Signed.

system#

fillBlock(_ratio: Perbill)#

  • interface: api.tx.system.fillBlock
  • summary: A dispatch that will fill the block weight up to the given ratio.

killPrefix(prefix: Key, _subkeys: u32)#

  • interface: api.tx.system.killPrefix

  • summary: Kill all storage items with a key that starts with the given prefix.

    NOTE: We rely on the Root origin to provide us the number of subkeys under the prefix we are removing to accurately calculate the weight of this function.

killStorage(keys: Vec<Key>)#

  • interface: api.tx.system.killStorage
  • summary: Kill some items from storage.

remark(_remark: Bytes)#

  • interface: api.tx.system.remark
  • summary: Make some on-chain remark.

remarkWithEvent(remark: Bytes)#

  • interface: api.tx.system.remarkWithEvent
  • summary: Make some on-chain remark and emit event.

setChangesTrieConfig(changes_trie_config: Option<ChangesTrieConfiguration>)#

  • interface: api.tx.system.setChangesTrieConfig
  • summary: Set the new changes trie configuration.

setCode(code: Bytes)#

  • interface: api.tx.system.setCode
  • summary: Set the new runtime code.

setCodeWithoutChecks(code: Bytes)#

  • interface: api.tx.system.setCodeWithoutChecks
  • summary: Set the new runtime code without doing any checks of the given code.

setHeapPages(pages: u64)#

  • interface: api.tx.system.setHeapPages
  • summary: Set the number of pages in the WebAssembly environment's heap.

setStorage(items: Vec<KeyValue>)#

  • interface: api.tx.system.setStorage
  • summary: Set some items of storage.

technicalCommittee#

close(proposal_hash: Hash, index: Compact<ProposalIndex>, proposal_weight_bound: Compact<Weight>, length_bound: Compact<u32>)#

  • interface: api.tx.technicalCommittee.close

  • summary: Close a vote that is either approved, disapproved or whose voting period has ended.

    May be called by any signed account in order to finish voting and close the proposal.

    If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.

    If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

    If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.

    • proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal. + length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

disapproveProposal(proposal_hash: Hash)#

  • interface: api.tx.technicalCommittee.disapproveProposal

  • summary: Disapprove a proposal, close, and remove it from the system, regardless of its current state.

    Must be called by the Root origin.

    Parameters:

    • proposal_hash: The hash of the proposal that should be disapproved.

execute(proposal: Proposal, length_bound: Compact<u32>)#

  • interface: api.tx.technicalCommittee.execute

  • summary: Dispatch a proposal from a member using the Member origin.

    Origin must be a member of the collective.

propose(threshold: Compact<MemberCount>, proposal: Proposal, length_bound: Compact<u32>)#

  • interface: api.tx.technicalCommittee.propose

  • summary: Add a new proposal to either be voted on or executed directly.

    Requires the sender to be member.

    threshold determines whether proposal is executed directly (threshold < 2) or put up for voting.

setMembers(new_members: Vec<AccountId>, prime: Option<AccountId>, old_count: MemberCount)#

  • interface: api.tx.technicalCommittee.setMembers

  • summary: Set the collective's membership.

    • new_members: The new member list. Be nice to the chain and provide it sorted.

    • prime: The prime member whose vote sets the default.

    • old_count: The upper bound for the previous number of members in storage. Used for weight estimation.

      Requires root origin.

      NOTE: Does not enforce the expected MaxMembers limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.

vote(proposal: Hash, index: Compact<ProposalIndex>, approve: bool)#

  • interface: api.tx.technicalCommittee.vote

  • summary: Add an aye or nay vote for the sender to the given proposal.

    Requires the sender to be a member.

    Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.

technicalCommitteeMembership#

addMember(who: AccountId)#

  • interface: api.tx.technicalMembership.addMember

  • summary: Add a member who to the set.

    May only be called from T::AddOrigin.

changeKey(new: AccountId)#

  • interface: api.tx.technicalMembership.changeKey

  • summary: Swap out the sending member for some other key new.

    May only be called from Signed origin of a current member.

    Prime membership is passed from the origin account to new, if extant.

clearPrime()#

  • interface: api.tx.technicalMembership.clearPrime

  • summary: Remove the prime member if it exists.

    May only be called from T::PrimeOrigin.

removeMember(who: AccountId)#

  • interface: api.tx.technicalMembership.removeMember

  • summary: Remove a member who from the set.

    May only be called from T::RemoveOrigin.

resetMembers(members: Vec<AccountId>)#

  • interface: api.tx.technicalMembership.resetMembers

  • summary: Change the membership to a new set, disregarding the existing membership. Be nice and pass members pre-sorted.

    May only be called from T::ResetOrigin.

setPrime(who: AccountId)#

  • interface: api.tx.technicalMembership.setPrime

  • summary: Set the prime member. Must be a current member.

    May only be called from T::PrimeOrigin.

swapMember(remove: AccountId, add: AccountId)#

  • interface: api.tx.technicalMembership.swapMember

  • summary: Swap out one member remove for another add.

    May only be called from T::SwapOrigin.

    Prime membership is not passed from remove to add, if extant.

timestamp#

set(now: Compact<Moment>)#

  • interface: api.tx.timestamp.set

  • summary: Set the current time.

    This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time.

    The timestamp should be greater than the previous one by the amount specified by MinimumPeriod.

    The dispatch origin for this call must be Inherent.

tips#

closeTip(hash: Hash)#

  • interface: api.tx.tips.closeTip

  • summary: Close and payout a tip.

    The dispatch origin for this call must be Signed.

    The tip identified by hash must have finished its countdown period.

    • hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the original tip reason and the beneficiary account ID.

reportAwesome(reason: Bytes, who: AccountId)#

  • interface: api.tx.tips.reportAwesome

  • summary: Report something reason that deserves a tip and claim any eventual the finder's fee.

    The dispatch origin for this call must be Signed.

    Payment: TipReportDepositBase will be reserved from the origin account, as well as DataDepositPerByte for each byte in reason.

    • reason: The reason for, or the thing that deserves, the tip; generally this will be a UTF-8-encoded URL.

    • who: The account which should be credited for the tip.

      Emits NewTip if successful.

retractTip(hash: Hash)#

  • interface: api.tx.tips.retractTip

  • summary: Retract a prior tip-report from report_awesome, and cancel the process of tipping.

    If successful, the original deposit will be unreserved.

    The dispatch origin for this call must be Signed and the tip identified by hash must have been reported by the signing account through report_awesome (and not through tip_new).

    • hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the original tip reason and the beneficiary account ID.

      Emits TipRetracted if successful.

slashTip(hash: Hash)#

  • interface: api.tx.tips.slashTip

  • summary: Remove and slash an already-open tip.

    May only be called from T::RejectOrigin.

    As a result, the finder is slashed and the deposits are lost.

    Emits TipSlashed if successful.

tip(hash: Hash, tip_value: Compact<BalanceOf>)#

  • interface: api.tx.tips.tip

  • summary: Declare a tip value for an already-open tip.

    The dispatch origin for this call must be Signed and the signing account must be a member of the Tippers set.

    • hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the hash of the original tip reason and the beneficiary account ID.

    • tip_value: The amount of tip that the sender would like to give. The median tip value of active tippers will be given to the who.

      Emits TipClosing if the threshold of tippers has been reached and the countdown period has started.

tipNew(reason: Bytes, who: AccountId, tip_value: Compact<BalanceOf>)#

  • interface: api.tx.tips.tipNew

  • summary: Give a tip for something new; no finder's fee will be taken.

    The dispatch origin for this call must be Signed and the signing account must be a member of the Tippers set.

    • reason: The reason for, or the thing that deserves, the tip; generally this will be a UTF-8-encoded URL.

    • who: The account which should be credited for the tip.

    • tip_value: The amount of tip that the sender would like to give. The median tip value of active tippers will be given to the who.

      Emits NewTip if successful.

transactionStorage#

checkProof(proof: TransactionStorageProof)#

  • interface: api.tx.transactionStorage.checkProof
  • summary: Check storage proof for block number block_number() - StoragePeriod. If such block does not exist the proof is expected to be None.

renew(block: BlockNumber, index: u32)#

  • interface: api.tx.transactionStorage.renew
  • summary: Renew previously stored data. Parameters are the block number that contains previous store or renew call and transaction index within that block. Transaction index is emitted in the Stored or Renewed event. Applies same fees as store.

store(data: Bytes)#

  • interface: api.tx.transactionStorage.store
  • summary: Index and store data on chain. Minimum data size is 1 bytes, maximum is MaxTransactionSize. Data will be removed after STORAGE_PERIOD blocks, unless renew is called.

treasury#

approveProposal(proposal_id: Compact<ProposalIndex>)#

  • interface: api.tx.treasury.approveProposal

  • summary: Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.

    May only be called from T::ApproveOrigin.

proposeSpend(value: Compact<BalanceOf>, beneficiary: LookupSource)#

  • interface: api.tx.treasury.proposeSpend
  • summary: Put forward a suggestion for spending. A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.

rejectProposal(proposal_id: Compact<ProposalIndex>)#

  • interface: api.tx.treasury.rejectProposal

  • summary: Reject a proposed spend. The original deposit will be slashed.

    May only be called from T::RejectOrigin.

uniques#

approveTransfer(class: Compact<ClassId>, instance: Compact<InstanceId>, delegate: LookupSource)#

  • interface: api.tx.uniques.approveTransfer

  • summary: Approve an instance to be transferred by a delegated third-party account.

    Origin must be Signed and must be the owner of the asset instance.

    • class: The class of the asset to be approved for delegated transfer.

    • instance: The instance of the asset to be approved for delegated transfer.

    • delegate: The account to delegate permission to transfer the asset.

      Emits ApprovedTransfer on success.

      Weight: O(1)

burn(class: Compact<ClassId>, instance: Compact<InstanceId>, check_owner: Option<LookupSource>)#

  • interface: api.tx.uniques.burn

  • summary: Destroy a single asset instance.

    Origin must be Signed and the sender should be the Admin of the asset class.

    • class: The class of the asset to be burned.

    • instance: The instance of the asset to be burned.

    • check_owner: If Some then the operation will fail with WrongOwner unless the asset is owned by this value.

      Emits Burned with the actual amount burned.

      Weight: O(1) Modes: check_owner.is_some().

cancelApproval(class: Compact<ClassId>, instance: Compact<InstanceId>, maybe_check_delegate: Option<LookupSource>)#

  • interface: api.tx.uniques.cancelApproval

  • summary: Cancel the prior approval for the transfer of an asset by a delegate.

    Origin must be either:

    • the Force origin;

    • Signed with the signer being the Admin of the asset class;

    • Signed with the signer being the Owner of the asset instance;

      Arguments:

    • class: The class of the asset of whose approval will be cancelled.

    • instance: The instance of the asset of whose approval will be cancelled.

    • maybe_check_delegate: If Some will ensure that the given account is the one to which permission of transfer is delegated.

      Emits ApprovalCancelled on success.

      Weight: O(1)

clearAttribute(class: Compact<ClassId>, maybe_instance: Option<InstanceId>, key: Bytes)#

  • interface: api.tx.uniques.clearAttribute

  • summary: Set an attribute for an asset class or instance.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset class.

    If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * (key.len + value.len) taking into account any already reserved funds.

    • class: The identifier of the asset class whose instance's metadata to set.

    • instance: The identifier of the asset instance whose metadata to set.

    • key: The key of the attribute.

    • value: The value to which to set the attribute.

      Emits AttributeSet.

      Weight: O(1)

clearClassMetadata(class: Compact<ClassId>)#

  • interface: api.tx.uniques.clearClassMetadata

  • summary: Clear the metadata for an asset class.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset class.

    Any deposit is freed for the asset class owner.

    • class: The identifier of the asset class whose metadata to clear.

      Emits ClassMetadataCleared.

      Weight: O(1)

clearMetadata(class: Compact<ClassId>, instance: Compact<InstanceId>)#

  • interface: api.tx.uniques.clearMetadata

  • summary: Clear the metadata for an asset instance.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset instance.

    Any deposit is freed for the asset class owner.

    • class: The identifier of the asset class whose instance's metadata to clear.

    • instance: The identifier of the asset instance whose metadata to clear.

      Emits MetadataCleared.

      Weight: O(1)

create(class: Compact<ClassId>, admin: LookupSource)#

  • interface: api.tx.uniques.create

  • summary: Issue a new class of non-fungible assets from a public origin.

    This new asset class has no assets initially and its owner is the origin.

    The origin must be Signed and the sender must have sufficient funds free.

    AssetDeposit funds of sender are reserved.

    Parameters:

    • class: The identifier of the new asset class. This must not be currently in use.

    • admin: The admin of this class of assets. The admin is the initial address of each member of the asset class's admin team.

      Emits Created event when successful.

      Weight: O(1)

destroy(class: Compact<ClassId>, witness: DestroyWitness)#

  • interface: api.tx.uniques.destroy

  • summary: Destroy a class of fungible assets.

    The origin must conform to ForceOrigin or must be Signed and the sender must be the owner of the asset class.

    • class: The identifier of the asset class to be destroyed.

    • witness: Information on the instances minted in the asset class. This must be correct.

      Emits Destroyed event when successful.

      Weight: O(n + m) where:

    • n = witness.instances

    • m = witness.instance_metdadatas

    • a = witness.attributes

forceAssetStatus(class: Compact<ClassId>, owner: LookupSource, issuer: LookupSource, admin: LookupSource, freezer: LookupSource, free_holding: bool, is_frozen: bool)#

  • interface: api.tx.uniques.forceAssetStatus

  • summary: Alter the attributes of a given asset.

    Origin must be ForceOrigin.

    • class: The identifier of the asset.

    • owner: The new Owner of this asset.

    • issuer: The new Issuer of this asset.

    • admin: The new Admin of this asset.

    • freezer: The new Freezer of this asset.

    • free_holding: Whether a deposit is taken for holding an instance of this asset class.

    • is_frozen: Whether this asset class is frozen except for permissioned/admin instructions.

      Emits AssetStatusChanged with the identity of the asset.

      Weight: O(1)

forceCreate(class: Compact<ClassId>, owner: LookupSource, free_holding: bool)#

  • interface: api.tx.uniques.forceCreate

  • summary: Issue a new class of non-fungible assets from a privileged origin.

    This new asset class has no assets initially.

    The origin must conform to ForceOrigin.

    Unlike create, no funds are reserved.

    • class: The identifier of the new asset. This must not be currently in use.

    • owner: The owner of this class of assets. The owner has full superuser permissions over this asset, but may later change and configure the permissions using transfer_ownership and set_team.

      Emits ForceCreated event when successful.

      Weight: O(1)

freeze(class: Compact<ClassId>, instance: Compact<InstanceId>)#

  • interface: api.tx.uniques.freeze

  • summary: Disallow further unprivileged transfer of an asset instance.

    Origin must be Signed and the sender should be the Freezer of the asset class.

    • class: The class of the asset to be frozen.

    • instance: The instance of the asset to be frozen.

      Emits Frozen.

      Weight: O(1)

freezeClass(class: Compact<ClassId>)#

  • interface: api.tx.uniques.freezeClass

  • summary: Disallow further unprivileged transfers for a whole asset class.

    Origin must be Signed and the sender should be the Freezer of the asset class.

    • class: The asset class to be frozen.

      Emits ClassFrozen.

      Weight: O(1)

mint(class: Compact<ClassId>, instance: Compact<InstanceId>, owner: LookupSource)#

  • interface: api.tx.uniques.mint

  • summary: Mint an asset instance of a particular class.

    The origin must be Signed and the sender must be the Issuer of the asset class.

    • class: The class of the asset to be minted.

    • instance: The instance value of the asset to be minted.

    • beneficiary: The initial owner of the minted asset.

      Emits Issued event when successful.

      Weight: O(1)

redeposit(class: Compact<ClassId>, instances: Vec<InstanceId>)#

  • interface: api.tx.uniques.redeposit

  • summary: Reevaluate the deposits on some assets.

    Origin must be Signed and the sender should be the Owner of the asset class.

    • class: The class of the asset to be frozen.

    • instances: The instances of the asset class whose deposits will be reevaluated.

      NOTE: This exists as a best-effort function. Any asset instances which are unknown or in the case that the owner account does not have reservable funds to pay for a deposit increase are ignored. Generally the owner isn't going to call this on instances whose existing deposit is less than the refreshed deposit as it would only cost them, so it's of little consequence.

      It will still return an error in the case that the class is unknown of the signer is not permitted to call it.

      Weight: O(instances.len())

setAttribute(class: Compact<ClassId>, maybe_instance: Option<InstanceId>, key: Bytes, value: Bytes)#

  • interface: api.tx.uniques.setAttribute

  • summary: Set an attribute for an asset class or instance.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset class.

    If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * (key.len + value.len) taking into account any already reserved funds.

    • class: The identifier of the asset class whose instance's metadata to set.

    • maybe_instance: The identifier of the asset instance whose metadata to set.

    • key: The key of the attribute.

    • value: The value to which to set the attribute.

      Emits AttributeSet.

      Weight: O(1)

setClassMetadata(class: Compact<ClassId>, data: Bytes, is_frozen: bool)#

  • interface: api.tx.uniques.setClassMetadata

  • summary: Set the metadata for an asset class.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset class.

    If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * data.len taking into account any already reserved funds.

    • class: The identifier of the asset whose metadata to update.

    • data: The general information of this asset. Limited in length by StringLimit.

    • is_frozen: Whether the metadata should be frozen against further changes.

      Emits ClassMetadataSet.

      Weight: O(1)

setMetadata(class: Compact<ClassId>, instance: Compact<InstanceId>, data: Bytes, is_frozen: bool)#

  • interface: api.tx.uniques.setMetadata

  • summary: Set the metadata for an asset instance.

    Origin must be either ForceOrigin or Signed and the sender should be the Owner of the asset class.

    If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * data.len taking into account any already reserved funds.

    • class: The identifier of the asset class whose instance's metadata to set.

    • instance: The identifier of the asset instance whose metadata to set.

    • data: The general information of this asset. Limited in length by StringLimit.

    • is_frozen: Whether the metadata should be frozen against further changes.

      Emits MetadataSet.

      Weight: O(1)

setTeam(class: Compact<ClassId>, issuer: LookupSource, admin: LookupSource, freezer: LookupSource)#

  • interface: api.tx.uniques.setTeam

  • summary: Change the Issuer, Admin and Freezer of an asset class.

    Origin must be Signed and the sender should be the Owner of the asset class.

    • class: The asset class whose team should be changed.

    • issuer: The new Issuer of this asset class.

    • admin: The new Admin of this asset class.

    • freezer: The new Freezer of this asset class.

      Emits TeamChanged.

      Weight: O(1)

thaw(class: Compact<ClassId>, instance: Compact<InstanceId>)#

  • interface: api.tx.uniques.thaw

  • summary: Re-allow unprivileged transfer of an asset instance.

    Origin must be Signed and the sender should be the Freezer of the asset class.

    • class: The class of the asset to be thawed.

    • instance: The instance of the asset to be thawed.

      Emits Thawed.

      Weight: O(1)

thawClass(class: Compact<ClassId>)#

  • interface: api.tx.uniques.thawClass

  • summary: Re-allow unprivileged transfers for a whole asset class.

    Origin must be Signed and the sender should be the Admin of the asset class.

    • class: The class to be thawed.

      Emits ClassThawed.

      Weight: O(1)

transfer(class: Compact<ClassId>, instance: Compact<InstanceId>, dest: LookupSource)#

  • interface: api.tx.uniques.transfer

  • summary: Move an asset from the sender account to another.

    Origin must be Signed and the signing account must be either:

    • the Admin of the asset class;

    • the Owner of the asset instance;

    • the approved delegate for the asset instance (in this case, the approval is reset).

      Arguments:

    • class: The class of the asset to be transferred.

    • instance: The instance of the asset to be transferred.

    • dest: The account to receive ownership of the asset.

      Emits Transferred.

      Weight: O(1)

transferOwnership(class: Compact<ClassId>, owner: LookupSource)#

  • interface: api.tx.uniques.transferOwnership

  • summary: Change the Owner of an asset class.

    Origin must be Signed and the sender should be the Owner of the asset class.

    • class: The asset class whose owner should be changed.

    • owner: The new Owner of this asset class.

      Emits OwnerChanged.

      Weight: O(1)

utility#

asDerivative(index: u16, call: Call)#

  • interface: api.tx.utility.asDerivative

  • summary: Send a call through an indexed pseudonym of the sender.

    Filter from origin are passed along. The call will be dispatched with an origin which use the same filter as the origin of this call.

    NOTE: If you need to ensure that any account-based filtering is not honored (i.e. because you expect proxy to have been used prior in the call stack and you do not want the call restrictions to apply to any sub-accounts), then use as_multi_threshold_1 in the Multisig pallet instead.

    NOTE: Prior to version *12, this was called as_limited_sub.

    The dispatch origin for this call must be Signed.

batch(calls: Vec<Call>)#

  • interface: api.tx.utility.batch

  • summary: Send a batch of dispatch calls.

    May be called from any origin.

    • calls: The calls to be dispatched from the same origin.

      If origin is root then call are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

This will return Ok in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterrupted event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompleted event is deposited.

batchAll(calls: Vec<Call>)#

  • interface: api.tx.utility.batchAll

  • summary: Send a batch of dispatch calls and atomically execute them. The whole transaction will rollback and fail if any of the calls failed.

    May be called from any origin.

    • calls: The calls to be dispatched from the same origin.

      If origin is root then call are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

vesting#

forceVestedTransfer(source: LookupSource, target: LookupSource, schedule: VestingInfo)#

  • interface: api.tx.vesting.forceVestedTransfer

  • summary: Force a vested transfer.

    The dispatch origin for this call must be Root.

    • source: The account whose funds should be transferred.

    • target: The account that should be transferred the vested funds.

    May be called from any origin.

    • calls: The calls to be dispatched from the same origin.

      Emits VestingCreated.

vest()#

  • interface: api.tx.vesting.vest

  • summary: Unlock any vested funds of the sender account.

    The dispatch origin for this call must be Signed and the sender must have funds still locked under this pallet.

    Emits either VestingCompleted or VestingUpdated.

vestOther(target: LookupSource)#

  • interface: api.tx.vesting.vestOther

  • summary: Unlock any vested funds of a target account.

    The dispatch origin for this call must be Signed.

    • target: The account whose vested funds should be unlocked. Must have funds still locked under this pallet.

      Emits either VestingCompleted or VestingUpdated.

vestedTransfer(dest: LookupSource, schedule: VestingScheduleOf)#

  • interface: api.tx.vesting.vestedTransfer

  • summary: Create a vested transfer.

    The dispatch origin for this call must be Signed.

    • target: The account that should be transferred the vested funds.

    • amount: The amount of funds to transfer and will be vested.

    • schedule: The vesting schedule attached to the transfer.

      Emits VestingCreated.

Edit this page