Phala Network Runtime Api Documentation

title: Constants

The following sections contain the module constants, also known as parameter types. These can only be changed as part of a runtime upgrade. On the api, these are exposed via api.consts.<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
authorship
balances
bounties
childBounties
democracy
identity
lottery
multisig
phragmenElection
proxy
scheduler
system
timestamp
tips
transactionPayment
treasury
utility
vesting

assets

approvalDeposit: `u128`

interface: api.consts.assets.approvalDeposit
summary: The amount of funds that must be reserved when creating a new approval.

assetAccountDeposit: `u128`

interface: api.consts.assets.assetAccountDeposit
summary: The amount of funds that must be reserved for a non-provider asset account to be maintained.

assetDeposit: `u128`

interface: api.consts.assets.assetDeposit
summary: The basic amount of funds that must be reserved for an asset.

metadataDepositBase: `u128`

interface: api.consts.assets.metadataDepositBase
summary: The basic amount of funds that must be reserved when adding metadata to your asset.

metadataDepositPerByte: `u128`

interface: api.consts.assets.metadataDepositPerByte
summary: The additional funds that must be reserved for the number of bytes you store in your metadata.

stringLimit: `u32`

interface: api.consts.assets.stringLimit
summary: The maximum length of a name or symbol stored on-chain.

authorship

uncleGenerations: `u32`

interface: api.consts.authorship.uncleGenerations
summary: The number of blocks back we should accept uncles. This means that we will deal with uncle-parents that are UncleGenerations + 1 before now.

balances

existentialDeposit: `u128`

interface: api.consts.balances.existentialDeposit
summary: The minimum amount required to keep an account open.

maxLocks: `u32`

interface: api.consts.balances.maxLocks
summary: The maximum number of locks that should exist on an account. Not strictly enforced, but used for weight estimation.

maxReserves: `u32`

interface: api.consts.balances.maxReserves
summary: The maximum number of named reserves that can exist on an account.

bounties

bountyDepositBase: `u128`

interface: api.consts.bounties.bountyDepositBase
summary: The amount held on deposit for placing a bounty proposal.

bountyDepositPayoutDelay: `u32`

interface: api.consts.bounties.bountyDepositPayoutDelay
summary: The delay period for which a bounty beneficiary need to wait before claim the payout.

bountyUpdatePeriod: `u32`

interface: api.consts.bounties.bountyUpdatePeriod
summary: Bounty duration in blocks.

bountyValueMinimum: `u128`

interface: api.consts.bounties.bountyValueMinimum
summary: Minimum value for a bounty.

curatorDepositMax: `Option<u128>`

interface: api.consts.bounties.curatorDepositMax
summary: Maximum amount of funds that should be placed in a deposit for making a proposal.

curatorDepositMin: `Option<u128>`

interface: api.consts.bounties.curatorDepositMin
summary: Minimum amount of funds that should be placed in a deposit for making a proposal.

curatorDepositMultiplier: `Permill`

interface: api.consts.bounties.curatorDepositMultiplier
summary: The curator deposit is calculated as a percentage of the curator fee.

This deposit has optional upper and lower bounds with CuratorDepositMax and CuratorDepositMin.

dataDepositPerByte: `u128`

interface: api.consts.bounties.dataDepositPerByte
summary: The amount held on deposit per byte within the tip report reason or bounty description.

maximumReasonLength: `u32`

interface: api.consts.bounties.maximumReasonLength
summary: Maximum acceptable reason length.

Benchmarks depend on this value, be sure to update weights file when changing this value

childBounties

childBountyValueMinimum: `u128`

interface: api.consts.childBounties.childBountyValueMinimum
summary: Minimum value for a child-bounty.

maxActiveChildBountyCount: `u32`

interface: api.consts.childBounties.maxActiveChildBountyCount
summary: Maximum number of child bounties that can be added to a parent bounty.

democracy

cooloffPeriod: `u32`

interface: api.consts.democracy.cooloffPeriod
summary: Period in blocks where an external proposal may not be re-submitted after being vetoed.

enactmentPeriod: `u32`

interface: api.consts.democracy.enactmentPeriod
summary: The period between a proposal being approved and enacted.

It should generally be a little more than the unstake period to ensure that voting stakers have an opportunity to remove themselves from the system in the case where they are on the losing side of a vote.

fastTrackVotingPeriod: `u32`

interface: api.consts.democracy.fastTrackVotingPeriod
summary: Minimum voting period allowed for a fast-track referendum.

instantAllowed: `bool`

interface: api.consts.democracy.instantAllowed
summary: Indicator for whether an emergency origin is even allowed to happen. Some chains may want to set this permanently to false, others may want to condition it on things such as an upgrade having happened recently.

launchPeriod: `u32`

interface: api.consts.democracy.launchPeriod
summary: How often (in blocks) new public referenda are launched.

maxProposals: `u32`

interface: api.consts.democracy.maxProposals
summary: The maximum number of public proposals that can exist at any time.

maxVotes: `u32`

interface: api.consts.democracy.maxVotes
summary: The maximum number of votes for an account.

Also used to compute weight, an overly big value can lead to extrinsic with very big weight: see delegate for instance.

minimumDeposit: `u128`

interface: api.consts.democracy.minimumDeposit
summary: The minimum amount to be used as a deposit for a public referendum proposal.

preimageByteDeposit: `u128`

interface: api.consts.democracy.preimageByteDeposit
summary: The amount of balance that must be deposited per byte of preimage stored.

voteLockingPeriod: `u32`

interface: api.consts.democracy.voteLockingPeriod
summary: The minimum period of vote locking.

It should be no shorter than enactment period to ensure that in the case of an approval, those successful voters are locked into the consequences that their votes entail.

votingPeriod: `u32`

interface: api.consts.democracy.votingPeriod
summary: How often (in blocks) to check for new votes.

identity

basicDeposit: `u128`

interface: api.consts.identity.basicDeposit
summary: The amount held on deposit for a registered identity

fieldDeposit: `u128`

interface: api.consts.identity.fieldDeposit
summary: The amount held on deposit per additional field for a registered identity.

maxAdditionalFields: `u32`

interface: api.consts.identity.maxAdditionalFields
summary: Maximum number of additional fields that may be stored in an ID. Needed to bound the I/O required to access an identity, but can be pretty high.

maxRegistrars: `u32`

interface: api.consts.identity.maxRegistrars
summary: Maxmimum number of registrars allowed in the system. Needed to bound the complexity of, e.g., updating judgements.

maxSubAccounts: `u32`

interface: api.consts.identity.maxSubAccounts
summary: The maximum number of sub-accounts allowed per identified account.

subAccountDeposit: `u128`

interface: api.consts.identity.subAccountDeposit
summary: The amount held on deposit for a registered subaccount. This should account for the fact that one storage item's value will increase by the size of an account ID, and there will be another trie item whose value is the size of an account ID plus 32 bytes.

lottery

maxCalls: `u32`

interface: api.consts.lottery.maxCalls
summary: The max number of calls available in a single lottery.

maxGenerateRandom: `u32`

interface: api.consts.lottery.maxGenerateRandom
summary: Number of time we should try to generate a random number that has no modulo bias. The larger this number, the more potential computation is used for picking the winner, but also the more likely that the chosen winner is done fairly.

palletId: `FrameSupportPalletId`

interface: api.consts.lottery.palletId
summary: The Lottery's pallet id

multisig

depositBase: `u128`

interface: api.consts.multisig.depositBase
summary: The base amount of currency needed to reserve for creating a multisig execution or to store a dispatch call for later.

This is held for an additional storage item whose value size is 4 + sizeof((BlockNumber, Balance, AccountId)) bytes and whose key size is 32 + sizeof(AccountId) bytes.

depositFactor: `u128`

interface: api.consts.multisig.depositFactor
summary: The amount of currency needed per unit threshold when creating a multisig execution.

This is held for adding 32 bytes more into a pre-existing storage value.

maxSignatories: `u16`

interface: api.consts.multisig.maxSignatories
summary: The maximum amount of signatories allowed in the multisig.

phragmenElection

candidacyBond: `u128`

interface: api.consts.phragmenElection.candidacyBond
summary: How much should be locked up in order to submit one's candidacy.

desiredMembers: `u32`

interface: api.consts.phragmenElection.desiredMembers
summary: Number of members to elect.

desiredRunnersUp: `u32`

interface: api.consts.phragmenElection.desiredRunnersUp
summary: Number of runners_up to keep.

palletId: `[u8;8]`

interface: api.consts.phragmenElection.palletId
summary: Identifier for the elections-phragmen pallet's lock

termDuration: `u32`

interface: api.consts.phragmenElection.termDuration
summary: How long each seat is kept. This defines the next block number at which an election round will happen. If set to zero, no elections are ever triggered and the module will be in passive mode.

votingBondBase: `u128`

interface: api.consts.phragmenElection.votingBondBase
summary: Base deposit associated with voting.

This should be sensibly high to economically ensure the pallet cannot be attacked by creating a gigantic number of votes.

votingBondFactor: `u128`

interface: api.consts.phragmenElection.votingBondFactor
summary: The amount of bond that need to be locked for each vote (32 bytes).

proxy

announcementDepositBase: `u128`

interface: api.consts.proxy.announcementDepositBase
summary: The base amount of currency needed to reserve for creating an announcement.

This is held when a new storage item holding a Balance is created (typically 16 bytes).

announcementDepositFactor: `u128`

interface: api.consts.proxy.announcementDepositFactor
summary: The amount of currency needed per announcement made.

This is held for adding an AccountId, Hash and BlockNumber (typically 68 bytes) into a pre-existing storage value.

maxPending: `u32`

interface: api.consts.proxy.maxPending
summary: The maximum amount of time-delayed announcements that are allowed to be pending.

maxProxies: `u32`

interface: api.consts.proxy.maxProxies
summary: The maximum amount of proxies allowed for a single account.

proxyDepositBase: `u128`

interface: api.consts.proxy.proxyDepositBase
summary: The base amount of currency needed to reserve for creating a proxy.

This is held for an additional storage item whose value size is sizeof(Balance) bytes and whose key size is sizeof(AccountId) bytes.

proxyDepositFactor: `u128`

interface: api.consts.proxy.proxyDepositFactor
summary: The amount of currency needed per proxy added.

This is held for adding 32 bytes plus an instance of ProxyType more into a pre-existing storage value. Thus, when configuring ProxyDepositFactor one should take into account 32 + proxy_type.encode().len() bytes of data.

scheduler

maximumWeight: `u64`

interface: api.consts.scheduler.maximumWeight
summary: The maximum weight that may be scheduled per block for any dispatchables of less priority than schedule::HARD_DEADLINE.

maxScheduledPerBlock: `u32`

interface: api.consts.scheduler.maxScheduledPerBlock
summary: The maximum number of scheduled calls in the queue for a single block. Not strictly enforced, but used for weight estimation.

system

blockHashCount: `u32`

interface: api.consts.system.blockHashCount
summary: Maximum number of block number to block hash mappings to keep (oldest pruned first).

blockLength: `FrameSystemLimitsBlockLength`

interface: api.consts.system.blockLength
summary: The maximum length of a block (in bytes).

blockWeights: `FrameSystemLimitsBlockWeights`

interface: api.consts.system.blockWeights
summary: Block & extrinsics weights: base values and limits.

dbWeight: `FrameSupportWeightsRuntimeDbWeight`

interface: api.consts.system.dbWeight
summary: The weight of runtime database operations the runtime can invoke.

ss58Prefix: `u16`

interface: api.consts.system.ss58Prefix
summary: The designated SS85 prefix of this chain.

This replaces the "ss58Format" property declared in the chain spec. Reason is that the runtime should know about the prefix in order to make use of it as an identifier of the chain.

version: `SpVersionRuntimeVersion`

interface: api.consts.system.version
summary: Get the chain's current version.

timestamp

minimumPeriod: `u64`

interface: api.consts.timestamp.minimumPeriod
summary: The minimum period between blocks. Beware that this is different to the expected period that the block production apparatus provides. Your chosen consensus system will generally work with this to determine a sensible block time. e.g. For Aura, it will be double this period on default settings.

tips

dataDepositPerByte: `u128`

interface: api.consts.tips.dataDepositPerByte
summary: The amount held on deposit per byte within the tip report reason or bounty description.

maximumReasonLength: `u32`

interface: api.consts.tips.maximumReasonLength
summary: Maximum acceptable reason length.

Benchmarks depend on this value, be sure to update weights file when changing this value

tipCountdown: `u32`

interface: api.consts.tips.tipCountdown
summary: The period for which a tip remains open after is has achieved threshold tippers.

tipFindersFee: `Percent`

interface: api.consts.tips.tipFindersFee
summary: The percent of the final tip which goes to the original reporter of the tip.

tipReportDepositBase: `u128`

interface: api.consts.tips.tipReportDepositBase
summary: The amount held on deposit for placing a tip report.

transactionPayment

operationalFeeMultiplier: `u8`

interface: api.consts.transactionPayment.operationalFeeMultiplier
summary: A fee mulitplier for Operational extrinsics to compute "virtual tip" to boost their priority

This value is multipled by the final_fee to obtain a "virtual tip" that is later added to a tip component in regular priority calculations. It means that a Normal transaction can front-run a similarly-sized Operational extrinsic (with no tip), by including a tip value greater than the virtual tip.

```rust,ignore // For Normal let priority = priority_calc(tip);

// For Operational let virtual_tip = (inclusion_fee + tip) * OperationalFeeMultiplier; let priority = priority_calc(tip + virtual_tip); ```

Note that since we use final_fee the multiplier applies also to the regular tip sent with the transaction. So, not only does the transaction get a priority bump based on the inclusion_fee, but we also amplify the impact of tips applied to Operational transactions.

treasury

burn: `Permill`

interface: api.consts.treasury.burn
summary: Percentage of spare funds (if any) that are burnt per spend period.

maxApprovals: `u32`

interface: api.consts.treasury.maxApprovals
summary: The maximum number of approvals that can wait in the spending queue.

NOTE: This parameter is also used within the Bounties Pallet extension if enabled.

palletId: `FrameSupportPalletId`

interface: api.consts.treasury.palletId
summary: The treasury's pallet id, used for deriving its sovereign account ID.

proposalBond: `Permill`

interface: api.consts.treasury.proposalBond
summary: Fraction of a proposal's value that should be bonded in order to place the proposal. An accepted proposal gets these back. A rejected proposal does not.

proposalBondMaximum: `Option<u128>`

interface: api.consts.treasury.proposalBondMaximum
summary: Maximum amount of funds that should be placed in a deposit for making a proposal.

proposalBondMinimum: `u128`

interface: api.consts.treasury.proposalBondMinimum
summary: Minimum amount of funds that should be placed in a deposit for making a proposal.

spendPeriod: `u32`

interface: api.consts.treasury.spendPeriod
summary: Period between successive spends.

utility

batchedCallsLimit: `u32`

interface: api.consts.utility.batchedCallsLimit
summary: The limit on the number of batched calls.

vesting

maxVestingSchedules: `u32`

interface: api.consts.vesting.maxVestingSchedules

minVestedTransfer: `u128`

interface: api.consts.vesting.minVestedTransfer
summary: The minimum amount transferred to call vested_transfer.

title: 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<u32>`, delegate: `MultiAddress`, amount: `Compact<u128>`)

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<u32>`, who: `MultiAddress`, amount: `Compact<u128>`)

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 NoAccount 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<u32>`, delegate: `MultiAddress`)

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<u32>`)

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<u32>`, admin: `MultiAddress`, min_balance: `u128`)

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<u32>`, witness: `PalletAssetsDestroyWitness`)

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<u32>`, owner: `MultiAddress`, issuer: `MultiAddress`, admin: `MultiAddress`, freezer: `MultiAddress`, min_balance: `Compact<u128>`, 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<u32>`, owner: `MultiAddress`, delegate: `MultiAddress`)

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<u32>`)

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<u32>`, owner: `MultiAddress`, is_sufficient: `bool`, min_balance: `Compact<u128>`)

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<u32>`, 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<u32>`, source: `MultiAddress`, dest: `MultiAddress`, amount: `Compact<u128>`)

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<u32>`, who: `MultiAddress`)

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<u32>`)

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<u32>`, beneficiary: `MultiAddress`, amount: `Compact<u128>`)

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.

refund(id: `Compact<u32>`, allow_burn: `bool`)

interface: api.tx.assets.refund
summary: Return the deposit (if any) of an asset account.

The origin must be Signed.
- id: The identifier of the asset for the account to be created.
- allow_burn: If true then assets may be destroyed in order to complete the refund.
Emits Refunded event when successful.

setMetadata(id: `Compact<u32>`, 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<u32>`, issuer: `MultiAddress`, admin: `MultiAddress`, freezer: `MultiAddress`)

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<u32>`, who: `MultiAddress`)

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<u32>`)

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)

touch(id: `Compact<u32>`)

interface: api.tx.assets.touch
summary: Create an asset account for non-provider assets.

A deposit will be taken from the signer account.
- origin: Must be Signed; the signer account must have sufficient funds for a deposit to be taken.
- id: The identifier of the asset for the account to be created.
Emits Touched event when successful.

transfer(id: `Compact<u32>`, target: `MultiAddress`, amount: `Compact<u128>`)

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<u32>`, owner: `MultiAddress`, destination: `MultiAddress`, amount: `Compact<u128>`)

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<u32>`, target: `MultiAddress`, amount: `Compact<u128>`)

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<u32>`, owner: `MultiAddress`)

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<SpRuntimeHeader>`)

interface: api.tx.authorship.setUncles
summary: Provide a set of uncles.

balances

forceTransfer(source: `MultiAddress`, dest: `MultiAddress`, value: `Compact<u128>`)

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

forceUnreserve(who: `MultiAddress`, amount: `u128`)

interface: api.tx.balances.forceUnreserve
summary: Unreserve some balance from a user by force.

Can only be called by ROOT.

setBalance(who: `MultiAddress`, new_free: `Compact<u128>`, new_reserved: `Compact<u128>`)

interface: api.tx.balances.setBalance
summary: Set the balances of a given account.

This will alter FreeBalance and ReservedBalance in storage. it will also alter the total issuance of the system (TotalIssuance) appropriately. 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: `MultiAddress`, value: `Compact<u128>`)

interface: api.tx.balances.transfer
summary: Transfer some liquid free balance to another account.

transfer will set the FreeBalance of the sender and receiver. 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: `MultiAddress`, 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: `MultiAddress`, value: `Compact<u128>`)

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<u32>`)

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<u32>`)

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<u32>`, beneficiary: `MultiAddress`)

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<u32>`)

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<u32>`)

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<u32>`, 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<u128>`, 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<u32>`, curator: `MultiAddress`, fee: `Compact<u128>`)

interface: api.tx.bounties.proposeCurator
summary: Assign a curator to a funded bounty.

May only be called from T::ApproveOrigin.

unassignCurator(bounty_id: `Compact<u32>`)

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.

childBounties

acceptCurator(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`)

interface: api.tx.childBounties.acceptCurator
summary: Accept the curator role for the child-bounty.

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

A deposit will be reserved from the curator and refund upon successful payout or cancellation.

Fee for curator is deducted from curator fee of parent bounty.

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in "CuratorProposed" state, for processing the call. And state of child-bounty is moved to "Active" on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.

addChildBounty(parent_bounty_id: `Compact<u32>`, value: `Compact<u128>`, description: `Bytes`)

interface: api.tx.childBounties.addChildBounty
summary: Add a new child-bounty.

The dispatch origin for this call must be the curator of parent bounty and the parent bounty must be in "active" state.

Child-bounty gets added successfully & fund gets transferred from parent bounty to child-bounty account, if parent bounty has enough funds, else the call fails.

Upper bound to maximum number of active child bounties that can be added are managed via runtime trait config [Config::MaxActiveChildBountyCount].

If the call is success, the status of child-bounty is updated to "Added".
- parent_bounty_id: Index of parent bounty for which child-bounty is being added.
- value: Value for executing the proposal.
- description: Text description for the child-bounty.

awardChildBounty(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`, beneficiary: `MultiAddress`)

interface: api.tx.childBounties.awardChildBounty
summary: Award child-bounty to a beneficiary.

The beneficiary will be able to claim the funds after a delay.

The dispatch origin for this call must be the parent curator or curator of this child-bounty.

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in active state, for processing the call. And state of child-bounty is moved to "PendingPayout" on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.
- beneficiary: Beneficiary account.

claimChildBounty(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`)

interface: api.tx.childBounties.claimChildBounty
summary: Claim the payout from an awarded child-bounty after payout delay.

The dispatch origin for this call may be any signed origin.

Call works independent of parent bounty state, No need for parent bounty to be in active state.

The Beneficiary is paid out with agreed bounty value. Curator fee is paid & curator deposit is unreserved.

Child-bounty must be in "PendingPayout" state, for processing the call. And instance of child-bounty is removed from the state on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.

closeChildBounty(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`)

interface: api.tx.childBounties.closeChildBounty
summary: Cancel a proposed or active child-bounty. Child-bounty account funds are transferred to parent bounty account. The child-bounty curator deposit may be unreserved if possible.

The dispatch origin for this call must be either parent curator or T::RejectOrigin.

If the state of child-bounty is Active, curator deposit is unreserved.

If the state of child-bounty is PendingPayout, call fails & returns PendingPayout error.

For the origin other than T::RejectOrigin, parent bounty must be in active state, for this child-bounty call to work. For origin T::RejectOrigin execution is forced.

Instance of child-bounty is removed from the state on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.

proposeCurator(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`, curator: `MultiAddress`, fee: `Compact<u128>`)

interface: api.tx.childBounties.proposeCurator
summary: Propose curator for funded child-bounty.

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

Parent bounty must be in active state, for this child-bounty call to work.

Child-bounty must be in "Added" state, for processing the call. And state of child-bounty is moved to "CuratorProposed" on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.
- curator: Address of child-bounty curator.
- fee: payment fee to child-bounty curator for execution.

unassignCurator(parent_bounty_id: `Compact<u32>`, child_bounty_id: `Compact<u32>`)

interface: api.tx.childBounties.unassignCurator
summary: Unassign curator from a child-bounty.

The dispatch origin for this call can be either RejectOrigin, or the curator of the parent bounty, or any signed origin.

For the origin other than T::RejectOrigin and the child-bounty curator, parent bounty must be in active state, for this call to work. We allow child-bounty curator and T::RejectOrigin to execute this call irrespective of the parent bounty state.

If this function is called by the RejectOrigin or the parent bounty curator, we assume that the child-bounty curator is malicious or inactive. As a result, child-bounty curator deposit is slashed.

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

Finally, the origin can be anyone iff the child-bounty curator is "inactive". Expiry update due of parent bounty is used to estimate inactive state of child-bounty curator.

This allows anyone in the community to call out that a child-bounty curator is not doing their due diligence, and we should pick a new one. In this case the child-bounty curator deposit is slashed.

State of child-bounty is moved to Added state on successful call completion.
- parent_bounty_id: Index of parent bounty.
- child_bounty_id: Index of child bounty.

collatorSelection

leaveIntent()

interface: api.tx.collatorSelection.leaveIntent
summary: Deregister origin as a collator candidate. Note that the collator can only leave on session change. The CandidacyBond will be unreserved immediately.

This call will fail if the total number of candidates would drop below MinCandidates.

This call is not available to Invulnerable collators.

registerAsCandidate()

interface: api.tx.collatorSelection.registerAsCandidate
summary: Register this account as a collator candidate. The account must (a) already have registered session keys and (b) be able to reserve the CandidacyBond.

This call is not available to Invulnerable collators.

setCandidacyBond(bond: `u128`)

interface: api.tx.collatorSelection.setCandidacyBond
summary: Set the candidacy bond amount.

setDesiredCandidates(max: `u32`)

interface: api.tx.collatorSelection.setDesiredCandidates
summary: Set the ideal number of collators (not including the invulnerables). If lowering this number, then the number of running collators could be higher than this figure. Aside from that edge case, there should be no other way to have more collators than the desired number.

setInvulnerables(new: `Vec<AccountId32>`)

interface: api.tx.collatorSelection.setInvulnerables
summary: Set the list of invulnerable (fixed) collators.

council

close(proposal_hash: `H256`, index: `Compact<u32>`, proposal_weight_bound: `Compact<u64>`, 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: `H256`)

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: `Call`, 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<u32>`, proposal: `Call`, 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<AccountId32>`, prime: `Option<AccountId32>`, old_count: `u32`)

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.

WARNING:

The pallet-collective can also be managed by logic outside of the pallet through the implementation of the trait [ChangeMembers]. Any call to set_members must be careful that the member set doesn't get out of sync with other logic managing the member set.

vote(proposal: `H256`, index: `Compact<u32>`, 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.

democracy

blacklist(proposal_hash: `H256`, maybe_ref_index: `Option<u32>`)

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<u32>`)

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: `u32`)

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<u32>`)

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: `AccountId32`, conviction: `PalletDemocracyConviction`, balance: `u128`)

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: `u32`)

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: `H256`, index: `u32`)

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: `H256`)

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: `H256`)

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: `H256`)

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: `H256`, voting_period: `u32`, delay: `u32`)

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: `H256`, value: `Compact<u128>`)

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.
- value: The amount of deposit (must be at least MinimumDeposit).
Emits Proposed.

Weight: O(p)

reapPreimage(proposal_hash: `H256`, 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: `AccountId32`, index: `u32`)

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

removeVote(index: `u32`)

interface: api.tx.democracy.removeVote
summary: Remove a vote for a referendum.

If:
- the referendum was cancelled, or
- the referendum is ongoing, or
- the referendum has ended such that
- the vote of the account was in opposition to the result; or
- there was no conviction to the account's vote; or
- 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:
- it finished corresponding to the vote of the account, and
- the account made a standard vote with conviction, 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<u32>`, 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: `AccountId32`)

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: `H256`)

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<u32>`, vote: `PalletDemocracyVoteAccountVote`)

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.
- vote: The vote configuration.
Weight: O(R) where R is the number of referendums the voter has voted on.

identity

addRegistrar(account: `AccountId32`)

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: `MultiAddress`, 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: `u32`)

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: `MultiAddress`)

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<u32>`, target: `MultiAddress`, judgement: `PalletIdentityJudgement`)

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.
- judgement: the judgement of the registrar of index reg_index about target.
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: `MultiAddress`)

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: `MultiAddress`, 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<u32>`, max_fee: `Compact<u128>`)

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.
- max_fee: The maximum fee that may be paid. This should just be auto-populated as:
nocompile Self::registrars().get(reg_index).unwrap().fee

Emits JudgementRequested if successful.

setAccountId(index: `Compact<u32>`, new: `AccountId32`)

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.
- new: the new account ID.

setFee(index: `Compact<u32>`, fee: `Compact<u128>`)

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.
- fee: the new fee.

setFields(index: `Compact<u32>`, fields: `PalletIdentityBitFlags`)

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.
- fields: the fields that the registrar concerns themselves with.

setIdentity(info: `PalletIdentityIdentityInfo`)

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<(AccountId32,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.

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: `u128`, length: `u32`, delay: `u32`, 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.

multisig

approveAsMulti(threshold: `u16`, other_signatories: `Vec<AccountId32>`, maybe_timepoint: `Option<PalletMultisigTimepoint>`, call_hash: `[u8;32]`, max_weight: `u64`)

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.
- call_hash: The hash of the call to be executed.
NOTE: If this is the final approval, you will want to use as_multi instead.

asMulti(threshold: `u16`, other_signatories: `Vec<AccountId32>`, maybe_timepoint: `Option<PalletMultisigTimepoint>`, call: `WrapperKeepOpaque<Call>`, store_call: `bool`, max_weight: `u64`)

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.
- call: The call to be executed.
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<AccountId32>`, 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.
- call: The call to be executed.
Result is equivalent to the dispatched result.

cancelAsMulti(threshold: `u16`, other_signatories: `Vec<AccountId32>`, timepoint: `PalletMultisigTimepoint`, 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.
- call_hash: The hash of the call to be executed.

parachainSystem

authorizeUpgrade(code_hash: `H256`)

interface: api.tx.parachainSystem.authorizeUpgrade

enactAuthorizedUpgrade(code: `Bytes`)

interface: api.tx.parachainSystem.enactAuthorizedUpgrade

setValidationData(data: `CumulusPrimitivesParachainInherentParachainInherentData`)

interface: api.tx.parachainSystem.setValidationData
summary: Set the current validation data.

This should be invoked exactly once per block. It will panic at the finalization phase if the call was not invoked.

The dispatch origin for this call must be Inherent

As a side effect, this function upgrades the current validation function if the appropriate time has come.

sudoSendUpwardMessage(message: `Bytes`)

interface: api.tx.parachainSystem.sudoSendUpwardMessage

phragmenElection

cleanDefunctVoters(num_voters: `u32`, num_defunct: `u32`)

interface: api.tx.phragmenElection.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: `MultiAddress`, has_replacement: `bool`)

interface: api.tx.phragmenElection.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.phragmenElection.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: `PalletElectionsPhragmenRenouncing`)

interface: api.tx.phragmenElection.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_member, 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.phragmenElection.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<AccountId32>`, value: `Compact<u128>`)

interface: api.tx.phragmenElection.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:
- not be empty.
- 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 free 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.

preimage

notePreimage(bytes: `Bytes`)

interface: api.tx.preimage.notePreimage
summary: Register a preimage on-chain.

If the preimage was previously requested, no fees or deposits are taken for providing the preimage. Otherwise, a deposit is taken proportional to the size of the preimage.

requestPreimage(hash: `H256`)

interface: api.tx.preimage.requestPreimage
summary: Request a preimage be uploaded to the chain without paying any fees or deposits.

If the preimage requests has already been provided on-chain, we unreserve any deposit a user may have paid, and take the control of the preimage out of their hands.

unnotePreimage(hash: `H256`)

interface: api.tx.preimage.unnotePreimage
summary: Clear an unrequested preimage from the runtime storage.

unrequestPreimage(hash: `H256`)

interface: api.tx.preimage.unrequestPreimage
summary: Clear a previously made request for a preimage.

NOTE: THIS MUST NOT BE CALLED ON hash MORE TIMES THAN request_preimage.

proxy

addProxy(delegate: `AccountId32`, proxy_type: `PhalaParachainRuntimeProxyType`, delay: `u32`)

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: `AccountId32`, call_hash: `H256`)

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: `PhalaParachainRuntimeProxyType`, delay: `u32`, 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: `AccountId32`, proxy_type: `PhalaParachainRuntimeProxyType`, index: `u16`, height: `Compact<u32>`, 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: `AccountId32`, force_proxy_type: `Option<PhalaParachainRuntimeProxyType>`, 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: `AccountId32`, real: `AccountId32`, force_proxy_type: `Option<PhalaParachainRuntimeProxyType>`, 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: `AccountId32`, call_hash: `H256`)

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: `AccountId32`, call_hash: `H256`)

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: `AccountId32`, proxy_type: `PhalaParachainRuntimeProxyType`, delay: `u32`)

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.

scheduler

cancel(when: `u32`, 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: `u32`, maybe_periodic: `Option<(u32,u32)>`, priority: `u8`, call: `FrameSupportScheduleMaybeHashed`)

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

scheduleAfter(after: `u32`, maybe_periodic: `Option<(u32,u32)>`, priority: `u8`, call: `FrameSupportScheduleMaybeHashed`)

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

scheduleNamed(id: `Bytes`, when: `u32`, maybe_periodic: `Option<(u32,u32)>`, priority: `u8`, call: `FrameSupportScheduleMaybeHashed`)

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

scheduleNamedAfter(id: `Bytes`, after: `u32`, maybe_periodic: `Option<(u32,u32)>`, priority: `u8`, call: `FrameSupportScheduleMaybeHashed`)

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 and the account must be either be convertible to a validator ID using the chain's typical addressing system (this usually means being a controller account) or directly convertible into a validator ID (which usually means being a stash account).

setKeys(keys: `PhalaParachainRuntimeOpaqueSessionKeys`, 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.

sudo

setKey(new: `MultiAddress`)

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: `MultiAddress`, 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: `u64`)

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: `Bytes`, 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<Bytes>`)

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.

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<(Bytes,Bytes)>`)

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

technicalCommittee

close(proposal_hash: `H256`, index: `Compact<u32>`, proposal_weight_bound: `Compact<u64>`, 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: `H256`)

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: `Call`, 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<u32>`, proposal: `Call`, 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<AccountId32>`, prime: `Option<AccountId32>`, old_count: `u32`)

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.

WARNING:

The pallet-collective can also be managed by logic outside of the pallet through the implementation of the trait [ChangeMembers]. Any call to set_members must be careful that the member set doesn't get out of sync with other logic managing the member set.

vote(proposal: `H256`, index: `Compact<u32>`, 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.

technicalMembership

addMember(who: `AccountId32`)

interface: api.tx.technicalMembership.addMember
summary: Add a member who to the set.

May only be called from T::AddOrigin.

changeKey(new: `AccountId32`)

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: `AccountId32`)

interface: api.tx.technicalMembership.removeMember
summary: Remove a member who from the set.

May only be called from T::RemoveOrigin.

resetMembers(members: `Vec<AccountId32>`)

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: `AccountId32`)

interface: api.tx.technicalMembership.setPrime
summary: Set the prime member. Must be a current member.

May only be called from T::PrimeOrigin.

swapMember(remove: `AccountId32`, add: `AccountId32`)

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<u64>`)

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: `H256`)

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: `AccountId32`)

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: `H256`)

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: `H256`)

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: `H256`, tip_value: `Compact<u128>`)

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: `AccountId32`, tip_value: `Compact<u128>`)

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.

treasury

approveProposal(proposal_id: `Compact<u32>`)

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<u128>`, beneficiary: `MultiAddress`)

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<u32>`)

interface: api.tx.treasury.rejectProposal
summary: Reject a proposed spend. The original deposit will be slashed.

May only be called from T::RejectOrigin.

removeApproval(proposal_id: `Compact<u32>`)

interface: api.tx.treasury.removeApproval
summary: Force a previously approved proposal to be removed from the approval queue. The original deposit will no longer be returned.

May only be called from T::RejectOrigin.
- proposal_id: The index of a proposal
Errors:
- ProposalNotApproved: The proposal_id supplied was not found in the approval queue, i.e., the proposal has not been approved. This could also mean the proposal does not exist altogether, thus there is no way it would have been approved in the first place.

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. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).
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. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).
If origin is root then call are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

batchTry(calls: `Vec<Call>`)

interface: api.tx.utility.batchTry
summary: DEPRECATED: Replaced by force_batch

Send a batch of dispatch calls. Unlike batch, it allows errors and won't interrupt.

May be called from any origin.
- calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).
If origin is root then call are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

dispatchAs(as_origin: `PhalaParachainRuntimeOriginCaller`, call: `Call`)

interface: api.tx.utility.dispatchAs
summary: Dispatches a function call with a provided origin.

The dispatch origin for this call must be Root.

forceBatch(calls: `Vec<Call>`)

interface: api.tx.utility.forceBatch
summary: Send a batch of dispatch calls. Unlike batch, it allows errors and won't interrupt.

May be called from any origin.
- calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).
If origin is root then call are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

vesting

forceVestedTransfer(source: `MultiAddress`, target: `MultiAddress`, schedule: `PalletVestingVestingInfo`)

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.
- schedule: The vesting schedule attached to the transfer.
Emits VestingCreated.

NOTE: This will unlock all schedules through the current block.

mergeSchedules(schedule1_index: `u32`, schedule2_index: `u32`)

interface: api.tx.vesting.mergeSchedules
summary: Merge two vesting schedules together, creating a new vesting schedule that unlocks over the highest possible start and end blocks. If both schedules have already started the current block will be used as the schedule start; with the caveat that if one schedule is finished by the current block, the other will be treated as the new merged schedule, unmodified.

NOTE: If schedule1_index == schedule2_index this is a no-op. NOTE: This will unlock all schedules through the current block prior to merging. NOTE: If both schedules have ended by the current block, no new schedule will be created and both will be removed.

Merged schedule attributes:
- starting_block: MAX(schedule1.starting_block, scheduled2.starting_block, current_block).
- ending_block: MAX(schedule1.ending_block, schedule2.ending_block).
- locked: schedule1.locked_at(current_block) + schedule2.locked_at(current_block).
The dispatch origin for this call must be Signed.
- schedule1_index: index of the first schedule to merge.
- schedule2_index: index of the second schedule to merge.

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: `MultiAddress`)

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(target: `MultiAddress`, schedule: `PalletVestingVestingInfo`)

interface: api.tx.vesting.vestedTransfer
summary: Create a vested transfer.

The dispatch origin for this call must be Signed.
- target: The account receiving the vested funds.
- schedule: The vesting schedule attached to the transfer.
Emits VestingCreated.

NOTE: This will unlock all schedules through the current block.

title: Events

Events are emitted for certain operations on the runtime. The following sections describe the events that are part of the default Substrate runtime.

(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

ApprovalCancelled(`u32`, `AccountId32`, `AccountId32`)

interface: api.events.assets.ApprovalCancelled.is
summary: An approval for account delegate was cancelled by owner.

ApprovedTransfer(`u32`, `AccountId32`, `AccountId32`, `u128`)

interface: api.events.assets.ApprovedTransfer.is
summary: (Additional) funds have been approved for transfer to a destination account.

AssetFrozen(`u32`)

interface: api.events.assets.AssetFrozen.is
summary: Some asset asset_id was frozen.

AssetStatusChanged(`u32`)

interface: api.events.assets.AssetStatusChanged.is
summary: An asset has had its attributes changed by the Force origin.

AssetThawed(`u32`)

interface: api.events.assets.AssetThawed.is
summary: Some asset asset_id was thawed.

Burned(`u32`, `AccountId32`, `u128`)

interface: api.events.assets.Burned.is
summary: Some assets were destroyed.

Created(`u32`, `AccountId32`, `AccountId32`)

interface: api.events.assets.Created.is
summary: Some asset class was created.

Destroyed(`u32`)

interface: api.events.assets.Destroyed.is
summary: An asset class was destroyed.

ForceCreated(`u32`, `AccountId32`)

interface: api.events.assets.ForceCreated.is
summary: Some asset class was force-created.

Frozen(`u32`, `AccountId32`)

interface: api.events.assets.Frozen.is
summary: Some account who was frozen.

Issued(`u32`, `AccountId32`, `u128`)

interface: api.events.assets.Issued.is
summary: Some assets were issued.

MetadataCleared(`u32`)

interface: api.events.assets.MetadataCleared.is
summary: Metadata has been cleared for an asset.

MetadataSet(`u32`, `Bytes`, `Bytes`, `u8`, `bool`)

interface: api.events.assets.MetadataSet.is
summary: New metadata has been set for an asset.

OwnerChanged(`u32`, `AccountId32`)

interface: api.events.assets.OwnerChanged.is
summary: The owner changed.

TeamChanged(`u32`, `AccountId32`, `AccountId32`, `AccountId32`)

interface: api.events.assets.TeamChanged.is
summary: The management team changed.

Thawed(`u32`, `AccountId32`)

interface: api.events.assets.Thawed.is
summary: Some account who was thawed.

Transferred(`u32`, `AccountId32`, `AccountId32`, `u128`)

interface: api.events.assets.Transferred.is
summary: Some assets were transferred.

TransferredApproved(`u32`, `AccountId32`, `AccountId32`, `AccountId32`, `u128`)

interface: api.events.assets.TransferredApproved.is
summary: An amount was transferred in its entirety from owner to destination by the approved delegate.

balances

BalanceSet(`AccountId32`, `u128`, `u128`)

interface: api.events.balances.BalanceSet.is
summary: A balance was set by root.

Deposit(`AccountId32`, `u128`)

interface: api.events.balances.Deposit.is
summary: Some amount was deposited (e.g. for transaction fees).

DustLost(`AccountId32`, `u128`)

interface: api.events.balances.DustLost.is
summary: An account was removed whose balance was non-zero but below ExistentialDeposit, resulting in an outright loss.

Endowed(`AccountId32`, `u128`)

interface: api.events.balances.Endowed.is
summary: An account was created with some free balance.

Reserved(`AccountId32`, `u128`)

interface: api.events.balances.Reserved.is
summary: Some balance was reserved (moved from free to reserved).

ReserveRepatriated(`AccountId32`, `AccountId32`, `u128`, `FrameSupportTokensMiscBalanceStatus`)

interface: api.events.balances.ReserveRepatriated.is
summary: Some balance was moved from the reserve of the first account to the second account. Final argument indicates the destination balance type.

Slashed(`AccountId32`, `u128`)

interface: api.events.balances.Slashed.is
summary: Some amount was removed from the account (e.g. for misbehavior).

Transfer(`AccountId32`, `AccountId32`, `u128`)

interface: api.events.balances.Transfer.is
summary: Transfer succeeded.

Unreserved(`AccountId32`, `u128`)

interface: api.events.balances.Unreserved.is
summary: Some balance was unreserved (moved from reserved to free).

Withdraw(`AccountId32`, `u128`)

interface: api.events.balances.Withdraw.is
summary: Some amount was withdrawn from the account (e.g. for transaction fees).

bounties

BountyAwarded(`u32`, `AccountId32`)

interface: api.events.bounties.BountyAwarded.is
summary: A bounty is awarded to a beneficiary.

BountyBecameActive(`u32`)

interface: api.events.bounties.BountyBecameActive.is
summary: A bounty proposal is funded and became active.

BountyCanceled(`u32`)

interface: api.events.bounties.BountyCanceled.is
summary: A bounty is cancelled.

BountyClaimed(`u32`, `u128`, `AccountId32`)

interface: api.events.bounties.BountyClaimed.is
summary: A bounty is claimed by beneficiary.

BountyExtended(`u32`)

interface: api.events.bounties.BountyExtended.is
summary: A bounty expiry is extended.

BountyProposed(`u32`)

interface: api.events.bounties.BountyProposed.is
summary: New bounty proposal.

BountyRejected(`u32`, `u128`)

interface: api.events.bounties.BountyRejected.is
summary: A bounty proposal was rejected; funds were slashed.

childBounties

Added(`u32`, `u32`)

interface: api.events.childBounties.Added.is
summary: A child-bounty is added.

Awarded(`u32`, `u32`, `AccountId32`)

interface: api.events.childBounties.Awarded.is
summary: A child-bounty is awarded to a beneficiary.

Canceled(`u32`, `u32`)

interface: api.events.childBounties.Canceled.is
summary: A child-bounty is cancelled.

Claimed(`u32`, `u32`, `u128`, `AccountId32`)

interface: api.events.childBounties.Claimed.is
summary: A child-bounty is claimed by beneficiary.

collatorSelection

CandidateAdded(`AccountId32`, `u128`)

interface: api.events.collatorSelection.CandidateAdded.is

CandidateRemoved(`AccountId32`)

interface: api.events.collatorSelection.CandidateRemoved.is

NewCandidacyBond(`u128`)

interface: api.events.collatorSelection.NewCandidacyBond.is

NewDesiredCandidates(`u32`)

interface: api.events.collatorSelection.NewDesiredCandidates.is

NewInvulnerables(`Vec<AccountId32>`)

interface: api.events.collatorSelection.NewInvulnerables.is

council

Approved(`H256`)

interface: api.events.council.Approved.is
summary: A motion was approved by the required threshold.

Closed(`H256`, `u32`, `u32`)

interface: api.events.council.Closed.is
summary: A proposal was closed because its threshold was reached or after its duration was up.

Disapproved(`H256`)

interface: api.events.council.Disapproved.is
summary: A motion was not approved by the required threshold.

Executed(`H256`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.council.Executed.is
summary: A motion was executed; result will be Ok if it returned without error.

MemberExecuted(`H256`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.council.MemberExecuted.is
summary: A single member did some action; result will be Ok if it returned without error.

Proposed(`AccountId32`, `u32`, `H256`, `u32`)

interface: api.events.council.Proposed.is
summary: A motion (given hash) has been proposed (by given account) with a threshold (given MemberCount).

Voted(`AccountId32`, `H256`, `bool`, `u32`, `u32`)

interface: api.events.council.Voted.is
summary: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given respectively as MemberCount).

democracy

Blacklisted(`H256`)

interface: api.events.democracy.Blacklisted.is
summary: A proposal_hash has been blacklisted permanently.

Cancelled(`u32`)

interface: api.events.democracy.Cancelled.is
summary: A referendum has been cancelled.

Delegated(`AccountId32`, `AccountId32`)

interface: api.events.democracy.Delegated.is
summary: An account has delegated their vote to another account.

Executed(`u32`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.democracy.Executed.is
summary: A proposal has been enacted.

ExternalTabled()

interface: api.events.democracy.ExternalTabled.is
summary: An external proposal has been tabled.

NotPassed(`u32`)

interface: api.events.democracy.NotPassed.is
summary: A proposal has been rejected by referendum.

Passed(`u32`)

interface: api.events.democracy.Passed.is
summary: A proposal has been approved by referendum.

PreimageInvalid(`H256`, `u32`)

interface: api.events.democracy.PreimageInvalid.is
summary: A proposal could not be executed because its preimage was invalid.

PreimageMissing(`H256`, `u32`)

interface: api.events.democracy.PreimageMissing.is
summary: A proposal could not be executed because its preimage was missing.

PreimageNoted(`H256`, `AccountId32`, `u128`)

interface: api.events.democracy.PreimageNoted.is
summary: A proposal's preimage was noted, and the deposit taken.

PreimageReaped(`H256`, `AccountId32`, `u128`, `AccountId32`)

interface: api.events.democracy.PreimageReaped.is
summary: A registered preimage was removed and the deposit collected by the reaper.

PreimageUsed(`H256`, `AccountId32`, `u128`)

interface: api.events.democracy.PreimageUsed.is
summary: A proposal preimage was removed and used (the deposit was returned).

Proposed(`u32`, `u128`)

interface: api.events.democracy.Proposed.is
summary: A motion has been proposed by a public account.

Seconded(`AccountId32`, `u32`)

interface: api.events.democracy.Seconded.is
summary: An account has secconded a proposal

Started(`u32`, `PalletDemocracyVoteThreshold`)

interface: api.events.democracy.Started.is
summary: A referendum has begun.

Tabled(`u32`, `u128`, `Vec<AccountId32>`)

interface: api.events.democracy.Tabled.is
summary: A public proposal has been tabled for referendum vote.

Undelegated(`AccountId32`)

interface: api.events.democracy.Undelegated.is
summary: An account has cancelled a previous delegation operation.

Vetoed(`AccountId32`, `H256`, `u32`)

interface: api.events.democracy.Vetoed.is
summary: An external proposal has been vetoed.

Voted(`AccountId32`, `u32`, `PalletDemocracyVoteAccountVote`)

interface: api.events.democracy.Voted.is
summary: An account has voted in a referendum

identity

IdentityCleared(`AccountId32`, `u128`)

interface: api.events.identity.IdentityCleared.is
summary: A name was cleared, and the given balance returned.

IdentityKilled(`AccountId32`, `u128`)

interface: api.events.identity.IdentityKilled.is
summary: A name was removed and the given balance slashed.

IdentitySet(`AccountId32`)

interface: api.events.identity.IdentitySet.is
summary: A name was set or reset (which will remove all judgements).

JudgementGiven(`AccountId32`, `u32`)

interface: api.events.identity.JudgementGiven.is
summary: A judgement was given by a registrar.

JudgementRequested(`AccountId32`, `u32`)

interface: api.events.identity.JudgementRequested.is
summary: A judgement was asked from a registrar.

JudgementUnrequested(`AccountId32`, `u32`)

interface: api.events.identity.JudgementUnrequested.is
summary: A judgement request was retracted.

RegistrarAdded(`u32`)

interface: api.events.identity.RegistrarAdded.is
summary: A registrar was added.

SubIdentityAdded(`AccountId32`, `AccountId32`, `u128`)

interface: api.events.identity.SubIdentityAdded.is
summary: A sub-identity was added to an identity and the deposit paid.

SubIdentityRemoved(`AccountId32`, `AccountId32`, `u128`)

interface: api.events.identity.SubIdentityRemoved.is
summary: A sub-identity was removed from an identity and the deposit freed.

SubIdentityRevoked(`AccountId32`, `AccountId32`, `u128`)

interface: api.events.identity.SubIdentityRevoked.is
summary: A sub-identity was cleared, and the given deposit repatriated from the main identity account to the sub-identity account.

lottery

CallsUpdated()

interface: api.events.lottery.CallsUpdated.is
summary: A new set of calls have been set!

LotteryStarted()

interface: api.events.lottery.LotteryStarted.is
summary: A lottery has been started!

TicketBought(`AccountId32`, `(u8,u8)`)

interface: api.events.lottery.TicketBought.is
summary: A ticket has been bought!

Winner(`AccountId32`, `u128`)

interface: api.events.lottery.Winner.is
summary: A winner has been chosen!

multisig

MultisigApproval(`AccountId32`, `PalletMultisigTimepoint`, `AccountId32`, `[u8;32]`)

interface: api.events.multisig.MultisigApproval.is
summary: A multisig operation has been approved by someone.

MultisigCancelled(`AccountId32`, `PalletMultisigTimepoint`, `AccountId32`, `[u8;32]`)

interface: api.events.multisig.MultisigCancelled.is
summary: A multisig operation has been cancelled.

MultisigExecuted(`AccountId32`, `PalletMultisigTimepoint`, `AccountId32`, `[u8;32]`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.multisig.MultisigExecuted.is
summary: A multisig operation has been executed.

NewMultisig(`AccountId32`, `AccountId32`, `[u8;32]`)

interface: api.events.multisig.NewMultisig.is
summary: A new multisig operation has begun.

parachainSystem

DownwardMessagesProcessed(`u64`, `H256`)

interface: api.events.parachainSystem.DownwardMessagesProcessed.is
summary: Downward messages were processed using the given weight.

DownwardMessagesReceived(`u32`)

interface: api.events.parachainSystem.DownwardMessagesReceived.is
summary: Some downward messages have been received and will be processed.

UpgradeAuthorized(`H256`)

interface: api.events.parachainSystem.UpgradeAuthorized.is
summary: An upgrade has been authorized.

ValidationFunctionApplied(`u32`)

interface: api.events.parachainSystem.ValidationFunctionApplied.is
summary: The validation function was applied as of the contained relay chain block number.

ValidationFunctionDiscarded()

interface: api.events.parachainSystem.ValidationFunctionDiscarded.is
summary: The relay-chain aborted the upgrade process.

ValidationFunctionStored()

interface: api.events.parachainSystem.ValidationFunctionStored.is
summary: The validation function has been scheduled to apply.

phragmenElection

CandidateSlashed(`AccountId32`, `u128`)

interface: api.events.phragmenElection.CandidateSlashed.is
summary: A candidate was slashed by amount due to failing to obtain a seat as member or runner-up.

Note that old members and runners-up are also candidates.

ElectionError()

interface: api.events.phragmenElection.ElectionError.is
summary: Internal error happened while trying to perform election.

EmptyTerm()

interface: api.events.phragmenElection.EmptyTerm.is
summary: No (or not enough) candidates existed for this round. This is different from NewTerm(\[\]). See the description of NewTerm.

MemberKicked(`AccountId32`)

interface: api.events.phragmenElection.MemberKicked.is
summary: A member has been removed. This should always be followed by either NewTerm or EmptyTerm.

NewTerm(`Vec<(AccountId32,u128)>`)

interface: api.events.phragmenElection.NewTerm.is
summary: A new term with new_members. This indicates that enough candidates existed to run the election, not that enough have has been elected. The inner value must be examined for this purpose. A NewTerm(\[\]) indicates that some candidates got their bond slashed and none were elected, whilst EmptyTerm means that no candidates existed to begin with.

Renounced(`AccountId32`)

interface: api.events.phragmenElection.Renounced.is
summary: Someone has renounced their candidacy.

SeatHolderSlashed(`AccountId32`, `u128`)

interface: api.events.phragmenElection.SeatHolderSlashed.is
summary: A seat holder was slashed by amount by being forcefully removed from the set.

preimage

Cleared(`H256`)

interface: api.events.preimage.Cleared.is
summary: A preimage has ben cleared.

Noted(`H256`)

interface: api.events.preimage.Noted.is
summary: A preimage has been noted.

Requested(`H256`)

interface: api.events.preimage.Requested.is
summary: A preimage has been requested.

proxy

Announced(`AccountId32`, `AccountId32`, `H256`)

interface: api.events.proxy.Announced.is
summary: An announcement was placed to make a call in the future.

AnonymousCreated(`AccountId32`, `AccountId32`, `PhalaParachainRuntimeProxyType`, `u16`)

interface: api.events.proxy.AnonymousCreated.is
summary: Anonymous account has been created by new proxy with given disambiguation index and proxy type.

ProxyAdded(`AccountId32`, `AccountId32`, `PhalaParachainRuntimeProxyType`, `u32`)

interface: api.events.proxy.ProxyAdded.is
summary: A proxy was added.

ProxyExecuted(`Result<Null, SpRuntimeDispatchError>`)

interface: api.events.proxy.ProxyExecuted.is
summary: A proxy was executed correctly, with the given.

ProxyRemoved(`AccountId32`, `AccountId32`, `PhalaParachainRuntimeProxyType`, `u32`)

interface: api.events.proxy.ProxyRemoved.is
summary: A proxy was removed.

scheduler

CallLookupFailed(`(u32,u32)`, `Option<Bytes>`, `FrameSupportScheduleLookupError`)

interface: api.events.scheduler.CallLookupFailed.is
summary: The call for the provided hash was not found so the task has been aborted.

Canceled(`u32`, `u32`)

interface: api.events.scheduler.Canceled.is
summary: Canceled some task.

Dispatched(`(u32,u32)`, `Option<Bytes>`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.scheduler.Dispatched.is
summary: Dispatched some task.

Scheduled(`u32`, `u32`)

interface: api.events.scheduler.Scheduled.is
summary: Scheduled some task.

session

NewSession(`u32`)

interface: api.events.session.NewSession.is
summary: New session has happened. Note that the argument is the session index, not the block number as the type might suggest.

sudo

KeyChanged(`Option<AccountId32>`)

interface: api.events.sudo.KeyChanged.is
summary: The [sudoer] just switched identity; the old key is supplied if one existed.

Sudid(`Result<Null, SpRuntimeDispatchError>`)

interface: api.events.sudo.Sudid.is
summary: A sudo just took place. [result]

SudoAsDone(`Result<Null, SpRuntimeDispatchError>`)

interface: api.events.sudo.SudoAsDone.is
summary: A sudo just took place. [result]

system

CodeUpdated()

interface: api.events.system.CodeUpdated.is
summary: :code was updated.

ExtrinsicFailed(`SpRuntimeDispatchError`, `FrameSupportWeightsDispatchInfo`)

interface: api.events.system.ExtrinsicFailed.is
summary: An extrinsic failed.

ExtrinsicSuccess(`FrameSupportWeightsDispatchInfo`)

interface: api.events.system.ExtrinsicSuccess.is
summary: An extrinsic completed successfully.

KilledAccount(`AccountId32`)

interface: api.events.system.KilledAccount.is
summary: An account was reaped.

NewAccount(`AccountId32`)

interface: api.events.system.NewAccount.is
summary: A new account was created.

Remarked(`AccountId32`, `H256`)

interface: api.events.system.Remarked.is
summary: On on-chain remark happened.

technicalCommittee

Approved(`H256`)

interface: api.events.technicalCommittee.Approved.is
summary: A motion was approved by the required threshold.

Closed(`H256`, `u32`, `u32`)

interface: api.events.technicalCommittee.Closed.is
summary: A proposal was closed because its threshold was reached or after its duration was up.

Disapproved(`H256`)

interface: api.events.technicalCommittee.Disapproved.is
summary: A motion was not approved by the required threshold.

Executed(`H256`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.technicalCommittee.Executed.is
summary: A motion was executed; result will be Ok if it returned without error.

MemberExecuted(`H256`, `Result<Null, SpRuntimeDispatchError>`)

interface: api.events.technicalCommittee.MemberExecuted.is
summary: A single member did some action; result will be Ok if it returned without error.

Proposed(`AccountId32`, `u32`, `H256`, `u32`)

interface: api.events.technicalCommittee.Proposed.is
summary: A motion (given hash) has been proposed (by given account) with a threshold (given MemberCount).

Voted(`AccountId32`, `H256`, `bool`, `u32`, `u32`)

interface: api.events.technicalCommittee.Voted.is
summary: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given respectively as MemberCount).

technicalMembership

Dummy()

interface: api.events.technicalMembership.Dummy.is
summary: Phantom member, never used.

KeyChanged()

interface: api.events.technicalMembership.KeyChanged.is
summary: One of the members' keys changed.

MemberAdded()

interface: api.events.technicalMembership.MemberAdded.is
summary: The given member was added; see the transaction for who.

MemberRemoved()

interface: api.events.technicalMembership.MemberRemoved.is
summary: The given member was removed; see the transaction for who.

MembersReset()

interface: api.events.technicalMembership.MembersReset.is
summary: The membership was reset; see the transaction for who the new set is.

MembersSwapped()

interface: api.events.technicalMembership.MembersSwapped.is
summary: Two members were swapped; see the transaction for who.

tips

NewTip(`H256`)

interface: api.events.tips.NewTip.is
summary: A new tip suggestion has been opened.

TipClosed(`H256`, `AccountId32`, `u128`)

interface: api.events.tips.TipClosed.is
summary: A tip suggestion has been closed.

TipClosing(`H256`)

interface: api.events.tips.TipClosing.is
summary: A tip suggestion has reached threshold and is closing.

TipRetracted(`H256`)

interface: api.events.tips.TipRetracted.is
summary: A tip suggestion has been retracted.

TipSlashed(`H256`, `AccountId32`, `u128`)

interface: api.events.tips.TipSlashed.is
summary: A tip suggestion has been slashed.

treasury

Awarded(`u32`, `u128`, `AccountId32`)

interface: api.events.treasury.Awarded.is
summary: Some funds have been allocated.

Burnt(`u128`)

interface: api.events.treasury.Burnt.is
summary: Some of our funds have been burnt.

Deposit(`u128`)

interface: api.events.treasury.Deposit.is
summary: Some funds have been deposited.

Proposed(`u32`)

interface: api.events.treasury.Proposed.is
summary: New proposal.

Rejected(`u32`, `u128`)

interface: api.events.treasury.Rejected.is
summary: A proposal was rejected; funds were slashed.

Rollover(`u128`)

interface: api.events.treasury.Rollover.is
summary: Spending has finished; this is the amount that rolls over until next spend.

Spending(`u128`)

interface: api.events.treasury.Spending.is
summary: We have ended a spend period and will now allocate funds.

utility

BatchCompleted()

interface: api.events.utility.BatchCompleted.is
summary: Batch of dispatches completed fully with no error.

BatchCompletedWithErrors()

interface: api.events.utility.BatchCompletedWithErrors.is
summary: Batch of dispatches completed but has errors.

BatchInterrupted(`u32`, `SpRuntimeDispatchError`)

interface: api.events.utility.BatchInterrupted.is
summary: Batch of dispatches did not complete fully. Index of first failing dispatch given, as well as the error.

DispatchedAs(`Result<Null, SpRuntimeDispatchError>`)

interface: api.events.utility.DispatchedAs.is
summary: A call was dispatched.

ItemCompleted()

interface: api.events.utility.ItemCompleted.is
summary: A single item within a Batch of dispatches has completed with no error.

ItemFailed(`SpRuntimeDispatchError`)

interface: api.events.utility.ItemFailed.is
summary: A single item within a Batch of dispatches has completed with error.

vesting

VestingCompleted(`AccountId32`)

interface: api.events.vesting.VestingCompleted.is
summary: An [account] has become fully vested.

VestingUpdated(`AccountId32`, `u128`)

interface: api.events.vesting.VestingUpdated.is
summary: The amount vested has been updated. This could indicate a change in funds available. The balance given is the amount which is left unvested (and thus locked).

title: Errors

This page lists the errors that can be encountered in the different modules.

(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

AlreadyExists

interface: api.errors.assets.AlreadyExists.is
summary: The asset-account already exists.

BadMetadata

interface: api.errors.assets.BadMetadata.is
summary: Invalid metadata given.

BadWitness

interface: api.errors.assets.BadWitness.is
summary: Invalid witness data given.

BalanceLow

interface: api.errors.assets.BalanceLow.is
summary: Account balance must be greater than or equal to the transfer amount.

Frozen

interface: api.errors.assets.Frozen.is
summary: The origin account is frozen.

InUse

interface: api.errors.assets.InUse.is
summary: The asset ID is already taken.

MinBalanceZero

interface: api.errors.assets.MinBalanceZero.is
summary: Minimum balance should be non-zero.

NoAccount

interface: api.errors.assets.NoAccount.is
summary: The account to alter does not exist.

NoDeposit

interface: api.errors.assets.NoDeposit.is
summary: The asset-account doesn't have an associated deposit.

NoPermission

interface: api.errors.assets.NoPermission.is
summary: The signing account has no permission to do the operation.

NoProvider

interface: api.errors.assets.NoProvider.is
summary: Unable to increment the consumer reference counters on the account. Either no provider reference exists to allow a non-zero balance of a non-self-sufficient asset, or the maximum number of consumers has been reached.

Unapproved

interface: api.errors.assets.Unapproved.is
summary: No approval exists that would allow the transfer.

Unknown

interface: api.errors.assets.Unknown.is
summary: The given asset ID is unknown.

WouldBurn

interface: api.errors.assets.WouldBurn.is
summary: The operation would result in funds being burned.

WouldDie

interface: api.errors.assets.WouldDie.is
summary: The source account would not survive the transfer and it needs to stay alive.

authorship

GenesisUncle

interface: api.errors.authorship.GenesisUncle.is
summary: The uncle is genesis.

InvalidUncleParent

interface: api.errors.authorship.InvalidUncleParent.is
summary: The uncle parent not in the chain.

OldUncle

interface: api.errors.authorship.OldUncle.is
summary: The uncle isn't recent enough to be included.

TooHighUncle

interface: api.errors.authorship.TooHighUncle.is
summary: The uncle is too high in chain.

TooManyUncles

interface: api.errors.authorship.TooManyUncles.is
summary: Too many uncles.

UncleAlreadyIncluded

interface: api.errors.authorship.UncleAlreadyIncluded.is
summary: The uncle is already included.

UnclesAlreadySet

interface: api.errors.authorship.UnclesAlreadySet.is
summary: Uncles already set in the block.

balances

DeadAccount

interface: api.errors.balances.DeadAccount.is
summary: Beneficiary account must pre-exist

ExistentialDeposit

interface: api.errors.balances.ExistentialDeposit.is
summary: Value too low to create account due to existential deposit

ExistingVestingSchedule

interface: api.errors.balances.ExistingVestingSchedule.is
summary: A vesting schedule already exists for this account

InsufficientBalance

interface: api.errors.balances.InsufficientBalance.is
summary: Balance too low to send value

KeepAlive

interface: api.errors.balances.KeepAlive.is
summary: Transfer/payment would kill account

LiquidityRestrictions

interface: api.errors.balances.LiquidityRestrictions.is
summary: Account liquidity restrictions prevent withdrawal

TooManyReserves

interface: api.errors.balances.TooManyReserves.is
summary: Number of named reserves exceed MaxReserves

VestingBalance

interface: api.errors.balances.VestingBalance.is
summary: Vesting balance too high to send value

bounties

HasActiveChildBounty

interface: api.errors.bounties.HasActiveChildBounty.is
summary: The bounty cannot be closed because it has active child bounties.

InsufficientProposersBalance

interface: api.errors.bounties.InsufficientProposersBalance.is
summary: Proposer's balance is too low.

InvalidFee

interface: api.errors.bounties.InvalidFee.is
summary: Invalid bounty fee.

InvalidIndex

interface: api.errors.bounties.InvalidIndex.is
summary: No proposal or bounty at that index.

InvalidValue

interface: api.errors.bounties.InvalidValue.is
summary: Invalid bounty value.

PendingPayout

interface: api.errors.bounties.PendingPayout.is
summary: A bounty payout is pending. To cancel the bounty, you must unassign and slash the curator.

Premature

interface: api.errors.bounties.Premature.is
summary: The bounties cannot be claimed/closed because it's still in the countdown period.

ReasonTooBig

interface: api.errors.bounties.ReasonTooBig.is
summary: The reason given is just too big.

RequireCurator

interface: api.errors.bounties.RequireCurator.is
summary: Require bounty curator.

TooManyQueued

interface: api.errors.bounties.TooManyQueued.is
summary: Too many approvals are already queued.

UnexpectedStatus

interface: api.errors.bounties.UnexpectedStatus.is
summary: The bounty status is unexpected.

childBounties

InsufficientBountyBalance

interface: api.errors.childBounties.InsufficientBountyBalance.is
summary: The bounty balance is not enough to add new child-bounty.

ParentBountyNotActive

interface: api.errors.childBounties.ParentBountyNotActive.is
summary: The parent bounty is not in active state.

TooManyChildBounties

interface: api.errors.childBounties.TooManyChildBounties.is
summary: Number of child bounties exceeds limit MaxActiveChildBountyCount.

collatorSelection

AlreadyCandidate

interface: api.errors.collatorSelection.AlreadyCandidate.is
summary: User is already a candidate

AlreadyInvulnerable

interface: api.errors.collatorSelection.AlreadyInvulnerable.is
summary: User is already an Invulnerable

NoAssociatedValidatorId

interface: api.errors.collatorSelection.NoAssociatedValidatorId.is
summary: Account has no associated validator ID

NotCandidate

interface: api.errors.collatorSelection.NotCandidate.is
summary: User is not a candidate

Permission

interface: api.errors.collatorSelection.Permission.is
summary: Permission issue

TooFewCandidates

interface: api.errors.collatorSelection.TooFewCandidates.is
summary: Too few candidates

TooManyCandidates

interface: api.errors.collatorSelection.TooManyCandidates.is
summary: Too many candidates

Unknown

interface: api.errors.collatorSelection.Unknown.is
summary: Unknown error

ValidatorNotRegistered

interface: api.errors.collatorSelection.ValidatorNotRegistered.is
summary: Validator ID is not yet registered

council

AlreadyInitialized

interface: api.errors.council.AlreadyInitialized.is
summary: Members are already initialized!

DuplicateProposal

interface: api.errors.council.DuplicateProposal.is
summary: Duplicate proposals not allowed

DuplicateVote

interface: api.errors.council.DuplicateVote.is
summary: Duplicate vote ignored

NotMember

interface: api.errors.council.NotMember.is
summary: Account is not a member

ProposalMissing

interface: api.errors.council.ProposalMissing.is
summary: Proposal must exist

TooEarly

interface: api.errors.council.TooEarly.is
summary: The close call was made too early, before the end of the voting.

TooManyProposals

interface: api.errors.council.TooManyProposals.is
summary: There can only be a maximum of MaxProposals active proposals.

WrongIndex

interface: api.errors.council.WrongIndex.is
summary: Mismatched index

WrongProposalLength

interface: api.errors.council.WrongProposalLength.is
summary: The given length bound for the proposal was too low.

WrongProposalWeight

interface: api.errors.council.WrongProposalWeight.is
summary: The given weight bound for the proposal was too low.

democracy

AlreadyCanceled

interface: api.errors.democracy.AlreadyCanceled.is
summary: Cannot cancel the same proposal twice

AlreadyDelegating

interface: api.errors.democracy.AlreadyDelegating.is
summary: The account is already delegating.

AlreadyVetoed

interface: api.errors.democracy.AlreadyVetoed.is
summary: Identity may not veto a proposal twice

DuplicatePreimage

interface: api.errors.democracy.DuplicatePreimage.is
summary: Preimage already noted

DuplicateProposal

interface: api.errors.democracy.DuplicateProposal.is
summary: Proposal already made

Imminent

interface: api.errors.democracy.Imminent.is
summary: Imminent

InstantNotAllowed

interface: api.errors.democracy.InstantNotAllowed.is
summary: The instant referendum origin is currently disallowed.

InsufficientFunds

interface: api.errors.democracy.InsufficientFunds.is
summary: Too high a balance was provided that the account cannot afford.

InvalidHash

interface: api.errors.democracy.InvalidHash.is
summary: Invalid hash

MaxVotesReached

interface: api.errors.democracy.MaxVotesReached.is
summary: Maximum number of votes reached.

NoneWaiting

interface: api.errors.democracy.NoneWaiting.is
summary: No proposals waiting

Nonsense

interface: api.errors.democracy.Nonsense.is
summary: Delegation to oneself makes no sense.

NoPermission

interface: api.errors.democracy.NoPermission.is
summary: The actor has no permission to conduct the action.

NoProposal

interface: api.errors.democracy.NoProposal.is
summary: No external proposal

NotDelegating

interface: api.errors.democracy.NotDelegating.is
summary: The account is not currently delegating.

NotImminent

interface: api.errors.democracy.NotImminent.is
summary: Not imminent

NotSimpleMajority

interface: api.errors.democracy.NotSimpleMajority.is
summary: Next external proposal not simple majority

NotVoter

interface: api.errors.democracy.NotVoter.is
summary: The given account did not vote on the referendum.

PreimageInvalid

interface: api.errors.democracy.PreimageInvalid.is
summary: Invalid preimage

PreimageMissing

interface: api.errors.democracy.PreimageMissing.is
summary: Preimage not found

ProposalBlacklisted

interface: api.errors.democracy.ProposalBlacklisted.is
summary: Proposal still blacklisted

ProposalMissing

interface: api.errors.democracy.ProposalMissing.is
summary: Proposal does not exist

ReferendumInvalid

interface: api.errors.democracy.ReferendumInvalid.is
summary: Vote given for invalid referendum

TooEarly

interface: api.errors.democracy.TooEarly.is
summary: Too early

TooManyProposals

interface: api.errors.democracy.TooManyProposals.is
summary: Maximum number of proposals reached.

ValueLow

interface: api.errors.democracy.ValueLow.is
summary: Value too low

VotesExist

interface: api.errors.democracy.VotesExist.is
summary: The account currently has votes attached to it and the operation cannot succeed until these are removed, either through unvote or reap_vote.

WrongUpperBound

interface: api.errors.democracy.WrongUpperBound.is
summary: Invalid upper bound.

identity

AlreadyClaimed

interface: api.errors.identity.AlreadyClaimed.is
summary: Account ID is already named.

EmptyIndex

interface: api.errors.identity.EmptyIndex.is
summary: Empty index.

FeeChanged

interface: api.errors.identity.FeeChanged.is
summary: Fee is changed.

InvalidIndex

interface: api.errors.identity.InvalidIndex.is
summary: The index is invalid.

InvalidJudgement

interface: api.errors.identity.InvalidJudgement.is
summary: Invalid judgement.

InvalidTarget

interface: api.errors.identity.InvalidTarget.is
summary: The target is invalid.

JudgementGiven

interface: api.errors.identity.JudgementGiven.is
summary: Judgement given.

NoIdentity

interface: api.errors.identity.NoIdentity.is
summary: No identity found.

NotFound

interface: api.errors.identity.NotFound.is
summary: Account isn't found.

NotNamed

interface: api.errors.identity.NotNamed.is
summary: Account isn't named.

NotOwned

interface: api.errors.identity.NotOwned.is
summary: Sub-account isn't owned by sender.

NotSub

interface: api.errors.identity.NotSub.is
summary: Sender is not a sub-account.

StickyJudgement

interface: api.errors.identity.StickyJudgement.is
summary: Sticky judgement.

TooManyFields

interface: api.errors.identity.TooManyFields.is
summary: Too many additional fields.

TooManyRegistrars

interface: api.errors.identity.TooManyRegistrars.is
summary: Maximum amount of registrars reached. Cannot add any more.

TooManySubAccounts

interface: api.errors.identity.TooManySubAccounts.is
summary: Too many subs-accounts.

lottery

AlreadyEnded

interface: api.errors.lottery.AlreadyEnded.is
summary: A lottery has already ended.

AlreadyParticipating

interface: api.errors.lottery.AlreadyParticipating.is
summary: You are already participating in the lottery with this call.

EncodingFailed

interface: api.errors.lottery.EncodingFailed.is
summary: Failed to encode calls

InProgress

interface: api.errors.lottery.InProgress.is
summary: A lottery is already in progress.

InvalidCall

interface: api.errors.lottery.InvalidCall.is
summary: The call is not valid for an open lottery.

NotConfigured

interface: api.errors.lottery.NotConfigured.is
summary: A lottery has not been configured.

TooManyCalls

interface: api.errors.lottery.TooManyCalls.is
summary: Too many calls for a single lottery.

multisig

AlreadyApproved

interface: api.errors.multisig.AlreadyApproved.is
summary: Call is already approved by this signatory.

AlreadyStored

interface: api.errors.multisig.AlreadyStored.is
summary: The data to be stored is already stored.

MaxWeightTooLow

interface: api.errors.multisig.MaxWeightTooLow.is
summary: The maximum weight information provided was too low.

MinimumThreshold

interface: api.errors.multisig.MinimumThreshold.is
summary: Threshold must be 2 or greater.

NoApprovalsNeeded

interface: api.errors.multisig.NoApprovalsNeeded.is
summary: Call doesn't need any (more) approvals.

NotFound

interface: api.errors.multisig.NotFound.is
summary: Multisig operation not found when attempting to cancel.

NoTimepoint

interface: api.errors.multisig.NoTimepoint.is
summary: No timepoint was given, yet the multisig operation is already underway.

NotOwner

interface: api.errors.multisig.NotOwner.is
summary: Only the account that originally created the multisig is able to cancel it.

SenderInSignatories

interface: api.errors.multisig.SenderInSignatories.is
summary: The sender was contained in the other signatories; it shouldn't be.

SignatoriesOutOfOrder

interface: api.errors.multisig.SignatoriesOutOfOrder.is
summary: The signatories were provided out of order; they should be ordered.

TooFewSignatories

interface: api.errors.multisig.TooFewSignatories.is
summary: There are too few signatories in the list.

TooManySignatories

interface: api.errors.multisig.TooManySignatories.is
summary: There are too many signatories in the list.

UnexpectedTimepoint

interface: api.errors.multisig.UnexpectedTimepoint.is
summary: A timepoint was given, yet no multisig operation is underway.

WrongTimepoint

interface: api.errors.multisig.WrongTimepoint.is
summary: A different timepoint was given to the multisig operation that is underway.

parachainSystem

HostConfigurationNotAvailable

interface: api.errors.parachainSystem.HostConfigurationNotAvailable.is
summary: The inherent which supplies the host configuration did not run this block

NothingAuthorized

interface: api.errors.parachainSystem.NothingAuthorized.is
summary: No code upgrade has been authorized.

NotScheduled

interface: api.errors.parachainSystem.NotScheduled.is
summary: No validation function upgrade is currently scheduled.

OverlappingUpgrades

interface: api.errors.parachainSystem.OverlappingUpgrades.is
summary: Attempt to upgrade validation function while existing upgrade pending

ProhibitedByPolkadot

interface: api.errors.parachainSystem.ProhibitedByPolkadot.is
summary: Polkadot currently prohibits this parachain from upgrading its validation function

TooBig

interface: api.errors.parachainSystem.TooBig.is
summary: The supplied validation function has compiled into a blob larger than Polkadot is willing to run

Unauthorized

interface: api.errors.parachainSystem.Unauthorized.is
summary: The given code upgrade has not been authorized.

ValidationDataNotAvailable

interface: api.errors.parachainSystem.ValidationDataNotAvailable.is
summary: The inherent which supplies the validation data did not run this block

phragmenElection

DuplicatedCandidate

interface: api.errors.phragmenElection.DuplicatedCandidate.is
summary: Duplicated candidate submission.

InsufficientCandidateFunds

interface: api.errors.phragmenElection.InsufficientCandidateFunds.is
summary: Candidate does not have enough funds.

InvalidRenouncing

interface: api.errors.phragmenElection.InvalidRenouncing.is
summary: The renouncing origin presented a wrong Renouncing parameter.

InvalidReplacement

interface: api.errors.phragmenElection.InvalidReplacement.is
summary: Prediction regarding replacement after member removal is wrong.

InvalidVoteCount

interface: api.errors.phragmenElection.InvalidVoteCount.is
summary: The provided count of number of votes is incorrect.

InvalidWitnessData

interface: api.errors.phragmenElection.InvalidWitnessData.is
summary: The provided count of number of candidates is incorrect.

LowBalance

interface: api.errors.phragmenElection.LowBalance.is
summary: Cannot vote with stake less than minimum balance.

MaximumVotesExceeded

interface: api.errors.phragmenElection.MaximumVotesExceeded.is
summary: Cannot vote more than maximum allowed.

MemberSubmit

interface: api.errors.phragmenElection.MemberSubmit.is
summary: Member cannot re-submit candidacy.

MustBeVoter

interface: api.errors.phragmenElection.MustBeVoter.is
summary: Must be a voter.

NotMember

interface: api.errors.phragmenElection.NotMember.is
summary: Not a member.

NoVotes

interface: api.errors.phragmenElection.NoVotes.is
summary: Must vote for at least one candidate.

ReportSelf

interface: api.errors.phragmenElection.ReportSelf.is
summary: Cannot report self.

RunnerUpSubmit

interface: api.errors.phragmenElection.RunnerUpSubmit.is
summary: Runner cannot re-submit candidacy.

TooManyVotes

interface: api.errors.phragmenElection.TooManyVotes.is
summary: Cannot vote more than candidates.

UnableToPayBond

interface: api.errors.phragmenElection.UnableToPayBond.is
summary: Voter can not pay voting bond.

UnableToVote

interface: api.errors.phragmenElection.UnableToVote.is
summary: Cannot vote when no candidates or members exist.

preimage

AlreadyNoted

interface: api.errors.preimage.AlreadyNoted.is
summary: Preimage has already been noted on-chain.

NotAuthorized

interface: api.errors.preimage.NotAuthorized.is
summary: The user is not authorized to perform this action.

NotNoted

interface: api.errors.preimage.NotNoted.is
summary: The preimage cannot be removed since it has not yet been noted.

NotRequested

interface: api.errors.preimage.NotRequested.is
summary: The preimage request cannot be removed since no outstanding requests exist.

Requested

interface: api.errors.preimage.Requested.is
summary: A preimage may not be removed when there are outstanding requests.

TooLarge

interface: api.errors.preimage.TooLarge.is
summary: Preimage is too large to store on-chain.

proxy

Duplicate

interface: api.errors.proxy.Duplicate.is
summary: Account is already a proxy.

NoPermission

interface: api.errors.proxy.NoPermission.is
summary: Call may not be made by proxy because it may escalate its privileges.

NoSelfProxy

interface: api.errors.proxy.NoSelfProxy.is
summary: Cannot add self as proxy.

NotFound

interface: api.errors.proxy.NotFound.is
summary: Proxy registration not found.

NotProxy

interface: api.errors.proxy.NotProxy.is
summary: Sender is not a proxy of the account to be proxied.

TooMany

interface: api.errors.proxy.TooMany.is
summary: There are too many proxies registered or too many announcements pending.

Unannounced

interface: api.errors.proxy.Unannounced.is
summary: Announcement, if made at all, was made too recently.

Unproxyable

interface: api.errors.proxy.Unproxyable.is
summary: A call which is incompatible with the proxy type's filter was attempted.

scheduler

FailedToSchedule

interface: api.errors.scheduler.FailedToSchedule.is
summary: Failed to schedule a call

NotFound

interface: api.errors.scheduler.NotFound.is
summary: Cannot find the scheduled call.

RescheduleNoChange

interface: api.errors.scheduler.RescheduleNoChange.is
summary: Reschedule failed because it does not change scheduled time.

TargetBlockNumberInPast

interface: api.errors.scheduler.TargetBlockNumberInPast.is
summary: Given target block number is in the past.

session

DuplicatedKey

interface: api.errors.session.DuplicatedKey.is
summary: Registered duplicate key.

InvalidProof

interface: api.errors.session.InvalidProof.is
summary: Invalid ownership proof.

NoAccount

interface: api.errors.session.NoAccount.is
summary: Key setting account is not live, so it's impossible to associate keys.

NoAssociatedValidatorId

interface: api.errors.session.NoAssociatedValidatorId.is
summary: No associated validator ID for account.

NoKeys

interface: api.errors.session.NoKeys.is
summary: No keys are associated with this account.

sudo

RequireSudo

interface: api.errors.sudo.RequireSudo.is
summary: Sender must be the Sudo account

system

CallFiltered

interface: api.errors.system.CallFiltered.is
summary: The origin filter prevent the call to be dispatched.

FailedToExtractRuntimeVersion

interface: api.errors.system.FailedToExtractRuntimeVersion.is
summary: Failed to extract the runtime version from the new runtime.

Either calling Core_version or decoding RuntimeVersion failed.

InvalidSpecName

interface: api.errors.system.InvalidSpecName.is
summary: The name of specification does not match between the current runtime and the new runtime.

NonDefaultComposite

interface: api.errors.system.NonDefaultComposite.is
summary: Suicide called when the account has non-default composite data.

NonZeroRefCount

interface: api.errors.system.NonZeroRefCount.is
summary: There is a non-zero reference count preventing the account from being purged.

SpecVersionNeedsToIncrease

interface: api.errors.system.SpecVersionNeedsToIncrease.is
summary: The specification version is not allowed to decrease between the current runtime and the new runtime.

technicalCommittee

AlreadyInitialized

interface: api.errors.technicalCommittee.AlreadyInitialized.is
summary: Members are already initialized!

DuplicateProposal

interface: api.errors.technicalCommittee.DuplicateProposal.is
summary: Duplicate proposals not allowed

DuplicateVote

interface: api.errors.technicalCommittee.DuplicateVote.is
summary: Duplicate vote ignored

NotMember

interface: api.errors.technicalCommittee.NotMember.is
summary: Account is not a member

ProposalMissing

interface: api.errors.technicalCommittee.ProposalMissing.is
summary: Proposal must exist

TooEarly

interface: api.errors.technicalCommittee.TooEarly.is
summary: The close call was made too early, before the end of the voting.

TooManyProposals

interface: api.errors.technicalCommittee.TooManyProposals.is
summary: There can only be a maximum of MaxProposals active proposals.

WrongIndex

interface: api.errors.technicalCommittee.WrongIndex.is
summary: Mismatched index

WrongProposalLength

interface: api.errors.technicalCommittee.WrongProposalLength.is
summary: The given length bound for the proposal was too low.

WrongProposalWeight

interface: api.errors.technicalCommittee.WrongProposalWeight.is
summary: The given weight bound for the proposal was too low.

technicalMembership

AlreadyMember

interface: api.errors.technicalMembership.AlreadyMember.is
summary: Already a member.

NotMember

interface: api.errors.technicalMembership.NotMember.is
summary: Not a member.

tips

AlreadyKnown

interface: api.errors.tips.AlreadyKnown.is
summary: The tip was already found/started.

NotFinder

interface: api.errors.tips.NotFinder.is
summary: The account attempting to retract the tip is not the finder of the tip.

Premature

interface: api.errors.tips.Premature.is
summary: The tip cannot be claimed/closed because it's still in the countdown period.

ReasonTooBig

interface: api.errors.tips.ReasonTooBig.is
summary: The reason given is just too big.

StillOpen

interface: api.errors.tips.StillOpen.is
summary: The tip cannot be claimed/closed because there are not enough tippers yet.

UnknownTip

interface: api.errors.tips.UnknownTip.is
summary: The tip hash is unknown.

treasury

InsufficientProposersBalance

interface: api.errors.treasury.InsufficientProposersBalance.is
summary: Proposer's balance is too low.

InvalidIndex

interface: api.errors.treasury.InvalidIndex.is
summary: No proposal or bounty at that index.

ProposalNotApproved

interface: api.errors.treasury.ProposalNotApproved.is
summary: Proposal has not been approved.

TooManyApprovals

interface: api.errors.treasury.TooManyApprovals.is
summary: Too many approvals in the queue.

utility

TooManyCalls

interface: api.errors.utility.TooManyCalls.is
summary: Too many calls batched.

vesting

AmountLow

interface: api.errors.vesting.AmountLow.is
summary: Amount being transferred is too low to create a vesting schedule.

AtMaxVestingSchedules

interface: api.errors.vesting.AtMaxVestingSchedules.is
summary: The account already has MaxVestingSchedules count of schedules and thus cannot add another one. Consider merging existing schedules in order to add another.

InvalidScheduleParams

interface: api.errors.vesting.InvalidScheduleParams.is
summary: Failed to create a new schedule because some parameter was invalid.

NotVesting

interface: api.errors.vesting.NotVesting.is
summary: The account given is not vesting.

ScheduleIndexOutOfBounds

interface: api.errors.vesting.ScheduleIndexOutOfBounds.is
summary: An index was out of bounds of the vesting schedules.

title: JSON-RPC

The following sections contain RPC methods that are Remote Calls available by default and allow you to interact with the actual node, query, and submit.

author
babe
beefy
chain
childstate
contracts
dev
engine
eth
eth/net
eth/web3
grandpa
mmr
offchain
payment
rpc
state
syncstate
system

author

hasKey(publicKey: `Bytes`, keyType: `Text`): `bool`

interface: api.rpc.author.hasKey
jsonrpc: author_hasKey
summary: Returns true if the keystore has private keys for the given public key and key type.

hasSessionKeys(sessionKeys: `Bytes`): `bool`

interface: api.rpc.author.hasSessionKeys
jsonrpc: author_hasSessionKeys
summary: Returns true if the keystore has private keys for the given session public keys.

insertKey(keyType: `Text`, suri: `Text`, publicKey: `Bytes`): `Bytes`

interface: api.rpc.author.insertKey
jsonrpc: author_insertKey
summary: Insert a key into the keystore.

pendingExtrinsics(): `Vec<Extrinsic>`

interface: api.rpc.author.pendingExtrinsics
jsonrpc: author_pendingExtrinsics
summary: Returns all pending extrinsics, potentially grouped by sender

removeExtrinsic(bytesOrHash: `Vec<ExtrinsicOrHash>`): `Vec<Hash>`

interface: api.rpc.author.removeExtrinsic
jsonrpc: author_removeExtrinsic
summary: Remove given extrinsic from the pool and temporarily ban it to prevent reimporting

rotateKeys(): `Bytes`

interface: api.rpc.author.rotateKeys
jsonrpc: author_rotateKeys
summary: Generate new session keys and returns the corresponding public keys

submitAndWatchExtrinsic(extrinsic: `Extrinsic`): `ExtrinsicStatus`

interface: api.rpc.author.submitAndWatchExtrinsic
jsonrpc: author_submitAndWatchExtrinsic
summary: Submit and subscribe to watch an extrinsic until unsubscribed

submitExtrinsic(extrinsic: `Extrinsic`): `Hash`

interface: api.rpc.author.submitExtrinsic
jsonrpc: author_submitExtrinsic
summary: Submit a fully formatted extrinsic for block inclusion

babe

epochAuthorship(): `HashMap<AuthorityId, EpochAuthorship>`

interface: api.rpc.babe.epochAuthorship
jsonrpc: babe_epochAuthorship
summary: Returns data about which slots (primary or secondary) can be claimed in the current epoch with the keys in the keystore

beefy

getFinalizedHead(): `H256`

interface: api.rpc.beefy.getFinalizedHead
jsonrpc: beefy_getFinalizedHead
summary: Returns hash of the latest BEEFY finalized block as seen by this client.

subscribeJustifications(): `BeefySignedCommitment`

interface: api.rpc.beefy.subscribeJustifications
jsonrpc: beefy_subscribeJustifications
summary: Returns the block most recently finalized by BEEFY, alongside side its justification.

chain

getBlock(hash?: `BlockHash`): `SignedBlock`

interface: api.rpc.chain.getBlock
jsonrpc: chain_getBlock
summary: Get header and body of a relay chain block

getBlockHash(blockNumber?: `BlockNumber`): `BlockHash`

interface: api.rpc.chain.getBlockHash
jsonrpc: chain_getBlockHash
summary: Get the block hash for a specific block

getFinalizedHead(): `BlockHash`

interface: api.rpc.chain.getFinalizedHead
jsonrpc: chain_getFinalizedHead
summary: Get hash of the last finalized block in the canon chain

getHeader(hash?: `BlockHash`): `Header`

interface: api.rpc.chain.getHeader
jsonrpc: chain_getHeader
summary: Retrieves the header for a specific block

subscribeAllHeads(): `Header`

interface: api.rpc.chain.subscribeAllHeads
jsonrpc: chain_subscribeAllHeads
summary: Retrieves the newest header via subscription

subscribeFinalizedHeads(): `Header`

interface: api.rpc.chain.subscribeFinalizedHeads
jsonrpc: chain_subscribeFinalizedHeads
summary: Retrieves the best finalized header via subscription

subscribeNewHeads(): `Header`

interface: api.rpc.chain.subscribeNewHeads
jsonrpc: chain_subscribeNewHeads
summary: Retrieves the best header via subscription

childstate

getKeys(childKey: `PrefixedStorageKey`, prefix: `StorageKey`, at?: `Hash`): `Vec<StorageKey>`

interface: api.rpc.childstate.getKeys
jsonrpc: childstate_getKeys
summary: Returns the keys with prefix from a child storage, leave empty to get all the keys

getKeysPaged(childKey: `PrefixedStorageKey`, prefix: `StorageKey`, count: `u32`, startKey?: `StorageKey`, at?: `Hash`): `Vec<StorageKey>`

interface: api.rpc.childstate.getKeysPaged
jsonrpc: childstate_getKeysPaged
summary: Returns the keys with prefix from a child storage with pagination support

getStorage(childKey: `PrefixedStorageKey`, key: `StorageKey`, at?: `Hash`): `Option<StorageData>`

interface: api.rpc.childstate.getStorage
jsonrpc: childstate_getStorage
summary: Returns a child storage entry at a specific block state

getStorageEntries(childKey: `PrefixedStorageKey`, keys: `Vec<StorageKey>`, at?: `Hash`): `Vec<Option<StorageData>>`

interface: api.rpc.childstate.getStorageEntries
jsonrpc: childstate_getStorageEntries
summary: Returns child storage entries for multiple keys at a specific block state

getStorageHash(childKey: `PrefixedStorageKey`, key: `StorageKey`, at?: `Hash`): `Option<Hash>`

interface: api.rpc.childstate.getStorageHash
jsonrpc: childstate_getStorageHash
summary: Returns the hash of a child storage entry at a block state

getStorageSize(childKey: `PrefixedStorageKey`, key: `StorageKey`, at?: `Hash`): `Option<u64>`

interface: api.rpc.childstate.getStorageSize
jsonrpc: childstate_getStorageSize
summary: Returns the size of a child storage entry at a block state

contracts

call(callRequest: `ContractCallRequest`, at?: `BlockHash`): `ContractExecResult`

interface: api.rpc.contracts.call
jsonrpc: contracts_call
summary: Executes a call to a contract

getStorage(address: `AccountId`, key: `H256`, at?: `BlockHash`): `Option<Bytes>`

interface: api.rpc.contracts.getStorage
jsonrpc: contracts_getStorage
summary: Returns the value under a specified storage key in a contract

instantiate(request: `InstantiateRequest`, at?: `BlockHash`): `ContractInstantiateResult`

interface: api.rpc.contracts.instantiate
jsonrpc: contracts_instantiate
summary: Instantiate a new contract

rentProjection(address: `AccountId`, at?: `BlockHash`): `Option<BlockNumber>`

interface: api.rpc.contracts.rentProjection
jsonrpc: contracts_rentProjection
summary: Returns the projected time a given contract will be able to sustain paying its rent

uploadCode(uploadRequest: `CodeUploadRequest`, at?: `BlockHash`): `CodeUploadResult`

interface: api.rpc.contracts.uploadCode
jsonrpc: contracts_upload_code
summary: Upload new code without instantiating a contract from it

dev

getBlockStats(at: `Hash`): `Option<BlockStats>`

interface: api.rpc.dev.getBlockStats
jsonrpc: dev_getBlockStats
summary: Reexecute the specified block_hash and gather statistics while doing so

engine

createBlock(createEmpty: `bool`, finalize: `bool`, parentHash?: `BlockHash`): `CreatedBlock`

interface: api.rpc.engine.createBlock
jsonrpc: engine_createBlock
summary: Instructs the manual-seal authorship task to create a new block

finalizeBlock(hash: `BlockHash`, justification?: `Justification`): `bool`

interface: api.rpc.engine.finalizeBlock
jsonrpc: engine_finalizeBlock
summary: Instructs the manual-seal authorship task to finalize a block

eth

accounts(): `Vec<H160>`

interface: api.rpc.eth.accounts
jsonrpc: eth_accounts
summary: Returns accounts list.

blockNumber(): `U256`

interface: api.rpc.eth.blockNumber
jsonrpc: eth_blockNumber
summary: Returns the blockNumber

call(request: `EthCallRequest`, number?: `BlockNumber`): `Bytes`

interface: api.rpc.eth.call
jsonrpc: eth_call
summary: Call contract, returning the output data.

chainId(): `U64`

interface: api.rpc.eth.chainId
jsonrpc: eth_chainId
summary: Returns the chain ID used for transaction signing at the current best block. None is returned if not available.

coinbase(): `H160`

interface: api.rpc.eth.coinbase
jsonrpc: eth_coinbase
summary: Returns block author.

estimateGas(request: `EthCallRequest`, number?: `BlockNumber`): `U256`

interface: api.rpc.eth.estimateGas
jsonrpc: eth_estimateGas
summary: Estimate gas needed for execution of given contract.

gasPrice(): `U256`

interface: api.rpc.eth.gasPrice
jsonrpc: eth_gasPrice
summary: Returns current gas price.

getBalance(address: `H160`, number?: `BlockNumber`): `U256`

interface: api.rpc.eth.getBalance
jsonrpc: eth_getBalance
summary: Returns balance of the given account.

getBlockByHash(hash: `H256`, full: `bool`): `Option<EthRichBlock>`

interface: api.rpc.eth.getBlockByHash
jsonrpc: eth_getBlockByHash
summary: Returns block with given hash.

getBlockByNumber(block: `BlockNumber`, full: `bool`): `Option<EthRichBlock>`

interface: api.rpc.eth.getBlockByNumber
jsonrpc: eth_getBlockByNumber
summary: Returns block with given number.

getBlockTransactionCountByHash(hash: `H256`): `U256`

interface: api.rpc.eth.getBlockTransactionCountByHash
jsonrpc: eth_getBlockTransactionCountByHash
summary: Returns the number of transactions in a block with given hash.

getBlockTransactionCountByNumber(block: `BlockNumber`): `U256`

interface: api.rpc.eth.getBlockTransactionCountByNumber
jsonrpc: eth_getBlockTransactionCountByNumber
summary: Returns the number of transactions in a block with given block number.

getCode(address: `H160`, number?: `BlockNumber`): `Bytes`

interface: api.rpc.eth.getCode
jsonrpc: eth_getCode
summary: Returns the code at given address at given time (block number).

getFilterChanges(index: `U256`): `EthFilterChanges`

interface: api.rpc.eth.getFilterChanges
jsonrpc: eth_getFilterChanges
summary: Returns filter changes since last poll.

getFilterLogs(index: `U256`): `Vec<EthLog>`

interface: api.rpc.eth.getFilterLogs
jsonrpc: eth_getFilterLogs
summary: Returns all logs matching given filter (in a range 'from' - 'to').

getLogs(filter: `EthFilter`): `Vec<EthLog>`

interface: api.rpc.eth.getLogs
jsonrpc: eth_getLogs
summary: Returns logs matching given filter object.

getProof(address: `H160`, storageKeys: `Vec<H256>`, number: `BlockNumber`): `EthAccount`

interface: api.rpc.eth.getProof
jsonrpc: eth_getProof
summary: Returns proof for account and storage.

getStorageAt(address: `H160`, index: `U256`, number?: `BlockNumber`): `H256`

interface: api.rpc.eth.getStorageAt
jsonrpc: eth_getStorageAt
summary: Returns content of the storage at given address.

getTransactionByBlockHashAndIndex(hash: `H256`, index: `U256`): `EthTransaction`

interface: api.rpc.eth.getTransactionByBlockHashAndIndex
jsonrpc: eth_getTransactionByBlockHashAndIndex
summary: Returns transaction at given block hash and index.

getTransactionByBlockNumberAndIndex(number: `BlockNumber`, index: `U256`): `EthTransaction`

interface: api.rpc.eth.getTransactionByBlockNumberAndIndex
jsonrpc: eth_getTransactionByBlockNumberAndIndex
summary: Returns transaction by given block number and index.

getTransactionByHash(hash: `H256`): `EthTransaction`

interface: api.rpc.eth.getTransactionByHash
jsonrpc: eth_getTransactionByHash
summary: Get transaction by its hash.

getTransactionCount(hash: `H256`, number?: `BlockNumber`): `U256`

interface: api.rpc.eth.getTransactionCount
jsonrpc: eth_getTransactionCount
summary: Returns the number of transactions sent from given address at given time (block number).

getTransactionReceipt(hash: `H256`): `EthReceipt`

interface: api.rpc.eth.getTransactionReceipt
jsonrpc: eth_getTransactionReceipt
summary: Returns transaction receipt by transaction hash.

getUncleByBlockHashAndIndex(hash: `H256`, index: `U256`): `EthRichBlock`

interface: api.rpc.eth.getUncleByBlockHashAndIndex
jsonrpc: eth_getUncleByBlockHashAndIndex
summary: Returns an uncles at given block and index.

getUncleByBlockNumberAndIndex(number: `BlockNumber`, index: `U256`): `EthRichBlock`

interface: api.rpc.eth.getUncleByBlockNumberAndIndex
jsonrpc: eth_getUncleByBlockNumberAndIndex
summary: Returns an uncles at given block and index.

getUncleCountByBlockHash(hash: `H256`): `U256`

interface: api.rpc.eth.getUncleCountByBlockHash
jsonrpc: eth_getUncleCountByBlockHash
summary: Returns the number of uncles in a block with given hash.

getUncleCountByBlockNumber(number: `BlockNumber`): `U256`

interface: api.rpc.eth.getUncleCountByBlockNumber
jsonrpc: eth_getUncleCountByBlockNumber
summary: Returns the number of uncles in a block with given block number.

getWork(): `EthWork`

interface: api.rpc.eth.getWork
jsonrpc: eth_getWork
summary: Returns the hash of the current block, the seedHash, and the boundary condition to be met.

hashrate(): `U256`

interface: api.rpc.eth.hashrate
jsonrpc: eth_hashrate
summary: Returns the number of hashes per second that the node is mining with.

mining(): `bool`

interface: api.rpc.eth.mining
jsonrpc: eth_mining
summary: Returns true if client is actively mining new blocks.

newBlockFilter(): `U256`

interface: api.rpc.eth.newBlockFilter
jsonrpc: eth_newBlockFilter
summary: Returns id of new block filter.

newFilter(filter: `EthFilter`): `U256`

interface: api.rpc.eth.newFilter
jsonrpc: eth_newFilter
summary: Returns id of new filter.

newPendingTransactionFilter(): `U256`

interface: api.rpc.eth.newPendingTransactionFilter
jsonrpc: eth_newPendingTransactionFilter
summary: Returns id of new block filter.

protocolVersion(): `u64`

interface: api.rpc.eth.protocolVersion
jsonrpc: eth_protocolVersion
summary: Returns protocol version encoded as a string (quotes are necessary).

sendRawTransaction(bytes: `Bytes`): `H256`

interface: api.rpc.eth.sendRawTransaction
jsonrpc: eth_sendRawTransaction
summary: Sends signed transaction, returning its hash.

sendTransaction(tx: `EthTransactionRequest`): `H256`

interface: api.rpc.eth.sendTransaction
jsonrpc: eth_sendTransaction
summary: Sends transaction; will block waiting for signer to return the transaction hash

submitHashrate(index: `U256`, hash: `H256`): `bool`

interface: api.rpc.eth.submitHashrate
jsonrpc: eth_submitHashrate
summary: Used for submitting mining hashrate.

submitWork(nonce: `H64`, headerHash: `H256`, mixDigest: `H256`): `bool`

interface: api.rpc.eth.submitWork
jsonrpc: eth_submitWork
summary: Used for submitting a proof-of-work solution.

subscribe(kind: `EthSubKind`, params?: `EthSubParams`): `Null`

interface: api.rpc.eth.subscribe
jsonrpc: eth_subscribe
summary: Subscribe to Eth subscription.

syncing(): `EthSyncStatus`

interface: api.rpc.eth.syncing
jsonrpc: eth_syncing
summary: Returns an object with data about the sync status or false.

uninstallFilter(index: `U256`): `bool`

interface: api.rpc.eth.uninstallFilter
jsonrpc: eth_uninstallFilter
summary: Uninstalls filter.

eth/net

listening(): `bool`

interface: api.rpc.net.listening
jsonrpc: net_listening
summary: Returns true if client is actively listening for network connections. Otherwise false.

peerCount(): `String`

interface: api.rpc.net.peerCount
jsonrpc: net_peerCount
summary: Returns number of peers connected to node.

version(): `String`

interface: api.rpc.net.version
jsonrpc: net_version
summary: Returns protocol version.

eth/web3

clientVersion(): `String`

interface: api.rpc.web3.clientVersion
jsonrpc: web3_clientVersion
summary: Returns current client version.

sha3(data: `Bytes`): `H256`

interface: api.rpc.web3.sha3
jsonrpc: web3_sha3
summary: Returns sha3 of the given data

grandpa

proveFinality(blockNumber: `BlockNumber`): `Option<EncodedFinalityProofs>`

interface: api.rpc.grandpa.proveFinality
jsonrpc: grandpa_proveFinality
summary: Prove finality for the given block number, returning the Justification for the last block in the set.

roundState(): `ReportedRoundStates`

interface: api.rpc.grandpa.roundState
jsonrpc: grandpa_roundState
summary: Returns the state of the current best round state as well as the ongoing background rounds

subscribeJustifications(): `JustificationNotification`

interface: api.rpc.grandpa.subscribeJustifications
jsonrpc: grandpa_subscribeJustifications
summary: Subscribes to grandpa justifications

mmr

generateBatchProof(leafIndices: `Vec<u64>`, at?: `BlockHash`): `MmrLeafProof`

interface: api.rpc.mmr.generateBatchProof
jsonrpc: mmr_generateBatchProof
summary: Generate MMR proof for the given leaf indices.

generateProof(leafIndex: `u64`, at?: `BlockHash`): `MmrLeafBatchProof`

interface: api.rpc.mmr.generateProof
jsonrpc: mmr_generateProof
summary: Generate MMR proof for given leaf index.

offchain

localStorageGet(kind: `StorageKind`, key: `Bytes`): `Option<Bytes>`

interface: api.rpc.offchain.localStorageGet
jsonrpc: offchain_localStorageGet
summary: Get offchain local storage under given key and prefix

localStorageSet(kind: `StorageKind`, key: `Bytes`, value: `Bytes`): `Null`

interface: api.rpc.offchain.localStorageSet
jsonrpc: offchain_localStorageSet
summary: Set offchain local storage under given key and prefix

payment

queryFeeDetails(extrinsic: `Bytes`, at?: `BlockHash`): `FeeDetails`

interface: api.rpc.payment.queryFeeDetails
jsonrpc: payment_queryFeeDetails
summary: Query the detailed fee of a given encoded extrinsic

queryInfo(extrinsic: `Bytes`, at?: `BlockHash`): `RuntimeDispatchInfo`

interface: api.rpc.payment.queryInfo
jsonrpc: payment_queryInfo
summary: Retrieves the fee information for an encoded extrinsic

rpc

methods(): `RpcMethods`

interface: api.rpc.rpc.methods
jsonrpc: rpc_methods
summary: Retrieves the list of RPC methods that are exposed by the node

state

call(method: `Text`, data: `Bytes`, at?: `BlockHash`): `Bytes`

interface: api.rpc.state.call
jsonrpc: state_call
summary: Perform a call to a builtin on the chain

getChildKeys(childStorageKey: `StorageKey`, childDefinition: `StorageKey`, childType: `u32`, key: `StorageKey`, at?: `BlockHash`): `Vec<StorageKey>`

interface: api.rpc.state.getChildKeys
jsonrpc: state_getChildKeys
summary: Retrieves the keys with prefix of a specific child storage

getChildReadProof(childStorageKey: `PrefixedStorageKey`, keys: `Vec<StorageKey>`, at?: `BlockHash`): `ReadProof`

interface: api.rpc.state.getChildReadProof
jsonrpc: state_getChildReadProof
summary: Returns proof of storage for child key entries at a specific block state.

getChildStorage(childStorageKey: `StorageKey`, childDefinition: `StorageKey`, childType: `u32`, key: `StorageKey`, at?: `BlockHash`): `StorageData`

interface: api.rpc.state.getChildStorage
jsonrpc: state_getChildStorage
summary: Retrieves the child storage for a key

getChildStorageHash(childStorageKey: `StorageKey`, childDefinition: `StorageKey`, childType: `u32`, key: `StorageKey`, at?: `BlockHash`): `Hash`

interface: api.rpc.state.getChildStorageHash
jsonrpc: state_getChildStorageHash
summary: Retrieves the child storage hash

getChildStorageSize(childStorageKey: `StorageKey`, childDefinition: `StorageKey`, childType: `u32`, key: `StorageKey`, at?: `BlockHash`): `u64`

interface: api.rpc.state.getChildStorageSize
jsonrpc: state_getChildStorageSize
summary: Retrieves the child storage size

getKeys(key: `StorageKey`, at?: `BlockHash`): `Vec<StorageKey>`

interface: api.rpc.state.getKeys
jsonrpc: state_getKeys
summary: Retrieves the keys with a certain prefix

getKeysPaged(key: `StorageKey`, count: `u32`, startKey?: `StorageKey`, at?: `BlockHash`): `Vec<StorageKey>`

interface: api.rpc.state.getKeysPaged
jsonrpc: state_getKeysPaged
summary: Returns the keys with prefix with pagination support.

getMetadata(at?: `BlockHash`): `Metadata`

interface: api.rpc.state.getMetadata
jsonrpc: state_getMetadata
summary: Returns the runtime metadata

getPairs(prefix: `StorageKey`, at?: `BlockHash`): `Vec<KeyValue>`

interface: api.rpc.state.getPairs
jsonrpc: state_getPairs
summary: Returns the keys with prefix, leave empty to get all the keys (deprecated: Use getKeysPaged)

getReadProof(keys: `Vec<StorageKey>`, at?: `BlockHash`): `ReadProof`

interface: api.rpc.state.getReadProof
jsonrpc: state_getReadProof
summary: Returns proof of storage entries at a specific block state

getRuntimeVersion(at?: `BlockHash`): `RuntimeVersion`

interface: api.rpc.state.getRuntimeVersion
jsonrpc: state_getRuntimeVersion
summary: Get the runtime version

getStorage(key: `StorageKey`, at?: `BlockHash`): `StorageData`

interface: api.rpc.state.getStorage
jsonrpc: state_getStorage
summary: Retrieves the storage for a key

getStorageHash(key: `StorageKey`, at?: `BlockHash`): `Hash`

interface: api.rpc.state.getStorageHash
jsonrpc: state_getStorageHash
summary: Retrieves the storage hash

getStorageSize(key: `StorageKey`, at?: `BlockHash`): `u64`

interface: api.rpc.state.getStorageSize
jsonrpc: state_getStorageSize
summary: Retrieves the storage size

queryStorage(keys: `Vec<StorageKey>`, fromBlock: `Hash`, toBlock?: `BlockHash`): `Vec<StorageChangeSet>`

interface: api.rpc.state.queryStorage
jsonrpc: state_queryStorage
summary: Query historical storage entries (by key) starting from a start block

queryStorageAt(keys: `Vec<StorageKey>`, at?: `BlockHash`): `Vec<StorageChangeSet>`

interface: api.rpc.state.queryStorageAt
jsonrpc: state_queryStorageAt
summary: Query storage entries (by key) starting at block hash given as the second parameter

subscribeRuntimeVersion(): `RuntimeVersion`

interface: api.rpc.state.subscribeRuntimeVersion
jsonrpc: state_subscribeRuntimeVersion
summary: Retrieves the runtime version via subscription

subscribeStorage(keys?: `Vec<StorageKey>`): `StorageChangeSet`

interface: api.rpc.state.subscribeStorage
jsonrpc: state_subscribeStorage
summary: Subscribes to storage changes for the provided keys

traceBlock(block: `Hash`, targets: `Option<Text>`, storageKeys: `Option<Text>`, methods: `Option<Text>`): `TraceBlockResponse`

interface: api.rpc.state.traceBlock
jsonrpc: state_traceBlock
summary: Provides a way to trace the re-execution of a single block

trieMigrationStatus(at?: `BlockHash`): `MigrationStatusResult`

interface: api.rpc.state.trieMigrationStatus
jsonrpc: state_trieMigrationStatus
summary: Check current migration state

syncstate

genSyncSpec(raw: `bool`): `Json`

interface: api.rpc.syncstate.genSyncSpec
jsonrpc: sync_state_genSyncSpec
summary: Returns the json-serialized chainspec running the node, with a sync state.

system

accountNextIndex(accountId: `AccountId`): `Index`

interface: api.rpc.system.accountNextIndex
jsonrpc: system_accountNextIndex
summary: Retrieves the next accountIndex as available on the node

addLogFilter(directives: `Text`): `Null`

interface: api.rpc.system.addLogFilter
jsonrpc: system_addLogFilter
summary: Adds the supplied directives to the current log filter

addReservedPeer(peer: `Text`): `Text`

interface: api.rpc.system.addReservedPeer
jsonrpc: system_addReservedPeer
summary: Adds a reserved peer

chain(): `Text`

interface: api.rpc.system.chain
jsonrpc: system_chain
summary: Retrieves the chain

chainType(): `ChainType`

interface: api.rpc.system.chainType
jsonrpc: system_chainType
summary: Retrieves the chain type

dryRun(extrinsic: `Bytes`, at?: `BlockHash`): `ApplyExtrinsicResult`

interface: api.rpc.system.dryRun
jsonrpc: system_dryRun
summary: Dry run an extrinsic at a given block

health(): `Health`

interface: api.rpc.system.health
jsonrpc: system_health
summary: Return health status of the node

localListenAddresses(): `Vec<Text>`

interface: api.rpc.system.localListenAddresses
jsonrpc: system_localListenAddresses
summary: The addresses include a trailing /p2p/ with the local PeerId, and are thus suitable to be passed to addReservedPeer or as a bootnode address for example

localPeerId(): `Text`

interface: api.rpc.system.localPeerId
jsonrpc: system_localPeerId
summary: Returns the base58-encoded PeerId of the node

name(): `Text`

interface: api.rpc.system.name
jsonrpc: system_name
summary: Retrieves the node name

networkState(): `NetworkState`

interface: api.rpc.system.networkState
jsonrpc: system_networkState
summary: Returns current state of the network

nodeRoles(): `Vec<NodeRole>`

interface: api.rpc.system.nodeRoles
jsonrpc: system_nodeRoles
summary: Returns the roles the node is running as

peers(): `Vec<PeerInfo>`

interface: api.rpc.system.peers
jsonrpc: system_peers
summary: Returns the currently connected peers

properties(): `ChainProperties`

interface: api.rpc.system.properties
jsonrpc: system_properties
summary: Get a custom set of properties as a JSON object, defined in the chain spec

removeReservedPeer(peerId: `Text`): `Text`

interface: api.rpc.system.removeReservedPeer
jsonrpc: system_removeReservedPeer
summary: Remove a reserved peer

reservedPeers(): `Vec<Text>`

interface: api.rpc.system.reservedPeers
jsonrpc: system_reservedPeers
summary: Returns the list of reserved peers

resetLogFilter(): `Null`

interface: api.rpc.system.resetLogFilter
jsonrpc: system_resetLogFilter
summary: Resets the log filter to Substrate defaults

syncState(): `SyncState`

interface: api.rpc.system.syncState
jsonrpc: system_syncState
summary: Returns the state of the syncing of the node

version(): `Text`

interface: api.rpc.system.version
jsonrpc: system_version
summary: Retrieves the version of the node

interface: api.query.assets.account
summary: The holdings of a specific account for a specific asset.

approvals(`u32, AccountId32, AccountId32`): `Option<PalletAssetsApproval>`

interface: api.query.assets.approvals
summary: Approved balance transfers. First balance is the amount approved for transfer. Second is the amount of T::Currency reserved for storing this. First key is the asset ID, second key is the owner and third key is the delegate.

asset(`u32`): `Option<PalletAssetsAssetDetails>`

interface: api.query.assets.asset
summary: Details of an asset.

metadata(`u32`): `PalletAssetsAssetMetadata`

interface: api.query.assets.metadata
summary: Metadata of an asset.

aura

authorities(): `Vec<SpConsensusAuraSr25519AppSr25519Public>`

interface: api.query.aura.authorities
summary: The current authority set.

currentSlot(): `u64`

interface: api.query.aura.currentSlot
summary: The current slot of this block.

This will be set in on_initialize.

auraExt

authorities(): `Vec<SpConsensusAuraSr25519AppSr25519Public>`

interface: api.query.auraExt.authorities
summary: Serves as cache for the authorities.

The authorities in AuRa are overwritten in on_initialize when we switch to a new session, but we require the old authorities to verify the seal when validating a PoV. This will always be updated to the latest AuRa authorities in on_finalize.

authorship

author(): `Option<AccountId32>`

interface: api.query.authorship.author
summary: Author of current block.

didSetUncles(): `bool`

interface: api.query.authorship.didSetUncles
summary: Whether uncles were already set in this block.

uncles(): `Vec<PalletAuthorshipUncleEntryItem>`

interface: api.query.authorship.uncles
summary: Uncles

balances

account(`AccountId32`): `PalletBalancesAccountData`

interface: api.query.balances.account
summary: The Balances pallet example of storing the balance of an account.

Example

nocompile impl pallet_balances::Config for Runtime { type AccountStore = StorageMapShim<Self::Account<Runtime>, frame_system::Provider<Runtime>, AccountId, Self::AccountData<Balance>> }

You can also store the balance of an account in the System pallet.

Example

nocompile impl pallet_balances::Config for Runtime { type AccountStore = System }

But this comes with tradeoffs, storing account balances in the system pallet stores frame_system data alongside the account data contrary to storing account balances in the Balances pallet, which uses a StorageMap to store balances data only. NOTE: This is only used in the case that this pallet is used to store balances.

locks(`AccountId32`): `Vec<PalletBalancesBalanceLock>`

interface: api.query.balances.locks
summary: Any liquidity locks on some account balances. NOTE: Should only be accessed when setting, changing and freeing a lock.

reserves(`AccountId32`): `Vec<PalletBalancesReserveData>`

interface: api.query.balances.reserves
summary: Named reserves on some account balances.

storageVersion(): `PalletBalancesReleases`

interface: api.query.balances.storageVersion
summary: Storage version of the pallet.

This is set to v2.0.0 for new networks.

totalIssuance(): `u128`

interface: api.query.balances.totalIssuance
summary: The total units issued in the system.

bounties

bounties(`u32`): `Option<PalletBountiesBounty>`

interface: api.query.bounties.bounties
summary: Bounties that have been made.

bountyApprovals(): `Vec<u32>`

interface: api.query.bounties.bountyApprovals
summary: Bounty indices that have been approved but not yet funded.

bountyCount(): `u32`

interface: api.query.bounties.bountyCount
summary: Number of bounty proposals that have been made.

bountyDescriptions(`u32`): `Option<Bytes>`

interface: api.query.bounties.bountyDescriptions
summary: The description of each bounty.

childBounties

childBounties(`u32, u32`): `Option<PalletChildBountiesChildBounty>`

interface: api.query.childBounties.childBounties
summary: Child bounties that have been added.

childBountyCount(): `u32`

interface: api.query.childBounties.childBountyCount
summary: Number of total child bounties.

childBountyDescriptions(`u32`): `Option<Bytes>`

interface: api.query.childBounties.childBountyDescriptions
summary: The description of each child-bounty.

childrenCuratorFees(`u32`): `u128`

interface: api.query.childBounties.childrenCuratorFees
summary: The cumulative child-bounty curator fee for each parent bounty.

parentChildBounties(`u32`): `u32`

interface: api.query.childBounties.parentChildBounties
summary: Number of child bounties per parent bounty. Map of parent bounty index to number of child bounties.

collatorSelection

candidacyBond(): `u128`

interface: api.query.collatorSelection.candidacyBond
summary: Fixed amount to deposit to become a collator.

When a collator calls leave_intent they immediately receive the deposit back.

candidates(): `Vec<PalletCollatorSelectionCandidateInfo>`

interface: api.query.collatorSelection.candidates
summary: The (community, limited) collation candidates.

desiredCandidates(): `u32`

interface: api.query.collatorSelection.desiredCandidates
summary: Desired number of candidates.

This should ideally always be less than [Config::MaxCandidates] for weights to be correct.

invulnerables(): `Vec<AccountId32>`

interface: api.query.collatorSelection.invulnerables
summary: The invulnerable, fixed collators.

lastAuthoredBlock(`AccountId32`): `u32`

interface: api.query.collatorSelection.lastAuthoredBlock
summary: Last block authored by collator.

council

members(): `Vec<AccountId32>`

interface: api.query.council.members
summary: The current members of the collective. This is stored sorted (just by value).

prime(): `Option<AccountId32>`

interface: api.query.council.prime
summary: The prime member that helps determine the default vote behavior in case of absentations.

proposalCount(): `u32`

interface: api.query.council.proposalCount
summary: Proposals so far.

proposalOf(`H256`): `Option<Call>`

interface: api.query.council.proposalOf
summary: Actual proposal for a given hash, if it's current.

proposals(): `Vec<H256>`

interface: api.query.council.proposals
summary: The hashes of the active proposals.

voting(`H256`): `Option<PalletCollectiveVotes>`

interface: api.query.council.voting
summary: Votes on a given proposal, if it is ongoing.

democracy

blacklist(`H256`): `Option<(u32,Vec<AccountId32>)>`

interface: api.query.democracy.blacklist
summary: A record of who vetoed what. Maps proposal hash to a possible existent block number (until when it may not be resubmitted) and who vetoed it.

cancellations(`H256`): `bool`

interface: api.query.democracy.cancellations
summary: Record of all proposals that have been subject to emergency cancellation.

depositOf(`u32`): `Option<(Vec<AccountId32>,u128)>`

interface: api.query.democracy.depositOf
summary: Those who have locked a deposit.

TWOX-NOTE: Safe, as increasing integer keys are safe.

lastTabledWasExternal(): `bool`

interface: api.query.democracy.lastTabledWasExternal
summary: True if the last referendum tabled was submitted externally. False if it was a public proposal.

lowestUnbaked(): `u32`

interface: api.query.democracy.lowestUnbaked
summary: The lowest referendum index representing an unbaked referendum. Equal to ReferendumCount if there isn't a unbaked referendum.

nextExternal(): `Option<(H256,PalletDemocracyVoteThreshold)>`

interface: api.query.democracy.nextExternal
summary: The referendum to be tabled whenever it would be valid to table an external proposal. This happens when a referendum needs to be tabled and one of two conditions are met:
- LastTabledWasExternal is false; or
- PublicProps is empty.

preimages(`H256`): `Option<PalletDemocracyPreimageStatus>`

interface: api.query.democracy.preimages
summary: Map of hashes to the proposal preimage, along with who registered it and their deposit. The block number is the block at which it was deposited.

publicPropCount(): `u32`

interface: api.query.democracy.publicPropCount
summary: The number of (public) proposals that have been made so far.

publicProps(): `Vec<(u32,H256,AccountId32)>`

interface: api.query.democracy.publicProps
summary: The public proposals. Unsorted. The second item is the proposal's hash.

referendumCount(): `u32`

interface: api.query.democracy.referendumCount
summary: The next free referendum index, aka the number of referenda started so far.

referendumInfoOf(`u32`): `Option<PalletDemocracyReferendumInfo>`

interface: api.query.democracy.referendumInfoOf
summary: Information concerning any given referendum.

TWOX-NOTE: SAFE as indexes are not under an attacker’s control.

storageVersion(): `Option<PalletDemocracyReleases>`

interface: api.query.democracy.storageVersion
summary: Storage version of the pallet.

New networks start with last version.

votingOf(`AccountId32`): `PalletDemocracyVoteVoting`

interface: api.query.democracy.votingOf
summary: All votes for a particular voter. We store the balance for the number of votes that we have recorded. The second item is the total amount of delegations, that will be added.

TWOX-NOTE: SAFE as AccountIds are crypto hashes anyway.

identity

identityOf(`AccountId32`): `Option<PalletIdentityRegistration>`

interface: api.query.identity.identityOf
summary: Information that is pertinent to identify the entity behind an account.

TWOX-NOTE: OK ― AccountId is a secure hash.

registrars(): `Vec<Option<PalletIdentityRegistrarInfo>>`

interface: api.query.identity.registrars
summary: The set of registrars. Not expected to get very big as can only be added through a special origin (likely a council motion).

The index into this can be cast to RegistrarIndex to get a valid value.

subsOf(`AccountId32`): `(u128,Vec<AccountId32>)`

interface: api.query.identity.subsOf
summary: Alternative "sub" identities of this account.

The first item is the deposit, the second is a vector of the accounts.

TWOX-NOTE: OK ― AccountId is a secure hash.

superOf(`AccountId32`): `Option<(AccountId32,Data)>`

interface: api.query.identity.superOf
summary: The super-identity of an alternative "sub" identity together with its name, within that context. If the account is not some other account's sub-identity, then just None.

lottery

callIndices(): `Vec<(u8,u8)>`

interface: api.query.lottery.callIndices
summary: The calls stored in this pallet to be used in an active lottery if configured by Config::ValidateCall.

lottery(): `Option<PalletLotteryLotteryConfig>`

interface: api.query.lottery.lottery
summary: The configuration for the current lottery.

lotteryIndex(): `u32`

interface: api.query.lottery.lotteryIndex

participants(`AccountId32`): `(u32,Vec<(u8,u8)>)`

interface: api.query.lottery.participants
summary: Users who have purchased a ticket. (Lottery Index, Tickets Purchased)

tickets(`u32`): `Option<AccountId32>`

interface: api.query.lottery.tickets
summary: Each ticket's owner.

May have residual storage from previous lotteries. Use TicketsCount to see which ones are actually valid ticket mappings.

ticketsCount(): `u32`

interface: api.query.lottery.ticketsCount
summary: Total number of tickets sold.

multisig

calls(`[u8;32]`): `Option<(WrapperKeepOpaque<Call>,AccountId32,u128)>`

interface: api.query.multisig.calls

multisigs(`AccountId32, [u8;32]`): `Option<PalletMultisigMultisig>`

interface: api.query.multisig.multisigs
summary: The set of open multisig operations.

parachainInfo

parachainId(): `u32`

interface: api.query.parachainInfo.parachainId

parachainSystem

announcedHrmpMessagesPerCandidate(): `u32`

interface: api.query.parachainSystem.announcedHrmpMessagesPerCandidate
summary: The number of HRMP messages we observed in on_initialize and thus used that number for announcing the weight of on_initialize and on_finalize.

authorizedUpgrade(): `Option<H256>`

interface: api.query.parachainSystem.authorizedUpgrade
summary: The next authorized upgrade, if there is one.

customValidationHeadData(): `Option<Bytes>`

interface: api.query.parachainSystem.customValidationHeadData
summary: A custom head data that should be returned as result of validate_block.

See [Pallet::set_custom_validation_head_data] for more information.

didSetValidationCode(): `bool`

interface: api.query.parachainSystem.didSetValidationCode
summary: Were the validation data set to notify the relay chain?

hostConfiguration(): `Option<PolkadotPrimitivesV2AbridgedHostConfiguration>`

interface: api.query.parachainSystem.hostConfiguration
summary: The parachain host configuration that was obtained from the relay parent.

This field is meant to be updated each block with the validation data inherent. Therefore, before processing of the inherent, e.g. in on_initialize this data may be stale.

This data is also absent from the genesis.

hrmpOutboundMessages(): `Vec<PolkadotCorePrimitivesOutboundHrmpMessage>`

interface: api.query.parachainSystem.hrmpOutboundMessages
summary: HRMP messages that were sent in a block.

This will be cleared in on_initialize of each new block.

hrmpWatermark(): `u32`

interface: api.query.parachainSystem.hrmpWatermark
summary: HRMP watermark that was set in a block.

This will be cleared in on_initialize of each new block.

lastDmqMqcHead(): `H256`

interface: api.query.parachainSystem.lastDmqMqcHead
summary: The last downward message queue chain head we have observed.

This value is loaded before and saved after processing inbound downward messages carried by the system inherent.

lastHrmpMqcHeads(): `BTreeMap<u32, H256>`

interface: api.query.parachainSystem.lastHrmpMqcHeads
summary: The message queue chain heads we have observed per each channel incoming channel.

This value is loaded before and saved after processing inbound downward messages carried by the system inherent.

newValidationCode(): `Option<Bytes>`

interface: api.query.parachainSystem.newValidationCode
summary: Validation code that is set by the parachain and is to be communicated to collator and consequently the relay-chain.

This will be cleared in on_initialize of each new block if no other pallet already set the value.

pendingUpwardMessages(): `Vec<Bytes>`

interface: api.query.parachainSystem.pendingUpwardMessages
summary: Upward messages that are still pending and not yet send to the relay chain.

pendingValidationCode(): `Bytes`

interface: api.query.parachainSystem.pendingValidationCode
summary: In case of a scheduled upgrade, this storage field contains the validation code to be applied.

As soon as the relay chain gives us the go-ahead signal, we will overwrite the :code which will result the next block process with the new validation code. This concludes the upgrade process.

processedDownwardMessages(): `u32`

interface: api.query.parachainSystem.processedDownwardMessages
summary: Number of downward messages processed in a block.

This will be cleared in on_initialize of each new block.

relayStateProof(): `Option<SpTrieStorageProof>`

interface: api.query.parachainSystem.relayStateProof
summary: The state proof for the last relay parent block.

This field is meant to be updated each block with the validation data inherent. Therefore, before processing of the inherent, e.g. in on_initialize this data may be stale.

This data is also absent from the genesis.

relevantMessagingState(): `Option<CumulusPalletParachainSystemRelayStateSnapshotMessagingStateSnapshot>`

interface: api.query.parachainSystem.relevantMessagingState
summary: The snapshot of some state related to messaging relevant to the current parachain as per the relay parent.

This field is meant to be updated each block with the validation data inherent. Therefore, before processing of the inherent, e.g. in on_initialize this data may be stale.

This data is also absent from the genesis.

reservedDmpWeightOverride(): `Option<u64>`

interface: api.query.parachainSystem.reservedDmpWeightOverride
summary: The weight we reserve at the beginning of the block for processing DMP messages. This overrides the amount set in the Config trait.

reservedXcmpWeightOverride(): `Option<u64>`

interface: api.query.parachainSystem.reservedXcmpWeightOverride
summary: The weight we reserve at the beginning of the block for processing XCMP messages. This overrides the amount set in the Config trait.

upgradeRestrictionSignal(): `Option<PolkadotPrimitivesV2UpgradeRestriction>`

interface: api.query.parachainSystem.upgradeRestrictionSignal
summary: An option which indicates if the relay-chain restricts signalling a validation code upgrade. In other words, if this is Some and [NewValidationCode] is Some then the produced candidate will be invalid.

This storage item is a mirror of the corresponding value for the current parachain from the relay-chain. This value is ephemeral which means it doesn't hit the storage. This value is set after the inherent.

upwardMessages(): `Vec<Bytes>`

interface: api.query.parachainSystem.upwardMessages
summary: Upward messages that were sent in a block.

This will be cleared in on_initialize of each new block.

validationData(): `Option<PolkadotPrimitivesV2PersistedValidationData>`

interface: api.query.parachainSystem.validationData
summary: The [PersistedValidationData] set for this block. This value is expected to be set only once per block and it's never stored in the trie.

phragmenElection

candidates(): `Vec<(AccountId32,u128)>`

interface: api.query.phragmenElection.candidates
summary: The present candidate list. A current member or runner-up can never enter this vector and is always implicitly assumed to be a candidate.

Second element is the deposit.

Invariant: Always sorted based on account id.

electionRounds(): `u32`

interface: api.query.phragmenElection.electionRounds
summary: The total number of vote rounds that have happened, excluding the upcoming one.

members(): `Vec<PalletElectionsPhragmenSeatHolder>`

interface: api.query.phragmenElection.members
summary: The current elected members.

Invariant: Always sorted based on account id.

runnersUp(): `Vec<PalletElectionsPhragmenSeatHolder>`

interface: api.query.phragmenElection.runnersUp
summary: The current reserved runners-up.

Invariant: Always sorted based on rank (worse to best). Upon removal of a member, the last (i.e. best) runner-up will be replaced.

voting(`AccountId32`): `PalletElectionsPhragmenVoter`

interface: api.query.phragmenElection.voting
summary: Votes and locked stake of a particular voter.

TWOX-NOTE: SAFE as AccountId is a crypto hash.

preimage

preimageFor(`H256`): `Option<Bytes>`

interface: api.query.preimage.preimageFor
summary: The preimages stored by this pallet.

statusFor(`H256`): `Option<PalletPreimageRequestStatus>`

interface: api.query.preimage.statusFor
summary: The request status of a given hash.

proxy

announcements(`AccountId32`): `(Vec<PalletProxyAnnouncement>,u128)`

interface: api.query.proxy.announcements
summary: The announcements made by the proxy (key).

proxies(`AccountId32`): `(Vec<PalletProxyProxyDefinition>,u128)`

interface: api.query.proxy.proxies
summary: The set of account proxies. Maps the account which has delegated to the accounts which are being delegated to, together with the amount held on deposit.

randomnessCollectiveFlip

randomMaterial(): `Vec<H256>`

interface: api.query.randomnessCollectiveFlip.randomMaterial
summary: Series of block headers from the last 81 blocks that acts as random seed material. This is arranged as a ring buffer with block_number % 81 being the index into the Vec of the oldest hash.

scheduler

agenda(`u32`): `Vec<Option<PalletSchedulerScheduledV3>>`

interface: api.query.scheduler.agenda
summary: Items to be executed, indexed by the block number that they should be executed on.

lookup(`Bytes`): `Option<(u32,u32)>`

interface: api.query.scheduler.lookup
summary: Lookup from identity to the block number and index of the task.

session

currentIndex(): `u32`

interface: api.query.session.currentIndex
summary: Current index of the session.

disabledValidators(): `Vec<u32>`

interface: api.query.session.disabledValidators
summary: Indices of disabled validators.

The vec is always kept sorted so that we can find whether a given validator is disabled using binary search. It gets cleared when on_session_ending returns a new set of identities.

keyOwner(`(SpCoreCryptoKeyTypeId,Bytes)`): `Option<AccountId32>`

interface: api.query.session.keyOwner
summary: The owner of a key. The key is the KeyTypeId + the encoded key.

nextKeys(`AccountId32`): `Option<PhalaParachainRuntimeOpaqueSessionKeys>`

interface: api.query.session.nextKeys
summary: The next session keys for a validator.

queuedChanged(): `bool`

interface: api.query.session.queuedChanged
summary: True if the underlying economic identities or weighting behind the validators has changed in the queued validator set.

queuedKeys(): `Vec<(AccountId32,PhalaParachainRuntimeOpaqueSessionKeys)>`

interface: api.query.session.queuedKeys
summary: The queued keys for the next session. When the next session begins, these keys will be used to determine the validator's session keys.

validators(): `Vec<AccountId32>`

interface: api.query.session.validators
summary: The current set of validators.

substrate

These are well-known keys that are always available to the runtime implementation of any Substrate-based network.

changesTrieConfig(): `u32`

interface: api.query.substrate.changesTrieConfig
summary: Changes trie configuration is stored under this key.

childStorageKeyPrefix(): `u32`

interface: api.query.substrate.childStorageKeyPrefix
summary: Prefix of child storage keys.

code(): `Bytes`

interface: api.query.substrate.code
summary: Wasm code of the runtime.

extrinsicIndex(): `u32`

interface: api.query.substrate.extrinsicIndex
summary: Current extrinsic index (u32) is stored under this key.

heapPages(): `u64`

interface: api.query.substrate.heapPages
summary: Number of wasm linear memory pages required for execution of the runtime.

sudo

key(): `Option<AccountId32>`

interface: api.query.sudo.key
summary: The AccountId of the sudo key.

system

account(`AccountId32`): `FrameSystemAccountInfo`

interface: api.query.system.account
summary: The full account information for a particular account ID.

allExtrinsicsLen(): `Option<u32>`

interface: api.query.system.allExtrinsicsLen
summary: Total length (in bytes) for all extrinsics put together, for the current block.

blockHash(`u32`): `H256`

interface: api.query.system.blockHash
summary: Map of block numbers to block hashes.

blockWeight(): `FrameSupportWeightsPerDispatchClassU64`

interface: api.query.system.blockWeight
summary: The current weight for the block.

digest(): `SpRuntimeDigest`

interface: api.query.system.digest
summary: Digest of the current block, also part of the block header.

eventCount(): `u32`

interface: api.query.system.eventCount
summary: The number of events in the Events<T> list.

events(): `Vec<FrameSystemEventRecord>`

interface: api.query.system.events
summary: Events deposited for the current block.

NOTE: The item is unbound and should therefore never be read on chain. It could otherwise inflate the PoV size of a block.

Events have a large in-memory size. Box the events to not go out-of-memory just in case someone still reads them from within the runtime.

eventTopics(`H256`): `Vec<(u32,u32)>`

interface: api.query.system.eventTopics
summary: Mapping between a topic (represented by T::Hash) and a vector of indexes of events in the <Events<T>> list.

All topic vectors have deterministic storage locations depending on the topic. This allows light-clients to leverage the changes trie storage tracking mechanism and in case of changes fetch the list of events of interest.

The value has the type (T::BlockNumber, EventIndex) because if we used only just the EventIndex then in case if the topic has the same contents on the next block no notification will be triggered thus the event might be lost.

executionPhase(): `Option<FrameSystemPhase>`

interface: api.query.system.executionPhase
summary: The execution phase of the block.

extrinsicCount(): `Option<u32>`

interface: api.query.system.extrinsicCount
summary: Total extrinsics count for the current block.

extrinsicData(`u32`): `Bytes`

interface: api.query.system.extrinsicData
summary: Extrinsics data for the current block (maps an extrinsic's index to its data).

lastRuntimeUpgrade(): `Option<FrameSystemLastRuntimeUpgradeInfo>`

interface: api.query.system.lastRuntimeUpgrade
summary: Stores the spec_version and spec_name of when the last runtime upgrade happened.

number(): `u32`

interface: api.query.system.number
summary: The current block number being processed. Set by execute_block.

parentHash(): `H256`

interface: api.query.system.parentHash
summary: Hash of the previous block.

upgradedToTripleRefCount(): `bool`

interface: api.query.system.upgradedToTripleRefCount
summary: True if we have upgraded so that AccountInfo contains three types of RefCount. False (default) if not.

upgradedToU32RefCount(): `bool`

interface: api.query.system.upgradedToU32RefCount
summary: True if we have upgraded so that type RefCount is u32. False (default) if not.

technicalCommittee

members(): `Vec<AccountId32>`

interface: api.query.technicalCommittee.members
summary: The current members of the collective. This is stored sorted (just by value).

prime(): `Option<AccountId32>`

interface: api.query.technicalCommittee.prime
summary: The prime member that helps determine the default vote behavior in case of absentations.

proposalCount(): `u32`

interface: api.query.technicalCommittee.proposalCount
summary: Proposals so far.

proposalOf(`H256`): `Option<Call>`

interface: api.query.technicalCommittee.proposalOf
summary: Actual proposal for a given hash, if it's current.

proposals(): `Vec<H256>`

interface: api.query.technicalCommittee.proposals
summary: The hashes of the active proposals.

voting(`H256`): `Option<PalletCollectiveVotes>`

interface: api.query.technicalCommittee.voting
summary: Votes on a given proposal, if it is ongoing.

technicalMembership

members(): `Vec<AccountId32>`

interface: api.query.technicalMembership.members
summary: The current membership, stored as an ordered Vec.

prime(): `Option<AccountId32>`

interface: api.query.technicalMembership.prime
summary: The current prime member, if one exists.

timestamp

didUpdate(): `bool`

interface: api.query.timestamp.didUpdate
summary: Did the timestamp get updated in this block?

now(): `u64`

interface: api.query.timestamp.now
summary: Current time for the current block.

tips

reasons(`H256`): `Option<Bytes>`

interface: api.query.tips.reasons
summary: Simple preimage lookup from the reason's hash to the original data. Again, has an insecure enumerable hash since the key is guaranteed to be the result of a secure hash.

tips(`H256`): `Option<PalletTipsOpenTip>`

interface: api.query.tips.tips
summary: TipsMap that are not yet completed. Keyed by the hash of (reason, who) from the value. This has the insecure enumerable hash function since the key itself is already guaranteed to be a secure hash.

transactionPayment

nextFeeMultiplier(): `u128`

interface: api.query.transactionPayment.nextFeeMultiplier

storageVersion(): `PalletTransactionPaymentReleases`

interface: api.query.transactionPayment.storageVersion

treasury

approvals(): `Vec<u32>`

interface: api.query.treasury.approvals
summary: Proposal indices that have been approved but not yet awarded.

proposalCount(): `u32`

interface: api.query.treasury.proposalCount
summary: Number of proposals that have been made.

proposals(`u32`): `Option<PalletTreasuryProposal>`

interface: api.query.treasury.proposals
summary: Proposals that have been made.

vesting

storageVersion(): `PalletVestingReleases`

interface: api.query.vesting.storageVersion
summary: Storage version of the pallet.

New networks start with latest version, as determined by the genesis build.

vesting(`AccountId32`): `Option<Vec<PalletVestingVestingInfo>>`

interface: api.query.vesting.vesting
summary: Information regarding the vesting of a given account.