Subshell >_
Substrate API playground in a Deno π¦ repl, using Polkadot.js extension wallet as remote signer βοΈ. Say goodbye to hardcoded mnemonics / seeds in dev scripts π!
Generated on 2022-06-28T21:18:26Z with 1da7a7b6f44bf351f7fe4e8b2b49001603daada0
Install
Currently Subshell is not intended to be used as a standalone cli command. Therefore installation is not officially supported.
However, if you'd like to try it anyway, first install a recent version of the rust toolchain (follow instructions on https://rustup.rs), then execute:
$ cargo install --locked subshell
and start it from command line:
$ subshell
Subshell 0.1.2
exit using ctrl+d or close()
>
When started without an --eval-file
option, it just behaves like Deno.
You may want to load the init script:
$ subshell repl --unstable --compat --eval-file=https://deno.land/x/subshell@0.0.1/init.ts
Download https://deno.land/x/polkadot@0.0.1/api/types
Download https://deno.land/x/polkadot@0.0.1/types/types
____ _ _ _ _ __
/ ___| _ _| |__ ___| |__ ___| | | \ \
\___ \| | | | '_ \/ __| '_ \ / _ \ | | \ \
___) | |_| | |_) \__ \ | | | __/ | | / / _____
|____/ \__,_|_.__/|___/_| |_|\___|_|_| /_/ |_____|
π¦ Deno 1.23.0
π Wiki https://wiki.subshell.xyz
π Issues https://github.com/btwiuse/subshell/issues
π RPC Provider: wss://rpc.polkadot.io
Custom types: None
api is initializing. Please hold on...
api has been injected into the global object.
Connecting to the Polkadot.js browser wallet extension...
π΄ Polkadot.js extension is not properly setup.
Please install, enable, and add to it at least one keypair to explore all features of Subshell.
π‘ Now you can start exploring the Polkadot.js api in this Deno repl environment! For example:
π check if the api is indeed connected:
> api.isConnected
true
π If it is your first time using Subshell, click the β icon at the top-right corner of the screen
Subshell 0.1.2
exit using ctrl+d or close()
>
Just keep in mind that Subshell won't be able to connect to a remote signer when started from a local terminal.
Please access it from the web ui: https://subshell.xyz
If you want to start the ui locally, visit Development guide
Development guide
π§ UNDER CONSTRUCTION π§
Connect to RPC provider
Append your WebSocket RPC endpoint url starting with ws://
or wss://
to https://subshell.xyz/?rpc=
, for example:
- Polkadot:
https://subshell.xyz/?rpc=wss://polkadot.api.onfinality.io/public-ws
- Kusama:
https://subshell.xyz/?rpc=wss://kusama.api.onfinality.io/public-ws
- Moonbeam:
https://subshell.xyz/?rpc=wss://moonbeam.api.onfinality.io/public-ws
- Acala:
https://subshell.xyz/?rpc=wss://acala-polkadot.api.onfinality.io/public-ws
- Litentry:
https://subshell.xyz/?rpc=wss://acala-polkadot.api.onfinality.io/public-ws
- Parallel:
https://subshell.xyz/?rpc=wss://parallel.api.onfinality.io/public-ws
- Phala:
https://subshell.xyz/?rpc=wss://api.phala.network/ws
- Aleph Zero:
https://subshell.xyz/?rpc=wss://ws.azero.dev
- Darwinia:
https://subshell.xyz/?rpc=wss://rpc.darwinia.network
- ChainX:
https://subshell.xyz/?rpc=wss://mainnet.chainx.org/ws
- Edgeware:
https://subshell.xyz/?rpc=wss://edgeware.api.onfinality.io/public-ws
- NFTMart:
https://subshell.xyz/?rpc=wss://mainnet.nftmart.io/rpc/ws
- ...
Add custom types
Go to Settings > Developer and paste your types definition in json. Then press save and reload the page.
Example types.json:
{
"TransactionInput": {
"parent_output": "Hash",
"signature": "Signature"
},
"TransactionOutput": {
"value": "u128",
"pubkey": "Hash",
"sale": "u32"
},
"Transaction": {
"inputs": "Vec<TransactionInput>",
"outputs": "Vec<TransactionOutput>"
}
}
Subshell API
On start, Subshell creates a global namespace that contains the Subshell public API, defined as:
interface SubshellExtensionBridge {
async selectAccount(): Promise<string|null>;
async web3Accounts(): Promise<InjectedAccountWithMeta[]>;
async signRaw({ address, data }: SignerPayloadRaw): Promise<SignerResult>;
async signPayload(payload: SignerPayloadJSON): Promise<SignerResult>;
}
declare namespace Subshell {
extension?: SubshellExtensionBridge;
}
extension
Subshell.extension
is a variable available only when the remote signer bridge is successfully initiated.
When not started from a web ui, the value is null
.
selectAccount
Subshell.extension.selectAccount
is an utility function for you to select an account address from remote signer. It returns address of the selected account as a string, or null
if cancelled.
Usage:
> await Subshell.extension.selectAccount()
web3Accounts
Subshell.extension.web3Accounts
is a proxy to @polkadot/extension-dapp's web3Accounts
function:
web3Accounts(): Promise<InjectedAccountWithMeta[]>
- returns a list of all the injected accounts, accross all extensions (source in meta)
If you have not installed the polkadot-js extension, or haven't imported any account and make them visible to the Subshell app, calling the function will return an empty array:
> await Subshell.extension.web3Accounts()
[]
Otherwise, you will see output like:
> await Subshell.extension.web3Accounts()
[
{
address: "5G9KKUwpghVHB3PUvcdFQrDqVip8eH5BG8sCzDdt19XTztgU",
meta: { genesisHash: "", name: "throwaway", source: "cennznet-extension" },
type: "sr25519"
},
{
address: "5G9KKUwpghVHB3PUvcdFQrDqVip8eH5BG8sCzDdt19XTztgU",
meta: { genesisHash: "", name: "throwaway", source: "polkadot-js" },
type: "sr25519"
}
]
signPayload
Subshell.extension.signPayload
is a proxy to web3FromAddress(address).signer.signPayload
. It is defined to satisfy the Signer interface and should not be used directly.
On startup, if Subshell.extension
is not null
api.setSigner(Subshell.extension)
will be called automatically to set it the default signer.
After that, you can sign with api.sign
or tx.signAndSend
signRaw
Subshell.extension.signRaw
is a proxy to web3FromAddress(address).signer.signRaw
. It is defined to satisfy the Signer interface and should not be used directly.
On startup, if Subshell.extension
is not null
api.setSigner(Subshell.extension)
will be called automatically to set it the default signer.
After that, you can sign with api.sign
or tx.signAndSend
Examples
Many examples here will work just fine outside of Subshell as a regular Deno script, as long as they do not contain any reference to the global Subshell
object. They are included here for educational purposes.
Get node information
π§ UNDER CONSTRUCTION π§
Generate pallet docs
π§ UNDER CONSTRUCTION π§
- assetManager:
- assets:
- assets.create
- assets.forceCreate
- assets.destroy
- assets.mint
- assets.burn
- assets.transfer
- assets.transferKeepAlive
- assets.forceTransfer
- assets.freeze
- assets.thaw
- assets.freezeAsset
- assets.thawAsset
- assets.transferOwnership
- assets.setTeam
- assets.setMetadata
- assets.clearMetadata
- assets.forceSetMetadata
- assets.forceClearMetadata
- assets.forceAssetStatus
- assets.approveTransfer
- assets.cancelApproval
- assets.forceCancelApproval
- assets.transferApproved
- assets.touch
- assets.refund
- authorFilter:
- authorInherent:
- authorMapping:
- balances:
- baseFee:
- councilCollective:
- crowdloanRewards:
- democracy:
- democracy.propose
- democracy.second
- democracy.vote
- democracy.emergencyCancel
- democracy.externalPropose
- democracy.externalProposeMajority
- democracy.externalProposeDefault
- democracy.fastTrack
- democracy.vetoExternal
- democracy.cancelReferendum
- democracy.cancelQueued
- democracy.delegate
- democracy.undelegate
- democracy.clearPublicProposals
- democracy.notePreimage
- democracy.notePreimageOperational
- democracy.noteImminentPreimage
- democracy.noteImminentPreimageOperational
- democracy.reapPreimage
- democracy.unlock
- democracy.removeVote
- democracy.removeOtherVote
- democracy.enactProposal
- democracy.blacklist
- democracy.cancelProposal
- dmpQueue:
- ethereum:
- evm:
- identity:
- identity.addRegistrar
- identity.setIdentity
- identity.setSubs
- identity.clearIdentity
- identity.requestJudgement
- identity.cancelRequest
- identity.setFee
- identity.setAccountId
- identity.setFields
- identity.provideJudgement
- identity.killIdentity
- identity.addSub
- identity.renameSub
- identity.removeSub
- identity.quitSub
- localAssets:
- localAssets.create
- localAssets.forceCreate
- localAssets.destroy
- localAssets.mint
- localAssets.burn
- localAssets.transfer
- localAssets.transferKeepAlive
- localAssets.forceTransfer
- localAssets.freeze
- localAssets.thaw
- localAssets.freezeAsset
- localAssets.thawAsset
- localAssets.transferOwnership
- localAssets.setTeam
- localAssets.setMetadata
- localAssets.clearMetadata
- localAssets.forceSetMetadata
- localAssets.forceClearMetadata
- localAssets.forceAssetStatus
- localAssets.approveTransfer
- localAssets.cancelApproval
- localAssets.forceCancelApproval
- localAssets.transferApproved
- localAssets.touch
- localAssets.refund
- maintenanceMode:
- moonbeamOrbiters:
- parachainStaking:
- parachainStaking.setStakingExpectations
- parachainStaking.setInflation
- parachainStaking.setParachainBondAccount
- parachainStaking.setParachainBondReservePercent
- parachainStaking.setTotalSelected
- parachainStaking.setCollatorCommission
- parachainStaking.setBlocksPerRound
- parachainStaking.joinCandidates
- parachainStaking.scheduleLeaveCandidates
- parachainStaking.executeLeaveCandidates
- parachainStaking.cancelLeaveCandidates
- parachainStaking.goOffline
- parachainStaking.goOnline
- parachainStaking.candidateBondMore
- parachainStaking.scheduleCandidateBondLess
- parachainStaking.executeCandidateBondLess
- parachainStaking.cancelCandidateBondLess
- parachainStaking.delegate
- parachainStaking.scheduleLeaveDelegators
- parachainStaking.executeLeaveDelegators
- parachainStaking.cancelLeaveDelegators
- parachainStaking.scheduleRevokeDelegation
- parachainStaking.delegatorBondMore
- parachainStaking.scheduleDelegatorBondLess
- parachainStaking.executeDelegationRequest
- parachainStaking.cancelDelegationRequest
- parachainSystem:
- polkadotXcm:
- polkadotXcm.send
- polkadotXcm.teleportAssets
- polkadotXcm.reserveTransferAssets
- polkadotXcm.execute
- polkadotXcm.forceXcmVersion
- polkadotXcm.forceDefaultXcmVersion
- polkadotXcm.forceSubscribeVersionNotify
- polkadotXcm.forceUnsubscribeVersionNotify
- polkadotXcm.limitedReserveTransferAssets
- polkadotXcm.limitedTeleportAssets
- proxy:
- scheduler:
- system:
- techCommitteeCollective:
- timestamp:
- treasury:
- utility:
- xTokens:
- xcmTransactor:
assetManager:
assetManager.registerForeignAsset
docs
@ Register new asset with the asset manager
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'asset' β 'MoonbeamRuntimeXcmConfigAssetType' β 'ForeignAssetType' β
β 1 β 'metadata' β 'MoonbeamRuntimeAssetConfigAssetRegistrarMetadata' β 'AssetRegistrarMetadata' β
β 2 β 'minAmount' β 'u128' β 'Balance' β
β 3 β 'isSufficient' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
assetManager.setAssetUnitsPerSecond
docs
@ Change the amount of units we are charging per execution second
@ for a given ForeignAssetType
args
βββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββ€
β 0 β 'assetType' β 'MoonbeamRuntimeXcmConfigAssetType' β 'ForeignAssetType' β
β 1 β 'unitsPerSecond' β 'u128' β 'u128' β
β 2 β 'numAssetsWeightHint' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββ
assetManager.changeExistingAssetType
docs
@ Change the xcm type mapping for a given assetId
@ We also change this if the previous units per second where pointing at the old
@ assetType
args
βββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββ€
β 0 β 'assetId' β 'u128' β 'AssetId' β
β 1 β 'newAssetType' β 'MoonbeamRuntimeXcmConfigAssetType' β 'ForeignAssetType' β
β 2 β 'numAssetsWeightHint' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββ
assetManager.removeSupportedAsset
docs
args
βββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββ€
β 0 β 'assetType' β 'MoonbeamRuntimeXcmConfigAssetType' β 'ForeignAssetType' β
β 1 β 'numAssetsWeightHint' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββ
assetManager.removeExistingAssetType
docs
@ Remove a given assetId -> assetType association
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββΌββββββββββββ€
β 0 β 'assetId' β 'u128' β 'AssetId' β
β 1 β 'numAssetsWeightHint' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββ΄ββββββββββββ
assetManager.registerLocalAsset
docs
@ Register a new local asset
@ No information is stored in this pallet about the local asset
@ The reason is that we dont need to hold a mapping between the multilocation
@ and the local asset, as this conversion is deterministic
@ Further, we dont allow xcm fee payment in local assets
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'creator' β 'AccountId20' β 'AccountId' β
β 1 β 'owner' β 'AccountId20' β 'AccountId' β
β 2 β 'isSufficient' β 'bool' β 'bool' β
β 3 β 'minBalance' β 'u128' β 'Balance' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
assetManager.destroyForeignAsset
docs
@ Destroy a given foreign assetId
@ The weight in this case is the one returned by the trait
@ plus the db writes and reads from removing all the associated
@ data
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββββββββββββββββΌββββββββββββββββββββββββ€
β 0 β 'assetId' β 'u128' β 'AssetId' β
β 1 β 'destroyAssetWitness' β 'PalletAssetsDestroyWitness' β 'AssetDestroyWitness' β
β 2 β 'numAssetsWeightHint' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββ
assetManager.destroyLocalAsset
docs
@ Destroy a given local assetId
@ We do not store anything related to local assets in this pallet other than the counter
@ and the counter is not used for destroying the asset, so no additional db reads/writes
@ to be counter here
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββββββββββββββββΌββββββββββββββββββββββββ€
β 0 β 'assetId' β 'u128' β 'AssetId' β
β 1 β 'destroyAssetWitness' β 'PalletAssetsDestroyWitness' β 'AssetDestroyWitness' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββ
assets:
assets.create
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'admin' β 'AccountId20' β 'LookupSource' β
β 2 β 'minBalance' β 'u128' β 'Balance' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.forceCreate
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'isSufficient' β 'bool' β 'bool' β
β 3 β 'minBalance' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.destroy
docs
@ 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`
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'witness' β 'PalletAssetsDestroyWitness' β 'DestroyWitness' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
assets.mint
docs
@ 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`.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'beneficiary' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.burn
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.transfer
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'target' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.transferKeepAlive
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'target' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.forceTransfer
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'source' β 'AccountId20' β 'LookupSource' β
β 2 β 'dest' β 'AccountId20' β 'LookupSource' β
β 3 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.freeze
docs
@ 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)`
args
βββββββββββ¬ββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.thaw
docs
@ 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)`
args
βββββββββββ¬ββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.freezeAsset
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.thawAsset
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.transferOwnership
docs
@ 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)`
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.setTeam
docs
@ 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)`
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'issuer' β 'AccountId20' β 'LookupSource' β
β 2 β 'admin' β 'AccountId20' β 'LookupSource' β
β 3 β 'freezer' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.setMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'name' β 'Bytes' β 'Bytes' β
β 2 β 'symbol' β 'Bytes' β 'Bytes' β
β 3 β 'decimals' β 'u8' β 'u8' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.clearMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.forceSetMetadata
docs
@ 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.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'name' β 'Bytes' β 'Bytes' β
β 2 β 'symbol' β 'Bytes' β 'Bytes' β
β 3 β 'decimals' β 'u8' β 'u8' β
β 4 β 'isFrozen' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.forceClearMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.forceAssetStatus
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'issuer' β 'AccountId20' β 'LookupSource' β
β 3 β 'admin' β 'AccountId20' β 'LookupSource' β
β 4 β 'freezer' β 'AccountId20' β 'LookupSource' β
β 5 β 'minBalance' β 'Compact<u128>' β 'Balance' β
β 6 β 'isSufficient' β 'bool' β 'bool' β
β 7 β 'isFrozen' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.approveTransfer
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'delegate' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.cancelApproval
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'delegate' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.forceCancelApproval
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'delegate' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.transferApproved
docs
@ 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)`
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'destination' β 'AccountId20' β 'LookupSource' β
β 3 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
assets.touch
docs
@ 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.
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
assets.refund
docs
@ 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.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'allowBurn' β 'bool' β 'bool' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
authorFilter:
authorFilter.setEligible
docs
@ Update the eligible count. Intended to be called by governance.
args
βββββββββββ¬ββββββββ¬ββββββββ¬βββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββΌβββββββββββββββββββββ€
β 0 β 'new' β 'u32' β 'EligibilityValue' β
βββββββββββ΄ββββββββ΄ββββββββ΄βββββββββββββββββββββ
authorInherent:
authorInherent.kickOffAuthorshipValidation
docs
@ This inherent is a workaround to run code after the "real" inherents have executed,
@ but before transactions are executed.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
authorMapping:
authorMapping.addAssociation
docs
@ Register your NimbusId onchain so blocks you author are associated with your account.
@
@ Users who have been (or will soon be) elected active collators in staking,
@ should submit this extrinsic to have their blocks accepted and earn rewards.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'authorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
authorMapping.updateAssociation
docs
@ Change your Mapping.
@
@ This is useful for normal key rotation or for when switching from one physical collator
@ machine to another. No new security deposit is required.
@ This sets keys to new_author_id.into() by default.
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'oldAuthorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
β 1 β 'newAuthorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
authorMapping.clearAssociation
docs
@ Clear your Mapping.
@
@ This is useful when you are no longer an author and would like to re-claim your security
@ deposit.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'authorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
authorMapping.registerKeys
docs
@ Add association and set session keys
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'authorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
β 1 β 'keys' β 'NimbusPrimitivesNimbusCryptoPublic' β 'Keys' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
authorMapping.setKeys
docs
@ Set association and session keys at once.
@
@ This is useful for key rotation to update Nimbus and VRF keys in one call.
@ No new security deposit is required. Will replace `update_association` which is kept
@ now for backwards compatibility reasons.
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'oldAuthorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
β 1 β 'newAuthorId' β 'NimbusPrimitivesNimbusCryptoPublic' β 'NimbusId' β
β 2 β 'newKeys' β 'NimbusPrimitivesNimbusCryptoPublic' β 'Keys' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
balances:
balances.transfer
docs
@ 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.
@
@ # <weight>
@ - Dependent on arguments but not critical, given proper implementations for input config
@ types. See related functions below.
@ - It contains a limited number of reads and writes internally and no complex
@ computation.
@
@ Related functions:
@
@ - `ensure_can_withdraw` is always called internally but has a bounded complexity.
@ - Transferring balances to accounts that did not exist before will cause
@ `T::OnNewAccount::on_new_account` to be called.
@ - Removing enough funds from an account will trigger `T::DustRemoval::on_unbalanced`.
@ - `transfer_keep_alive` works the same way as `transfer`, but has an additional check
@ that the transfer will not kill the origin account.
@ ---------------------------------
@ - Origin account is already in memory, so no DB operations for them.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'AccountId20' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.setBalance
docs
@ 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`.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'AccountId20' β 'LookupSource' β
β 1 β 'newFree' β 'Compact<u128>' β 'Balance' β
β 2 β 'newReserved' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.forceTransfer
docs
@ Exactly as `transfer`, except the origin must be root and the source account may be
@ specified.
@ # <weight>
@ - Same as transfer, but additional read and write because the source account is not
@ assumed to be in the overlay.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'source' β 'AccountId20' β 'LookupSource' β
β 1 β 'dest' β 'AccountId20' β 'LookupSource' β
β 2 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.transferKeepAlive
docs
@ 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.
@
@ [`transfer`]: struct.Pallet.html#method.transfer
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'AccountId20' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.transferAll
docs
@ 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). # <weight>
@ - O(1). Just like transfer, but reading the user's transferable balance first.
@ #</weight>
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'AccountId20' β 'LookupSource' β
β 1 β 'keepAlive' β 'bool' β 'bool' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
balances.forceUnreserve
docs
@ Unreserve some balance from a user by force.
@
@ Can only be called by ROOT.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'AccountId20' β 'LookupSource' β
β 1 β 'amount' β 'u128' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
baseFee:
baseFee.setBaseFeePerGas
docs
args
βββββββββββ¬ββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββΌβββββββββββ€
β 0 β 'fee' β 'U256' β 'U256' β
βββββββββββ΄ββββββββ΄βββββββββ΄βββββββββββ
baseFee.setIsActive
docs
args
βββββββββββ¬βββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'isActive' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄βββββββββ΄βββββββββββ
baseFee.setElasticity
docs
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'elasticity' β 'Permill' β 'Permill' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββ΄ββββββββββββ
councilCollective:
councilCollective.setMembers
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(MP + N)` where:
@ - `M` old-members-count (code- and governance-bounded)
@ - `N` new-members-count (code- and governance-bounded)
@ - `P` proposals-count (code-bounded)
@ - DB:
@ - 1 storage mutation (codec `O(M)` read, `O(N)` write) for reading and writing the
@ members
@ - 1 storage read (codec `O(P)`) for reading the proposals
@ - `P` storage mutations (codec `O(M)`) for updating the votes for each proposal
@ - 1 storage write (codec `O(1)`) for deleting the old `prime` and setting the new one
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'newMembers' β 'Vec<AccountId20>' β 'Vec<AccountId>' β
β 1 β 'prime' β 'Option<AccountId20>' β 'Option<AccountId>' β
β 2 β 'oldCount' β 'u32' β 'MemberCount' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
councilCollective.execute
docs
@ Dispatch a proposal from a member using the `Member` origin.
@
@ Origin must be a member of the collective.
@
@ # <weight>
@ ## Weight
@ - `O(M + P)` where `M` members-count (code-bounded) and `P` complexity of dispatching
@ `proposal`
@ - DB: 1 read (codec `O(M)`) + DB access of `proposal`
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'proposal' β 'Call' β 'Proposal' β
β 1 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
councilCollective.propose
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1)` or `O(B + M + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - branching is influenced by `threshold` where:
@ - `P1` is proposal execution complexity (`threshold < 2`)
@ - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
@ - DB:
@ - 1 storage read `is_member` (codec `O(M)`)
@ - 1 storage read `ProposalOf::contains_key` (codec `O(1)`)
@ - DB accesses influenced by `threshold`:
@ - EITHER storage accesses done by `proposal` (`threshold < 2`)
@ - OR proposal insertion (`threshold <= 2`)
@ - 1 storage mutation `Proposals` (codec `O(P2)`)
@ - 1 storage mutation `ProposalCount` (codec `O(1)`)
@ - 1 storage write `ProposalOf` (codec `O(B)`)
@ - 1 storage write `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'threshold' β 'Compact<u32>' β 'MemberCount' β
β 1 β 'proposal' β 'Call' β 'Proposal' β
β 2 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
councilCollective.vote
docs
@ 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.
@ # <weight>
@ ## Weight
@ - `O(M)` where `M` is members-count (code- and governance-bounded)
@ - DB:
@ - 1 storage read `Members` (codec `O(M)`)
@ - 1 storage mutation `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposal' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'approve' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
councilCollective.close
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1 + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - `P1` is the complexity of `proposal` preimage.
@ - `P2` is proposal-count (code-bounded)
@ - DB:
@ - 2 storage reads (`Members`: codec `O(M)`, `Prime`: codec `O(1)`)
@ - 3 mutations (`Voting`: codec `O(M)`, `ProposalOf`: codec `O(B)`, `Proposals`: codec
@ `O(P2)`)
@ - any mutations done while executing `proposal` (`P1`)
@ - up to 3 events
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'proposalWeightBound' β 'Compact<u64>' β 'Weight' β
β 3 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
councilCollective.disapproveProposal
docs
@ 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.
@
@ # <weight>
@ Complexity: O(P) where P is the number of max proposals
@ DB Weight:
@ * Reads: Proposals
@ * Writes: Voting, Proposals, ProposalOf
@ # </weight>
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
crowdloanRewards:
crowdloanRewards.associateNativeIdentity
docs
@ Associate a native rewards_destination identity with a crowdloan contribution.
@
@ The caller needs to provide the unassociated relay account and a proof to succeed
@ with the association
@ The proof is nothing but a signature over the reward_address using the relay keys
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββββββββΌββββββββββββββββββββββββ€
β 0 β 'rewardAccount' β 'AccountId20' β 'AccountId' β
β 1 β 'relayAccount' β '[u8;32]' β 'RelayChainAccountId' β
β 2 β 'proof' β 'SpRuntimeMultiSignature' β 'MultiSignature' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββ
crowdloanRewards.changeAssociationWithRelayKeys
docs
@ Change reward account by submitting proofs from relay accounts
@
@ The number of valid proofs needs to be bigger than 'RewardAddressRelayVoteThreshold'
@ The account to be changed needs to be submitted as 'previous_account'
@ Origin must be RewardAddressChangeOrigin
args
βββββββββββ¬ββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'rewardAccount' β 'AccountId20' β 'AccountId' β
β 1 β 'previousAccount' β 'AccountId20' β 'AccountId' β
β 2 β 'proofs' β 'Vec<([u8;32],SpRuntimeMultiSignature)>' β 'Vec<(RelayChainAccountId,MultiSignature)>' β
βββββββββββ΄ββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββββ
crowdloanRewards.claim
docs
@ Collect whatever portion of your reward are currently vested.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
crowdloanRewards.updateRewardAddress
docs
@ Update reward address, proving that the caller owns the current native key
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'newRewardAccount' β 'AccountId20' β 'AccountId' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
crowdloanRewards.completeInitialization
docs
@ This extrinsic completes the initialization if some checks are fullfiled. These checks are:
@ -The reward contribution money matches the crowdloan pot
@ -The end vesting block is higher than the init vesting block
@ -The initialization has not complete yet
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββ¬βββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββΌβββββββββββββββββββββββ€
β 0 β 'leaseEndingBlock' β 'u32' β 'VestingBlockNumber' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββ΄βββββββββββββββββββββββ
crowdloanRewards.initializeRewardVec
docs
@ Initialize the reward distribution storage. It shortcuts whenever an error is found
@ This does not enforce any checks other than making sure we dont go over funds
@ complete_initialization should perform any additional
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'rewards' β 'Vec<([u8;32],Option<AccountId20>,u128)>' β 'Vec<(RelayChainAccountId,Option<AccountId>,BalanceOf)>' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
democracy:
democracy.propose
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'value' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
democracy.second
docs
@ 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.
args
βββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'proposal' β 'Compact<u32>' β 'PropIndex' β
β 1 β 'secondsUpperBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
democracy.vote
docs
@ 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.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββββββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'Compact<u32>' β 'ReferendumIndex' β
β 1 β 'vote' β 'PalletDemocracyVoteAccountVote' β 'AccountVote' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββ
democracy.emergencyCancel
docs
@ 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)`.
args
βββββββββββ¬βββββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.externalPropose
docs
@ 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
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.externalProposeMajority
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.externalProposeDefault
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.fastTrack
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'votingPeriod' β 'u32' β 'BlockNumber' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄ββββββββββββββββ
democracy.vetoExternal
docs
@ 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`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.cancelReferendum
docs
@ Remove a referendum.
@
@ The dispatch origin of this call must be _Root_.
@
@ - `ref_index`: The index of the referendum to cancel.
@
@ # Weight: `O(1)`.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'Compact<u32>' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββ
democracy.cancelQueued
docs
@ 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`.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'which' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.delegate
docs
@ 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.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββ€
β 0 β 'to' β 'AccountId20' β 'AccountId' β
β 1 β 'conviction' β 'PalletDemocracyConviction' β 'Conviction' β
β 2 β 'balance' β 'u128' β 'BalanceOf' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββ
democracy.undelegate
docs
@ 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.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
democracy.clearPublicProposals
docs
@ Clears all public proposals.
@
@ The dispatch origin of this call must be _Root_.
@
@ Weight: `O(1)`.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
democracy.notePreimage
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.notePreimageOperational
docs
@ Same as `note_preimage` but origin is `OperationalPreimageOrigin`.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.noteImminentPreimage
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.noteImminentPreimageOperational
docs
@ Same as `note_imminent_preimage` but origin is `OperationalPreimageOrigin`.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.reapPreimage
docs
@ 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.
args
βββββββββββ¬ββββββββββββββββββββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'proposalLenUpperBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββββ΄βββββββββββββββββ΄βββββββββββ
democracy.unlock
docs
@ 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.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'target' β 'AccountId20' β 'AccountId' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
democracy.removeVote
docs
@ 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.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.removeOtherVote
docs
@ 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.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'target' β 'AccountId20' β 'AccountId' β
β 1 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ
democracy.enactProposal
docs
@ Enact a proposal from a referendum. For now we just make the weight be the maximum.
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌββββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄ββββββββββββββββββββ
democracy.blacklist
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββΌββββββββββββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'maybeRefIndex' β 'Option<u32>' β 'Option<ReferendumIndex>' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββββββββββ
democracy.cancelProposal
docs
@ 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()`
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'propIndex' β 'Compact<u32>' β 'PropIndex' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
dmpQueue:
dmpQueue.serviceOverweight
docs
@ Service a single overweight message.
@
@ - `origin`: Must pass `ExecuteOverweightOrigin`.
@ - `index`: The index of the overweight message to service.
@ - `weight_limit`: The amount of weight that message execution may take.
@
@ Errors:
@ - `Unknown`: Message of `index` is unknown.
@ - `OverLimit`: Message execution may use greater than `weight_limit`.
@
@ Events:
@ - `OverweightServiced`: On success.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'index' β 'u64' β 'OverweightIndex' β
β 1 β 'weightLimit' β 'u64' β 'Weight' β
βββββββββββ΄ββββββββββββββββ΄ββββββββ΄ββββββββββββββββββββ
ethereum:
ethereum.transact
docs
@ Transact an Ethereum transaction.
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'transaction' β 'EthereumTransactionTransactionV2' β 'Transaction' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββ
evm:
evm.withdraw
docs
@ Withdraw balance from EVM into currency/balances pallet.
args
βββββββββββ¬ββββββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'address' β 'H160' β 'H160' β
β 1 β 'value' β 'u128' β 'BalanceOf' β
βββββββββββ΄ββββββββββββ΄βββββββββ΄ββββββββββββββ
evm.call
docs
@ Issue an EVM call operation. This is similar to a message call transaction in Ethereum.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'target' β 'H160' β 'H160' β
β 2 β 'input' β 'Bytes' β 'Bytes' β
β 3 β 'value' β 'U256' β 'U256' β
β 4 β 'gasLimit' β 'u64' β 'u64' β
β 5 β 'maxFeePerGas' β 'U256' β 'U256' β
β 6 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 8 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
evm.create
docs
@ Issue an EVM create operation. This is similar to a contract creation transaction in
@ Ethereum.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'init' β 'Bytes' β 'Bytes' β
β 2 β 'value' β 'U256' β 'U256' β
β 3 β 'gasLimit' β 'u64' β 'u64' β
β 4 β 'maxFeePerGas' β 'U256' β 'U256' β
β 5 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 6 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
evm.create2
docs
@ Issue an EVM create2 operation.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'init' β 'Bytes' β 'Bytes' β
β 2 β 'salt' β 'H256' β 'H256' β
β 3 β 'value' β 'U256' β 'U256' β
β 4 β 'gasLimit' β 'u64' β 'u64' β
β 5 β 'maxFeePerGas' β 'U256' β 'U256' β
β 6 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 8 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
evm.hotfixIncAccountSufficients
docs
@ Increment `sufficients` for existing accounts having a nonzero `nonce` but zero `sufficients` value.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββΌββββββββββββββ€
β 0 β 'addresses' β 'Vec<H160>' β 'Vec<H160>' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββ΄ββββββββββββββ
identity:
identity.addRegistrar
docs
@ 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.
@
@ # <weight>
@ - `O(R)` where `R` registrar-count (governance-bounded and code-bounded).
@ - One storage mutation (codec `O(R)`).
@ - One event.
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
identity.setIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(X + X' + R)`
@ - where `X` additional-field-count (deposit-bounded and code-bounded)
@ - where `R` judgements-count (registrar-count-bounded)
@ - One balance reserve operation.
@ - One storage mutation (codec-read `O(X' + R)`, codec-write `O(X + R)`).
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββββββββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'info' β 'PalletIdentityIdentityInfo' β 'IdentityInfo' β
βββββββββββ΄βββββββββ΄βββββββββββββββββββββββββββββββ΄βββββββββββββββββ
identity.setSubs
docs
@ 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.
@
@ # <weight>
@ - `O(P + S)`
@ - where `P` old-subs-count (hard- and deposit-bounded).
@ - where `S` subs-count (hard- and deposit-bounded).
@ - At most one balance operations.
@ - DB:
@ - `P + S` storage mutations (codec complexity `O(1)`)
@ - One storage read (codec complexity `O(P)`).
@ - One storage write (codec complexity `O(S)`).
@ - One storage-exists (`IdentityOf::contains_key`).
@ # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'subs' β 'Vec<(AccountId20,Data)>' β 'Vec<(AccountId,Data)>' β
βββββββββββ΄βββββββββ΄ββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
identity.clearIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(R + S + X)`
@ - where `R` registrar-count (governance-bounded).
@ - where `S` subs-count (hard- and deposit-bounded).
@ - where `X` additional-field-count (deposit-bounded and code-bounded).
@ - One balance-unreserve operation.
@ - `2` storage reads and `S + 2` storage deletions.
@ - One event.
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
identity.requestJudgement
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-reserve operation.
@ - Storage: 1 read `O(R)`, 1 mutate `O(X + R)`.
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'maxFee' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ
identity.cancelRequest
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-reserve operation.
@ - One storage mutation `O(R + X)`.
@ - One event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'u32' β 'RegistrarIndex' β
βββββββββββ΄βββββββββββββ΄ββββββββ΄βββββββββββββββββββ
identity.setFee
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 7.315 + R * 0.329 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'fee' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ
identity.setAccountId
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 8.823 + R * 0.32 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'new' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββ΄βββββββββββββββββββ
identity.setFields
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 7.464 + R * 0.325 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬βββββββββββ¬βββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'fields' β 'PalletIdentityBitFlags' β 'IdentityFields' β
βββββββββββ΄βββββββββββ΄βββββββββββββββββββββββββββ΄βββββββββββββββββββ
identity.provideJudgement
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-transfer operation.
@ - Up to one account-lookup operation.
@ - Storage: 1 read `O(R)`, 1 mutate `O(R + X)`.
@ - One event.
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'target' β 'AccountId20' β 'LookupSource' β
β 2 β 'judgement' β 'PalletIdentityJudgement' β 'Judgement' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββββββββββββ΄βββββββββββββββββββ
identity.killIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(R + S + X)`.
@ - One balance-reserve operation.
@ - `S + 2` storage mutations.
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'target' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
identity.addSub
docs
@ 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`.
args
βββββββββββ¬βββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'AccountId20' β 'LookupSource' β
β 1 β 'data' β 'Data' β 'Data' β
βββββββββββ΄βββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
identity.renameSub
docs
@ 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`.
args
βββββββββββ¬βββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'AccountId20' β 'LookupSource' β
β 1 β 'data' β 'Data' β 'Data' β
βββββββββββ΄βββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
identity.removeSub
docs
@ 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`.
args
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
identity.quitSub
docs
@ 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.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
localAssets:
localAssets.create
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'admin' β 'AccountId20' β 'LookupSource' β
β 2 β 'minBalance' β 'u128' β 'Balance' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.forceCreate
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'isSufficient' β 'bool' β 'bool' β
β 3 β 'minBalance' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.destroy
docs
@ 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`
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'witness' β 'PalletAssetsDestroyWitness' β 'DestroyWitness' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
localAssets.mint
docs
@ 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`.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'beneficiary' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.burn
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.transfer
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'target' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.transferKeepAlive
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'target' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.forceTransfer
docs
@ 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`.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'source' β 'AccountId20' β 'LookupSource' β
β 2 β 'dest' β 'AccountId20' β 'LookupSource' β
β 3 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.freeze
docs
@ 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)`
args
βββββββββββ¬ββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.thaw
docs
@ 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)`
args
βββββββββββ¬ββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'who' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.freezeAsset
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.thawAsset
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.transferOwnership
docs
@ 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)`
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.setTeam
docs
@ 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)`
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'issuer' β 'AccountId20' β 'LookupSource' β
β 2 β 'admin' β 'AccountId20' β 'LookupSource' β
β 3 β 'freezer' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.setMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'name' β 'Bytes' β 'Bytes' β
β 2 β 'symbol' β 'Bytes' β 'Bytes' β
β 3 β 'decimals' β 'u8' β 'u8' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.clearMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.forceSetMetadata
docs
@ 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.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'name' β 'Bytes' β 'Bytes' β
β 2 β 'symbol' β 'Bytes' β 'Bytes' β
β 3 β 'decimals' β 'u8' β 'u8' β
β 4 β 'isFrozen' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.forceClearMetadata
docs
@ 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)`
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.forceAssetStatus
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'issuer' β 'AccountId20' β 'LookupSource' β
β 3 β 'admin' β 'AccountId20' β 'LookupSource' β
β 4 β 'freezer' β 'AccountId20' β 'LookupSource' β
β 5 β 'minBalance' β 'Compact<u128>' β 'Balance' β
β 6 β 'isSufficient' β 'bool' β 'bool' β
β 7 β 'isFrozen' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.approveTransfer
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'delegate' β 'AccountId20' β 'LookupSource' β
β 2 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.cancelApproval
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'delegate' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.forceCancelApproval
docs
@ 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)`
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'delegate' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.transferApproved
docs
@ 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)`
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'owner' β 'AccountId20' β 'LookupSource' β
β 2 β 'destination' β 'AccountId20' β 'LookupSource' β
β 3 β 'amount' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
localAssets.touch
docs
@ 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.
args
βββββββββββ¬βββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
βββββββββββ΄βββββββ΄ββββββββββββββββββ΄ββββββββββββ
localAssets.refund
docs
@ 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.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββΌββββββββββββ€
β 0 β 'id' β 'Compact<u128>' β 'AssetId' β
β 1 β 'allowBurn' β 'bool' β 'bool' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββ
maintenanceMode:
maintenanceMode.enterMaintenanceMode
docs
@ Place the chain in maintenance mode
@
@ Weight cost is:
@ * One DB read to ensure we're not already in maintenance mode
@ * Three DB writes - 1 for the mode, 1 for suspending xcm execution, 1 for the event
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
maintenanceMode.resumeNormalOperation
docs
@ Return the chain to normal operating mode
@
@ Weight cost is:
@ * One DB read to ensure we're in maintenance mode
@ * Three DB writes - 1 for the mode, 1 for resuming xcm execution, 1 for the event
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
moonbeamOrbiters:
moonbeamOrbiters.collatorAddOrbiter
docs
@ Add an orbiter in a collator pool
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'orbiter' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
moonbeamOrbiters.collatorRemoveOrbiter
docs
@ Remove an orbiter from the caller collator pool
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'orbiter' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
moonbeamOrbiters.orbiterLeaveCollatorPool
docs
@ Remove the caller from the specified collator pool
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'collator' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
moonbeamOrbiters.orbiterRegister
docs
@ Registering as an orbiter
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
moonbeamOrbiters.orbiterUnregister
docs
@ Deregistering from orbiters
args
βββββββββββ¬βββββββββββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'collatorsPoolCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββββ΄ββββββββ΄βββββββββββ
moonbeamOrbiters.addCollator
docs
@ Add a collator to orbiters program.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'collator' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
moonbeamOrbiters.removeCollator
docs
@ Remove a collator from orbiters program.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'collator' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
parachainStaking:
parachainStaking.setStakingExpectations
docs
@ Set the expectations for total staked. These expectations determine the issuance for
@ the round according to logic in `fn compute_issuance`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββ€
β 0 β 'expectations' β '{"min":"u128","ideal":"u128","max":"u128"}' β 'Range<BalanceOf>' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββ
parachainStaking.setInflation
docs
@ Set the annual inflation rate to derive per-round inflation
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'schedule' β '{"min":"Perbill","ideal":"Perbill","max":"Perbill"}' β 'Range<Perbill>' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
parachainStaking.setParachainBondAccount
docs
@ Set the account that will hold funds set aside for parachain bond
args
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'new' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.setParachainBondReservePercent
docs
@ Set the percent of inflation set aside for parachain bond
args
βββββββββββ¬ββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'new' β 'Percent' β 'Percent' β
βββββββββββ΄ββββββββ΄ββββββββββββ΄ββββββββββββ
parachainStaking.setTotalSelected
docs
@ Set the total number of collator candidates selected per round
@ - changes are not applied until the start of the next round
args
βββββββββββ¬ββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββΌβββββββββββ€
β 0 β 'new' β 'u32' β 'u32' β
βββββββββββ΄ββββββββ΄ββββββββ΄βββββββββββ
parachainStaking.setCollatorCommission
docs
@ Set the commission for all collators
args
βββββββββββ¬ββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'new' β 'Perbill' β 'Perbill' β
βββββββββββ΄ββββββββ΄ββββββββββββ΄ββββββββββββ
parachainStaking.setBlocksPerRound
docs
@ Set blocks per round
@ - if called with `new` less than length of current round, will transition immediately
@ in the next block
@ - also updates per-round inflation config
args
βββββββββββ¬ββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββΌβββββββββββ€
β 0 β 'new' β 'u32' β 'u32' β
βββββββββββ΄ββββββββ΄ββββββββ΄βββββββββββ
parachainStaking.joinCandidates
docs
@ Join the set of collator candidates
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'bond' β 'u128' β 'BalanceOf' β
β 1 β 'candidateCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββ΄ββββββββββββββ
parachainStaking.scheduleLeaveCandidates
docs
@ Request to leave the set of candidates. If successful, the account is immediately
@ removed from the candidate pool to prevent selection as a collator.
args
βββββββββββ¬βββββββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'candidateCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββ΄ββββββββ΄βββββββββββ
parachainStaking.executeLeaveCandidates
docs
@ Execute leave candidates request
args
βββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
β 1 β 'candidateDelegationCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.cancelLeaveCandidates
docs
@ Cancel open request to leave candidates
@ - only callable by collator account
@ - result upon successful call is the candidate is active in the candidate pool
args
βββββββββββ¬βββββββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'candidateCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββ΄ββββββββ΄βββββββββββ
parachainStaking.goOffline
docs
@ Temporarily leave the set of collator candidates without unbonding
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
parachainStaking.goOnline
docs
@ Rejoin the set of collator candidates if previously had called `go_offline`
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
parachainStaking.candidateBondMore
docs
@ Increase collator candidate self bond by `more`
args
βββββββββββ¬βββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'more' β 'u128' β 'BalanceOf' β
βββββββββββ΄βββββββββ΄βββββββββ΄ββββββββββββββ
parachainStaking.scheduleCandidateBondLess
docs
@ Request by collator candidate to decrease self bond by `less`
args
βββββββββββ¬βββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'less' β 'u128' β 'BalanceOf' β
βββββββββββ΄βββββββββ΄βββββββββ΄ββββββββββββββ
parachainStaking.executeCandidateBondLess
docs
@ Execute pending request to adjust the collator candidate self bond
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.cancelCandidateBondLess
docs
@ Cancel pending request to adjust the collator candidate self bond
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
parachainStaking.delegate
docs
@ If caller is not a delegator and not a collator, then join the set of delegators
@ If caller is a delegator, then makes delegation to change their delegation state
args
βββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
β 1 β 'amount' β 'u128' β 'BalanceOf' β
β 2 β 'candidateDelegationCount' β 'u32' β 'u32' β
β 3 β 'delegationCount' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.scheduleLeaveDelegators
docs
@ Request to leave the set of delegators. If successful, the caller is scheduled
@ to be allowed to exit. Success forbids future delegator actions until the request is
@ invoked or cancelled.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
parachainStaking.executeLeaveDelegators
docs
@ Execute the right to exit the set of delegators and revoke all ongoing delegations.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'delegator' β 'AccountId20' β 'AccountId' β
β 1 β 'delegationCount' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.cancelLeaveDelegators
docs
@ Cancel a pending request to exit the set of delegators. Success clears the pending exit
@ request (thereby resetting the delay upon another `leave_delegators` call).
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
parachainStaking.scheduleRevokeDelegation
docs
@ Request to revoke an existing delegation. If successful, the delegation is scheduled
@ to be allowed to be revoked via the `execute_delegation_request` extrinsic.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'collator' β 'AccountId20' β 'AccountId' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.delegatorBondMore
docs
@ Bond more for delegators wrt a specific collator candidate.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
β 1 β 'more' β 'u128' β 'BalanceOf' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.scheduleDelegatorBondLess
docs
@ Request bond less for delegators wrt a specific collator candidate.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
β 1 β 'less' β 'u128' β 'BalanceOf' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.executeDelegationRequest
docs
@ Execute pending request to change an existing delegation
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'delegator' β 'AccountId20' β 'AccountId' β
β 1 β 'candidate' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainStaking.cancelDelegationRequest
docs
@ Cancel request to change an existing delegation.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'candidate' β 'AccountId20' β 'AccountId' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
parachainSystem:
parachainSystem.setValidationData
docs
@ 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.
args
βββββββββββ¬βββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'data' β 'CumulusPrimitivesParachainInherentParachainInherentData' β 'ParachainInherentData' β
βββββββββββ΄βββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
parachainSystem.sudoSendUpwardMessage
docs
args
βββββββββββ¬ββββββββββββ¬ββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββΌββββββββββββββββββ€
β 0 β 'message' β 'Bytes' β 'UpwardMessage' β
βββββββββββ΄ββββββββββββ΄ββββββββββ΄ββββββββββββββββββ
parachainSystem.authorizeUpgrade
docs
args
βββββββββββ¬βββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'codeHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββ΄βββββββββ΄βββββββββββ
parachainSystem.enactAuthorizedUpgrade
docs
args
βββββββββββ¬βββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββΌβββββββββββ€
β 0 β 'code' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββ΄ββββββββββ΄βββββββββββ
polkadotXcm:
polkadotXcm.send
docs
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'message' β 'XcmVersionedXcm' β 'VersionedXcm' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.teleportAssets
docs
@ Teleport some assets from the local chain to some destination chain.
@
@ Fee payment on the destination side is made from the first asset listed in the `assets` vector and
@ fee-weight is calculated locally and thus remote weights are assumed to be equal to
@ local weights.
@
@ - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@ - `dest`: Destination context for the assets. Will typically be `X2(Parent, Parachain(..))` to send
@ from parachain to parachain, or `X1(Parachain(..))` to send from relay to parachain.
@ - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will generally be
@ an `AccountId32` value.
@ - `assets`: The assets to be withdrawn. The first item should be the currency used to to pay the fee on the
@ `dest` side. May not be empty.
@ - `fee_asset_item`: The index into `assets` of the item which should be used to pay
@ fees.
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'beneficiary' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 2 β 'assets' β 'XcmVersionedMultiAssets' β 'VersionedMultiAssets' β
β 3 β 'feeAssetItem' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.reserveTransferAssets
docs
@ Transfer some assets from the local chain to the sovereign account of a destination chain and forward
@ a notification XCM.
@
@ Fee payment on the destination side is made from the first asset listed in the `assets` vector and
@ fee-weight is calculated locally and thus remote weights are assumed to be equal to
@ local weights.
@
@ - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@ - `dest`: Destination context for the assets. Will typically be `X2(Parent, Parachain(..))` to send
@ from parachain to parachain, or `X1(Parachain(..))` to send from relay to parachain.
@ - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will generally be
@ an `AccountId32` value.
@ - `assets`: The assets to be withdrawn. This should include the assets used to pay the fee on the
@ `dest` side.
@ - `fee_asset_item`: The index into `assets` of the item which should be used to pay
@ fees.
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'beneficiary' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 2 β 'assets' β 'XcmVersionedMultiAssets' β 'VersionedMultiAssets' β
β 3 β 'feeAssetItem' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.execute
docs
@ Execute an XCM message from a local, signed, origin.
@
@ An event is deposited indicating whether `msg` could be executed completely or only
@ partially.
@
@ No more than `max_weight` will be used in its attempted execution. If this is less than the
@ maximum amount of weight that the message could take to be executed, then no execution
@ attempt will be made.
@
@ NOTE: A successful return to this does *not* imply that the `msg` was executed successfully
@ to completion; only that *some* of it was executed.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'message' β 'XcmVersionedXcm' β 'VersionedXcm' β
β 1 β 'maxWeight' β 'u64' β 'Weight' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββββ΄βββββββββββββββββ
polkadotXcm.forceXcmVersion
docs
@ Extoll that a particular destination can be communicated with through a particular
@ version of XCM.
@
@ - `origin`: Must be Root.
@ - `location`: The destination that is being described.
@ - `xcm_version`: The latest version of XCM that `location` supports.
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'location' β 'XcmV1MultiLocation' β 'MultiLocation' β
β 1 β 'xcmVersion' β 'u32' β 'XcmVersion' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββββββββ΄ββββββββββββββββββ
polkadotXcm.forceDefaultXcmVersion
docs
@ Set a safe XCM version (the version that XCM should be encoded with if the most recent
@ version a destination can accept is unknown).
@
@ - `origin`: Must be Root.
@ - `maybe_xcm_version`: The default XCM encoding version, or `None` to disable.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββΌβββββββββββββββββββββββ€
β 0 β 'maybeXcmVersion' β 'Option<u32>' β 'Option<XcmVersion>' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββ
polkadotXcm.forceSubscribeVersionNotify
docs
@ Ask a location to notify us regarding their XCM version and any changes to it.
@
@ - `origin`: Must be Root.
@ - `location`: The location to which we should subscribe for XCM version notifications.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'location' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.forceUnsubscribeVersionNotify
docs
@ Require that a particular destination should no longer notify us regarding any XCM
@ version changes.
@
@ - `origin`: Must be Root.
@ - `location`: The location to which we are currently subscribed for XCM version
@ notifications which we no longer desire.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'location' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.limitedReserveTransferAssets
docs
@ Transfer some assets from the local chain to the sovereign account of a destination chain and forward
@ a notification XCM.
@
@ Fee payment on the destination side is made from the first asset listed in the `assets` vector.
@
@ - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@ - `dest`: Destination context for the assets. Will typically be `X2(Parent, Parachain(..))` to send
@ from parachain to parachain, or `X1(Parachain(..))` to send from relay to parachain.
@ - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will generally be
@ an `AccountId32` value.
@ - `assets`: The assets to be withdrawn. This should include the assets used to pay the fee on the
@ `dest` side.
@ - `fee_asset_item`: The index into `assets` of the item which should be used to pay
@ fees.
@ - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'beneficiary' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 2 β 'assets' β 'XcmVersionedMultiAssets' β 'VersionedMultiAssets' β
β 3 β 'feeAssetItem' β 'u32' β 'u32' β
β 4 β 'weightLimit' β 'XcmV2WeightLimit' β 'WeightLimit' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
polkadotXcm.limitedTeleportAssets
docs
@ Teleport some assets from the local chain to some destination chain.
@
@ Fee payment on the destination side is made from the first asset listed in the `assets` vector.
@
@ - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@ - `dest`: Destination context for the assets. Will typically be `X2(Parent, Parachain(..))` to send
@ from parachain to parachain, or `X1(Parachain(..))` to send from relay to parachain.
@ - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will generally be
@ an `AccountId32` value.
@ - `assets`: The assets to be withdrawn. The first item should be the currency used to to pay the fee on the
@ `dest` side. May not be empty.
@ - `fee_asset_item`: The index into `assets` of the item which should be used to pay
@ fees.
@ - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'beneficiary' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 2 β 'assets' β 'XcmVersionedMultiAssets' β 'VersionedMultiAssets' β
β 3 β 'feeAssetItem' β 'u32' β 'u32' β
β 4 β 'weightLimit' β 'XcmV2WeightLimit' β 'WeightLimit' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
proxy:
proxy.proxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'real' β 'AccountId20' β 'AccountId' β
β 1 β 'forceProxyType' β 'Option<MoonbeamRuntimeProxyType>' β 'Option<ProxyType>' β
β 2 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
proxy.addProxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'delegate' β 'AccountId20' β 'AccountId' β
β 1 β 'proxyType' β 'MoonbeamRuntimeProxyType' β 'ProxyType' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.removeProxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'delegate' β 'AccountId20' β 'AccountId' β
β 1 β 'proxyType' β 'MoonbeamRuntimeProxyType' β 'ProxyType' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.removeProxies
docs
@ 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.**
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
proxy.anonymous
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
@ TODO: Might be over counting 1 read
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'proxyType' β 'MoonbeamRuntimeProxyType' β 'ProxyType' β
β 1 β 'delay' β 'u32' β 'BlockNumber' β
β 2 β 'index' β 'u16' β 'u16' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.killAnonymous
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'spawner' β 'AccountId20' β 'AccountId' β
β 1 β 'proxyType' β 'MoonbeamRuntimeProxyType' β 'ProxyType' β
β 2 β 'index' β 'u16' β 'u16' β
β 3 β 'height' β 'Compact<u32>' β 'BlockNumber' β
β 4 β 'extIndex' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.announce
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'real' β 'AccountId20' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.removeAnnouncement
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'real' β 'AccountId20' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.rejectAnnouncement
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'delegate' β 'AccountId20' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.proxyAnnounced
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'delegate' β 'AccountId20' β 'AccountId' β
β 1 β 'real' β 'AccountId20' β 'AccountId' β
β 2 β 'forceProxyType' β 'Option<MoonbeamRuntimeProxyType>' β 'Option<ProxyType>' β
β 3 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
scheduler:
scheduler.schedule
docs
@ Anonymously schedule a task.
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'when' β 'u32' β 'BlockNumber' β
β 1 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 2 β 'priority' β 'u8' β 'Priority' β
β 3 β 'call' β 'FrameSupportScheduleMaybeHashed' β 'CallOrHashOf' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.cancel
docs
@ Cancel an anonymously scheduled task.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββ€
β 0 β 'when' β 'u32' β 'BlockNumber' β
β 1 β 'index' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββ
scheduler.scheduleNamed
docs
@ Schedule a named task.
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
β 1 β 'when' β 'u32' β 'BlockNumber' β
β 2 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 3 β 'priority' β 'u8' β 'Priority' β
β 4 β 'call' β 'FrameSupportScheduleMaybeHashed' β 'CallOrHashOf' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.cancelNamed
docs
@ Cancel a named scheduled task.
args
βββββββββββ¬βββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββΌβββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββ΄ββββββββββ΄βββββββββββ
scheduler.scheduleAfter
docs
@ Anonymously schedule a task after a delay.
@
@ # <weight>
@ Same as [`schedule`].
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'after' β 'u32' β 'BlockNumber' β
β 1 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 2 β 'priority' β 'u8' β 'Priority' β
β 3 β 'call' β 'FrameSupportScheduleMaybeHashed' β 'CallOrHashOf' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.scheduleNamedAfter
docs
@ Schedule a named task after a delay.
@
@ # <weight>
@ Same as [`schedule_named`](Self::schedule_named).
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
β 1 β 'after' β 'u32' β 'BlockNumber' β
β 2 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 3 β 'priority' β 'u8' β 'Priority' β
β 4 β 'call' β 'FrameSupportScheduleMaybeHashed' β 'CallOrHashOf' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
system:
system.fillBlock
docs
@ A dispatch that will fill the block weight up to the given ratio.
args
βββββββββββ¬ββββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'ratio' β 'Perbill' β 'Perbill' β
βββββββββββ΄ββββββββββ΄ββββββββββββ΄ββββββββββββ
system.remark
docs
@ Make some on-chain remark.
@
@ # <weight>
@ - `O(1)`
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'remark' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββ΄ββββββββββ΄βββββββββββ
system.setHeapPages
docs
@ Set the number of pages in the WebAssembly environment's heap.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββ€
β 0 β 'pages' β 'u64' β 'u64' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββ
system.setCode
docs
@ Set the new runtime code.
@
@ # <weight>
@ - `O(C + S)` where `C` length of `code` and `S` complexity of `can_set_code`
@ - 1 call to `can_set_code`: `O(S)` (calls `sp_io::misc::runtime_version` which is
@ expensive).
@ - 1 storage write (codec `O(C)`).
@ - 1 digest item.
@ - 1 event.
@ The weight of this function is dependent on the runtime, but generally this is very
@ expensive. We will treat this as a full block.
@ # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββΌβββββββββββ€
β 0 β 'code' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββ΄ββββββββββ΄βββββββββββ
system.setCodeWithoutChecks
docs
@ Set the new runtime code without doing any checks of the given `code`.
@
@ # <weight>
@ - `O(C)` where `C` length of `code`
@ - 1 storage write (codec `O(C)`).
@ - 1 digest item.
@ - 1 event.
@ The weight of this function is dependent on the runtime. We will treat this as a full
@ block. # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββΌβββββββββββ€
β 0 β 'code' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββ΄ββββββββββ΄βββββββββββ
system.setStorage
docs
@ Set some items of storage.
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'items' β 'Vec<(Bytes,Bytes)>' β 'Vec<KeyValue>' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββ΄ββββββββββββββββββ
system.killStorage
docs
@ Kill some items from storage.
args
βββββββββββ¬βββββββββ¬βββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββΌβββββββββββββ€
β 0 β 'keys' β 'Vec<Bytes>' β 'Vec<Key>' β
βββββββββββ΄βββββββββ΄βββββββββββββββ΄βββββββββββββ
system.killPrefix
docs
@ 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.
args
βββββββββββ¬ββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'prefix' β 'Bytes' β 'Key' β
β 1 β 'subkeys' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββ΄ββββββββββ΄βββββββββββ
system.remarkWithEvent
docs
@ Make some on-chain remark and emit event.
args
βββββββββββ¬βββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'remark' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββ΄ββββββββββ΄βββββββββββ
techCommitteeCollective:
techCommitteeCollective.setMembers
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(MP + N)` where:
@ - `M` old-members-count (code- and governance-bounded)
@ - `N` new-members-count (code- and governance-bounded)
@ - `P` proposals-count (code-bounded)
@ - DB:
@ - 1 storage mutation (codec `O(M)` read, `O(N)` write) for reading and writing the
@ members
@ - 1 storage read (codec `O(P)`) for reading the proposals
@ - `P` storage mutations (codec `O(M)`) for updating the votes for each proposal
@ - 1 storage write (codec `O(1)`) for deleting the old `prime` and setting the new one
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'newMembers' β 'Vec<AccountId20>' β 'Vec<AccountId>' β
β 1 β 'prime' β 'Option<AccountId20>' β 'Option<AccountId>' β
β 2 β 'oldCount' β 'u32' β 'MemberCount' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
techCommitteeCollective.execute
docs
@ Dispatch a proposal from a member using the `Member` origin.
@
@ Origin must be a member of the collective.
@
@ # <weight>
@ ## Weight
@ - `O(M + P)` where `M` members-count (code-bounded) and `P` complexity of dispatching
@ `proposal`
@ - DB: 1 read (codec `O(M)`) + DB access of `proposal`
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'proposal' β 'Call' β 'Proposal' β
β 1 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
techCommitteeCollective.propose
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1)` or `O(B + M + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - branching is influenced by `threshold` where:
@ - `P1` is proposal execution complexity (`threshold < 2`)
@ - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
@ - DB:
@ - 1 storage read `is_member` (codec `O(M)`)
@ - 1 storage read `ProposalOf::contains_key` (codec `O(1)`)
@ - DB accesses influenced by `threshold`:
@ - EITHER storage accesses done by `proposal` (`threshold < 2`)
@ - OR proposal insertion (`threshold <= 2`)
@ - 1 storage mutation `Proposals` (codec `O(P2)`)
@ - 1 storage mutation `ProposalCount` (codec `O(1)`)
@ - 1 storage write `ProposalOf` (codec `O(B)`)
@ - 1 storage write `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'threshold' β 'Compact<u32>' β 'MemberCount' β
β 1 β 'proposal' β 'Call' β 'Proposal' β
β 2 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
techCommitteeCollective.vote
docs
@ 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.
@ # <weight>
@ ## Weight
@ - `O(M)` where `M` is members-count (code- and governance-bounded)
@ - DB:
@ - 1 storage read `Members` (codec `O(M)`)
@ - 1 storage mutation `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposal' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'approve' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
techCommitteeCollective.close
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1 + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - `P1` is the complexity of `proposal` preimage.
@ - `P2` is proposal-count (code-bounded)
@ - DB:
@ - 2 storage reads (`Members`: codec `O(M)`, `Prime`: codec `O(1)`)
@ - 3 mutations (`Voting`: codec `O(M)`, `ProposalOf`: codec `O(B)`, `Proposals`: codec
@ `O(P2)`)
@ - any mutations done while executing `proposal` (`P1`)
@ - up to 3 events
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'proposalWeightBound' β 'Compact<u64>' β 'Weight' β
β 3 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
techCommitteeCollective.disapproveProposal
docs
@ 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.
@
@ # <weight>
@ Complexity: O(P) where P is the number of max proposals
@ DB Weight:
@ * Reads: Proposals
@ * Writes: Voting, Proposals, ProposalOf
@ # </weight>
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
timestamp:
timestamp.set
docs
@ 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`.
@
@ # <weight>
@ - `O(1)` (Note that implementations of `OnTimestampSet` must also be `O(1)`)
@ - 1 storage read and 1 storage mutation (codec `O(1)`). (because of `DidUpdate::take` in
@ `on_finalize`)
@ - 1 event handler `on_timestamp_set`. Must be `O(1)`.
@ # </weight>
args
βββββββββββ¬ββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'now' β 'Compact<u64>' β 'Moment' β
βββββββββββ΄ββββββββ΄βββββββββββββββββ΄βββββββββββ
treasury:
treasury.proposeSpend
docs
@ 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.
@
@ # <weight>
@ - Complexity: O(1)
@ - DbReads: `ProposalCount`, `origin account`
@ - DbWrites: `ProposalCount`, `Proposals`, `origin account`
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'value' β 'Compact<u128>' β 'BalanceOf' β
β 1 β 'beneficiary' β 'AccountId20' β 'LookupSource' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
treasury.rejectProposal
docs
@ Reject a proposed spend. The original deposit will be slashed.
@
@ May only be called from `T::RejectOrigin`.
@
@ # <weight>
@ - Complexity: O(1)
@ - DbReads: `Proposals`, `rejected proposer account`
@ - DbWrites: `Proposals`, `rejected proposer account`
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalId' β 'Compact<u32>' β 'ProposalIndex' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
treasury.approveProposal
docs
@ 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`.
@
@ # <weight>
@ - Complexity: O(1).
@ - DbReads: `Proposals`, `Approvals`
@ - DbWrite: `Approvals`
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalId' β 'Compact<u32>' β 'ProposalIndex' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
utility:
utility.batch
docs
@ 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`).
@
@ # <weight>
@ - Complexity: O(C) where C is the number of calls to be batched.
@ # </weight>
@
@ 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.
args
βββββββββββ¬ββββββββββ¬ββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββΌββββββββββββββ€
β 0 β 'calls' β 'Vec<Call>' β 'Vec<Call>' β
βββββββββββ΄ββββββββββ΄ββββββββββββββ΄ββββββββββββββ
utility.asDerivative
docs
@ 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_.
args
βββββββββββ¬ββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'index' β 'u16' β 'u16' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββ΄βββββββββ΄βββββββββββ
utility.batchAll
docs
@ 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`).
@
@ # <weight>
@ - Complexity: O(C) where C is the number of calls to be batched.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββΌββββββββββββββ€
β 0 β 'calls' β 'Vec<Call>' β 'Vec<Call>' β
βββββββββββ΄ββββββββββ΄ββββββββββββββ΄ββββββββββββββ
utility.dispatchAs
docs
@ Dispatches a function call with a provided origin.
@
@ The dispatch origin for this call must be _Root_.
@
@ # <weight>
@ - O(1).
@ - Limited storage reads.
@ - One DB write (event).
@ - Weight of derivative `call` execution + T::WeightInfo::dispatch_as().
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'asOrigin' β 'MoonbeamRuntimeOriginCaller' β 'PalletsOrigin' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββββ΄ββββββββββββββββββ
xTokens:
xTokens.transfer
docs
@ Transfer native currencies.
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'MoonbeamRuntimeXcmConfigCurrencyId' β 'CurrencyId' β
β 1 β 'amount' β 'u128' β 'Balance' β
β 2 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xTokens.transferMultiasset
docs
@ Transfer `MultiAsset`.
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'asset' β 'XcmVersionedMultiAsset' β 'VersionedMultiAsset' β
β 1 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 2 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xTokens.transferWithFee
docs
@ Transfer native currencies specifying the fee and amount as
@ separate.
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ `fee` is the amount to be spent to pay for execution in destination
@ chain. Both fee and amount will be subtracted form the callers
@ balance.
@
@ If `fee` is not high enough to cover for the execution costs in the
@ destination chain, then the assets will be trapped in the
@ destination chain
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'MoonbeamRuntimeXcmConfigCurrencyId' β 'CurrencyId' β
β 1 β 'amount' β 'u128' β 'Balance' β
β 2 β 'fee' β 'u128' β 'Balance' β
β 3 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 4 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xTokens.transferMultiassetWithFee
docs
@ Transfer `MultiAsset` specifying the fee and amount as separate.
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ `fee` is the multiasset to be spent to pay for execution in
@ destination chain. Both fee and amount will be subtracted form the
@ callers balance For now we only accept fee and asset having the same
@ `MultiLocation` id.
@
@ If `fee` is not high enough to cover for the execution costs in the
@ destination chain, then the assets will be trapped in the
@ destination chain
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'asset' β 'XcmVersionedMultiAsset' β 'VersionedMultiAsset' β
β 1 β 'fee' β 'XcmVersionedMultiAsset' β 'VersionedMultiAsset' β
β 2 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xTokens.transferMulticurrencies
docs
@ Transfer several currencies specifying the item to be used as fee
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ `fee_item` is index of the currencies tuple that we want to use for
@ payment
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€
β 0 β 'currencies' β 'Vec<(MoonbeamRuntimeXcmConfigCurrencyId,u128)>' β 'Vec<(CurrencyId,Balance)>' β
β 1 β 'feeItem' β 'u32' β 'u32' β
β 2 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ
xTokens.transferMultiassets
docs
@ Transfer several `MultiAsset` specifying the item to be used as fee
@
@ `dest_weight` is the weight for XCM execution on the dest chain, and
@ it would be charged from the transferred assets. If set below
@ requirements, the execution may fail and assets wouldn't be
@ received.
@
@ `fee_item` is index of the MultiAssets that we want to use for
@ payment
@
@ It's a no-op if any error on local XCM execution or message sending.
@ Note sending assets out per se doesn't guarantee they would be
@ received. Receiving depends on if the XCM message could be delivered
@ by the network, and if the receiving chain would handle
@ messages correctly.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'assets' β 'XcmVersionedMultiAssets' β 'VersionedMultiAssets' β
β 1 β 'feeItem' β 'u32' β 'u32' β
β 2 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xcmTransactor:
xcmTransactor.register
docs
@ Register a derivative index for an account id. Dispatchable by
@ DerivativeAddressRegistrationOrigin
@
@ We do not store the derivative address, but only the index. We do not need to store
@ the derivative address to issue calls, only the index is enough
@
@ For now an index is registered for all possible destinations and not per-destination.
@ We can change this in the future although it would just make things more complicated
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'who' β 'AccountId20' β 'AccountId' β
β 1 β 'index' β 'u16' β 'u16' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
xcmTransactor.deregister
docs
@ De-Register a derivative index. This prevents an account to use a derivative address
@ (represented by an index) from our of our sovereign accounts anymore
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββ€
β 0 β 'index' β 'u16' β 'u16' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββ
xcmTransactor.transactThroughDerivativeMultilocation
docs
@ Transact the inner call through a derivative account in a destination chain,
@ using 'fee_location' to pay for the fees. This fee_location is given as a multilocation
@
@ The caller needs to have the index registered in this pallet. The fee multiasset needs
@ to be a reserve asset for the destination transactor::multilocation.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'MoonbeamRuntimeXcmConfigTransactors' β 'Transactor' β
β 1 β 'index' β 'u16' β 'u16' β
β 2 β 'feeLocation' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
β 4 β 'innerCall' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xcmTransactor.transactThroughDerivative
docs
@ Transact the inner call through a derivative account in a destination chain,
@ using 'currency_id' to pay for the fees.
@
@ The caller needs to have the index registered in this pallet. The fee multiasset needs
@ to be a reserve asset for the destination transactor::multilocation.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββ€
β 0 β 'dest' β 'MoonbeamRuntimeXcmConfigTransactors' β 'Transactor' β
β 1 β 'index' β 'u16' β 'u16' β
β 2 β 'currencyId' β 'MoonbeamRuntimeXcmConfigCurrencyId' β 'CurrencyId' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
β 4 β 'innerCall' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββ
xcmTransactor.transactThroughSovereign
docs
@ Transact the call through the sovereign account in a destination chain,
@ 'fee_payer' pays for the fee
@
@ SovereignAccountDispatcherOrigin callable only
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'dest' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'feePayer' β 'AccountId20' β 'AccountId' β
β 2 β 'feeLocation' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 3 β 'destWeight' β 'u64' β 'Weight' β
β 4 β 'call' β 'Bytes' β 'Bytes' β
β 5 β 'originKind' β 'XcmV0OriginKind' β 'OriginKind' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xcmTransactor.setTransactInfo
docs
@ Change the transact info of a location
args
βββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'location' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
β 1 β 'transactExtraWeight' β 'u64' β 'Weight' β
β 2 β 'feePerSecond' β 'u128' β 'u128' β
β 3 β 'maxWeight' β 'u64' β 'u64' β
βββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
xcmTransactor.removeTransactInfo
docs
@ Remove the transact info of a location
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'location' β 'XcmVersionedMultiLocation' β 'VersionedMultiLocation' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
- authorship:
- babe:
- bagsList:
- balances:
- bounties:
- contracts:
- council:
- currencies:
- democracy:
- democracy.propose
- democracy.second
- democracy.vote
- democracy.emergencyCancel
- democracy.externalPropose
- democracy.externalProposeMajority
- democracy.externalProposeDefault
- democracy.fastTrack
- democracy.vetoExternal
- democracy.cancelReferendum
- democracy.cancelQueued
- democracy.delegate
- democracy.undelegate
- democracy.clearPublicProposals
- democracy.notePreimage
- democracy.notePreimageOperational
- democracy.noteImminentPreimage
- democracy.noteImminentPreimageOperational
- democracy.reapPreimage
- democracy.unlock
- democracy.removeVote
- democracy.removeOtherVote
- democracy.enactProposal
- democracy.blacklist
- democracy.cancelProposal
- deposit:
- electionProviderMultiPhase:
- elections:
- ethereum:
- ethereumChainId:
- evm:
- grandpa:
- identity:
- identity.addRegistrar
- identity.setIdentity
- identity.setSubs
- identity.clearIdentity
- identity.requestJudgement
- identity.cancelRequest
- identity.setFee
- identity.setAccountId
- identity.setFields
- identity.provideJudgement
- identity.killIdentity
- identity.addSub
- identity.renameSub
- identity.removeSub
- identity.quitSub
- imOnline:
- indices:
- multisig:
- nftmart:
- nftmartAuction:
- nftmartAuction.submitDutchAuction
- nftmartAuction.bidDutchAuction
- nftmartAuction.redeemDutchAuction
- nftmartAuction.removeDutchAuction
- nftmartAuction.removeExpiredDutchAuction
- nftmartAuction.submitBritishAuction
- nftmartAuction.bidBritishAuction
- nftmartAuction.redeemBritishAuction
- nftmartAuction.removeBritishAuction
- nftmartAuction.removeExpiredBritishAuction
- nftmartConf:
- nftmartOrder:
- nopEmitT:
- proxy:
- recovery:
- scheduler:
- session:
- staking:
- staking.bond
- staking.bondExtra
- staking.unbond
- staking.withdrawUnbonded
- staking.validate
- staking.nominate
- staking.chill
- staking.setPayee
- staking.setController
- staking.setValidatorCount
- staking.increaseValidatorCount
- staking.scaleValidatorCount
- staking.forceNoEras
- staking.forceNewEra
- staking.setInvulnerables
- staking.forceUnstake
- staking.forceNewEraAlways
- staking.cancelDeferredSlash
- staking.payoutStakers
- staking.rebond
- staking.setHistoryDepth
- staking.reapStash
- staking.kick
- staking.setStakingLimits
- staking.chillOther
- sudo:
- system:
- technicalCommittee:
- template:
- timestamp:
- tips:
- treasury:
- utility:
authorship:
authorship.setUncles
docs
@ Provide a set of uncles.
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'newUncles' β 'Vec<SpRuntimeHeader>' β 'Vec<Header>' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββ
babe:
babe.reportEquivocation
docs
@ Report authority equivocation/misbehavior. This method will verify
@ the equivocation proof and validate the given key ownership proof
@ against the extracted offender. If both are valid, the offence will
@ be reported.
args
βββββββββββ¬ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'equivocationProof' β 'SpConsensusSlotsEquivocationProof' β 'EquivocationProof' β
β 1 β 'keyOwnerProof' β 'SpSessionMembershipProof' β 'KeyOwnerProof' β
βββββββββββ΄ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
babe.reportEquivocationUnsigned
docs
@ Report authority equivocation/misbehavior. This method will verify
@ the equivocation proof and validate the given key ownership proof
@ against the extracted offender. If both are valid, the offence will
@ be reported.
@ This extrinsic must be called unsigned and it is expected that only
@ block authors will call it (validated in `ValidateUnsigned`), as such
@ if the block author is defined it will be defined as the equivocation
@ reporter.
args
βββββββββββ¬ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'equivocationProof' β 'SpConsensusSlotsEquivocationProof' β 'EquivocationProof' β
β 1 β 'keyOwnerProof' β 'SpSessionMembershipProof' β 'KeyOwnerProof' β
βββββββββββ΄ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
babe.planConfigChange
docs
@ Plan an epoch config change. The epoch config change is recorded and will be enacted on
@ the next call to `enact_epoch_change`. The config will be activated one epoch after.
@ Multiple calls to this method will replace any existing planned config change that had
@ not been enacted yet.
args
βββββββββββ¬βββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββ€
β 0 β 'config' β 'SpConsensusBabeDigestsNextConfigDescriptor' β 'NextConfigDescriptor' β
βββββββββββ΄βββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββ
bagsList:
bagsList.rebag
docs
@ Declare that some `dislocated` account has, through rewards or penalties, sufficiently
@ changed its weight that it should properly fall into a different bag than its current
@ one.
@
@ Anyone can call this function about any potentially dislocated account.
@
@ Will never return an error; if `dislocated` does not exist or doesn't need a rebag, then
@ it is a noop and fees are still collected from `origin`.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'dislocated' β 'AccountId32' β 'AccountId' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
balances:
balances.transfer
docs
@ Transfer some liquid free balance to another account.
@
@ `transfer` will set the `FreeBalance` of the sender and receiver.
@ It will decrease the total issuance of the system by the `TransferFee`.
@ If the sender's account is below the existential deposit as a result
@ of the transfer, the account will be reaped.
@
@ The dispatch origin for this call must be `Signed` by the transactor.
@
@ # <weight>
@ - Dependent on arguments but not critical, given proper implementations for input config
@ types. See related functions below.
@ - It contains a limited number of reads and writes internally and no complex
@ computation.
@
@ Related functions:
@
@ - `ensure_can_withdraw` is always called internally but has a bounded complexity.
@ - Transferring balances to accounts that did not exist before will cause
@ `T::OnNewAccount::on_new_account` to be called.
@ - Removing enough funds from an account will trigger `T::DustRemoval::on_unbalanced`.
@ - `transfer_keep_alive` works the same way as `transfer`, but has an additional check
@ that the transfer will not kill the origin account.
@ ---------------------------------
@ - Origin account is already in memory, so no DB operations for them.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.setBalance
docs
@ Set the balances of a given account.
@
@ This will alter `FreeBalance` and `ReservedBalance` in storage. it will
@ also decrease the total issuance of the system (`TotalIssuance`).
@ If the new free or reserved balance is below the existential deposit,
@ it will reset the account nonce (`frame_system::AccountNonce`).
@
@ The dispatch origin for this call is `root`.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'MultiAddress' β 'LookupSource' β
β 1 β 'newFree' β 'Compact<u128>' β 'Balance' β
β 2 β 'newReserved' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.forceTransfer
docs
@ Exactly as `transfer`, except the origin must be root and the source account may be
@ specified.
@ # <weight>
@ - Same as transfer, but additional read and write because the source account is not
@ assumed to be in the overlay.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'source' β 'MultiAddress' β 'LookupSource' β
β 1 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 2 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.transferKeepAlive
docs
@ 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.
@
@ [`transfer`]: struct.Pallet.html#method.transfer
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'Balance' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
balances.transferAll
docs
@ 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). # <weight>
@ - O(1). Just like transfer, but reading the user's transferable balance first.
@ #</weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'keepAlive' β 'bool' β 'bool' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
balances.forceUnreserve
docs
@ Unreserve some balance from a user by force.
@
@ Can only be called by ROOT.
args
βββββββββββ¬βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'MultiAddress' β 'LookupSource' β
β 1 β 'amount' β 'u128' β 'Balance' β
βββββββββββ΄βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
bounties:
bounties.proposeBounty
docs
@ 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.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'value' β 'Compact<u128>' β 'BalanceOf' β
β 1 β 'description' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
bounties.approveBounty
docs
@ 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`.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
bounties.proposeCurator
docs
@ Assign a curator to a funded bounty.
@
@ May only be called from `T::ApproveOrigin`.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
β 1 β 'curator' β 'MultiAddress' β 'LookupSource' β
β 2 β 'fee' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
bounties.unassignCurator
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
bounties.acceptCurator
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
bounties.awardBounty
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
β 1 β 'beneficiary' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
bounties.claimBounty
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
bounties.closeBounty
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
bounties.extendBountyExpiry
docs
@ 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.
@
@ # <weight>
@ - O(1).
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'bountyId' β 'Compact<u32>' β 'BountyIndex' β
β 1 β 'remark' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
contracts:
contracts.call
docs
@ Makes a call to an account, optionally transferring some balance.
@
@ * If the account is a smart-contract account, the associated code will be
@ executed and any value will be transferred.
@ * If the account is a regular account, any value will be transferred.
@ * If no account exists and the call value is not less than `existential_deposit`,
@ a regular account will be created and any value will be transferred.
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'BalanceOf' β
β 2 β 'gasLimit' β 'Compact<u64>' β 'Weight' β
β 3 β 'data' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
contracts.instantiateWithCode
docs
@ Instantiates a new contract from the supplied `code` optionally transferring
@ some balance.
@
@ This is the only function that can deploy new code to the chain.
@
@ # Parameters
@
@ * `endowment`: The balance to transfer from the `origin` to the newly created contract.
@ * `gas_limit`: The gas limit enforced when executing the constructor.
@ * `code`: The contract code to deploy in raw bytes.
@ * `data`: The input data to pass to the contract constructor.
@ * `salt`: Used for the address derivation. See [`Pallet::contract_address`].
@
@ Instantiation is executed as follows:
@
@ - The supplied `code` is instrumented, deployed, and a `code_hash` is created for that
@ code.
@ - If the `code_hash` already exists on the chain the underlying `code` will be shared.
@ - The destination address is computed based on the sender, code_hash and the salt.
@ - The smart-contract account is created at the computed address.
@ - The `endowment` is transferred to the new account.
@ - The `deploy` function is executed in the context of the newly-created account.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'endowment' β 'Compact<u128>' β 'BalanceOf' β
β 1 β 'gasLimit' β 'Compact<u64>' β 'Weight' β
β 2 β 'code' β 'Bytes' β 'Bytes' β
β 3 β 'data' β 'Bytes' β 'Bytes' β
β 4 β 'salt' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
contracts.instantiate
docs
@ Instantiates a contract from a previously deployed wasm binary.
@
@ This function is identical to [`Self::instantiate_with_code`] but without the
@ code deployment step. Instead, the `code_hash` of an on-chain deployed wasm binary
@ must be supplied.
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'endowment' β 'Compact<u128>' β 'BalanceOf' β
β 1 β 'gasLimit' β 'Compact<u64>' β 'Weight' β
β 2 β 'codeHash' β 'H256' β 'CodeHash' β
β 3 β 'data' β 'Bytes' β 'Bytes' β
β 4 β 'salt' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
council:
council.setMembers
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(MP + N)` where:
@ - `M` old-members-count (code- and governance-bounded)
@ - `N` new-members-count (code- and governance-bounded)
@ - `P` proposals-count (code-bounded)
@ - DB:
@ - 1 storage mutation (codec `O(M)` read, `O(N)` write) for reading and writing the
@ members
@ - 1 storage read (codec `O(P)`) for reading the proposals
@ - `P` storage mutations (codec `O(M)`) for updating the votes for each proposal
@ - 1 storage write (codec `O(1)`) for deleting the old `prime` and setting the new one
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'newMembers' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 1 β 'prime' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 2 β 'oldCount' β 'u32' β 'MemberCount' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
council.execute
docs
@ Dispatch a proposal from a member using the `Member` origin.
@
@ Origin must be a member of the collective.
@
@ # <weight>
@ ## Weight
@ - `O(M + P)` where `M` members-count (code-bounded) and `P` complexity of dispatching
@ `proposal`
@ - DB: 1 read (codec `O(M)`) + DB access of `proposal`
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'proposal' β 'Call' β 'Proposal' β
β 1 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
council.propose
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1)` or `O(B + M + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - branching is influenced by `threshold` where:
@ - `P1` is proposal execution complexity (`threshold < 2`)
@ - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
@ - DB:
@ - 1 storage read `is_member` (codec `O(M)`)
@ - 1 storage read `ProposalOf::contains_key` (codec `O(1)`)
@ - DB accesses influenced by `threshold`:
@ - EITHER storage accesses done by `proposal` (`threshold < 2`)
@ - OR proposal insertion (`threshold <= 2`)
@ - 1 storage mutation `Proposals` (codec `O(P2)`)
@ - 1 storage mutation `ProposalCount` (codec `O(1)`)
@ - 1 storage write `ProposalOf` (codec `O(B)`)
@ - 1 storage write `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'threshold' β 'Compact<u32>' β 'MemberCount' β
β 1 β 'proposal' β 'Call' β 'Proposal' β
β 2 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
council.vote
docs
@ 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.
@ # <weight>
@ ## Weight
@ - `O(M)` where `M` is members-count (code- and governance-bounded)
@ - DB:
@ - 1 storage read `Members` (codec `O(M)`)
@ - 1 storage mutation `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposal' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'approve' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
council.close
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1 + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - `P1` is the complexity of `proposal` preimage.
@ - `P2` is proposal-count (code-bounded)
@ - DB:
@ - 2 storage reads (`Members`: codec `O(M)`, `Prime`: codec `O(1)`)
@ - 3 mutations (`Voting`: codec `O(M)`, `ProposalOf`: codec `O(B)`, `Proposals`: codec
@ `O(P2)`)
@ - any mutations done while executing `proposal` (`P1`)
@ - up to 3 events
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'proposalWeightBound' β 'Compact<u64>' β 'Weight' β
β 3 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
council.disapproveProposal
docs
@ 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.
@
@ # <weight>
@ Complexity: O(P) where P is the number of max proposals
@ DB Weight:
@ * Reads: Proposals
@ * Writes: Voting, Proposals, ProposalOf
@ # </weight>
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
currencies:
currencies.transfer
docs
@ Transfer some balance to another account under `currency_id`.
@
@ The dispatch origin for this call must be `Signed` by the
@ transactor.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'currencyId' β 'u32' β 'CurrencyIdOf' β
β 2 β 'amount' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
currencies.transferNativeCurrency
docs
@ Transfer some native currency to another account.
@
@ The dispatch origin for this call must be `Signed` by the
@ transactor.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'dest' β 'MultiAddress' β 'LookupSource' β
β 1 β 'amount' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
currencies.updateBalance
docs
@ update amount of account `who` under `currency_id`.
@
@ The dispatch origin of this call must be _Root_.
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'MultiAddress' β 'LookupSource' β
β 1 β 'currencyId' β 'u32' β 'CurrencyIdOf' β
β 2 β 'amount' β 'i128' β 'AmountOf' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
democracy:
democracy.propose
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'value' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
democracy.second
docs
@ 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.
args
βββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'proposal' β 'Compact<u32>' β 'PropIndex' β
β 1 β 'secondsUpperBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
democracy.vote
docs
@ 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.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββββββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'Compact<u32>' β 'ReferendumIndex' β
β 1 β 'vote' β 'PalletDemocracyVoteAccountVote' β 'AccountVote' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββ
democracy.emergencyCancel
docs
@ 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)`.
args
βββββββββββ¬βββββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.externalPropose
docs
@ 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
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.externalProposeMajority
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.externalProposeDefault
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.fastTrack
docs
@ 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)`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'votingPeriod' β 'u32' β 'BlockNumber' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄ββββββββββββββββ
democracy.vetoExternal
docs
@ 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`
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
democracy.cancelReferendum
docs
@ Remove a referendum.
@
@ The dispatch origin of this call must be _Root_.
@
@ - `ref_index`: The index of the referendum to cancel.
@
@ # Weight: `O(1)`.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'refIndex' β 'Compact<u32>' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββββ
democracy.cancelQueued
docs
@ 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`.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'which' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.delegate
docs
@ 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.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββΌβββββββββββββββ€
β 0 β 'to' β 'AccountId32' β 'AccountId' β
β 1 β 'conviction' β 'PalletDemocracyConviction' β 'Conviction' β
β 2 β 'balance' β 'u128' β 'BalanceOf' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββ΄βββββββββββββββ
democracy.undelegate
docs
@ 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.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
democracy.clearPublicProposals
docs
@ Clears all public proposals.
@
@ The dispatch origin of this call must be _Root_.
@
@ Weight: `O(1)`.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
democracy.notePreimage
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.notePreimageOperational
docs
@ Same as `note_preimage` but origin is `OperationalPreimageOrigin`.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.noteImminentPreimage
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.noteImminentPreimageOperational
docs
@ Same as `note_imminent_preimage` but origin is `OperationalPreimageOrigin`.
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'encodedProposal' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
democracy.reapPreimage
docs
@ 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.
args
βββββββββββ¬ββββββββββββββββββββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'proposalLenUpperBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββββ΄βββββββββββββββββ΄βββββββββββ
democracy.unlock
docs
@ 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.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'target' β 'AccountId32' β 'AccountId' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
democracy.removeVote
docs
@ 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.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββββββ€
β 0 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββββββ
democracy.removeOtherVote
docs
@ 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.
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'target' β 'AccountId32' β 'AccountId' β
β 1 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ
democracy.enactProposal
docs
@ Enact a proposal from a referendum. For now we just make the weight be the maximum.
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌββββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'u32' β 'ReferendumIndex' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄ββββββββββββββββββββ
democracy.blacklist
docs
@ 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).
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββΌββββββββββββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'maybeRefIndex' β 'Option<u32>' β 'Option<ReferendumIndex>' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββββββββββ
democracy.cancelProposal
docs
@ 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()`
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'propIndex' β 'Compact<u32>' β 'PropIndex' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
deposit:
deposit.depositBalance
docs
args
βββββββββββ¬ββββββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'address' β 'H160' β 'H160' β
β 1 β 'value' β 'u128' β 'BalanceOf' β
βββββββββββ΄ββββββββββββ΄βββββββββ΄ββββββββββββββ
electionProviderMultiPhase:
electionProviderMultiPhase.submitUnsigned
docs
@ Submit a solution for the unsigned phase.
@
@ The dispatch origin fo this call must be __none__.
@
@ This submission is checked on the fly. Moreover, this unsigned solution is only
@ validated when submitted to the pool from the **local** node. Effectively, this means
@ that only active validators can submit this transaction when authoring a block (similar
@ to an inherent).
@
@ To prevent any incorrect solution (and thus wasted time/weight), this transaction will
@ panic if the solution submitted by the validator is invalid in any way, effectively
@ putting their authoring reward at risk.
@
@ No deposit or reward is associated with this submission.
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββ€
β 0 β 'rawSolution' β 'PalletElectionProviderMultiPhaseRawSolution' β 'RawSolution' β
β 1 β 'witness' β 'PalletElectionProviderMultiPhaseSolutionOrSnapshotSize' β 'SolutionOrSnapshotSize' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββ
electionProviderMultiPhase.setMinimumUntrustedScore
docs
@ Set a new value for `MinimumUntrustedScore`.
@
@ Dispatch origin must be aligned with `T::ForceOrigin`.
@
@ This check can be turned off by setting the value to `None`.
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'maybeNextScore' β 'Option<[u128;3]>' β 'Option<ElectionScore>' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββββββββββββ
electionProviderMultiPhase.setEmergencyElectionResult
docs
@ Set a solution in the queue, to be handed out to the client of this pallet in the next
@ call to `ElectionProvider::elect`.
@
@ This can only be set by `T::ForceOrigin`, and only when the phase is `Emergency`.
@
@ The solution is not checked for any feasibility and is assumed to be trustworthy, as any
@ feasibility check itself can in principle cause the election process to fail (due to
@ memory/weight constrains).
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββΌβββββββββββββ€
β 0 β 'supports' β 'Vec<(AccountId32,SpNposElectionsSupport)>' β 'Supports' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ
electionProviderMultiPhase.submit
docs
@ Submit a solution for the signed phase.
@
@ The dispatch origin fo this call must be __signed__.
@
@ The solution is potentially queued, based on the claimed score and processed at the end
@ of the signed phase.
@
@ A deposit is reserved and recorded for the solution. Based on the outcome, the solution
@ might be rewarded, slashed, or get all or a part of the deposit back.
@
@ # <weight>
@ Queue size must be provided as witness data.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'rawSolution' β 'PalletElectionProviderMultiPhaseRawSolution' β 'RawSolution' β
β 1 β 'numSignedSubmissions' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββ
elections:
elections.vote
docs
@ 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 total balance, then the maximum of the two is used.
@
@ The dispatch origin of this call must be signed.
@
@ ### Warning
@
@ It is the responsibility of the caller to **NOT** place all of their balance into the
@ lock and keep some for further operations.
@
@ # <weight>
@ We assume the maximum weight among all 3 cases: vote_equal, vote_more and vote_less.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'votes' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 1 β 'value' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββ΄βββββββββββββββββββ
elections.removeVoter
docs
@ 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.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
elections.submitCandidacy
docs
@ 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.
@
@ # <weight>
@ The number of current candidates must be provided as witness data.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'candidateCount' β 'Compact<u32>' β 'u32' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββ΄βββββββββββ
elections.renounceCandidacy
docs
@ 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`](Self::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.
@
@ # <weight>
@ The type of renouncing must be provided as witness data.
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββββββββββββββββΌβββββββββββββββ€
β 0 β 'renouncing' β 'PalletElectionsPhragmenRenouncing' β 'Renouncing' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ΄βββββββββββββββ
elections.removeMember
docs
@ 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.
@
@ # <weight>
@ If we have a replacement, we use a small weight. Else, since this is a root call and
@ will go into phragmen, we assume full block for now.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'MultiAddress' β 'LookupSource' β
β 1 β 'hasReplacement' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
elections.cleanDefunctVoters
docs
@ 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.
@
@ # <weight>
@ The total number of voters and those that are defunct must be provided as witness data.
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'numVoters' β 'u32' β 'u32' β
β 1 β 'numDefunct' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββ΄ββββββββ΄βββββββββββ
ethereum:
ethereum.transact
docs
@ Transact an Ethereum transaction.
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'transaction' β 'EthereumTransactionTransactionV2' β 'Transaction' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββ
ethereumChainId:
ethereumChainId.setChainId
docs
@ set chain_id
args
βββββββββββ¬ββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'chainId' β 'u64' β 'u64' β
βββββββββββ΄ββββββββββββ΄ββββββββ΄βββββββββββ
evm:
evm.withdraw
docs
@ Withdraw balance from EVM into currency/balances pallet.
args
βββββββββββ¬ββββββββββββ¬βββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββΌββββββββββββββ€
β 0 β 'address' β 'H160' β 'H160' β
β 1 β 'value' β 'u128' β 'BalanceOf' β
βββββββββββ΄ββββββββββββ΄βββββββββ΄ββββββββββββββ
evm.call
docs
@ Issue an EVM call operation. This is similar to a message call transaction in Ethereum.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'target' β 'H160' β 'H160' β
β 2 β 'input' β 'Bytes' β 'Bytes' β
β 3 β 'value' β 'U256' β 'U256' β
β 4 β 'gasLimit' β 'u64' β 'u64' β
β 5 β 'maxFeePerGas' β 'U256' β 'U256' β
β 6 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 8 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
evm.create
docs
@ Issue an EVM create operation. This is similar to a contract creation transaction in
@ Ethereum.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'init' β 'Bytes' β 'Bytes' β
β 2 β 'value' β 'U256' β 'U256' β
β 3 β 'gasLimit' β 'u64' β 'u64' β
β 4 β 'maxFeePerGas' β 'U256' β 'U256' β
β 5 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 6 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
evm.create2
docs
@ Issue an EVM create2 operation.
args
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'source' β 'H160' β 'H160' β
β 1 β 'init' β 'Bytes' β 'Bytes' β
β 2 β 'salt' β 'H256' β 'H256' β
β 3 β 'value' β 'U256' β 'U256' β
β 4 β 'gasLimit' β 'u64' β 'u64' β
β 5 β 'maxFeePerGas' β 'U256' β 'U256' β
β 6 β 'maxPriorityFeePerGas' β 'Option<U256>' β 'Option<U256>' β
β 7 β 'nonce' β 'Option<U256>' β 'Option<U256>' β
β 8 β 'accessList' β 'Vec<(H160,Vec<H256>)>' β 'Vec<(H160,Vec<H256>)>' β
βββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
grandpa:
grandpa.reportEquivocation
docs
@ Report voter equivocation/misbehavior. This method will verify the
@ equivocation proof and validate the given key ownership proof
@ against the extracted offender. If both are valid, the offence
@ will be reported.
args
βββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'equivocationProof' β 'SpFinalityGrandpaEquivocationProof' β 'EquivocationProof' β
β 1 β 'keyOwnerProof' β 'SpSessionMembershipProof' β 'KeyOwnerProof' β
βββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
grandpa.reportEquivocationUnsigned
docs
@ Report voter equivocation/misbehavior. This method will verify the
@ equivocation proof and validate the given key ownership proof
@ against the extracted offender. If both are valid, the offence
@ will be reported.
@
@ This extrinsic must be called unsigned and it is expected that only
@ block authors will call it (validated in `ValidateUnsigned`), as such
@ if the block author is defined it will be defined as the equivocation
@ reporter.
args
βββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'equivocationProof' β 'SpFinalityGrandpaEquivocationProof' β 'EquivocationProof' β
β 1 β 'keyOwnerProof' β 'SpSessionMembershipProof' β 'KeyOwnerProof' β
βββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
grandpa.noteStalled
docs
@ Note that the current authority set of the GRANDPA finality gadget has
@ stalled. This will trigger a forced authority set change at the beginning
@ of the next session, to be enacted `delay` blocks after that. The delay
@ should be high enough to safely assume that the block signalling the
@ forced change will not be re-orged (e.g. 1000 blocks). The GRANDPA voters
@ will start the new authority set using the given finalized block as base.
@ Only callable by root.
args
βββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββββββββββΌββββββββΌββββββββββββββββ€
β 0 β 'delay' β 'u32' β 'BlockNumber' β
β 1 β 'bestFinalizedBlockNumber' β 'u32' β 'BlockNumber' β
βββββββββββ΄βββββββββββββββββββββββββββββ΄ββββββββ΄ββββββββββββββββ
identity:
identity.addRegistrar
docs
@ 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.
@
@ # <weight>
@ - `O(R)` where `R` registrar-count (governance-bounded and code-bounded).
@ - One storage mutation (codec `O(R)`).
@ - One event.
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
identity.setIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(X + X' + R)`
@ - where `X` additional-field-count (deposit-bounded and code-bounded)
@ - where `R` judgements-count (registrar-count-bounded)
@ - One balance reserve operation.
@ - One storage mutation (codec-read `O(X' + R)`, codec-write `O(X + R)`).
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββββββββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'info' β 'PalletIdentityIdentityInfo' β 'IdentityInfo' β
βββββββββββ΄βββββββββ΄βββββββββββββββββββββββββββββββ΄βββββββββββββββββ
identity.setSubs
docs
@ 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.
@
@ # <weight>
@ - `O(P + S)`
@ - where `P` old-subs-count (hard- and deposit-bounded).
@ - where `S` subs-count (hard- and deposit-bounded).
@ - At most one balance operations.
@ - DB:
@ - `P + S` storage mutations (codec complexity `O(1)`)
@ - One storage read (codec complexity `O(P)`).
@ - One storage write (codec complexity `O(S)`).
@ - One storage-exists (`IdentityOf::contains_key`).
@ # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββββββββββββββββββββΌββββββββββββββββββββββββββ€
β 0 β 'subs' β 'Vec<(AccountId32,Data)>' β 'Vec<(AccountId,Data)>' β
βββββββββββ΄βββββββββ΄ββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ
identity.clearIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(R + S + X)`
@ - where `R` registrar-count (governance-bounded).
@ - where `S` subs-count (hard- and deposit-bounded).
@ - where `X` additional-field-count (deposit-bounded and code-bounded).
@ - One balance-unreserve operation.
@ - `2` storage reads and `S + 2` storage deletions.
@ - One event.
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
identity.requestJudgement
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-reserve operation.
@ - Storage: 1 read `O(R)`, 1 mutate `O(X + R)`.
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'maxFee' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ
identity.cancelRequest
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-reserve operation.
@ - One storage mutation `O(R + X)`.
@ - One event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'u32' β 'RegistrarIndex' β
βββββββββββ΄βββββββββββββ΄ββββββββ΄βββββββββββββββββββ
identity.setFee
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 7.315 + R * 0.329 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'fee' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ
identity.setAccountId
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 8.823 + R * 0.32 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'new' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββ΄βββββββββββββββββββ
identity.setFields
docs
@ 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.
@
@ # <weight>
@ - `O(R)`.
@ - One storage mutation `O(R)`.
@ - Benchmark: 7.464 + R * 0.325 Β΅s (min squares analysis)
@ # </weight>
args
βββββββββββ¬βββββββββββ¬βββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'index' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'fields' β 'PalletIdentityBitFlags' β 'IdentityFields' β
βββββββββββ΄βββββββββββ΄βββββββββββββββββββββββββββ΄βββββββββββββββββββ
identity.provideJudgement
docs
@ 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.
@
@ # <weight>
@ - `O(R + X)`.
@ - One balance-transfer operation.
@ - Up to one account-lookup operation.
@ - Storage: 1 read `O(R)`, 1 mutate `O(R + X)`.
@ - One event.
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬ββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'regIndex' β 'Compact<u32>' β 'RegistrarIndex' β
β 1 β 'target' β 'MultiAddress' β 'LookupSource' β
β 2 β 'judgement' β 'PalletIdentityJudgement' β 'Judgement' β
βββββββββββ΄ββββββββββββββ΄ββββββββββββββββββββββββββββ΄βββββββββββββββββββ
identity.killIdentity
docs
@ 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.
@
@ # <weight>
@ - `O(R + S + X)`.
@ - One balance-reserve operation.
@ - `S + 2` storage mutations.
@ - One event.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'target' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
identity.addSub
docs
@ 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`.
args
βββββββββββ¬βββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'MultiAddress' β 'LookupSource' β
β 1 β 'data' β 'Data' β 'Data' β
βββββββββββ΄βββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
identity.renameSub
docs
@ 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`.
args
βββββββββββ¬βββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'MultiAddress' β 'LookupSource' β
β 1 β 'data' β 'Data' β 'Data' β
βββββββββββ΄βββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
identity.removeSub
docs
@ 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`.
args
βββββββββββ¬ββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'sub' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
identity.quitSub
docs
@ 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.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
imOnline:
imOnline.heartbeat
docs
@ # <weight>
@ - Complexity: `O(K + E)` where K is length of `Keys` (heartbeat.validators_len) and E is
@ length of `heartbeat.network_state.external_address`
@ - `O(K)`: decoding of length `K`
@ - `O(E)`: decoding/encoding of length `E`
@ - DbReads: pallet_session `Validators`, pallet_session `CurrentIndex`, `Keys`,
@ `ReceivedHeartbeats`
@ - DbWrites: `ReceivedHeartbeats`
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββ€
β 0 β 'heartbeat' β 'PalletImOnlineHeartbeat' β 'Heartbeat' β
β 1 β 'signature' β 'PalletImOnlineSr25519AppSr25519Signature' β 'Signature' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββ
indices:
indices.claim
docs
@ Assign an previously unassigned index.
@
@ Payment: `Deposit` is reserved from the sender account.
@
@ The dispatch origin for this call must be _Signed_.
@
@ - `index`: the index to be claimed. This must not be in use.
@
@ Emits `IndexAssigned` if successful.
@
@ # <weight>
@ - `O(1)`.
@ - One storage mutation (codec `O(1)`).
@ - One reserve operation.
@ - One event.
@ -------------------
@ - DB Weight: 1 Read/Write (Accounts)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββββββββ€
β 0 β 'index' β 'u32' β 'AccountIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββββββββ
indices.transfer
docs
@ Assign an index already owned by the sender to another account. The balance reservation
@ is effectively transferred to the new account.
@
@ The dispatch origin for this call must be _Signed_.
@
@ - `index`: the index to be re-assigned. This must be owned by the sender.
@ - `new`: the new owner of the index. This function is a no-op if it is equal to sender.
@
@ Emits `IndexAssigned` if successful.
@
@ # <weight>
@ - `O(1)`.
@ - One storage mutation (codec `O(1)`).
@ - One transfer operation.
@ - One event.
@ -------------------
@ - DB Weight:
@ - Reads: Indices Accounts, System Account (recipient)
@ - Writes: Indices Accounts, System Account (recipient)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'new' β 'AccountId32' β 'AccountId' β
β 1 β 'index' β 'u32' β 'AccountIndex' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
indices.free
docs
@ Free up an index owned by the sender.
@
@ Payment: Any previous deposit placed for the index is unreserved in the sender account.
@
@ The dispatch origin for this call must be _Signed_ and the sender must own the index.
@
@ - `index`: the index to be freed. This must be owned by the sender.
@
@ Emits `IndexFreed` if successful.
@
@ # <weight>
@ - `O(1)`.
@ - One storage mutation (codec `O(1)`).
@ - One reserve operation.
@ - One event.
@ -------------------
@ - DB Weight: 1 Read/Write (Accounts)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββββββββ€
β 0 β 'index' β 'u32' β 'AccountIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββββββββ
indices.forceTransfer
docs
@ Force an index to an account. This doesn't require a deposit. If the index is already
@ held, then any deposit is reimbursed to its current owner.
@
@ The dispatch origin for this call must be _Root_.
@
@ - `index`: the index to be (re-)assigned.
@ - `new`: the new owner of the index. This function is a no-op if it is equal to sender.
@ - `freeze`: if set to `true`, will freeze the index so it cannot be transferred.
@
@ Emits `IndexAssigned` if successful.
@
@ # <weight>
@ - `O(1)`.
@ - One storage mutation (codec `O(1)`).
@ - Up to one reserve operation.
@ - One event.
@ -------------------
@ - DB Weight:
@ - Reads: Indices Accounts, System Account (original owner)
@ - Writes: Indices Accounts, System Account (original owner)
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌβββββββββββββββββ€
β 0 β 'new' β 'AccountId32' β 'AccountId' β
β 1 β 'index' β 'u32' β 'AccountIndex' β
β 2 β 'freeze' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ
indices.freeze
docs
@ Freeze an index so it will always point to the sender account. This consumes the
@ deposit.
@
@ The dispatch origin for this call must be _Signed_ and the signing account must have a
@ non-frozen account `index`.
@
@ - `index`: the index to be frozen in place.
@
@ Emits `IndexFrozen` if successful.
@
@ # <weight>
@ - `O(1)`.
@ - One storage mutation (codec `O(1)`).
@ - Up to one slash operation.
@ - One event.
@ -------------------
@ - DB Weight: 1 Read/Write (Accounts)
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββββββββ€
β 0 β 'index' β 'u32' β 'AccountIndex' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββββββββ
multisig:
multisig.asMultiThreshold1
docs
@ 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.
@
@ # <weight>
@ O(Z + C) where Z is the length of the call and C its execution weight.
@ -------------------------------
@ - DB Weight: None
@ - Plus Call Weight
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬βββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌβββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'otherSignatories' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββββββββββ΄βββββββββββββββββββββ΄βββββββββββββββββββ
multisig.asMulti
docs
@ 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.
@
@ # <weight>
@ - `O(S + Z + Call)`.
@ - Up to one balance-reserve or unreserve operation.
@ - One passthrough operation, one insert, both `O(S)` where `S` is the number of
@ signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
@ - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len.
@ - One encode & hash, both of complexity `O(S)`.
@ - Up to one binary search and insert (`O(logS + S)`).
@ - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
@ - One event.
@ - The weight of the `call`.
@ - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
@ taken for its lifetime of `DepositBase + threshold * DepositFactor`.
@ -------------------------------
@ - DB Weight:
@ - Reads: Multisig Storage, [Caller Account], Calls (if `store_call`)
@ - Writes: Multisig Storage, [Caller Account], Calls (if `store_call`)
@ - Plus Call Weight
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'threshold' β 'u16' β 'u16' β
β 1 β 'otherSignatories' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 2 β 'maybeTimepoint' β 'Option<PalletMultisigTimepoint>' β 'Option<Timepoint>' β
β 3 β 'call' β 'WrapperKeepOpaque<Call>' β 'OpaqueCall' β
β 4 β 'storeCall' β 'bool' β 'bool' β
β 5 β 'maxWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
multisig.approveAsMulti
docs
@ 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.
@
@ # <weight>
@ - `O(S)`.
@ - Up to one balance-reserve or unreserve operation.
@ - One passthrough operation, one insert, both `O(S)` where `S` is the number of
@ signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
@ - One encode & hash, both of complexity `O(S)`.
@ - Up to one binary search and insert (`O(logS + S)`).
@ - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
@ - One event.
@ - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
@ taken for its lifetime of `DepositBase + threshold * DepositFactor`.
@ ----------------------------------
@ - DB Weight:
@ - Read: Multisig Storage, [Caller Account]
@ - Write: Multisig Storage, [Caller Account]
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'threshold' β 'u16' β 'u16' β
β 1 β 'otherSignatories' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 2 β 'maybeTimepoint' β 'Option<PalletMultisigTimepoint>' β 'Option<Timepoint>' β
β 3 β 'callHash' β '[u8;32]' β '[u8;32]' β
β 4 β 'maxWeight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
multisig.cancelAsMulti
docs
@ 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.
@
@ # <weight>
@ - `O(S)`.
@ - Up to one balance-reserve or unreserve operation.
@ - One passthrough operation, one insert, both `O(S)` where `S` is the number of
@ signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
@ - One encode & hash, both of complexity `O(S)`.
@ - One event.
@ - I/O: 1 read `O(S)`, one remove.
@ - Storage: removes one item.
@ ----------------------------------
@ - DB Weight:
@ - Read: Multisig Storage, [Caller Account], Refund Account, Calls
@ - Write: Multisig Storage, [Caller Account], Refund Account, Calls
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'threshold' β 'u16' β 'u16' β
β 1 β 'otherSignatories' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 2 β 'timepoint' β 'PalletMultisigTimepoint' β 'Timepoint' β
β 3 β 'callHash' β '[u8;32]' β '[u8;32]' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββββββββββββββ΄βββββββββββββββββββ
nftmart:
nftmart.createClass
docs
@ Create NFT class, tokens belong to the class.
@
@ - `metadata`: external metadata
@ - `properties`: class property, include `Transferable` `Burnable`
@ - `name`: class name, with len limitation.
@ - `description`: class description, with len limitation.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'metadata' β 'Bytes' β 'NFTMetadata' β
β 1 β 'name' β 'Bytes' β 'Bytes' β
β 2 β 'description' β 'Bytes' β 'Bytes' β
β 3 β 'royaltyRate' β 'Compact<PerU16>' β 'PerU16' β
β 4 β 'properties' β 'u64' β 'Properties' β
β 5 β 'categoryIds' β 'Vec<u64>' β 'Vec<GlobalId>' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββ
nftmart.updateClass
docs
@ Update NFT class.
@
@ - `class_id`: class id
@ - `metadata`: external metadata
@ - `properties`: class property, include `Transferable` `Burnable`
@ - `name`: class name, with len limitation.
@ - `description`: class description, with len limitation.
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'metadata' β 'Bytes' β 'NFTMetadata' β
β 2 β 'name' β 'Bytes' β 'Bytes' β
β 3 β 'description' β 'Bytes' β 'Bytes' β
β 4 β 'royaltyRate' β 'Compact<PerU16>' β 'PerU16' β
β 5 β 'properties' β 'u64' β 'Properties' β
β 6 β 'categoryIds' β 'Vec<u64>' β 'Vec<GlobalId>' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββ
nftmart.updateTokenRoyalty
docs
@ Update token royalty.
args
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β
β 2 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β
βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
nftmart.updateTokenRoyaltyBeneficiary
docs
@ Update token royalty beneficiary.
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β
β 2 β 'to' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
nftmart.updateTokenMetadata
docs
@ Update token metadata.
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β
β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
nftmart.updateToken
docs
@ Update token royalty_beneficiary, quantity, metadata, and royalty.
args
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'to' β 'MultiAddress' β 'LookupSource' β
β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 2 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β
β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β
β 4 β 'metadata' β 'Bytes' β 'NFTMetadata' β
β 5 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β
βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
nftmart.mint
docs
@ Mint NFT token
@
@ - `to`: the token owner's account
@ - `class_id`: token belong to the class id
@ - `metadata`: external metadata
@ - `quantity`: token quantity
args
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'to' β 'MultiAddress' β 'LookupSource' β
β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β
β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β
β 4 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β
βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
nftmart.proxyMint
docs
@ Mint NFT token by a proxy account.
@
@ - `origin`: a proxy account
args
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'to' β 'MultiAddress' β 'LookupSource' β
β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β
β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β
β 4 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β
βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
nftmart.transfer
docs
@ Transfer NFT tokens to another account
@
@ - `to`: the token owner's account
@ - `class_id`: class id
@ - `token_id`: token id
@ - `quantity`: quantity
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'to' β 'MultiAddress' β 'LookupSource' β
β 1 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
nftmart.burn
docs
@ Burn NFT token
@
@ - `class_id`: class id
@ - `token_id`: token id
@ - `quantity`: quantity
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β
β 2 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
nftmart.destroyClass
docs
@ Destroy NFT class
@
@ - `class_id`: destroy class id
@ - `dest`: transfer reserve balance from sub_account to dest
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β
β 1 β 'dest' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
nftmartAuction:
nftmartAuction.submitDutchAuction
docs
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β
β 1 β 'deposit' β 'Compact<u128>' β 'Balance' β
β 2 β 'minPrice' β 'Compact<u128>' β 'Balance' β
β 3 β 'maxPrice' β 'Compact<u128>' β 'Balance' β
β 4 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β
β 5 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β
β 6 β 'allowBritishAuction' β 'bool' β 'bool' β
β 7 β 'minRaise' β 'Compact<PerU16>' β 'PerU16' β
β 8 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
nftmartAuction.bidDutchAuction
docs
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'price' β 'Compact<u128>' β 'Balance' β
β 1 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β
β 2 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
β 3 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 4 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
nftmartAuction.redeemDutchAuction
docs
@ redeem
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β
β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
nftmartAuction.removeDutchAuction
docs
@ remove a dutch auction by auction owner.
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
nftmartAuction.removeExpiredDutchAuction
docs
@ remove an expired dutch auction by auction owner.
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'auctionOwner' β 'AccountId32' β 'AccountId' β
β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
nftmartAuction.submitBritishAuction
docs
@ Create an British auction.
@
@ - `currency_id`: Currency Id
@ - `hammer_price`: If somebody offer this price, the auction will be finished. Set to zero to disable.
@ - `min_raise`: The next price of bid should be larger than old_price * ( 1 + min_raise )
@ - `deposit`: A higher deposit will be good for the display of the auction in the market.
@ - `init_price`: The initial price for the auction to kick off.
@ - `deadline`: A block number which represents the end of the auction activity.
@ - `allow_delay`: If ture, in some cases the deadline will be extended.
@ - `items`: Nft list.
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β
β 1 β 'hammerPrice' β 'Compact<u128>' β 'Balance' β
β 2 β 'minRaise' β 'Compact<PerU16>' β 'PerU16' β
β 3 β 'deposit' β 'Compact<u128>' β 'Balance' β
β 4 β 'initPrice' β 'Compact<u128>' β 'Balance' β
β 5 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β
β 6 β 'allowDelay' β 'bool' β 'bool' β
β 7 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β
β 8 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
nftmartAuction.bidBritishAuction
docs
@ Bid
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'price' β 'Compact<u128>' β 'Balance' β
β 1 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β
β 2 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
β 3 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 4 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
nftmartAuction.redeemBritishAuction
docs
@ redeem
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β
β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
nftmartAuction.removeBritishAuction
docs
@ remove an auction by auction owner.
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
nftmartAuction.removeExpiredBritishAuction
docs
@ remove an expired british auction by auction owner.
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€
β 0 β 'auctionOwner' β 'AccountId32' β 'AccountId' β
β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
nftmartConf:
nftmartConf.addWhitelist
docs
@ add an account into whitelist
args
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'who' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββ΄ββββββββββββββββ΄ββββββββββββββ
nftmartConf.removeWhitelist
docs
@ remove an account from whitelist
args
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'who' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββ΄ββββββββββββββββ΄ββββββββββββββ
nftmartConf.createCategory
docs
@ Create a common category for trading NFT.
@ A Selling NFT should belong to a category.
@
@ - `metadata`: metadata
args
βββββββββββ¬βββββββββββββ¬ββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββΌββββββββββββββββ€
β 0 β 'metadata' β 'Bytes' β 'NFTMetadata' β
βββββββββββ΄βββββββββββββ΄ββββββββββ΄ββββββββββββββββ
nftmartConf.updateCategory
docs
@ Update a common category.
@
@ - `category_id`: category ID
@ - `metadata`: metadata
args
βββββββββββ¬βββββββββββββββ¬ββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββΌββββββββββββββββ€
β 0 β 'categoryId' β 'u64' β 'GlobalId' β
β 1 β 'metadata' β 'Bytes' β 'NFTMetadata' β
βββββββββββ΄βββββββββββββββ΄ββββββββββ΄ββββββββββββββββ
nftmartConf.updateAuctionCloseDelay
docs
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββββββββββ€
β 0 β 'delay' β 'u32' β 'BlockNumberFor' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββββββββββ
nftmartOrder:
nftmartOrder.submitOrder
docs
@ Create an order.
@
@ - `currency_id`: currency id
@ - `category_id`: category id
@ - `deposit`: The balances to create an order
@ - `price`: nfts' price.
@ - `deadline`: deadline
@ - `items`: a list of `(class_id, token_id, quantity, price)`
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β
β 1 β 'deposit' β 'Compact<u128>' β 'Balance' β
β 2 β 'price' β 'Compact<u128>' β 'Balance' β
β 3 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β
β 4 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β
β 5 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
nftmartOrder.takeOrder
docs
@ Take a NFT order.
@
@ - `order_id`: order id
@ - `order_owner`: token owner
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'orderId' β 'Compact<u64>' β 'GlobalId' β
β 1 β 'orderOwner' β 'MultiAddress' β 'LookupSource' β
β 2 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 3 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
nftmartOrder.removeOrder
docs
@ remove an order by order owner.
@
@ - `order_id`: order id
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'orderId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
nftmartOrder.removeOffer
docs
@ remove an offer by offer owner.
@
@ - `offer_id`: offer id
args
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'offerId' β 'Compact<u64>' β 'GlobalId' β
βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
nftmartOrder.submitOffer
docs
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€
β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β
β 1 β 'price' β 'Compact<u128>' β 'Balance' β
β 2 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β
β 3 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β
β 4 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
nftmartOrder.takeOffer
docs
@ Take a NFT offer.
@
@ - `offer_id`: offer id
@ - `offer_owner`: token owner
args
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'offerId' β 'Compact<u64>' β 'GlobalId' β
β 1 β 'offerOwner' β 'MultiAddress' β 'LookupSource' β
β 2 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 3 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β
βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
nopEmitT:
nopEmitT.emit
docs
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
proxy:
proxy.proxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'real' β 'AccountId32' β 'AccountId' β
β 1 β 'forceProxyType' β 'Option<NodeRuntimeProxyType>' β 'Option<ProxyType>' β
β 2 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
proxy.addProxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'delegate' β 'AccountId32' β 'AccountId' β
β 1 β 'proxyType' β 'NodeRuntimeProxyType' β 'ProxyType' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.removeProxy
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'delegate' β 'AccountId32' β 'AccountId' β
β 1 β 'proxyType' β 'NodeRuntimeProxyType' β 'ProxyType' β
β 2 β 'delay' β 'u32' β 'BlockNumber' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.removeProxies
docs
@ 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.**
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
proxy.anonymous
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
@ TODO: Might be over counting 1 read
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'proxyType' β 'NodeRuntimeProxyType' β 'ProxyType' β
β 1 β 'delay' β 'u32' β 'BlockNumber' β
β 2 β 'index' β 'u16' β 'u16' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.killAnonymous
docs
@ 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.
@
@ # <weight>
@ Weight is a function of the number of proxies the user has (P).
@ # </weight>
args
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌβββββββββββββββββββββββββΌββββββββββββββββ€
β 0 β 'spawner' β 'AccountId32' β 'AccountId' β
β 1 β 'proxyType' β 'NodeRuntimeProxyType' β 'ProxyType' β
β 2 β 'index' β 'u16' β 'u16' β
β 3 β 'height' β 'Compact<u32>' β 'BlockNumber' β
β 4 β 'extIndex' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββββ΄ββββββββββββββββ
proxy.announce
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'real' β 'AccountId32' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.removeAnnouncement
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'real' β 'AccountId32' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.rejectAnnouncement
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββ¬βββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββΌβββββββββββββββ€
β 0 β 'delegate' β 'AccountId32' β 'AccountId' β
β 1 β 'callHash' β 'H256' β 'CallHashOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββ΄βββββββββββββββ
proxy.proxyAnnounced
docs
@ 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.
@
@ # <weight>
@ Weight is a function of:
@ - A: the number of announcements made.
@ - P: the number of proxies the user has.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'delegate' β 'AccountId32' β 'AccountId' β
β 1 β 'real' β 'AccountId32' β 'AccountId' β
β 2 β 'forceProxyType' β 'Option<NodeRuntimeProxyType>' β 'Option<ProxyType>' β
β 3 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
recovery:
recovery.asRecovered
docs
@ Send a call through a recovered account.
@
@ The dispatch origin for this call must be _Signed_ and registered to
@ be able to make calls on behalf of the recovered account.
@
@ Parameters:
@ - `account`: The recovered account you want to make a call on-behalf-of.
@ - `call`: The call you want to make with the recovered account.
@
@ # <weight>
@ - The weight of the `call` + 10,000.
@ - One storage lookup to check account is recovered by `who`. O(1)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId32' β 'AccountId' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.setRecovered
docs
@ Allow ROOT to bypass the recovery process and set an a rescuer account
@ for a lost account directly.
@
@ The dispatch origin for this call must be _ROOT_.
@
@ Parameters:
@ - `lost`: The "lost account" to be recovered.
@ - `rescuer`: The "rescuer account" which can call as the lost account.
@
@ # <weight>
@ - One storage write O(1)
@ - One event
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'lost' β 'AccountId32' β 'AccountId' β
β 1 β 'rescuer' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.createRecovery
docs
@ Create a recovery configuration for your account. This makes your account recoverable.
@
@ Payment: `ConfigDepositBase` + `FriendDepositFactor` * #_of_friends balance
@ will be reserved for storing the recovery configuration. This deposit is returned
@ in full when the user calls `remove_recovery`.
@
@ The dispatch origin for this call must be _Signed_.
@
@ Parameters:
@ - `friends`: A list of friends you trust to vouch for recovery attempts. Should be
@ ordered and contain no duplicate values.
@ - `threshold`: The number of friends that must vouch for a recovery attempt before the
@ account can be recovered. Should be less than or equal to the length of the list of
@ friends.
@ - `delay_period`: The number of blocks after a recovery attempt is initialized that
@ needs to pass before the account can be recovered.
@
@ # <weight>
@ - Key: F (len of friends)
@ - One storage read to check that account is not already recoverable. O(1).
@ - A check that the friends list is sorted and unique. O(F)
@ - One currency reserve operation. O(X)
@ - One storage write. O(1). Codec O(F).
@ - One event.
@
@ Total Complexity: O(F + X)
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'friends' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 1 β 'threshold' β 'u16' β 'u16' β
β 2 β 'delayPeriod' β 'u32' β 'BlockNumber' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββββββ΄βββββββββββββββββββ
recovery.initiateRecovery
docs
@ Initiate the process for recovering a recoverable account.
@
@ Payment: `RecoveryDeposit` balance will be reserved for initiating the
@ recovery process. This deposit will always be repatriated to the account
@ trying to be recovered. See `close_recovery`.
@
@ The dispatch origin for this call must be _Signed_.
@
@ Parameters:
@ - `account`: The lost account that you want to recover. This account needs to be
@ recoverable (i.e. have a recovery configuration).
@
@ # <weight>
@ - One storage read to check that account is recoverable. O(F)
@ - One storage read to check that this recovery process hasn't already started. O(1)
@ - One currency reserve operation. O(X)
@ - One storage read to get the current block number. O(1)
@ - One storage write. O(1).
@ - One event.
@
@ Total Complexity: O(F + X)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.vouchRecovery
docs
@ Allow a "friend" of a recoverable account to vouch for an active recovery
@ process for that account.
@
@ The dispatch origin for this call must be _Signed_ and must be a "friend"
@ for the recoverable account.
@
@ Parameters:
@ - `lost`: The lost account that you want to recover.
@ - `rescuer`: The account trying to rescue the lost account that you want to vouch for.
@
@ The combination of these two parameters must point to an active recovery
@ process.
@
@ # <weight>
@ Key: F (len of friends in config), V (len of vouching friends)
@ - One storage read to get the recovery configuration. O(1), Codec O(F)
@ - One storage read to get the active recovery process. O(1), Codec O(V)
@ - One binary search to confirm caller is a friend. O(logF)
@ - One binary search to confirm caller has not already vouched. O(logV)
@ - One storage write. O(1), Codec O(V).
@ - One event.
@
@ Total Complexity: O(F + logF + V + logV)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'lost' β 'AccountId32' β 'AccountId' β
β 1 β 'rescuer' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.claimRecovery
docs
@ Allow a successful rescuer to claim their recovered account.
@
@ The dispatch origin for this call must be _Signed_ and must be a "rescuer"
@ who has successfully completed the account recovery process: collected
@ `threshold` or more vouches, waited `delay_period` blocks since initiation.
@
@ Parameters:
@ - `account`: The lost account that you want to claim has been successfully recovered by
@ you.
@
@ # <weight>
@ Key: F (len of friends in config), V (len of vouching friends)
@ - One storage read to get the recovery configuration. O(1), Codec O(F)
@ - One storage read to get the active recovery process. O(1), Codec O(V)
@ - One storage read to get the current block number. O(1)
@ - One storage write. O(1), Codec O(V).
@ - One event.
@
@ Total Complexity: O(F + V)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.closeRecovery
docs
@ As the controller of a recoverable account, close an active recovery
@ process for your account.
@
@ Payment: By calling this function, the recoverable account will receive
@ the recovery deposit `RecoveryDeposit` placed by the rescuer.
@
@ The dispatch origin for this call must be _Signed_ and must be a
@ recoverable account with an active recovery process for it.
@
@ Parameters:
@ - `rescuer`: The account trying to rescue this recoverable account.
@
@ # <weight>
@ Key: V (len of vouching friends)
@ - One storage read/remove to get the active recovery process. O(1), Codec O(V)
@ - One balance call to repatriate reserved. O(X)
@ - One event.
@
@ Total Complexity: O(V + X)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'rescuer' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
recovery.removeRecovery
docs
@ Remove the recovery process for your account. Recovered accounts are still accessible.
@
@ NOTE: The user must make sure to call `close_recovery` on all active
@ recovery attempts before calling this function else it will fail.
@
@ Payment: By calling this function the recoverable account will unreserve
@ their recovery configuration deposit.
@ (`ConfigDepositBase` + `FriendDepositFactor` * #_of_friends)
@
@ The dispatch origin for this call must be _Signed_ and must be a
@ recoverable account (i.e. has a recovery configuration).
@
@ # <weight>
@ Key: F (len of friends)
@ - One storage read to get the prefix iterator for active recoveries. O(1)
@ - One storage read/remove to get the recovery configuration. O(1), Codec O(F)
@ - One balance call to unreserved. O(X)
@ - One event.
@
@ Total Complexity: O(F + X)
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
recovery.cancelRecovered
docs
@ Cancel the ability to use `as_recovered` for `account`.
@
@ The dispatch origin for this call must be _Signed_ and registered to
@ be able to make calls on behalf of the recovered account.
@
@ Parameters:
@ - `account`: The recovered account you are able to call on-behalf-of.
@
@ # <weight>
@ - One storage mutation to check account is recovered by `who`. O(1)
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'account' β 'AccountId32' β 'AccountId' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
scheduler:
scheduler.schedule
docs
@ Anonymously schedule a task.
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'when' β 'u32' β 'BlockNumber' β
β 1 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 2 β 'priority' β 'u8' β 'Priority' β
β 3 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.cancel
docs
@ Cancel an anonymously scheduled task.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌββββββββββββββββ€
β 0 β 'when' β 'u32' β 'BlockNumber' β
β 1 β 'index' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββ΄ββββββββ΄ββββββββββββββββ
scheduler.scheduleNamed
docs
@ Schedule a named task.
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
β 1 β 'when' β 'u32' β 'BlockNumber' β
β 2 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 3 β 'priority' β 'u8' β 'Priority' β
β 4 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.cancelNamed
docs
@ Cancel a named scheduled task.
args
βββββββββββ¬βββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββΌββββββββββΌβββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββ΄ββββββββββ΄βββββββββββ
scheduler.scheduleAfter
docs
@ Anonymously schedule a task after a delay.
@
@ # <weight>
@ Same as [`schedule`].
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'after' β 'u32' β 'BlockNumber' β
β 1 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 2 β 'priority' β 'u8' β 'Priority' β
β 3 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββ
scheduler.scheduleNamedAfter
docs
@ Schedule a named task after a delay.
@
@ # <weight>
@ Same as [`schedule_named`](Self::schedule_named).
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'id' β 'Bytes' β 'Bytes' β
β 1 β 'after' β 'u32' β 'BlockNumber' β
β 2 β 'maybePeriodic' β 'Option<(u32,u32)>' β 'Option<Period>' β
β 3 β 'priority' β 'u8' β 'Priority' β
β 4 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββββ
session:
session.setKeys
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(1)`. Actual cost depends on the number of length of
@ `T::Keys::key_ids()` which is fixed.
@ - DbReads: `origin account`, `T::ValidatorIdOf`, `NextKeys`
@ - DbWrites: `origin account`, `NextKeys`
@ - DbReads per key id: `KeyOwner`
@ - DbWrites per key id: `KeyOwner`
@ # </weight>
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββββββββΌβββββββββββ€
β 0 β 'keys' β 'NodeRuntimeSessionKeys' β 'Keys' β
β 1 β 'proof' β 'Bytes' β 'Bytes' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββββββ΄βββββββββββ
session.purgeKeys
docs
@ 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).
@
@ # <weight>
@ - Complexity: `O(1)` in number of key types. Actual cost depends on the number of length
@ of `T::Keys::key_ids()` which is fixed.
@ - DbReads: `T::ValidatorIdOf`, `NextKeys`, `origin account`
@ - DbWrites: `NextKeys`, `origin account`
@ - DbWrites per key id: `KeyOwner`
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
staking:
staking.bond
docs
@ Take the origin account as a stash and lock up `value` of its balance. `controller` will
@ be the account that controls it.
@
@ `value` must be more than the `minimum_balance` specified by `T::Currency`.
@
@ The dispatch origin for this call must be _Signed_ by the stash account.
@
@ Emits `Bonded`.
@ # <weight>
@ - Independent of the arguments. Moderate complexity.
@ - O(1).
@ - Three extra DB entries.
@
@ NOTE: Two of the storage writes (`Self::bonded`, `Self::payee`) are _never_ cleaned
@ unless the `origin` falls below _existential deposit_ and gets removed as dust.
@ ------------------
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'controller' β 'MultiAddress' β 'LookupSource' β
β 1 β 'value' β 'Compact<u128>' β 'BalanceOf' β
β 2 β 'payee' β 'PalletStakingRewardDestination' β 'RewardDestination' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
staking.bondExtra
docs
@ Add some extra amount that have appeared in the stash `free_balance` into the balance up
@ for staking.
@
@ The dispatch origin for this call must be _Signed_ by the stash, not the controller.
@
@ Use this if there are additional funds in your stash account that you wish to bond.
@ Unlike [`bond`](Self::bond) or [`unbond`](Self::unbond) this function does not impose
@ any limitation on the amount that can be added.
@
@ Emits `Bonded`.
@
@ # <weight>
@ - Independent of the arguments. Insignificant complexity.
@ - O(1).
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'maxAdditional' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
staking.unbond
docs
@ Schedule a portion of the stash to be unlocked ready for transfer out after the bond
@ period ends. If this leaves an amount actively bonded less than
@ T::Currency::minimum_balance(), then it is increased to the full amount.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
@
@ Once the unlock period is done, you can call `withdraw_unbonded` to actually move
@ the funds out of management ready for transfer.
@
@ No more than a limited number of unlocking chunks (see `MAX_UNLOCKING_CHUNKS`)
@ can co-exists at the same time. In that case, [`Call::withdraw_unbonded`] need
@ to be called first to remove some of the chunks (if possible).
@
@ If a user encounters the `InsufficientBond` error when calling this extrinsic,
@ they should call `chill` first in order to free up their bonded funds.
@
@ Emits `Unbonded`.
@
@ See also [`Call::withdraw_unbonded`].
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'value' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
staking.withdrawUnbonded
docs
@ Remove any unlocked chunks from the `unlocking` queue from our management.
@
@ This essentially frees up that balance to be used by the stash account to do
@ whatever it wants.
@
@ The dispatch origin for this call must be _Signed_ by the controller.
@
@ Emits `Withdrawn`.
@
@ See also [`Call::unbond`].
@
@ # <weight>
@ Complexity O(S) where S is the number of slashing spans to remove
@ NOTE: Weight annotation is the kill scenario, we refund otherwise.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'numSlashingSpans' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββ΄βββββββββββ
staking.validate
docs
@ Declare the desire to validate for the origin controller.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'prefs' β 'PalletStakingValidatorPrefs' β 'ValidatorPrefs' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββββββββββββββββ΄βββββββββββββββββββ
staking.nominate
docs
@ Declare the desire to nominate `targets` for the origin controller.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
@
@ # <weight>
@ - The transaction's complexity is proportional to the size of `targets` (N)
@ which is capped at CompactAssignments::LIMIT (MAX_NOMINATIONS).
@ - Both the reads and writes follow a similar pattern.
@ # </weight>
args
βββββββββββ¬ββββββββββββ¬ββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'targets' β 'Vec<MultiAddress>' β 'Vec<LookupSource>' β
βββββββββββ΄ββββββββββββ΄ββββββββββββββββββββββ΄ββββββββββββββββββββββ
staking.chill
docs
@ Declare no desire to either validate or nominate.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
@
@ # <weight>
@ - Independent of the arguments. Insignificant complexity.
@ - Contains one read.
@ - Writes are limited to the `origin` account key.
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
staking.setPayee
docs
@ (Re-)set the payment target for a controller.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
@
@ # <weight>
@ - Independent of the arguments. Insignificant complexity.
@ - Contains a limited number of reads.
@ - Writes are limited to the `origin` account key.
@ ---------
@ - Weight: O(1)
@ - DB Weight:
@ - Read: Ledger
@ - Write: Payee
@ # </weight>
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'payee' β 'PalletStakingRewardDestination' β 'RewardDestination' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββ
staking.setController
docs
@ (Re-)set the controller of a stash.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the stash, not the controller.
@
@ # <weight>
@ - Independent of the arguments. Insignificant complexity.
@ - Contains a limited number of reads.
@ - Writes are limited to the `origin` account key.
@ ----------
@ Weight: O(1)
@ DB Weight:
@ - Read: Bonded, Ledger New Controller, Ledger Old Controller
@ - Write: Bonded, Ledger New Controller, Ledger Old Controller
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'controller' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
staking.setValidatorCount
docs
@ Sets the ideal number of validators.
@
@ The dispatch origin must be Root.
@
@ # <weight>
@ Weight: O(1)
@ Write: Validator Count
@ # </weight>
args
βββββββββββ¬ββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'new' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββ΄βββββββββββββββββ΄βββββββββββ
staking.increaseValidatorCount
docs
@ Increments the ideal number of validators.
@
@ The dispatch origin must be Root.
@
@ # <weight>
@ Same as [`Self::set_validator_count`].
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'additional' β 'Compact<u32>' β 'u32' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄βββββββββββ
staking.scaleValidatorCount
docs
@ Scale up the ideal number of validators by a factor.
@
@ The dispatch origin must be Root.
@
@ # <weight>
@ Same as [`Self::set_validator_count`].
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'factor' β 'Percent' β 'Percent' β
βββββββββββ΄βββββββββββ΄ββββββββββββ΄ββββββββββββ
staking.forceNoEras
docs
@ Force there to be no new eras indefinitely.
@
@ The dispatch origin must be Root.
@
@ # Warning
@
@ The election process starts multiple blocks before the end of the era.
@ Thus the election process may be ongoing when this is called. In this case the
@ election will continue until the next era is triggered.
@
@ # <weight>
@ - No arguments.
@ - Weight: O(1)
@ - Write: ForceEra
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
staking.forceNewEra
docs
@ Force there to be a new era at the end of the next session. After this, it will be
@ reset to normal (non-forced) behaviour.
@
@ The dispatch origin must be Root.
@
@ # Warning
@
@ The election process starts multiple blocks before the end of the era.
@ If this is called just before a new era is triggered, the election process may not
@ have enough blocks to get a result.
@
@ # <weight>
@ - No arguments.
@ - Weight: O(1)
@ - Write ForceEra
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
staking.setInvulnerables
docs
@ Set the validators who cannot be slashed (if any).
@
@ The dispatch origin must be Root.
@
@ # <weight>
@ - O(V)
@ - Write: Invulnerables
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββββ¬βββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββΌβββββββββββββββββββββΌβββββββββββββββββββ€
β 0 β 'invulnerables' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββββ΄βββββββββββββββββββ
staking.forceUnstake
docs
@ Force a current staker to become completely unstaked, immediately.
@
@ The dispatch origin must be Root.
@
@ # <weight>
@ O(S) where S is the number of slashing spans to be removed
@ Reads: Bonded, Slashing Spans, Account, Locks
@ Writes: Bonded, Slashing Spans (if S > 0), Ledger, Payee, Validators, Nominators,
@ Account, Locks Writes Each: SpanSlash * S
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'stash' β 'AccountId32' β 'AccountId' β
β 1 β 'numSlashingSpans' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
staking.forceNewEraAlways
docs
@ Force there to be a new era at the end of sessions indefinitely.
@
@ The dispatch origin must be Root.
@
@ # Warning
@
@ The election process starts multiple blocks before the end of the era.
@ If this is called just before a new era is triggered, the election process may not
@ have enough blocks to get a result.
@
@ # <weight>
@ - Weight: O(1)
@ - Write: ForceEra
@ # </weight>
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
staking.cancelDeferredSlash
docs
@ Cancel enactment of a deferred slash.
@
@ Can be called by the `T::SlashCancelOrigin`.
@
@ Parameters: era and indices of the slashes for that era to kill.
@
@ # <weight>
@ Complexity: O(U + S)
@ with U unapplied slashes weighted with U=1000
@ and S is the number of slash indices to be canceled.
@ - Read: Unapplied Slashes
@ - Write: Unapplied Slashes
@ # </weight>
args
βββββββββββ¬βββββββββββββββββ¬βββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββββββΌβββββββββββββ€
β 0 β 'era' β 'u32' β 'EraIndex' β
β 1 β 'slashIndices' β 'Vec<u32>' β 'Vec<u32>' β
βββββββββββ΄βββββββββββββββββ΄βββββββββββββ΄βββββββββββββ
staking.payoutStakers
docs
@ Pay out all the stakers behind a single validator for a single era.
@
@ - `validator_stash` is the stash account of the validator. Their nominators, up to
@ `T::MaxNominatorRewardedPerValidator`, will also receive their rewards.
@ - `era` may be any era between `[current_era - history_depth; current_era]`.
@
@ The origin of this call must be _Signed_. Any account can call this function, even if
@ it is not one of the stakers.
@
@ # <weight>
@ - Time complexity: at most O(MaxNominatorRewardedPerValidator).
@ - Contains a limited number of reads and writes.
@ -----------
@ N is the Number of payouts for the validator (including the validator)
@ Weight:
@ - Reward Destination Staked: O(N)
@ - Reward Destination Controller (Creating): O(N)
@
@ NOTE: weights are assuming that payouts are made to alive stash account (Staked).
@ Paying even a dead controller is cheaper weight-wise. We don't do any refunds here.
@ # </weight>
args
βββββββββββ¬βββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'validatorStash' β 'AccountId32' β 'AccountId' β
β 1 β 'era' β 'u32' β 'EraIndex' β
βββββββββββ΄βββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
staking.rebond
docs
@ Rebond a portion of the stash scheduled to be unlocked.
@
@ The dispatch origin must be signed by the controller.
@
@ # <weight>
@ - Time complexity: O(L), where L is unlocking chunks
@ - Bounded by `MAX_UNLOCKING_CHUNKS`.
@ - Storage changes: Can't increase storage, only decrease it.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'value' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄ββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
staking.setHistoryDepth
docs
@ Set `HistoryDepth` value. This function will delete any history information
@ when `HistoryDepth` is reduced.
@
@ Parameters:
@ - `new_history_depth`: The new history depth you would like to set.
@ - `era_items_deleted`: The number of items that will be deleted by this dispatch. This
@ should report all the storage items that will be deleted by clearing old era history.
@ Needed to report an accurate weight for the dispatch. Trusted by `Root` to report an
@ accurate number.
@
@ Origin must be root.
@
@ # <weight>
@ - E: Number of history depths removed, i.e. 10 -> 7 = 3
@ - Weight: O(E)
@ - DB Weight:
@ - Reads: Current Era, History Depth
@ - Writes: History Depth
@ - Clear Prefix Each: Era Stakers, EraStakersClipped, ErasValidatorPrefs
@ - Writes Each: ErasValidatorReward, ErasRewardPoints, ErasTotalStake,
@ ErasStartSessionIndex
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'newHistoryDepth' β 'Compact<u32>' β 'EraIndex' β
β 1 β 'eraItemsDeleted' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
staking.reapStash
docs
@ Remove all data structures concerning a staker/stash once it is at a state where it can
@ be considered `dust` in the staking system. The requirements are:
@
@ 1. the `total_balance` of the stash is below existential deposit.
@ 2. or, the `ledger.total` of the stash is below existential deposit.
@
@ The former can happen in cases like a slash; the latter when a fully unbonded account
@ is still receiving staking rewards in `RewardDestination::Staked`.
@
@ It can be called by anyone, as long as `stash` meets the above requirements.
@
@ Refunds the transaction fees upon successful execution.
args
βββββββββββ¬βββββββββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'stash' β 'AccountId32' β 'AccountId' β
β 1 β 'numSlashingSpans' β 'u32' β 'u32' β
βββββββββββ΄βββββββββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
staking.kick
docs
@ Remove the given nominations from the calling validator.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_ by the controller, not the stash.
@
@ - `who`: A list of nominator stash accounts who are nominating this validator which
@ should no longer be nominating this validator.
@
@ Note: Making this call only makes sense if you first set the validator preferences to
@ block any further nominations.
args
βββββββββββ¬ββββββββ¬ββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'who' β 'Vec<MultiAddress>' β 'Vec<LookupSource>' β
βββββββββββ΄ββββββββ΄ββββββββββββββββββββββ΄ββββββββββββββββββββββ
staking.setStakingLimits
docs
@ Update the various staking limits this pallet.
@
@ * `min_nominator_bond`: The minimum active bond needed to be a nominator.
@ * `min_validator_bond`: The minimum active bond needed to be a validator.
@ * `max_nominator_count`: The max number of users who can be a nominator at once. When
@ set to `None`, no limit is enforced.
@ * `max_validator_count`: The max number of users who can be a validator at once. When
@ set to `None`, no limit is enforced.
@
@ Origin must be Root to call this function.
@
@ NOTE: Existing nominators and validators will not be affected by this update.
@ to kick people under the new limits, `chill_other` should be called.
args
βββββββββββ¬ββββββββββββββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββΌββββββββββββββββββββΌββββββββββββββββββββ€
β 0 β 'minNominatorBond' β 'u128' β 'BalanceOf' β
β 1 β 'minValidatorBond' β 'u128' β 'BalanceOf' β
β 2 β 'maxNominatorCount' β 'Option<u32>' β 'Option<u32>' β
β 3 β 'maxValidatorCount' β 'Option<u32>' β 'Option<u32>' β
β 4 β 'threshold' β 'Option<Percent>' β 'Option<Percent>' β
βββββββββββ΄ββββββββββββββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββ
staking.chillOther
docs
@ Declare a `controller` to stop participating as either a validator or nominator.
@
@ Effects will be felt at the beginning of the next era.
@
@ The dispatch origin for this call must be _Signed_, but can be called by anyone.
@
@ If the caller is the same as the controller being targeted, then no further checks are
@ enforced, and this function behaves just like `chill`.
@
@ If the caller is different than the controller being targeted, the following conditions
@ must be met:
@ * A `ChillThreshold` must be set and checked which defines how close to the max
@ nominators or validators we must reach before users can start chilling one-another.
@ * A `MaxNominatorCount` and `MaxValidatorCount` must be set which is used to determine
@ how close we are to the threshold.
@ * A `MinNominatorBond` and `MinValidatorBond` must be set and checked, which determines
@ if this is a person that should be chilled because they have not met the threshold
@ bond required.
@
@ This can be helpful if bond requirements are updated, and we need to remove old users
@ who do not satisfy these requirements.
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'controller' β 'AccountId32' β 'AccountId' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
sudo:
sudo.sudo
docs
@ Authenticates the sudo key and dispatches a function call with `Root` origin.
@
@ The dispatch origin for this call must be _Signed_.
@
@ # <weight>
@ - O(1).
@ - Limited storage reads.
@ - One DB write (event).
@ - Weight of derivative `call` execution + 10,000.
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌβββββββββββ€
β 0 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββ΄βββββββββ΄βββββββββββ
sudo.sudoUncheckedWeight
docs
@ 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_.
@
@ # <weight>
@ - O(1).
@ - The weight of this call is defined by the caller.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'call' β 'Call' β 'Call' β
β 1 β 'weight' β 'u64' β 'Weight' β
βββββββββββ΄βββββββββββ΄βββββββββ΄βββββββββββ
sudo.setKey
docs
@ 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_.
@
@ # <weight>
@ - O(1).
@ - Limited storage reads.
@ - One DB change.
@ # </weight>
args
βββββββββββ¬ββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'new' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
sudo.sudoAs
docs
@ 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_.
@
@ # <weight>
@ - O(1).
@ - Limited storage reads.
@ - One DB write (event).
@ - Weight of derivative `call` execution + 10,000.
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββββΌβββββββββββββββββ€
β 0 β 'who' β 'MultiAddress' β 'LookupSource' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
system:
system.fillBlock
docs
@ A dispatch that will fill the block weight up to the given ratio.
args
βββββββββββ¬ββββββββββ¬ββββββββββββ¬ββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββΌββββββββββββ€
β 0 β 'ratio' β 'Perbill' β 'Perbill' β
βββββββββββ΄ββββββββββ΄ββββββββββββ΄ββββββββββββ
system.remark
docs
@ Make some on-chain remark.
@
@ # <weight>
@ - `O(1)`
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'remark' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββ΄ββββββββββ΄βββββββββββ
system.setHeapPages
docs
@ Set the number of pages in the WebAssembly environment's heap.
args
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββΌβββββββββββ€
β 0 β 'pages' β 'u64' β 'u64' β
βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββ
system.setCode
docs
@ Set the new runtime code.
@
@ # <weight>
@ - `O(C + S)` where `C` length of `code` and `S` complexity of `can_set_code`
@ - 1 call to `can_set_code`: `O(S)` (calls `sp_io::misc::runtime_version` which is
@ expensive).
@ - 1 storage write (codec `O(C)`).
@ - 1 digest item.
@ - 1 event.
@ The weight of this function is dependent on the runtime, but generally this is very
@ expensive. We will treat this as a full block.
@ # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββΌβββββββββββ€
β 0 β 'code' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββ΄ββββββββββ΄βββββββββββ
system.setCodeWithoutChecks
docs
@ Set the new runtime code without doing any checks of the given `code`.
@
@ # <weight>
@ - `O(C)` where `C` length of `code`
@ - 1 storage write (codec `O(C)`).
@ - 1 digest item.
@ - 1 event.
@ The weight of this function is dependent on the runtime. We will treat this as a full
@ block. # </weight>
args
βββββββββββ¬βββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌββββββββββΌβββββββββββ€
β 0 β 'code' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββ΄ββββββββββ΄βββββββββββ
system.setStorage
docs
@ Set some items of storage.
args
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'items' β 'Vec<(Bytes,Bytes)>' β 'Vec<KeyValue>' β
βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββ΄ββββββββββββββββββ
system.killStorage
docs
@ Kill some items from storage.
args
βββββββββββ¬βββββββββ¬βββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββββββββΌβββββββββββββ€
β 0 β 'keys' β 'Vec<Bytes>' β 'Vec<Key>' β
βββββββββββ΄βββββββββ΄βββββββββββββββ΄βββββββββββββ
system.killPrefix
docs
@ 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.
args
βββββββββββ¬ββββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'prefix' β 'Bytes' β 'Key' β
β 1 β 'subkeys' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββ΄ββββββββββ΄βββββββββββ
system.remarkWithEvent
docs
@ Make some on-chain remark and emit event.
@
@ # <weight>
@ - `O(b)` where b is the length of the remark.
@ - 1 event.
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββΌβββββββββββ€
β 0 β 'remark' β 'Bytes' β 'Bytes' β
βββββββββββ΄βββββββββββ΄ββββββββββ΄βββββββββββ
technicalCommittee:
technicalCommittee.setMembers
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(MP + N)` where:
@ - `M` old-members-count (code- and governance-bounded)
@ - `N` new-members-count (code- and governance-bounded)
@ - `P` proposals-count (code-bounded)
@ - DB:
@ - 1 storage mutation (codec `O(M)` read, `O(N)` write) for reading and writing the
@ members
@ - 1 storage read (codec `O(P)`) for reading the proposals
@ - `P` storage mutations (codec `O(M)`) for updating the votes for each proposal
@ - 1 storage write (codec `O(1)`) for deleting the old `prime` and setting the new one
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€
β 0 β 'newMembers' β 'Vec<AccountId32>' β 'Vec<AccountId>' β
β 1 β 'prime' β 'Option<AccountId32>' β 'Option<AccountId>' β
β 2 β 'oldCount' β 'u32' β 'MemberCount' β
βββββββββββ΄βββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
technicalCommittee.execute
docs
@ Dispatch a proposal from a member using the `Member` origin.
@
@ Origin must be a member of the collective.
@
@ # <weight>
@ ## Weight
@ - `O(M + P)` where `M` members-count (code-bounded) and `P` complexity of dispatching
@ `proposal`
@ - DB: 1 read (codec `O(M)`) + DB access of `proposal`
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌβββββββββββββ€
β 0 β 'proposal' β 'Call' β 'Proposal' β
β 1 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
technicalCommittee.propose
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1)` or `O(B + M + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - branching is influenced by `threshold` where:
@ - `P1` is proposal execution complexity (`threshold < 2`)
@ - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
@ - DB:
@ - 1 storage read `is_member` (codec `O(M)`)
@ - 1 storage read `ProposalOf::contains_key` (codec `O(1)`)
@ - DB accesses influenced by `threshold`:
@ - EITHER storage accesses done by `proposal` (`threshold < 2`)
@ - OR proposal insertion (`threshold <= 2`)
@ - 1 storage mutation `Proposals` (codec `O(P2)`)
@ - 1 storage mutation `ProposalCount` (codec `O(1)`)
@ - 1 storage write `ProposalOf` (codec `O(B)`)
@ - 1 storage write `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌβββββββββββββββββΌββββββββββββββββ€
β 0 β 'threshold' β 'Compact<u32>' β 'MemberCount' β
β 1 β 'proposal' β 'Call' β 'Proposal' β
β 2 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
technicalCommittee.vote
docs
@ 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.
@ # <weight>
@ ## Weight
@ - `O(M)` where `M` is members-count (code- and governance-bounded)
@ - DB:
@ - 1 storage read `Members` (codec `O(M)`)
@ - 1 storage mutation `Voting` (codec `O(M)`)
@ - 1 event
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposal' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'approve' β 'bool' β 'bool' β
βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
technicalCommittee.close
docs
@ 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.
@
@ # <weight>
@ ## Weight
@ - `O(B + M + P1 + P2)` where:
@ - `B` is `proposal` size in bytes (length-fee-bounded)
@ - `M` is members-count (code- and governance-bounded)
@ - `P1` is the complexity of `proposal` preimage.
@ - `P2` is proposal-count (code-bounded)
@ - DB:
@ - 2 storage reads (`Members`: codec `O(M)`, `Prime`: codec `O(1)`)
@ - 3 mutations (`Voting`: codec `O(M)`, `ProposalOf`: codec `O(B)`, `Proposals`: codec
@ `O(P2)`)
@ - any mutations done while executing `proposal` (`P1`)
@ - up to 3 events
@ # </weight>
args
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
β 1 β 'index' β 'Compact<u32>' β 'ProposalIndex' β
β 2 β 'proposalWeightBound' β 'Compact<u64>' β 'Weight' β
β 3 β 'lengthBound' β 'Compact<u32>' β 'u32' β
βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
technicalCommittee.disapproveProposal
docs
@ 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.
@
@ # <weight>
@ Complexity: O(P) where P is the number of max proposals
@ DB Weight:
@ * Reads: Proposals
@ * Writes: Voting, Proposals, ProposalOf
@ # </weight>
args
βββββββββββ¬βββββββββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'proposalHash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββββββββββ΄βββββββββ΄βββββββββββ
template:
template.doSomething
docs
@ An example dispatchable that takes a singles value as a parameter, writes the value to
@ storage and emits an event. This function must be dispatched by a signed extrinsic.
args
βββββββββββ¬ββββββββββββββ¬ββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββΌββββββββΌβββββββββββ€
β 0 β 'something' β 'u32' β 'u32' β
βββββββββββ΄ββββββββββββββ΄ββββββββ΄βββββββββββ
template.causeError
docs
@ An example dispatchable that may throw a custom error.
args
βββββββββββ
β (index) β
βββββββββββ€
βββββββββββ
timestamp:
timestamp.set
docs
@ 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`.
@
@ # <weight>
@ - `O(1)` (Note that implementations of `OnTimestampSet` must also be `O(1)`)
@ - 1 storage read and 1 storage mutation (codec `O(1)`). (because of `DidUpdate::take` in
@ `on_finalize`)
@ - 1 event handler `on_timestamp_set`. Must be `O(1)`.
@ # </weight>
args
βββββββββββ¬ββββββββ¬βββββββββββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββΌβββββββββββββββββΌβββββββββββ€
β 0 β 'now' β 'Compact<u64>' β 'Moment' β
βββββββββββ΄ββββββββ΄βββββββββββββββββ΄βββββββββββ
tips:
tips.reportAwesome
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(R)` where `R` length of `reason`.
@ - encoding and hashing of 'reason'
@ - DbReads: `Reasons`, `Tips`
@ - DbWrites: `Reasons`, `Tips`
@ # </weight>
args
βββββββββββ¬βββββββββββ¬ββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββΌββββββββββββββββΌββββββββββββββ€
β 0 β 'reason' β 'Bytes' β 'Bytes' β
β 1 β 'who' β 'AccountId32' β 'AccountId' β
βββββββββββ΄βββββββββββ΄ββββββββββββββββ΄ββββββββββββββ
tips.retractTip
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(1)`
@ - Depends on the length of `T::Hash` which is fixed.
@ - DbReads: `Tips`, `origin account`
@ - DbWrites: `Reasons`, `Tips`, `origin account`
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌβββββββββββ€
β 0 β 'hash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββ΄βββββββββ΄βββββββββββ
tips.tipNew
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(R + T)` where `R` length of `reason`, `T` is the number of tippers.
@ - `O(T)`: decoding `Tipper` vec of length `T`. `T` is charged as upper bound given by
@ `ContainsLengthBound`. The actual cost depends on the implementation of
@ `T::Tippers`.
@ - `O(R)`: hashing and encoding of reason of length `R`
@ - DbReads: `Tippers`, `Reasons`
@ - DbWrites: `Reasons`, `Tips`
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'reason' β 'Bytes' β 'Bytes' β
β 1 β 'who' β 'AccountId32' β 'AccountId' β
β 2 β 'tipValue' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
tips.tip
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(T)` where `T` is the number of tippers. decoding `Tipper` vec of length
@ `T`, insert tip and check closing, `T` is charged as upper bound given by
@ `ContainsLengthBound`. The actual cost depends on the implementation of `T::Tippers`.
@
@ Actually weight could be lower as it depends on how many tips are in `OpenTip` but it
@ is weighted as if almost full i.e of length `T-1`.
@ - DbReads: `Tippers`, `Tips`
@ - DbWrites: `Tips`
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββΌββββββββββββββ€
β 0 β 'hash' β 'H256' β 'Hash' β
β 1 β 'tipValue' β 'Compact<u128>' β 'BalanceOf' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββ΄ββββββββββββββ
tips.closeTip
docs
@ 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.
@
@ # <weight>
@ - Complexity: `O(T)` where `T` is the number of tippers. decoding `Tipper` vec of length
@ `T`. `T` is charged as upper bound given by `ContainsLengthBound`. The actual cost
@ depends on the implementation of `T::Tippers`.
@ - DbReads: `Tips`, `Tippers`, `tip finder`
@ - DbWrites: `Reasons`, `Tips`, `Tippers`, `tip finder`
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌβββββββββββ€
β 0 β 'hash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββ΄βββββββββ΄βββββββββββ
tips.slashTip
docs
@ 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.
@
@ # <weight>
@ `T` is charged as upper bound given by `ContainsLengthBound`.
@ The actual cost depends on the implementation of `T::Tippers`.
@ # </weight>
args
βββββββββββ¬βββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββΌβββββββββΌβββββββββββ€
β 0 β 'hash' β 'H256' β 'Hash' β
βββββββββββ΄βββββββββ΄βββββββββ΄βββββββββββ
treasury:
treasury.proposeSpend
docs
@ 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.
@
@ # <weight>
@ - Complexity: O(1)
@ - DbReads: `ProposalCount`, `origin account`
@ - DbWrites: `ProposalCount`, `Proposals`, `origin account`
@ # </weight>
args
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββββββββΌββββββββββββββββββΌβββββββββββββββββ€
β 0 β 'value' β 'Compact<u128>' β 'BalanceOf' β
β 1 β 'beneficiary' β 'MultiAddress' β 'LookupSource' β
βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββ
treasury.rejectProposal
docs
@ Reject a proposed spend. The original deposit will be slashed.
@
@ May only be called from `T::RejectOrigin`.
@
@ # <weight>
@ - Complexity: O(1)
@ - DbReads: `Proposals`, `rejected proposer account`
@ - DbWrites: `Proposals`, `rejected proposer account`
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalId' β 'Compact<u32>' β 'ProposalIndex' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
treasury.approveProposal
docs
@ 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`.
@
@ # <weight>
@ - Complexity: O(1).
@ - DbReads: `Proposals`, `Approvals`
@ - DbWrite: `Approvals`
@ # </weight>
args
βββββββββββ¬βββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββββΌβββββββββββββββββΌββββββββββββββββββ€
β 0 β 'proposalId' β 'Compact<u32>' β 'ProposalIndex' β
βββββββββββ΄βββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββββ
utility:
utility.batch
docs
@ 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`).
@
@ # <weight>
@ - Complexity: O(C) where C is the number of calls to be batched.
@ # </weight>
@
@ 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.
args
βββββββββββ¬ββββββββββ¬ββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββΌββββββββββββββ€
β 0 β 'calls' β 'Vec<Call>' β 'Vec<Call>' β
βββββββββββ΄ββββββββββ΄ββββββββββββββ΄ββββββββββββββ
utility.asDerivative
docs
@ 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_.
args
βββββββββββ¬ββββββββββ¬βββββββββ¬βββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌβββββββββΌβββββββββββ€
β 0 β 'index' β 'u16' β 'u16' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄ββββββββββ΄βββββββββ΄βββββββββββ
utility.batchAll
docs
@ 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`).
@
@ # <weight>
@ - Complexity: O(C) where C is the number of calls to be batched.
@ # </weight>
args
βββββββββββ¬ββββββββββ¬ββββββββββββββ¬ββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌββββββββββΌββββββββββββββΌββββββββββββββ€
β 0 β 'calls' β 'Vec<Call>' β 'Vec<Call>' β
βββββββββββ΄ββββββββββ΄ββββββββββββββ΄ββββββββββββββ
utility.dispatchAs
docs
@ Dispatches a function call with a provided origin.
@
@ The dispatch origin for this call must be _Root_.
@
@ # <weight>
@ - O(1).
@ - Limited storage reads.
@ - One DB write (event).
@ - Weight of derivative `call` execution + T::WeightInfo::dispatch_as().
@ # </weight>
args
βββββββββββ¬βββββββββββββ¬ββββββββββββββββββββββββββββ¬ββββββββββββββββββ
β (index) β name β type β typeName β
βββββββββββΌβββββββββββββΌββββββββββββββββββββββββββββΌββββββββββββββββββ€
β 0 β 'asOrigin' β 'NodeRuntimeOriginCaller' β 'PalletsOrigin' β
β 1 β 'call' β 'Call' β 'Call' β
βββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββββ΄ββββββββββββββββββ
nftmart
consts
api.consts.nftmart.createClassDeposit
The minimum balance to create class
type:
6
api.consts.nftmart.metaDataByteDeposit
The amount of balance that must be deposited per byte of metadata.
type:
6
api.consts.nftmart.createTokenDeposit
The minimum balance to create token
type:
6
api.consts.nftmart.moduleId
The NFT's module id
type:
430
errors
api.errors.nftmart.ClassIdNotFound
ClassId not found
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.TokenIdNotFound
TokenId not found
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.CategoryNotFound
Category not found
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.NoPermission
The operator is not the owner of the token and has no permission
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.InvalidQuantity
Quantity is invalid. need >= 1
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.InvalidDeadline
Invalid deadline
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.InvalidDeposit
Invalid deposit
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.NonTransferable
Property of class don't support transfer
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.NonBurnable
Property of class don't support burn
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.CannotDestroyClass
Can not destroy class Total issuance is not 0
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.NoAvailableCategoryId
No available category ID
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.NameTooLong
NameTooLong
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.DescriptionTooLong
DescriptionTooLong
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.AccountNotInWhitelist
account not in whitelist
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.CategoryOutOfBound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.DuplicatedCategories
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmart.RoyaltyRateTooHigh
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
events
api.events.nftmart.CreatedClass
Created NFT class. [owner, class_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.UpdatedClass
Updated NFT class. [owner, class_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.MintedToken
Minted NFT token. [from, to, class_id, token_id, quantity]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'AccountId32' β β 2 β 'u32' β β 3 β 'u64' β β 4 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.UpdatedToken
Updated NFT token beneficiary, quantity, metadata, royalty. [owner, class_id, token_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.UpdatedTokenMetadata
Updated NFT token metadata. [owner, class_id, token_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.UpdatedTokenRoyalty
Updated NFT token royalty. [beneficiary, class_id, token_id, royalty]
args:
βββββββββββ¬βββββββββββββββββββ β (index) β Values β βββββββββββΌβββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'u64' β β 3 β 'Option<PerU16>' β βββββββββββ΄βββββββββββββββββββ
api.events.nftmart.UpdatedTokenRoyaltyBeneficiary
Updated NFT token royalty beneficiary. [from, class_id, token_id, to]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'u64' β β 3 β 'AccountId32' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.TransferredToken
Transferred NFT token. [from, to, class_id, token_id, quantity]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'AccountId32' β β 2 β 'u32' β β 3 β 'u64' β β 4 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.BurnedToken
Burned NFT token. [owner, class_id, token_id, quantity, unreserved]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'u64' β β 3 β 'u64' β β 4 β 'u128' β βββββββββββ΄ββββββββββββββββ
api.events.nftmart.DestroyedClass
Destroyed NFT class. [owner, class_id, dest]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u32' β β 2 β 'AccountId32' β βββββββββββ΄ββββββββββββββββ
query
api.query.nftmart.palletVersion
Returns the current pallet version from storage
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '73' β βββββββββββ΄βββββββββ
api.query.nftmart.storageVersion
Storage version of the pallet.
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '507' β βββββββββββ΄βββββββββ
tx
api.tx.nftmart.createClass
Create NFT class, tokens belong to the class.
metadata
: external metadataproperties
: class property, includeTransferable
Burnable
name
: class name, with len limitation.description
: class description, with len limitation.args:
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββΌββββββββββββββββββββΌββββββββββββββββββ€ β 0 β 'metadata' β 'Bytes' β 'NFTMetadata' β β 1 β 'name' β 'Bytes' β 'Bytes' β β 2 β 'description' β 'Bytes' β 'Bytes' β β 3 β 'royaltyRate' β 'Compact<PerU16>' β 'PerU16' β β 4 β 'properties' β 'u64' β 'Properties' β β 5 β 'categoryIds' β 'Vec<u64>' β 'Vec<GlobalId>' β βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββ
api.tx.nftmart.updateClass
Update NFT class.
class_id
: class idmetadata
: external metadataproperties
: class property, includeTransferable
Burnable
name
: class name, with len limitation.description
: class description, with len limitation.args:
βββββββββββ¬ββββββββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββΌββββββββββββββββββββΌββββββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'metadata' β 'Bytes' β 'NFTMetadata' β β 2 β 'name' β 'Bytes' β 'Bytes' β β 3 β 'description' β 'Bytes' β 'Bytes' β β 4 β 'royaltyRate' β 'Compact<PerU16>' β 'PerU16' β β 5 β 'properties' β 'u64' β 'Properties' β β 6 β 'categoryIds' β 'Vec<u64>' β 'Vec<GlobalId>' β βββββββββββ΄ββββββββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββ
api.tx.nftmart.updateTokenRoyalty
Update token royalty.
args:
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β β 2 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
api.tx.nftmart.updateTokenRoyaltyBeneficiary
Update token royalty beneficiary.
args:
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β β 2 β 'to' β 'MultiAddress' β 'LookupSource' β βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
api.tx.nftmart.updateTokenMetadata
Update token metadata.
args:
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββββ
api.tx.nftmart.updateToken
Update token royalty_beneficiary, quantity, metadata, and royalty.
args:
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€ β 0 β 'to' β 'MultiAddress' β 'LookupSource' β β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 2 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β β 4 β 'metadata' β 'Bytes' β 'NFTMetadata' β β 5 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
api.tx.nftmart.mint
Mint NFT token
to
: the token owner's accountclass_id
: token belong to the class idmetadata
: external metadataquantity
: token quantityargs:
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€ β 0 β 'to' β 'MultiAddress' β 'LookupSource' β β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β β 4 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
api.tx.nftmart.proxyMint
Mint NFT token by a proxy account.
origin
: a proxy accountargs:
βββββββββββ¬ββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββΌβββββββββββββββββββΌβββββββββββββββββββ€ β 0 β 'to' β 'MultiAddress' β 'LookupSource' β β 1 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 2 β 'metadata' β 'Bytes' β 'NFTMetadata' β β 3 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β β 4 β 'chargeRoyalty' β 'Option<PerU16>' β 'Option<PerU16>' β βββββββββββ΄ββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ
api.tx.nftmart.transfer
Transfer NFT tokens to another account
to
: the token owner's accountclass_id
: class idtoken_id
: token idquantity
: quantityargs:
βββββββββββ¬ββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ β 0 β 'to' β 'MultiAddress' β 'LookupSource' β β 1 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β βββββββββββ΄ββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
api.tx.nftmart.burn
Burn NFT token
class_id
: class idtoken_id
: token idquantity
: quantityargs:
βββββββββββ¬βββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββΌβββββββββββββββββΌββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'tokenId' β 'Compact<u64>' β 'TokenIdOf' β β 2 β 'quantity' β 'Compact<u64>' β 'TokenIdOf' β βββββββββββ΄βββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
api.tx.nftmart.destroyClass
Destroy NFT class
class_id
: destroy class iddest
: transfer reserve balance from sub_account to destargs:
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€ β 0 β 'classId' β 'Compact<u32>' β 'ClassIdOf' β β 1 β 'dest' β 'MultiAddress' β 'LookupSource' β βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
nftmartAuction
consts
api.consts.nftmartAuction.treasuryPalletId
The treasury's pallet id, used for deriving its sovereign account ID.
type:
430
errors
api.errors.nftmartAuction.SubmitWithInvalidDeposit
submit with invalid deposit
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.SubmitWithInvalidDeadline
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.TooManyTokenChargedRoyalty
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.InvalidHammerPrice
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.BritishAuctionNotFound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.DutchAuctionNotFound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.BritishAuctionBidNotFound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.DutchAuctionBidNotFound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.BritishAuctionClosed
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.DutchAuctionClosed
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.PriceTooLow
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.CannotRemoveAuction
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.CannotRedeemAuction
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.CannotRedeemAuctionNoBid
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.CannotRedeemAuctionUntilDeadline
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.DuplicatedBid
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.MaxPriceShouldBeGreaterThanMinPrice
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.InvalidDutchMinPrice
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.SelfBid
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.TooManyTokens
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.EmptyTokenList
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.InvalidCommissionRate
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartAuction.SenderTakeCommission
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
events
api.events.nftmartAuction.CreatedBritishAuction
CreatedBritishAuction [who, auction_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.CreatedDutchAuction
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.RemovedBritishAuction
RemovedBritishAuction [who, auction_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.RemovedDutchAuction
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.RedeemedBritishAuction
args:
βββββββββββ¬ββββββββββββββββββββββββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββββββββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β β 2 β 'Option<(bool,AccountId32,PerU16)>' β β 3 β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββββββββββββββββββββ
api.events.nftmartAuction.RedeemedDutchAuction
args:
βββββββββββ¬ββββββββββββββββββββββββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββββββββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β β 2 β 'Option<(bool,AccountId32,PerU16)>' β β 3 β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββββββββββββββββββββ
api.events.nftmartAuction.BidBritishAuction
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.BidDutchAuction
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartAuction.HammerBritishAuction
args:
βββββββββββ¬ββββββββββββββββββββββββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββββββββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β β 2 β 'Option<(bool,AccountId32,PerU16)>' β β 3 β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββββββββββββββββββββ
query
api.query.nftmartAuction.palletVersion
Returns the current pallet version from storage
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '73' β βββββββββββ΄βββββββββ
api.query.nftmartAuction.storageVersion
Storage version of the pallet.
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '516' β βββββββββββ΄βββββββββ
api.query.nftmartAuction.britishAuctions
BritishAuctions
type:
βββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ¬ββββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββββββββββββββββββββββΌββββββββΌββββββββ€ β Map β [ 'Blake2_128Concat', 'Twox64Concat' ] β '510' β '517' β βββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ΄ββββββββ΄ββββββββ
api.query.nftmartAuction.britishAuctionBids
BritishAuctionBids
type:
βββββββββββ¬βββββββββββββββββββββ¬ββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββΌββββββΌββββββββ€ β Map β [ 'Twox64Concat' ] β '8' β '518' β βββββββββββ΄βββββββββββββββββββββ΄ββββββ΄ββββββββ
api.query.nftmartAuction.dutchAuctions
DutchAuctions
type:
βββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ¬ββββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββββββββββββββββββββββΌββββββββΌββββββββ€ β Map β [ 'Blake2_128Concat', 'Twox64Concat' ] β '510' β '519' β βββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ΄ββββββββ΄ββββββββ
api.query.nftmartAuction.dutchAuctionBids
DutchAuctionBids
type:
βββββββββββ¬βββββββββββββββββββββ¬ββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββΌββββββΌββββββββ€ β Map β [ 'Twox64Concat' ] β '8' β '518' β βββββββββββ΄βββββββββββββββββββββ΄ββββββ΄ββββββββ
tx
api.tx.nftmartAuction.submitDutchAuction
args:
βββββββββββ¬ββββββββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β β 1 β 'deposit' β 'Compact<u128>' β 'Balance' β β 2 β 'minPrice' β 'Compact<u128>' β 'Balance' β β 3 β 'maxPrice' β 'Compact<u128>' β 'Balance' β β 4 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β β 5 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β β 6 β 'allowBritishAuction' β 'bool' β 'bool' β β 7 β 'minRaise' β 'Compact<PerU16>' β 'PerU16' β β 8 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β βββββββββββ΄ββββββββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
api.tx.nftmartAuction.bidDutchAuction
args:
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€ β 0 β 'price' β 'Compact<u128>' β 'Balance' β β 1 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β β 2 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β β 3 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β β 4 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
api.tx.nftmartAuction.redeemDutchAuction
redeem
args:
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€ β 0 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
api.tx.nftmartAuction.removeDutchAuction
remove a dutch auction by auction owner.
args:
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββΌβββββββββββββββββΌβββββββββββββ€ β 0 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
api.tx.nftmartAuction.removeExpiredDutchAuction
remove an expired dutch auction by auction owner.
args:
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€ β 0 β 'auctionOwner' β 'AccountId32' β 'AccountId' β β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
api.tx.nftmartAuction.submitBritishAuction
Create an British auction.
currency_id
: Currency Idhammer_price
: If somebody offer this price, the auction will be finished. Set to zero to disable.min_raise
: The next price of bid should be larger than old_price * ( 1 + min_raise )deposit
: A higher deposit will be good for the display of the auction in the market.init_price
: The initial price for the auction to kick off.deadline
: A block number which represents the end of the auction activity.allow_delay
: If ture, in some cases the deadline will be extended.items
: Nft list.args:
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β β 1 β 'hammerPrice' β 'Compact<u128>' β 'Balance' β β 2 β 'minRaise' β 'Compact<PerU16>' β 'PerU16' β β 3 β 'deposit' β 'Compact<u128>' β 'Balance' β β 4 β 'initPrice' β 'Compact<u128>' β 'Balance' β β 5 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β β 6 β 'allowDelay' β 'bool' β 'bool' β β 7 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β β 8 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
api.tx.nftmartAuction.bidBritishAuction
Bid
args:
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€ β 0 β 'price' β 'Compact<u128>' β 'Balance' β β 1 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β β 2 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β β 3 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β β 4 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
api.tx.nftmartAuction.redeemBritishAuction
redeem
args:
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌβββββββββββββββββ€ β 0 β 'auctionOwner' β 'MultiAddress' β 'LookupSource' β β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ
api.tx.nftmartAuction.removeBritishAuction
remove an auction by auction owner.
args:
βββββββββββ¬ββββββββββββββ¬βββββββββββββββββ¬βββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββΌβββββββββββββββββΌβββββββββββββ€ β 0 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄ββββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
api.tx.nftmartAuction.removeExpiredBritishAuction
remove an expired british auction by auction owner.
args:
βββββββββββ¬βββββββββββββββββ¬βββββββββββββββββ¬ββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββΌβββββββββββββββββΌββββββββββββββ€ β 0 β 'auctionOwner' β 'AccountId32' β 'AccountId' β β 1 β 'auctionId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄βββββββββββββββββ΄βββββββββββββββββ΄ββββββββββββββ
nftmartConf
errors
api.errors.nftmartConf.NoAvailableId
no available id
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartConf.CategoryNotFound
category not found
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
events
api.events.nftmartConf.AddWhitelist
AddWhitelist [who]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartConf.RemoveWhitelist
RemoveWhitelist [who]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartConf.CreatedCategory
Created NFT common category. [category_id]
args:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β 0 β 'u64' β βββββββββββ΄βββββββββ
api.events.nftmartConf.UpdatedCategory
Updated NFT common category. [category_id]
args:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β 0 β 'u64' β βββββββββββ΄βββββββββ
query
api.query.nftmartConf.palletVersion
Returns the current pallet version from storage
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '73' β βββββββββββ΄βββββββββ
api.query.nftmartConf.auctionCloseDelay
auction delay
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '4' β βββββββββββ΄βββββββββ
api.query.nftmartConf.accountWhitelist
Whitelist for class creation
type:
βββββββββββ¬βββββββββββββββββββββββββ¬ββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββββββΌββββββΌββββββββ€ β Map β [ 'Blake2_128Concat' ] β '0' β '27' β βββββββββββ΄βββββββββββββββββββββββββ΄ββββββ΄ββββββββ
api.query.nftmartConf.royaltiesRate
Royalties rate, which can be set by council or sudo.
Incentive: In order to reward creators of nfts. A small part of trading price will be paid to the nft creator.
Royalty = Price *
RoyaltiesRate
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '84' β βββββββββββ΄βββββββββ
api.query.nftmartConf.platformFeeRate
Platform fee rate for trading nfts. After deals, it will transfer a small amount of price into the treasury.
PlatformFee = Price *
PlatformFeeRate
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '84' β βββββββββββ΄βββββββββ
api.query.nftmartConf.maxCommissionRewardRate
max distribution reward
Reward = (Price - Royalty - PlatformFee) *
distributionReward
It will pay theReward
to the secondary retailer.type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '84' β βββββββββββ΄βββββββββ
api.query.nftmartConf.minCommissionAgentDeposit
min reference deposit
The secondary retailer who will get reward from helping selling should keep at least
MinReferenceDeposit
balances.type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '6' β βββββββββββ΄βββββββββ
api.query.nftmartConf.minOrderDeposit
The lowest deposit every order should deposit.
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '6' β βββββββββββ΄βββββββββ
api.query.nftmartConf.nextId
Next available global ID.
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '8' β βββββββββββ΄βββββββββ
api.query.nftmartConf.categories
The storage of categories.
type:
βββββββββββ¬βββββββββββββββββββββ¬ββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββΌββββββΌββββββββ€ β Map β [ 'Twox64Concat' ] β '8' β '505' β βββββββββββ΄βββββββββββββββββββββ΄ββββββ΄ββββββββ
tx
api.tx.nftmartConf.addWhitelist
add an account into whitelist
args:
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬ββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββΌββββββββββββββββΌββββββββββββββ€ β 0 β 'who' β 'AccountId32' β 'AccountId' β βββββββββββ΄ββββββββ΄ββββββββββββββββ΄ββββββββββββββ
api.tx.nftmartConf.removeWhitelist
remove an account from whitelist
args:
βββββββββββ¬ββββββββ¬ββββββββββββββββ¬ββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββΌββββββββββββββββΌββββββββββββββ€ β 0 β 'who' β 'AccountId32' β 'AccountId' β βββββββββββ΄ββββββββ΄ββββββββββββββββ΄ββββββββββββββ
api.tx.nftmartConf.createCategory
Create a common category for trading NFT. A Selling NFT should belong to a category.
metadata
: metadataargs:
βββββββββββ¬βββββββββββββ¬ββββββββββ¬ββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββΌββββββββββΌββββββββββββββββ€ β 0 β 'metadata' β 'Bytes' β 'NFTMetadata' β βββββββββββ΄βββββββββββββ΄ββββββββββ΄ββββββββββββββββ
api.tx.nftmartConf.updateCategory
Update a common category.
category_id
: category IDmetadata
: metadataargs:
βββββββββββ¬βββββββββββββββ¬ββββββββββ¬ββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββΌββββββββββΌββββββββββββββββ€ β 0 β 'categoryId' β 'u64' β 'GlobalId' β β 1 β 'metadata' β 'Bytes' β 'NFTMetadata' β βββββββββββ΄βββββββββββββββ΄ββββββββββ΄ββββββββββββββββ
api.tx.nftmartConf.updateAuctionCloseDelay
args:
βββββββββββ¬ββββββββββ¬ββββββββ¬βββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββΌββββββββΌβββββββββββββββββββ€ β 0 β 'delay' β 'u32' β 'BlockNumberFor' β βββββββββββ΄ββββββββββ΄ββββββββ΄βββββββββββββββββββ
nftmartOrder
consts
api.consts.nftmartOrder.treasuryPalletId
The treasury's pallet id, used for deriving its sovereign account ID.
type:
430
errors
api.errors.nftmartOrder.SubmitWithInvalidDeposit
submit with invalid deposit
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.SubmitWithInvalidDeadline
submit with invalid deadline
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.TakeExpiredOrderOrOffer
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.TooManyTokenChargedRoyalty
too many token charged royalty
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.OrderNotFound
order not found
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.OfferNotFound
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.TakeOwnOrder
cannot take one's own order
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.TakeOwnOffer
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.InvalidCommissionRate
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
api.errors.nftmartOrder.SenderTakeCommission
args:
βββββββββββ β (index) β βββββββββββ€ βββββββββββ
events
api.events.nftmartOrder.CreatedOrder
CreatedOrder [who, order_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartOrder.RemovedOrder
RemovedOrder [who, order_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartOrder.RemovedOffer
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
api.events.nftmartOrder.TakenOrder
TakenOrder [purchaser, order_owner, order_id]
args:
βββββββββββ¬ββββββββββββββββββββββββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββββββββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'AccountId32' β β 2 β 'u64' β β 3 β 'Option<(bool,AccountId32,PerU16)>' β β 4 β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββββββββββββββββββββ
api.events.nftmartOrder.TakenOffer
TakenOrder [token_owner, offer_owner, order_id]
args:
βββββββββββ¬ββββββββββββββββββββββββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββββββββββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'AccountId32' β β 2 β 'u64' β β 3 β 'Option<(bool,AccountId32,PerU16)>' β β 4 β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββββββββββββββββββββ
api.events.nftmartOrder.CreatedOffer
CreatedOffer [who, order_id]
args:
βββββββββββ¬ββββββββββββββββ β (index) β Values β βββββββββββΌββββββββββββββββ€ β 0 β 'AccountId32' β β 1 β 'u64' β βββββββββββ΄ββββββββββββββββ
query
api.query.nftmartOrder.palletVersion
Returns the current pallet version from storage
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '73' β βββββββββββ΄βββββββββ
api.query.nftmartOrder.storageVersion
Storage version of the pallet.
type:
βββββββββββ¬βββββββββ β (index) β Values β βββββββββββΌβββββββββ€ β Plain β '509' β βββββββββββ΄βββββββββ
api.query.nftmartOrder.orders
Index/store orders by account as primary key and order id as secondary key.
type:
βββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ¬ββββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββββββββββββββββββββββΌββββββββΌββββββββ€ β Map β [ 'Blake2_128Concat', 'Twox64Concat' ] β '510' β '511' β βββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ΄ββββββββ΄ββββββββ
api.query.nftmartOrder.offers
Index/store offers by account as primary key and order id as secondary key.
type:
βββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ¬ββββββββ¬ββββββββ β (index) β hashers β key β value β βββββββββββΌβββββββββββββββββββββββββββββββββββββββββΌββββββββΌββββββββ€ β Map β [ 'Blake2_128Concat', 'Twox64Concat' ] β '510' β '514' β βββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ΄ββββββββ΄ββββββββ
tx
api.tx.nftmartOrder.submitOrder
Create an order.
currency_id
: currency idcategory_id
: category iddeposit
: The balances to create an orderprice
: nfts' price.deadline
: deadlineitems
: a list of(class_id, token_id, quantity, price)
args:
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β β 1 β 'deposit' β 'Compact<u128>' β 'Balance' β β 2 β 'price' β 'Compact<u128>' β 'Balance' β β 3 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β β 4 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β β 5 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
api.tx.nftmartOrder.takeOrder
Take a NFT order.
order_id
: order idorder_owner
: token ownerargs:
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€ β 0 β 'orderId' β 'Compact<u64>' β 'GlobalId' β β 1 β 'orderOwner' β 'MultiAddress' β 'LookupSource' β β 2 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β β 3 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ
api.tx.nftmartOrder.removeOrder
remove an order by order owner.
order_id
: order idargs:
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββ€ β 0 β 'orderId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
api.tx.nftmartOrder.removeOffer
remove an offer by offer owner.
offer_id
: offer idargs:
βββββββββββ¬ββββββββββββ¬βββββββββββββββββ¬βββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββΌβββββββββββββββββΌβββββββββββββ€ β 0 β 'offerId' β 'Compact<u64>' β 'GlobalId' β βββββββββββ΄ββββββββββββ΄βββββββββββββββββ΄βββββββββββββ
api.tx.nftmartOrder.submitOffer
args:
βββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌβββββββββββββββββββΌβββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ β 0 β 'currencyId' β 'Compact<u32>' β 'CurrencyIdOf' β β 1 β 'price' β 'Compact<u128>' β 'Balance' β β 2 β 'deadline' β 'Compact<u32>' β 'BlockNumberOf' β β 3 β 'items' β 'Vec<(u32,u64,u64)>' β 'Vec<(ClassIdOf,TokenIdOf,TokenIdOf)>' β β 4 β 'commissionRate' β 'Compact<PerU16>' β 'PerU16' β βββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ
api.tx.nftmartOrder.takeOffer
Take a NFT offer.
offer_id
: offer idoffer_owner
: token ownerargs:
βββββββββββ¬ββββββββββββββββββββ¬ββββββββββββββββββββββββ¬ββββββββββββββββββββββ β (index) β name β type β typeName β βββββββββββΌββββββββββββββββββββΌββββββββββββββββββββββββΌββββββββββββββββββββββ€ β 0 β 'offerId' β 'Compact<u64>' β 'GlobalId' β β 1 β 'offerOwner' β 'MultiAddress' β 'LookupSource' β β 2 β 'commissionAgent' β 'Option<AccountId32>' β 'Option<AccountId>' β β 3 β 'commissionData' β 'Option<Bytes>' β 'Option<Bytes>' β βββββββββββ΄ββββββββββββββββββββ΄ββββββββββββββββββββββββ΄ββββββββββββββββββββββ