Extrinsics
The following sections contain Extrinsics methods are part of the default Substrate runtime. On the api, these are exposed via api.tx.<module>.<method>
.
(NOTE: These were generated from a static/snapshot view of a recent Substrate master node. Some items may not be available in older nodes, or in any customized implementations.)
#
assetsCompact<u32>
, delegate: MultiAddress
, amount: Compact<u64>
)#
approveTransfer(id: interface:
api.tx.assets.approveTransfer
summary: Approve an amount of asset for transfer by a delegated third-party account.
Origin must be Signed.
Ensures that
ApprovalDeposit
worth ofCurrency
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 todelegate
, 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 bydelegate
. If there is already an approval in place, then this acts additively.Emits
ApprovedTransfer
on success.Weight:
O(1)
Compact<u32>
, who: MultiAddress
, amount: Compact<u64>
)#
burn(id: interface:
api.tx.assets.burn
summary: Reduce the balance of
who
by as much as possible up toamount
assets ofid
.Origin must be Signed and the sender should be the Manager of the asset
id
.Bails with
BalanceZero
if thewho
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 whichwho
'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 ofwho
; Pre & post Zombie-status ofwho
.
Compact<u32>
, delegate: MultiAddress
)#
cancelApproval(id: interface:
api.tx.assets.cancelApproval
summary: Cancel all of some asset approved for delegated transfer by a third-party account.
Origin must be Signed and there must be an approval in place between signer and
delegate
.Unreserves any deposit previously reserved by
approve_transfer
for the approval.id
: The identifier of the asset.delegate
: The account delegated permission to transfer asset.Emits
ApprovalCancelled
on success.Weight:
O(1)
Compact<u32>
)#
clearMetadata(id: interface:
api.tx.assets.clearMetadata
summary: Clear the metadata for an asset.
Origin must be Signed and the sender should be the Owner of the asset
id
.Any deposit is freed for the asset owner.
id
: The identifier of the asset to clear.Emits
MetadataCleared
.Weight:
O(1)
Compact<u32>
, admin: MultiAddress
, min_balance: u64
)#
create(id: interface:
api.tx.assets.create
summary: Issue a new class of fungible assets from a public origin.
This new asset class has no assets initially and its owner is the origin.
The origin must be Signed and the sender must have sufficient funds free.
Funds of sender are reserved by
AssetDeposit
.Parameters:
id
: The identifier of the new asset. This must not be currently in use to identify an existing asset.admin
: The admin of this class of assets. The admin is the initial address of each member of the asset class's admin team.min_balance
: The minimum balance of this new asset that any single account must have. If an account's balance is reduced below this, then it collapses to zero.Emits
Created
event when successful.Weight:
O(1)
Compact<u32>
, witness: PalletAssetsDestroyWitness
)#
destroy(id: interface:
api.tx.assets.destroy
summary: Destroy a class of fungible assets.
The origin must conform to
ForceOrigin
or must be Signed and the sender must be the owner of the assetid
.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
Compact<u32>
, owner: MultiAddress
, issuer: MultiAddress
, admin: MultiAddress
, freezer: MultiAddress
, min_balance: Compact<u64>
, is_sufficient: bool
, is_frozen: bool
)#
forceAssetStatus(id: interface:
api.tx.assets.forceAssetStatus
summary: Alter the attributes of a given asset.
Origin must be
ForceOrigin
.id
: The identifier of the asset.owner
: The new Owner of this asset.issuer
: The new Issuer of this asset.admin
: The new Admin of this asset.freezer
: The new Freezer of this asset.min_balance
: The minimum balance of this new asset that any single account must have. If an account's balance is reduced below this, then it collapses to zero.is_sufficient
: Whether a non-zero balance of this asset is deposit of sufficient value to account for the state bloat associated with its balance storage. If set totrue
, then non-zero balances may be stored without aconsumer
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)
Compact<u32>
, owner: MultiAddress
, delegate: MultiAddress
)#
forceCancelApproval(id: interface:
api.tx.assets.forceCancelApproval
summary: Cancel all of some asset approved for delegated transfer by a third-party account.
Origin must be either ForceOrigin or Signed origin with the signer being the Admin account of the asset
id
.Unreserves any deposit previously reserved by
approve_transfer
for the approval.id
: The identifier of the asset.delegate
: The account delegated permission to transfer asset.Emits
ApprovalCancelled
on success.Weight:
O(1)
Compact<u32>
)#
forceClearMetadata(id: interface:
api.tx.assets.forceClearMetadata
summary: Clear the metadata for an asset.
Origin must be ForceOrigin.
Any deposit is returned.
id
: The identifier of the asset to clear.Emits
MetadataCleared
.Weight:
O(1)
Compact<u32>
, owner: MultiAddress
, is_sufficient: bool
, min_balance: Compact<u64>
)#
forceCreate(id: interface:
api.tx.assets.forceCreate
summary: Issue a new class of fungible assets from a privileged origin.
This new asset class has no assets initially.
The origin must conform to
ForceOrigin
.Unlike
create
, no funds are reserved.id
: The identifier of the new asset. This must not be currently in use to identify an existing asset.owner
: The owner of this class of assets. The owner has full superuser permissions over this asset, but may later change and configure the permissions usingtransfer_ownership
andset_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)
Compact<u32>
, name: Bytes
, symbol: Bytes
, decimals: u8
, is_frozen: bool
)#
forceSetMetadata(id: interface:
api.tx.assets.forceSetMetadata
summary: Force the metadata for an asset to some value.
Origin must be ForceOrigin.
Any deposit is left alone.
id
: The identifier of the asset to update.name
: The user friendly name of this asset. Limited in length byStringLimit
.symbol
: The exchange symbol for this asset. Limited in length byStringLimit
.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.
Compact<u32>
, source: MultiAddress
, dest: MultiAddress
, amount: Compact<u64>
)#
forceTransfer(id: interface:
api.tx.assets.forceTransfer
summary: Move some assets from one account to another.
Origin must be Signed and the sender should be the Admin of the asset
id
.id
: The identifier of the asset to have some amount transferred.source
: The account to be debited.dest
: The account to be credited.amount
: The amount by which thesource
's balance of assets should be reduced anddest
's balance increased. The amount actually transferred may be slightly greater in the case that the transfer would otherwise take thesource
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 ofdest
; Post-existence ofsource
; Account pre-existence ofdest
.
Compact<u32>
, who: MultiAddress
)#
freeze(id: interface:
api.tx.assets.freeze
summary: Disallow further unprivileged transfers from an account.
Origin must be Signed and the sender should be the Freezer of the asset
id
.id
: The identifier of the asset to be frozen.who
: The account to be frozen.Emits
Frozen
.Weight:
O(1)
Compact<u32>
)#
freezeAsset(id: interface:
api.tx.assets.freezeAsset
summary: Disallow further unprivileged transfers for the asset class.
Origin must be Signed and the sender should be the Freezer of the asset
id
.id
: The identifier of the asset to be frozen.Emits
Frozen
.Weight:
O(1)
Compact<u32>
, beneficiary: MultiAddress
, amount: Compact<u64>
)#
mint(id: interface:
api.tx.assets.mint
summary: Mint assets of a particular class.
The origin must be Signed and the sender must be the Issuer of the asset
id
.id
: The identifier of the asset to have some amount minted.beneficiary
: The account to be credited with the minted assets.amount
: The amount of the asset to be minted.Emits
Issued
event when successful.Weight:
O(1)
Modes: Pre-existing balance ofbeneficiary
; Account pre-existence ofbeneficiary
.
Compact<u32>
, name: Bytes
, symbol: Bytes
, decimals: u8
)#
setMetadata(id: interface:
api.tx.assets.setMetadata
summary: Set the metadata for an asset.
Origin must be Signed and the sender should be the Owner of the asset
id
.Funds of sender are reserved according to the formula:
MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len)
taking into account any already reserved funds.id
: The identifier of the asset to update.name
: The user friendly name of this asset. Limited in length byStringLimit
.symbol
: The exchange symbol for this asset. Limited in length byStringLimit
.decimals
: The number of decimals this asset uses to represent one unit.Emits
MetadataSet
.Weight:
O(1)
Compact<u32>
, issuer: MultiAddress
, admin: MultiAddress
, freezer: MultiAddress
)#
setTeam(id: interface:
api.tx.assets.setTeam
summary: Change the Issuer, Admin and Freezer of an asset.
Origin must be Signed and the sender should be the Owner of the asset
id
.id
: The identifier of the asset to be frozen.issuer
: The new Issuer of this asset.admin
: The new Admin of this asset.freezer
: The new Freezer of this asset.Emits
TeamChanged
.Weight:
O(1)
Compact<u32>
, who: MultiAddress
)#
thaw(id: interface:
api.tx.assets.thaw
summary: Allow unprivileged transfers from an account again.
Origin must be Signed and the sender should be the Admin of the asset
id
.id
: The identifier of the asset to be frozen.who
: The account to be unfrozen.Emits
Thawed
.Weight:
O(1)
Compact<u32>
)#
thawAsset(id: interface:
api.tx.assets.thawAsset
summary: Allow unprivileged transfers for the asset again.
Origin must be Signed and the sender should be the Admin of the asset
id
.id
: The identifier of the asset to be thawed.Emits
Thawed
.Weight:
O(1)
Compact<u32>
, target: MultiAddress
, amount: Compact<u64>
)#
transfer(id: interface:
api.tx.assets.transfer
summary: Move some assets from the sender account to another.
Origin must be Signed.
id
: The identifier of the asset to have some amount transferred.target
: The account to be credited.amount
: The amount by which the sender's balance of assets should be reduced andtarget
'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 oftarget
; Post-existence of sender; Account pre-existence oftarget
.
Compact<u32>
, owner: MultiAddress
, destination: MultiAddress
, amount: Compact<u64>
)#
transferApproved(id: interface:
api.tx.assets.transferApproved
summary: Transfer some asset balance from a previously delegated account to some third-party account.
Origin must be Signed and there must be an approval in place by the
owner
to the signer.If the entire amount approved for transfer is transferred, then any deposit previously reserved by
approve_transfer
is unreserved.id
: The identifier of the asset.owner
: The account which previously approved for a transfer of at leastamount
and from which the asset balance will be withdrawn.destination
: The account to which the asset balance ofamount
will be transferred.amount
: The amount of assets to transfer.Emits
TransferredApproved
on success.Weight:
O(1)
Compact<u32>
, target: MultiAddress
, amount: Compact<u64>
)#
transferKeepAlive(id: interface:
api.tx.assets.transferKeepAlive
summary: Move some assets from the sender account to another, keeping the sender account alive.
Origin must be Signed.
id
: The identifier of the asset to have some amount transferred.target
: The account to be credited.amount
: The amount by which the sender's balance of assets should be reduced andtarget
'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 oftarget
; Post-existence of sender; Account pre-existence oftarget
.
Compact<u32>
, owner: MultiAddress
)#
transferOwnership(id: interface:
api.tx.assets.transferOwnership
summary: Change the Owner of an asset.
Origin must be Signed and the sender should be the Owner of the asset
id
.id
: The identifier of the asset.owner
: The new Owner of this asset.Emits
OwnerChanged
.Weight:
O(1)
#
authorshipVec<SpRuntimeHeader>
)#
setUncles(new_uncles: - interface:
api.tx.authorship.setUncles
- summary: Provide a set of uncles.
#
babeSpConsensusBabeDigestsNextConfigDescriptor
)#
planConfigChange(config: - interface:
api.tx.babe.planConfigChange
- summary: Plan an epoch config change. The epoch config change is recorded and will be enacted on the next call to
enact_epoch_change
. The config will be activated one epoch after. Multiple calls to this method will replace any existing planned config change that had not been enacted yet.
SpConsensusSlotsEquivocationProof
, key_owner_proof: SpSessionMembershipProof
)#
reportEquivocation(equivocation_proof: - interface:
api.tx.babe.reportEquivocation
- summary: Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.
SpConsensusSlotsEquivocationProof
, key_owner_proof: SpSessionMembershipProof
)#
reportEquivocationUnsigned(equivocation_proof: - interface:
api.tx.babe.reportEquivocationUnsigned
- summary: Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported. This extrinsic must be called unsigned and it is expected that only block authors will call it (validated in
ValidateUnsigned
), as such if the block author is defined it will be defined as the equivocation reporter.
#
balancesMultiAddress
, dest: MultiAddress
, value: Compact<u128>
)#
forceTransfer(source: - interface:
api.tx.balances.forceTransfer
- summary: Exactly as
transfer
, except the origin must be root and the source account may be specified.
MultiAddress
, amount: u128
)#
forceUnreserve(who: interface:
api.tx.balances.forceUnreserve
summary: Unreserve some balance from a user by force.
Can only be called by ROOT.
MultiAddress
, new_free: Compact<u128>
, new_reserved: Compact<u128>
)#
setBalance(who: interface:
api.tx.balances.setBalance
summary: Set the balances of a given account.
This will alter
FreeBalance
andReservedBalance
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
.
MultiAddress
, value: Compact<u128>
)#
transfer(dest: interface:
api.tx.balances.transfer
summary: Transfer some liquid free balance to another account.
transfer
will set theFreeBalance
of the sender and receiver. It will decrease the total issuance of the system by theTransferFee
. 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.
MultiAddress
, keep_alive: bool
)#
transferAll(dest: interface:
api.tx.balances.transferAll
summary: Transfer the entire transferable balance from the caller account.
NOTE: This function only attempts to transfer transferable balances. This means that any locked, reserved, or existential deposits (when
keep_alive
istrue
), 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 thetransfer_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). #
MultiAddress
, value: Compact<u128>
)#
transferKeepAlive(dest: interface:
api.tx.balances.transferKeepAlive
summary: Same as the
transfer
call, but with a check that the transfer will not kill the origin account.99% of the time you want
transfer
instead.
#
bountiesCompact<u32>
)#
acceptCurator(bounty_id: interface:
api.tx.bounties.acceptCurator
summary: Accept the curator role for a bounty. A deposit will be reserved from curator and refund upon successful payout.
May only be called from the curator.
Compact<u32>
)#
approveBounty(bounty_id: interface:
api.tx.bounties.approveBounty
summary: Approve a bounty proposal. At a later time, the bounty will be funded and become active and the original deposit will be returned.
May only be called from
T::ApproveOrigin
.
Compact<u32>
, beneficiary: MultiAddress
)#
awardBounty(bounty_id: interface:
api.tx.bounties.awardBounty
summary: Award bounty to a beneficiary account. The beneficiary will be able to claim the funds after a delay.
The dispatch origin for this call must be the curator of this bounty.
bounty_id
: Bounty ID to award.beneficiary
: The beneficiary account whom will receive the payout.
Compact<u32>
)#
claimBounty(bounty_id: interface:
api.tx.bounties.claimBounty
summary: Claim the payout from an awarded bounty after payout delay.
The dispatch origin for this call must be the beneficiary of this bounty.
bounty_id
: Bounty ID to claim.
Compact<u32>
)#
closeBounty(bounty_id: interface:
api.tx.bounties.closeBounty
summary: Cancel a proposed or active bounty. All the funds will be sent to treasury and the curator deposit will be unreserved if possible.
Only
T::RejectOrigin
is able to cancel a bounty.bounty_id
: Bounty ID to cancel.
Compact<u32>
, remark: Bytes
)#
extendBountyExpiry(bounty_id: interface:
api.tx.bounties.extendBountyExpiry
summary: Extend the expiry time of an active bounty.
The dispatch origin for this call must be the curator of this bounty.
bounty_id
: Bounty ID to extend.remark
: additional information.
Compact<u128>
, description: Bytes
)#
proposeBounty(value: interface:
api.tx.bounties.proposeBounty
summary: Propose a new bounty.
The dispatch origin for this call must be Signed.
Payment:
TipReportDepositBase
will be reserved from the origin account, as well asDataDepositPerByte
for each byte inreason
. 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.
Compact<u32>
, curator: MultiAddress
, fee: Compact<u128>
)#
proposeCurator(bounty_id: interface:
api.tx.bounties.proposeCurator
summary: Assign a curator to a funded bounty.
May only be called from
T::ApproveOrigin
.
Compact<u32>
)#
unassignCurator(bounty_id: interface:
api.tx.bounties.unassignCurator
summary: Unassign curator from a bounty.
This function can only be called by the
RejectOrigin
a signed origin.If this function is called by the
RejectOrigin
, we assume that the curator is malicious or inactive. As a result, we will slash the curator when possible.If the origin is the curator, we take this as a sign they are unable to do their job and they willingly give up. We could slash them, but for now we allow them to recover their deposit and exit without issue. (We may want to change this if it is abused.)
Finally, the origin can be anyone if and only if the curator is "inactive". This allows anyone in the community to call out that a curator is not doing their due diligence, and we should pick a new curator. In this case the curator should also be slashed.
#
chainBridgeu64
, src_id: u8
, r_id: [u8;32]
, call: Call
)#
acknowledgeProposal(nonce: interface:
api.tx.chainBridge.acknowledgeProposal
summary: Commits a vote in favour of the provided proposal.
If a proposal with the given nonce and source chain ID does not already exist, it will be created with an initial vote in favour from the caller.
AccountId32
)#
addRelayer(v: - interface:
api.tx.chainBridge.addRelayer
- summary: Adds a new relayer to the relayer set.
u64
, src_id: u8
, prop: Call
)#
evalVoteState(nonce: interface:
api.tx.chainBridge.evalVoteState
summary: Evaluate the state of a proposal given the current vote threshold.
A proposal with enough votes will be either executed or cancelled, and the status will be updated accordingly.
u64
, src_id: u8
, r_id: [u8;32]
, call: Call
)#
rejectProposal(nonce: - interface:
api.tx.chainBridge.rejectProposal
- summary: Commits a vote against a provided proposal.
AccountId32
)#
removeRelayer(v: - interface:
api.tx.chainBridge.removeRelayer
- summary: Removes an existing relayer from the set.
[u8;32]
)#
removeResource(id: interface:
api.tx.chainBridge.removeResource
summary: Removes a resource ID from the resource mapping.
After this call, bridge transfers with the associated resource ID will be rejected.
[u8;32]
, method: Bytes
)#
setResource(id: - interface:
api.tx.chainBridge.setResource
- summary: Stores a method name on chain under an associated resource ID.
u32
)#
setThreshold(threshold: interface:
api.tx.chainBridge.setThreshold
summary: Sets the vote threshold for proposals.
This threshold is used to determine how many votes are required before a proposal is executed.
u8
)#
whitelistChain(id: - interface:
api.tx.chainBridge.whitelistChain
- summary: Enables a chain ID as a source or destination for a bridge transfer.
#
claimsBytes
)#
attest(statement: interface:
api.tx.claims.attest
summary: Attest to a statement, needed to finalize the claims process.
WARNING: Insecure unless your chain includes
PrevalidateAttests
as aSignedExtension
.Unsigned Validation: A call to attest is deemed valid if the sender has a
Preclaim
registered and provides astatement
which is expected for the account.Parameters:
statement
: The identity of the statement which is being attested to in the signature.
AccountId32
, ethereum_signature: ClaimsEcdsaSignature
)#
claim(dest: interface:
api.tx.claims.claim
summary: Make a claim to collect your coins.
The dispatch origin for this call must be None.
Unsigned Validation: A call to claim is deemed valid if the signature provided matches the expected signed message of:
Ethereum Signed Message: > (configured prefix string)(address)
and
address
matches thedest
account.Parameters:
dest
: The destination account to payout the claim.ethereum_signature
: The signature of an ethereum signed message matching the format described above.
AccountId32
, ethereum_signature: ClaimsEcdsaSignature
, statement: Bytes
)#
claimAttest(dest: interface:
api.tx.claims.claimAttest
summary: Make a claim to collect your coins by signing a statement.
The dispatch origin for this call must be None.
Unsigned Validation: A call to
claim_attest
is deemed valid if the signature provided matches the expected signed message of:Ethereum Signed Message: > (configured prefix string)(address)(statement)
and
address
matches thedest
account; thestatement
must match that which is expected according to your purchase arrangement.Parameters:
dest
: The destination account to payout the claim.ethereum_signature
: The signature of an ethereum signed message matching the format described above.statement
: The identity of the statement which is being attested to in the signature.
ClaimsEthereumAddress
, value: u128
, vesting_schedules: Option<Vec<(u128,u128,u32)>>
, statement: Option<ClaimsStatementKind>
)#
mintClaim(who: interface:
api.tx.claims.mintClaim
summary: Mint a new claim to collect coins.
The dispatch origin for this call must be Root.
Parameters:
who
: The Ethereum address allowed to collect this claim.value
: The number of coins that will be claimed.vesting_schedules
: An optional list of vesting schedules for these coins.NOTE: It is the responsibility of the caller to not list more vesting schedules than supported by the Vesting pallet. Any schedules specified above that limit will be ignored.
ClaimsEthereumAddress
, new: ClaimsEthereumAddress
, maybe_preclaim: Option<AccountId32>
)#
moveClaim(old: - interface:
api.tx.claims.moveClaim
#
councilH256
, index: Compact<u32>
, proposal_weight_bound: Compact<u64>
, length_bound: Compact<u32>
)#
close(proposal_hash: interface:
api.tx.council.close
summary: Close a vote that is either approved, disapproved or whose voting period has ended.
May be called by any signed account in order to finish voting and close the proposal.
If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.
If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.
If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.
proposal_weight_bound
: The maximum amount of weight consumed by executing the closed proposal. +length_bound
: The upper bound for the length of the proposal in storage. Checked viastorage::read
so it issize_of::<u32>() == 4
larger than the pure length.
H256
)#
disapproveProposal(proposal_hash: interface:
api.tx.council.disapproveProposal
summary: Disapprove a proposal, close, and remove it from the system, regardless of its current state.
Must be called by the Root origin.
Parameters:
proposal_hash
: The hash of the proposal that should be disapproved.
Call
, length_bound: Compact<u32>
)#
execute(proposal: interface:
api.tx.council.execute
summary: Dispatch a proposal from a member using the
Member
origin.Origin must be a member of the collective.
Compact<u32>
, proposal: Call
, length_bound: Compact<u32>
)#
propose(threshold: interface:
api.tx.council.propose
summary: Add a new proposal to either be voted on or executed directly.
Requires the sender to be member.
threshold
determines whetherproposal
is executed directly (threshold < 2
) or put up for voting.
Vec<AccountId32>
, prime: Option<AccountId32>
, old_count: u32
)#
setMembers(new_members: interface:
api.tx.council.setMembers
summary: Set the collective's membership.
new_members
: The new member list. Be nice to the chain and provide it sorted.prime
: The prime member whose vote sets the default.old_count
: The upper bound for the previous number of members in storage. Used for weight estimation.Requires root origin.
NOTE: Does not enforce the expected
MaxMembers
limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.#
WARNING:The
pallet-collective
can also be managed by logic outside of the pallet through the implementation of the trait [ChangeMembers
]. Any call toset_members
must be careful that the member set doesn't get out of sync with other logic managing the member set.
H256
, index: Compact<u32>
, approve: bool
)#
vote(proposal: interface:
api.tx.council.vote
summary: Add an aye or nay vote for the sender to the given proposal.
Requires the sender to be a member.
Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.
#
democracyH256
, maybe_ref_index: Option<u32>
)#
blacklist(proposal_hash: interface:
api.tx.democracy.blacklist
summary: Permanently place a proposal into the blacklist. This prevents it from ever being proposed again.
If called on a queued public or external proposal, then this will result in it being removed. If the
ref_index
supplied is an active referendum with the proposal hash, then it will be cancelled.The dispatch origin of this call must be
BlacklistOrigin
.proposal_hash
: The proposal hash to blacklist permanently.ref_index
: An ongoing referendum whose hash isproposal_hash
, which will be cancelled.Weight:
O(p)
(though as this is an high-privilege dispatch, we assume it has a reasonable value).
Compact<u32>
)#
cancelProposal(prop_index: interface:
api.tx.democracy.cancelProposal
summary: Remove a proposal.
The dispatch origin of this call must be
CancelProposalOrigin
.prop_index
: The index of the proposal to cancel.Weight:
O(p)
wherep = PublicProps::<T>::decode_len()
u32
)#
cancelQueued(which: interface:
api.tx.democracy.cancelQueued
summary: Cancel a proposal queued for enactment.
The dispatch origin of this call must be Root.
which
: The index of the referendum to cancel.Weight:
O(D)
whereD
is the items in the dispatch queue. Weighted asD = 10
.
Compact<u32>
)#
cancelReferendum(ref_index: interface:
api.tx.democracy.cancelReferendum
summary: Remove a referendum.
The dispatch origin of this call must be Root.
ref_index
: The index of the referendum to cancel.Weight:
O(1)
.
#
clearPublicProposals()interface:
api.tx.democracy.clearPublicProposals
summary: Clears all public proposals.
The dispatch origin of this call must be Root.
Weight:
O(1)
.
AccountId32
, conviction: PalletDemocracyConviction
, balance: u128
)#
delegate(to: interface:
api.tx.democracy.delegate
summary: Delegate the voting power (with some given conviction) of the sending account.
The balance delegated is locked for as long as it's delegated, and thereafter for the time appropriate for the conviction's lock period.
The dispatch origin of this call must be Signed, and the signing account must either:
be delegating already; or
have no voting activity (if there is, then it will need to be removed/consolidated through
reap_vote
orunvote
).to
: The account whose voting thetarget
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.
u32
)#
emergencyCancel(ref_index: interface:
api.tx.democracy.emergencyCancel
summary: Schedule an emergency cancellation of a referendum. Cannot happen twice to the same referendum.
The dispatch origin of this call must be
CancellationOrigin
.-
ref_index
: The index of the referendum to cancel.Weight:
O(1)
.
H256
, index: u32
)#
enactProposal(proposal_hash: - interface:
api.tx.democracy.enactProposal
- summary: Enact a proposal from a referendum. For now we just make the weight be the maximum.
H256
)#
externalPropose(proposal_hash: interface:
api.tx.democracy.externalPropose
summary: Schedule a referendum to be tabled once it is legal to schedule an external referendum.
The dispatch origin of this call must be
ExternalOrigin
.proposal_hash
: The preimage hash of the proposal.Weight:
O(V)
with V number of vetoers in the blacklist of proposal. Decoding vec of length V. Charged as maximum
H256
)#
externalProposeDefault(proposal_hash: interface:
api.tx.democracy.externalProposeDefault
summary: Schedule a negative-turnout-bias referendum to be tabled next once it is legal to schedule an external referendum.
The dispatch of this call must be
ExternalDefaultOrigin
.proposal_hash
: The preimage hash of the proposal.Unlike
external_propose
, blacklisting has no effect on this and it may replace a pre-scheduledexternal_propose
call.Weight:
O(1)
H256
)#
externalProposeMajority(proposal_hash: interface:
api.tx.democracy.externalProposeMajority
summary: Schedule a majority-carries referendum to be tabled next once it is legal to schedule an external referendum.
The dispatch of this call must be
ExternalMajorityOrigin
.proposal_hash
: The preimage hash of the proposal.Unlike
external_propose
, blacklisting has no effect on this and it may replace a pre-scheduledexternal_propose
call.Weight:
O(1)
H256
, voting_period: u32
, delay: u32
)#
fastTrack(proposal_hash: interface:
api.tx.democracy.fastTrack
summary: Schedule the currently externally-proposed majority-carries referendum to be tabled immediately. If there is no externally-proposed referendum currently, or if there is one but it is not a majority-carries referendum then it fails.
The dispatch of this call must be
FastTrackOrigin
.proposal_hash
: The hash of the current external proposal.voting_period
: The period that is allowed for voting on this proposal. Increased toFastTrackVotingPeriod
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)
Bytes
)#
noteImminentPreimage(encoded_proposal: interface:
api.tx.democracy.noteImminentPreimage
summary: Register the preimage for an upcoming proposal. This requires the proposal to be in the dispatch queue. No deposit is needed. When this call is successful, i.e. the preimage has not been uploaded before and matches some imminent proposal, no fee is paid.
The dispatch origin of this call must be Signed.
encoded_proposal
: The preimage of a proposal.Emits
PreimageNoted
.Weight:
O(E)
with E size ofencoded_proposal
(protected by a required deposit).
Bytes
)#
noteImminentPreimageOperational(encoded_proposal: - interface:
api.tx.democracy.noteImminentPreimageOperational
- summary: Same as
note_imminent_preimage
but origin isOperationalPreimageOrigin
.
Bytes
)#
notePreimage(encoded_proposal: interface:
api.tx.democracy.notePreimage
summary: Register the preimage for an upcoming proposal. This doesn't require the proposal to be in the dispatch queue but does require a deposit, returned once enacted.
The dispatch origin of this call must be Signed.
encoded_proposal
: The preimage of a proposal.Emits
PreimageNoted
.Weight:
O(E)
with E size ofencoded_proposal
(protected by a required deposit).
Bytes
)#
notePreimageOperational(encoded_proposal: - interface:
api.tx.democracy.notePreimageOperational
- summary: Same as
note_preimage
but origin isOperationalPreimageOrigin
.
H256
, value: Compact<u128>
)#
propose(proposal_hash: interface:
api.tx.democracy.propose
summary: Propose a sensitive action to be taken.
The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit.
proposal_hash
: The hash of the proposal preimage.value
: The amount of deposit (must be at leastMinimumDeposit
).Emits
Proposed
.Weight:
O(p)
H256
, proposal_len_upper_bound: Compact<u32>
)#
reapPreimage(proposal_hash: interface:
api.tx.democracy.reapPreimage
summary: Remove an expired proposal preimage and collect the deposit.
The dispatch origin of this call must be Signed.
proposal_hash
: The preimage hash of a proposal.proposal_length_upper_bound
: an upper bound on length of the proposal. Extrinsic is weighted according to this value with no refund.This will only work after
VotingPeriod
blocks from the time that the preimage was noted, if it's the same account doing it. If it's a different account, then it'll only work an additionalEnactmentPeriod
later.Emits
PreimageReaped
.Weight:
O(D)
where D is length of proposal.
AccountId32
, index: u32
)#
removeOtherVote(target: interface:
api.tx.democracy.removeOtherVote
summary: Remove a vote for a referendum.
If the
target
is equal to the signer, then this function is exactly equivalent toremove_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 referendumindex
.index
: The index of referendum of the vote to be removed.Weight:
O(R + log R)
where R is the number of referenda thattarget
has voted on. Weight is calculated for the maximum number of vote.
u32
)#
removeVote(index: interface:
api.tx.democracy.removeVote
summary: Remove a vote for a referendum.
If:
the referendum was cancelled, or
the referendum is ongoing, or
the referendum has ended such that
the vote of the account was in opposition to the result; or
there was no conviction to the account's vote; or
the account made a split vote ...then the vote is removed cleanly and a following call to
unlock
may result in more funds being available.If, however, the referendum has ended and:
it finished corresponding to the vote of the account, and
the account made a standard vote with conviction, and
the lock period of the conviction is not over ...then the lock will be aggregated into the overall account's lock, which may involve
overlocking (where the two locks are combined into a single lock that is the maximum of both the amount locked and the time is it locked for).
The dispatch origin of this call must be Signed, and the signer must have a vote registered for referendum
index
.index
: The index of referendum of the vote to be removed.Weight:
O(R + log R)
where R is the number of referenda thattarget
has voted on. Weight is calculated for the maximum number of vote.
Compact<u32>
, seconds_upper_bound: Compact<u32>
)#
second(proposal: interface:
api.tx.democracy.second
summary: Signals agreement with a particular proposal.
The dispatch origin of this call must be Signed and the sender must have funds to cover the deposit, equal to the original deposit.
proposal
: The index of the proposal to second.seconds_upper_bound
: an upper bound on the current number of seconds on this proposal. Extrinsic is weighted according to this value with no refund.Weight:
O(S)
where S is the number of seconds a proposal already has.
#
undelegate()interface:
api.tx.democracy.undelegate
summary: Undelegate the voting power of the sending account.
Tokens may be unlocked following once an amount of time consistent with the lock period of the conviction with which the delegation was issued.
The dispatch origin of this call must be Signed and the signing account must be currently delegating.
Emits
Undelegated
.Weight:
O(R)
where R is the number of referendums the voter delegating to has voted on. Weight is charged as if maximum votes.
AccountId32
)#
unlock(target: interface:
api.tx.democracy.unlock
summary: Unlock tokens that have an expired lock.
The dispatch origin of this call must be Signed.
target
: The account to remove the lock on.Weight:
O(R)
with R number of vote of target.
H256
)#
vetoExternal(proposal_hash: interface:
api.tx.democracy.vetoExternal
summary: Veto and blacklist the external proposal hash.
The dispatch origin of this call must be
VetoOrigin
.proposal_hash
: The preimage hash of the proposal to veto and blacklist.Emits
Vetoed
.Weight:
O(V + log(V))
where V is number ofexisting vetoers
Compact<u32>
, vote: PalletDemocracyVoteAccountVote
)#
vote(ref_index: interface:
api.tx.democracy.vote
summary: Vote in a referendum. If
vote.is_aye()
, the vote is to enact the proposal; otherwise it is a vote to keep the status quo.The dispatch origin of this call must be Signed.
ref_index
: The index of the referendum to vote for.vote
: The vote configuration.Weight:
O(R)
where R is the number of referendums the voter has voted on.
#
electionProviderMultiPhaseVec<(AccountId32,SpNposElectionsSupport)>
)#
setEmergencyElectionResult(supports: interface:
api.tx.electionProviderMultiPhase.setEmergencyElectionResult
summary: Set a solution in the queue, to be handed out to the client of this pallet in the next call to
ElectionProvider::elect
.This can only be set by
T::ForceOrigin
, and only when the phase isEmergency
.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).
Option<[u128;3]>
)#
setMinimumUntrustedScore(maybe_next_score: interface:
api.tx.electionProviderMultiPhase.setMinimumUntrustedScore
summary: Set a new value for
MinimumUntrustedScore
.Dispatch origin must be aligned with
T::ForceOrigin
.This check can be turned off by setting the value to
None
.
PalletElectionProviderMultiPhaseRawSolution
, num_signed_submissions: u32
)#
submit(raw_solution: interface:
api.tx.electionProviderMultiPhase.submit
summary: 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.
PalletElectionProviderMultiPhaseRawSolution
, witness: PalletElectionProviderMultiPhaseSolutionOrSnapshotSize
)#
submitUnsigned(raw_solution: interface:
api.tx.electionProviderMultiPhase.submitUnsigned
summary: Submit a solution for the unsigned phase.
The dispatch origin fo this call must be none.
This submission is checked on the fly. Moreover, this unsigned solution is only validated when submitted to the pool from the local node. Effectively, this means that only active validators can submit this transaction when authoring a block (similar to an inherent).
To prevent any incorrect solution (and thus wasted time/weight), this transaction will panic if the solution submitted by the validator is invalid in any way, effectively putting their authoring reward at risk.
No deposit or reward is associated with this submission.
#
electionsu32
, num_defunct: u32
)#
cleanDefunctVoters(num_voters: interface:
api.tx.elections.cleanDefunctVoters
summary: Clean all voters who are defunct (i.e. they do not serve any purpose at all). The deposit of the removed voters are returned.
This is an root function to be used only for cleaning the state.
The dispatch origin of this call must be root.
MultiAddress
, has_replacement: bool
)#
removeMember(who: interface:
api.tx.elections.removeMember
summary: Remove a particular member from the set. This is effective immediately and the bond of the outgoing member is slashed.
If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, a new phragmen election is started.
The dispatch origin of this call must be root.
Note that this does not affect the designated block number of the next election.
#
removeVoter()interface:
api.tx.elections.removeVoter
summary: Remove
origin
as a voter.This removes the lock and returns the deposit.
The dispatch origin of this call must be signed and be a voter.
PalletElectionsPhragmenRenouncing
)#
renounceCandidacy(renouncing: interface:
api.tx.elections.renounceCandidacy
summary: Renounce one's intention to be a candidate for the next election round. 3 potential outcomes exist:
origin
is a candidate and not elected in any set. In this case, the deposit is unreserved, returned and origin is removed as a candidate.origin
is a current runner-up. In this case, the deposit is unreserved, returned and origin is removed as a runner-up.origin
is a current member. In this case, the deposit is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar toremove_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.
Compact<u32>
)#
submitCandidacy(candidate_count: interface:
api.tx.elections.submitCandidacy
summary: Submit oneself for candidacy. A fixed amount of deposit is recorded.
All candidates are wiped at the end of the term. They either become a member/runner-up, or leave the system while their deposit is slashed.
The dispatch origin of this call must be signed.
#
WarningEven 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.
Vec<AccountId32>
, value: Compact<u128>
)#
vote(votes: interface:
api.tx.elections.vote
summary: Vote for a set of candidates for the upcoming round of election. This can be called to set the initial votes, or update already existing votes.
Upon initial voting,
value
units ofwho
'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 thanwho
's free balance, then the maximum of the two is used.The dispatch origin of this call must be signed.
#
WarningIt is the responsibility of the caller to NOT place all of their balance into the lock and keep some for further operations.
#
grandpau32
, best_finalized_block_number: u32
)#
noteStalled(delay: - interface:
api.tx.grandpa.noteStalled
- summary: Note that the current authority set of the GRANDPA finality gadget has stalled. This will trigger a forced authority set change at the beginning of the next session, to be enacted
delay
blocks after that. The delay should be high enough to safely assume that the block signalling the forced change will not be re-orged (e.g. 1000 blocks). The GRANDPA voters will start the new authority set using the given finalized block as base. Only callable by root.
SpFinalityGrandpaEquivocationProof
, key_owner_proof: SpSessionMembershipProof
)#
reportEquivocation(equivocation_proof: - interface:
api.tx.grandpa.reportEquivocation
- summary: Report voter equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.
SpFinalityGrandpaEquivocationProof
, key_owner_proof: SpSessionMembershipProof
)#
reportEquivocationUnsigned(equivocation_proof: interface:
api.tx.grandpa.reportEquivocationUnsigned
summary: Report voter equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.
This extrinsic must be called unsigned and it is expected that only block authors will call it (validated in
ValidateUnsigned
), as such if the block author is defined it will be defined as the equivocation reporter.
#
identityAccountId32
)#
addRegistrar(account: interface:
api.tx.identity.addRegistrar
summary: Add a registrar to the system.
The dispatch origin for this call must be
T::RegistrarOrigin
.account
: the account of the registrar.Emits
RegistrarAdded
if successful.
MultiAddress
, data: Data
)#
addSub(sub: interface:
api.tx.identity.addSub
summary: Add the given account to the sender's subs.
Payment: Balance reserved by a previous
set_subs
call for one sub will be repatriated to the sender.The dispatch origin for this call must be Signed and the sender must have a registered sub identity of
sub
.
u32
)#
cancelRequest(reg_index: interface:
api.tx.identity.cancelRequest
summary: Cancel a previous request.
Payment: A previously reserved deposit is returned on success.
The dispatch origin for this call must be Signed and the sender must have a registered identity.
reg_index
: The index of the registrar whose judgement is no longer requested.Emits
JudgementUnrequested
if successful.
#
clearIdentity()interface:
api.tx.identity.clearIdentity
summary: Clear an account's identity info and all sub-accounts and return all deposits.
Payment: All reserved balances on the account are returned.
The dispatch origin for this call must be Signed and the sender must have a registered identity.
Emits
IdentityCleared
if successful.
MultiAddress
)#
killIdentity(target: interface:
api.tx.identity.killIdentity
summary: Remove an account's identity and sub-account information and slash the deposits.
Payment: Reserved balances from
set_subs
andset_identity
are slashed and handled bySlash
. Verification request deposits are not returned; they should be cancelled manually usingcancel_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.
Compact<u32>
, target: MultiAddress
, judgement: PalletIdentityJudgement
)#
provideJudgement(reg_index: interface:
api.tx.identity.provideJudgement
summary: Provide a judgement for an account's identity.
The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is
reg_index
.reg_index
: the index of the registrar whose judgement is being made.target
: the account whose identity the judgement is upon. This must be an account with a registered identity.judgement
: the judgement of the registrar of indexreg_index
abouttarget
.Emits
JudgementGiven
if successful.
#
quitSub()interface:
api.tx.identity.quitSub
summary: Remove the sender as a sub-account.
Payment: Balance reserved by a previous
set_subs
call for one sub will be repatriated to the sender (not the original depositor).The dispatch origin for this call must be Signed and the sender must have a registered super-identity.
NOTE: This should not normally be used, but is provided in the case that the non- controller of an account is maliciously registered as a sub-account.
MultiAddress
)#
removeSub(sub: interface:
api.tx.identity.removeSub
summary: Remove the given account from the sender's subs.
Payment: Balance reserved by a previous
set_subs
call for one sub will be repatriated to the sender.The dispatch origin for this call must be Signed and the sender must have a registered sub identity of
sub
.
MultiAddress
, data: Data
)#
renameSub(sub: interface:
api.tx.identity.renameSub
summary: Alter the associated name of the given sub-account.
The dispatch origin for this call must be Signed and the sender must have a registered sub identity of
sub
.
Compact<u32>
, max_fee: Compact<u128>
)#
requestJudgement(reg_index: interface:
api.tx.identity.requestJudgement
summary: Request a judgement from a registrar.
Payment: At most
max_fee
will be reserved for payment to the registrar if judgement given.The dispatch origin for this call must be Signed and the sender must have a registered identity.
reg_index
: The index of the registrar whose judgement is requested.max_fee
: The maximum fee that may be paid. This should just be auto-populated as:nocompile Self::registrars().get(reg_index).unwrap().fee
Emits
JudgementRequested
if successful.
Compact<u32>
, new: AccountId32
)#
setAccountId(index: interface:
api.tx.identity.setAccountId
summary: Change the account associated with a registrar.
The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is
index
.index
: the index of the registrar whose fee is to be set.new
: the new account ID.
Compact<u32>
, fee: Compact<u128>
)#
setFee(index: interface:
api.tx.identity.setFee
summary: Set the fee required for a judgement to be requested from a registrar.
The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is
index
.index
: the index of the registrar whose fee is to be set.fee
: the new fee.
Compact<u32>
, fields: PalletIdentityBitFlags
)#
setFields(index: interface:
api.tx.identity.setFields
summary: Set the field information for a registrar.
The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is
index
.index
: the index of the registrar whose fee is to be set.fields
: the fields that the registrar concerns themselves with.
PalletIdentityIdentityInfo
)#
setIdentity(info: interface:
api.tx.identity.setIdentity
summary: Set an account's identity information and reserve the appropriate deposit.
If the account already has identity information, the deposit is taken as part payment for the new deposit.
The dispatch origin for this call must be Signed.
info
: The identity information.Emits
IdentitySet
if successful.
Vec<(AccountId32,Data)>
)#
setSubs(subs: interface:
api.tx.identity.setSubs
summary: Set the sub-accounts of the sender.
Payment: Any aggregate balance reserved by previous
set_subs
calls will be returned and an amountSubAccountDeposit
will be reserved for each item insubs
.The dispatch origin for this call must be Signed and the sender must have a registered identity.
subs
: The identity's (new) sub-accounts.
#
imOnlinePalletImOnlineHeartbeat
, signature: PalletImOnlineSr25519AppSr25519Signature
)#
heartbeat(heartbeat: - interface:
api.tx.imOnline.heartbeat
- summary:
#
multisigu16
, other_signatories: Vec<AccountId32>
, maybe_timepoint: Option<PalletMultisigTimepoint>
, call_hash: [u8;32]
, max_weight: u64
)#
approveAsMulti(threshold: interface:
api.tx.multisig.approveAsMulti
summary: Register approval for a dispatch to be made from a deterministic composite account if approved by a total of
threshold - 1
ofother_signatories
.Payment:
DepositBase
will be reserved if this is the first approval, plusthreshold
timesDepositFactor
. 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 beNone
. If it is not the first approval, then it must beSome
, 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.
u16
, other_signatories: Vec<AccountId32>
, maybe_timepoint: Option<PalletMultisigTimepoint>
, call: WrapperKeepOpaque<Call>
, store_call: bool
, max_weight: u64
)#
asMulti(threshold: interface:
api.tx.multisig.asMulti
summary: Register approval for a dispatch to be made from a deterministic composite account if approved by a total of
threshold - 1
ofother_signatories
.If there are enough, then dispatch the call.
Payment:
DepositBase
will be reserved if this is the first approval, plusthreshold
timesDepositFactor
. 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 beNone
. If it is not the first approval, then it must beSome
, 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 exactly1
. Otherwise on success, result isOk
and the result from the interior call, if it was executed, may be found in the depositedMultisigExecuted
event.
Vec<AccountId32>
, call: Call
)#
asMultiThreshold1(other_signatories: interface:
api.tx.multisig.asMultiThreshold1
summary: Immediately dispatch a multi-signature call using a single approval from the caller.
The dispatch origin for this call must be Signed.
other_signatories
: The accounts (other than the sender) who are part of the multi-signature, but do not participate in the approval process.call
: The call to be executed.Result is equivalent to the dispatched result.
u16
, other_signatories: Vec<AccountId32>
, timepoint: PalletMultisigTimepoint
, call_hash: [u8;32]
)#
cancelAsMulti(threshold: interface:
api.tx.multisig.cancelAsMulti
summary: Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously for this operation will be unreserved on success.
The dispatch origin for this call must be Signed.
threshold
: The total number of approvals for this dispatch before it is executed.other_signatories
: The accounts (other than the sender) who can approve this dispatch. May not be empty.timepoint
: The timepoint (block number and transaction index) of the first approval transaction for this dispatch.call_hash
: The hash of the call to be executed.
#
proxyAccountId32
, proxy_type: XxnetworkRuntimeProxyType
, delay: u32
)#
addProxy(delegate: interface:
api.tx.proxy.addProxy
summary: Register a proxy account for the sender that is able to make calls on its behalf.
The dispatch origin for this call must be Signed.
Parameters:
proxy
: The account that thecaller
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.
AccountId32
, call_hash: H256
)#
announce(real: interface:
api.tx.proxy.announce
summary: Publish the hash of a proxy-call that will be made in the future.
This must be called some number of blocks before the corresponding
proxy
is attempted if the delay associated with the proxy relationship is greater than zero.No more than
MaxPending
announcements may be made at any one time.This will take a deposit of
AnnouncementDepositFactor
as well asAnnouncementDepositBase
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 thereal
account.
XxnetworkRuntimeProxyType
, delay: u32
, index: u16
)#
anonymous(proxy_type: interface:
api.tx.proxy.anonymous
summary: Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and initialize it with a proxy of
proxy_type
fororigin
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 permissiveProxyType
possible to allow for maximum flexibility.index
: A disambiguation index, in case this is called multiple times in the same transaction (e.g. withutility::batch
). Unless you're usingbatch
you probably just want to use0
.delay
: The announcement period required of the initial proxy. Will generally be zero.Fails with
Duplicate
if this has already been called in this transaction, from the same sender, with the same parameters.Fails if there are insufficient funds to pay for deposit.
TODO: Might be over counting 1 read
AccountId32
, proxy_type: XxnetworkRuntimeProxyType
, index: u16
, height: Compact<u32>
, ext_index: Compact<u32>
)#
killAnonymous(spawner: interface:
api.tx.proxy.killAnonymous
summary: Removes a previously spawned anonymous proxy.
WARNING: All access to this account will be lost. Any funds held in it will be inaccessible.
Requires a
Signed
origin, and the sender account must have been created by a call toanonymous
with corresponding parameters.spawner
: The account that originally calledanonymous
to create this account.index
: The disambiguation index originally passed toanonymous
. Probably0
.proxy_type
: The proxy type originally passed toanonymous
.height
: The height of the chain when the call toanonymous
was processed.ext_index
: The extrinsic index in which the call toanonymous
was processed.Fails with
NoPermission
in case the caller is not a previously created anonymous account whoseanonymous
call has corresponding parameters.
AccountId32
, force_proxy_type: Option<XxnetworkRuntimeProxyType>
, call: Call
)#
proxy(real: interface:
api.tx.proxy.proxy
summary: Dispatch the given
call
from an account that the sender is authorised for throughadd_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 thereal
account.
AccountId32
, real: AccountId32
, force_proxy_type: Option<XxnetworkRuntimeProxyType>
, call: Call
)#
proxyAnnounced(delegate: interface:
api.tx.proxy.proxyAnnounced
summary: Dispatch the given
call
from an account that the sender is authorized for throughadd_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 thereal
account.
AccountId32
, call_hash: H256
)#
rejectAnnouncement(delegate: interface:
api.tx.proxy.rejectAnnouncement
summary: Remove the given announcement of a delegate.
May be called by a target (proxied) account to remove a call that one of their delegates (
delegate
) has announced they want to execute. The deposit is returned.The dispatch origin for this call must be Signed.
Parameters:
delegate
: The account that previously announced the call.call_hash
: The hash of the call to be made.
AccountId32
, call_hash: H256
)#
removeAnnouncement(real: interface:
api.tx.proxy.removeAnnouncement
summary: Remove a given announcement.
May be called by a proxy account to remove a call they previously announced and return the deposit.
The dispatch origin for this call must be Signed.
Parameters:
real
: The account that the proxy will make a call on behalf of.call_hash
: The hash of the call to be made by thereal
account.
#
removeProxies()interface:
api.tx.proxy.removeProxies
summary: Unregister all proxy accounts for the sender.
The dispatch origin for this call must be Signed.
WARNING: This may be called on accounts created by
anonymous
, however if done, then the unreserved fees will be inaccessible. All access to this account will be lost.
AccountId32
, proxy_type: XxnetworkRuntimeProxyType
, delay: u32
)#
removeProxy(delegate: interface:
api.tx.proxy.removeProxy
summary: Unregister a proxy account for the sender.
The dispatch origin for this call must be Signed.
Parameters:
proxy
: The account that thecaller
would like to remove as a proxy.proxy_type
: The permissions currently enabled for the removed proxy account.
#
recoveryAccountId32
, call: Call
)#
asRecovered(account: interface:
api.tx.recovery.asRecovered
summary: Send a call through a recovered account.
The dispatch origin for this call must be Signed and registered to be able to make calls on behalf of the recovered account.
Parameters:
account
: The recovered account you want to make a call on-behalf-of.call
: The call you want to make with the recovered account.
AccountId32
)#
cancelRecovered(account: interface:
api.tx.recovery.cancelRecovered
summary: Cancel the ability to use
as_recovered
foraccount
.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.
AccountId32
)#
claimRecovery(account: interface:
api.tx.recovery.claimRecovery
summary: Allow a successful rescuer to claim their recovered account.
The dispatch origin for this call must be Signed and must be a "rescuer" who has successfully completed the account recovery process: collected
threshold
or more vouches, waiteddelay_period
blocks since initiation.Parameters:
account
: The lost account that you want to claim has been successfully recovered by you.
AccountId32
)#
closeRecovery(rescuer: interface:
api.tx.recovery.closeRecovery
summary: As the controller of a recoverable account, close an active recovery process for your account.
Payment: By calling this function, the recoverable account will receive the recovery deposit
RecoveryDeposit
placed by the rescuer.The dispatch origin for this call must be Signed and must be a recoverable account with an active recovery process for it.
Parameters:
rescuer
: The account trying to rescue this recoverable account.
Vec<AccountId32>
, threshold: u16
, delay_period: u32
)#
createRecovery(friends: interface:
api.tx.recovery.createRecovery
summary: Create a recovery configuration for your account. This makes your account recoverable.
Payment:
ConfigDepositBase
+FriendDepositFactor
* #_of_friends balance will be reserved for storing the recovery configuration. This deposit is returned in full when the user callsremove_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.
AccountId32
)#
initiateRecovery(account: interface:
api.tx.recovery.initiateRecovery
summary: Initiate the process for recovering a recoverable account.
Payment:
RecoveryDeposit
balance will be reserved for initiating the recovery process. This deposit will always be repatriated to the account trying to be recovered. Seeclose_recovery
.The dispatch origin for this call must be Signed.
Parameters:
account
: The lost account that you want to recover. This account needs to be recoverable (i.e. have a recovery configuration).
#
removeRecovery()interface:
api.tx.recovery.removeRecovery
summary: Remove the recovery process for your account. Recovered accounts are still accessible.
NOTE: The user must make sure to call
close_recovery
on all active recovery attempts before calling this function else it will fail.Payment: By calling this function the recoverable account will unreserve their recovery configuration deposit. (
ConfigDepositBase
+FriendDepositFactor
* #_of_friends)The dispatch origin for this call must be Signed and must be a recoverable account (i.e. has a recovery configuration).
AccountId32
, rescuer: AccountId32
)#
setRecovered(lost: interface:
api.tx.recovery.setRecovered
summary: Allow ROOT to bypass the recovery process and set an a rescuer account for a lost account directly.
The dispatch origin for this call must be ROOT.
Parameters:
lost
: The "lost account" to be recovered.rescuer
: The "rescuer account" which can call as the lost account.
AccountId32
, rescuer: AccountId32
)#
vouchRecovery(lost: interface:
api.tx.recovery.vouchRecovery
summary: Allow a "friend" of a recoverable account to vouch for an active recovery process for that account.
The dispatch origin for this call must be Signed and must be a "friend" for the recoverable account.
Parameters:
lost
: The lost account that you want to recover.rescuer
: The account trying to rescue the lost account that you want to vouch for.The combination of these two parameters must point to an active recovery process.
#
scheduleru32
, index: u32
)#
cancel(when: - interface:
api.tx.scheduler.cancel
- summary: Cancel an anonymously scheduled task.
Bytes
)#
cancelNamed(id: - interface:
api.tx.scheduler.cancelNamed
- summary: Cancel a named scheduled task.
u32
, maybe_periodic: Option<(u32,u32)>
, priority: u8
, call: Call
)#
schedule(when: - interface:
api.tx.scheduler.schedule
- summary: Anonymously schedule a task.
u32
, maybe_periodic: Option<(u32,u32)>
, priority: u8
, call: Call
)#
scheduleAfter(after: - interface:
api.tx.scheduler.scheduleAfter
- summary: Anonymously schedule a task after a delay.
Bytes
, when: u32
, maybe_periodic: Option<(u32,u32)>
, priority: u8
, call: Call
)#
scheduleNamed(id: - interface:
api.tx.scheduler.scheduleNamed
- summary: Schedule a named task.
Bytes
, after: u32
, maybe_periodic: Option<(u32,u32)>
, priority: u8
, call: Call
)#
scheduleNamedAfter(id: - interface:
api.tx.scheduler.scheduleNamedAfter
- summary: Schedule a named task after a delay.
#
session#
purgeKeys()interface:
api.tx.session.purgeKeys
summary: Removes any session key(s) of the function caller.
This doesn't take effect until the next session.
The dispatch origin of this function must be Signed and the account must be either be convertible to a validator ID using the chain's typical addressing system (this usually means being a controller account) or directly convertible into a validator ID (which usually means being a stash account).
XxnetworkRuntimeSessionKeys
, proof: Bytes
)#
setKeys(keys: interface:
api.tx.session.setKeys
summary: Sets the session key(s) of the function caller to
keys
. Allows an account to set its session key prior to becoming a validator. This doesn't take effect until the next session.The dispatch origin of this function must be signed.
#
stakingMultiAddress
, value: Compact<u128>
, cmix_id: Option<H256>
)#
bond(controller: interface:
api.tx.staking.bond
summary: Take the origin account as a stash and lock up
value
of its balance.controller
will be the account that controls it.value
must be more than theminimum_balance
specified byT::Currency
.The dispatch origin for this call must be Signed by the stash account.
Emits
Bonded
.
Compact<u128>
)#
bondExtra(max_additional: interface:
api.tx.staking.bondExtra
summary: 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
orunbond
this function does not impose any limitation on the amount that can be added.Emits
Bonded
.
u32
, slash_indices: Vec<u32>
)#
cancelDeferredSlash(era: interface:
api.tx.staking.cancelDeferredSlash
summary: Cancel enactment of a deferred slash.
Can be called by the
T::SlashCancelOrigin
.Parameters: era and indices of the slashes for that era to kill.
#
chill()interface:
api.tx.staking.chill
summary: Declare no desire to either validate or nominate.
Effects will be felt at the beginning of the next era.
The dispatch origin for this call must be Signed by the controller, not the stash.
AccountId32
)#
chillOther(controller: interface:
api.tx.staking.chillOther
summary: 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
andMaxValidatorCount
must be set which is used to determine how close we are to the threshold.A
MinNominatorBond
andMinValidatorBond
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.
#
forceNewEra()interface:
api.tx.staking.forceNewEra
summary: Force there to be a new era at the end of the next session. After this, it will be reset to normal (non-forced) behaviour.
The dispatch origin must be Root.
#
WarningThe election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.
#
forceNewEraAlways()interface:
api.tx.staking.forceNewEraAlways
summary: Force there to be a new era at the end of sessions indefinitely.
The dispatch origin must be Root.
#
WarningThe election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.
#
forceNoEras()interface:
api.tx.staking.forceNoEras
summary: Force there to be no new eras indefinitely.
The dispatch origin must be Root.
#
WarningThe 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.
AccountId32
, num_slashing_spans: u32
)#
forceUnstake(stash: interface:
api.tx.staking.forceUnstake
summary: Force a current staker to become completely unstaked, immediately.
The dispatch origin must be Root.
Compact<u32>
)#
increaseValidatorCount(additional: interface:
api.tx.staking.increaseValidatorCount
summary: Increments the ideal number of validators.
The dispatch origin must be Root.
Vec<MultiAddress>
)#
kick(who: interface:
api.tx.staking.kick
summary: Remove the given nominations from the calling validator.
Effects will be felt at the beginning of the next era.
The dispatch origin for this call must be Signed by the controller, not the stash.
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.
Vec<MultiAddress>
)#
nominate(targets: interface:
api.tx.staking.nominate
summary: Declare the desire to nominate
targets
for the origin controller.Effects will be felt at the beginning of the next era.
The dispatch origin for this call must be Signed by the controller, not the stash.
AccountId32
, era: u32
)#
payoutStakers(validator_stash: interface:
api.tx.staking.payoutStakers
summary: Pay out all the stakers behind a single validator for a single era.
validator_stash
is the stash account of the validator. Their nominators, up toT::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.
AccountId32
, num_slashing_spans: u32
)#
reapStash(stash: interface:
api.tx.staking.reapStash
summary: Remove all data structure concerning a staker/stash once its balance is at the minimum. This is essentially equivalent to
withdraw_unbonded
except it can be called by anyone and the targetstash
must have no funds left beyond the ED.This can be called from any origin.
stash
: The stash account to reap. Its balance must be zero.
Compact<u128>
)#
rebond(value: interface:
api.tx.staking.rebond
summary: Rebond a portion of the stash scheduled to be unlocked.
The dispatch origin must be signed by the controller.
Percent
)#
scaleValidatorCount(factor: interface:
api.tx.staking.scaleValidatorCount
summary: Scale up the ideal number of validators by a factor.
The dispatch origin must be Root.
H256
)#
setCmixId(cmix_id: interface:
api.tx.staking.setCmixId
summary: Set the CMIX ID of a stash, if it doesn't have one already.
The dispatch origin for this call must be Signed by the stash, not the controller.
MultiAddress
)#
setController(controller: interface:
api.tx.staking.setController
summary: (Re-)set the controller of a stash.
Effects will be felt at the beginning of the next era.
The dispatch origin for this call must be Signed by the stash, not the controller.
Compact<u32>
, era_items_deleted: Compact<u32>
)#
setHistoryDepth(new_history_depth: interface:
api.tx.staking.setHistoryDepth
summary: Set
HistoryDepth
value. This function will delete any history information whenHistoryDepth
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 byRoot
to report an accurate number.Origin must be root.
Vec<AccountId32>
)#
setInvulnerables(invulnerables: interface:
api.tx.staking.setInvulnerables
summary: Set the validators who cannot be slashed (if any).
The dispatch origin must be Root.
u128
, min_validator_bond: u128
, max_nominator_count: Option<u32>
, max_validator_count: Option<u32>
, threshold: Option<Percent>
, min_commission: Perbill
)#
setStakingLimits(min_nominator_bond: interface:
api.tx.staking.setStakingLimits
summary: Update the various staking limits this pallet.
min_nominator_bond
: The minimum active bond needed to be a nominator.min_validator_bond
: The minimum active bond needed to be a validator.max_nominator_count
: The max number of users who can be a nominator at once. When set toNone
, no limit is enforced.max_validator_count
: The max number of users who can be a validator at once. When set toNone
, no limit is enforced.Origin must be AdminOrigin 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.
Compact<u32>
)#
setValidatorCount(new: interface:
api.tx.staking.setValidatorCount
summary: Sets the ideal number of validators.
The dispatch origin must be AdminOrigin.
AccountId32
)#
transferCmixId(dest: interface:
api.tx.staking.transferCmixId
summary: Transfer the CMIX ID of a stash to a destination account.
Function is only callable if the Election is NOT active.
The origin account must be a stash and cannot be validating. Furthermore, it cannot be an validator in the current era, neither elected for the next era. The destination account must be a stash, without a CMIX ID.
The dispatch origin for this call must be Signed by the stash, not the controller.
Compact<u128>
)#
unbond(value: interface:
api.tx.staking.unbond
summary: Schedule a portion of the stash to be unlocked ready for transfer out after the bond period ends. If this leaves an amount actively bonded less than T::Currency::minimum_balance(), then it is increased to the full amount.
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 callchill
first in order to free up their bonded funds.Emits
Unbonded
.See also [
Call::withdraw_unbonded
].
PalletStakingValidatorPrefs
)#
validate(prefs: interface:
api.tx.staking.validate
summary: Declare the desire to validate for the origin controller.
Effects will be felt at the beginning of the next era.
The dispatch origin for this call must be Signed by the controller, not the stash.
u32
)#
withdrawUnbonded(num_slashing_spans: interface:
api.tx.staking.withdrawUnbonded
summary: Remove any unlocked chunks from the
unlocking
queue from our management.This essentially frees up that balance to be used by the stash account to do whatever it wants.
The dispatch origin for this call must be Signed by the controller.
Emits
Withdrawn
.See also [
Call::unbond
].
#
swapAccountId32
)#
setFeeDestination(dest: - interface:
api.tx.swap.setFeeDestination
- summary: Set fee destination
Compact<u128>
)#
setSwapFee(fee: - interface:
api.tx.swap.setSwapFee
- summary: Set swap fee
AccountId32
, amount: u128
)#
transfer(to: - interface:
api.tx.swap.transfer
- summary: Executes a currency transfer from the bridge account
u128
, recipient: Bytes
, dest_id: u8
)#
transferNative(amount: - interface:
api.tx.swap.transferNative
- summary: Transfers an amount of the native token to some recipient on a (whitelisted) destination chain.
#
systemPerbill
)#
fillBlock(ratio: - interface:
api.tx.system.fillBlock
- summary: A dispatch that will fill the block weight up to the given ratio.
Bytes
, subkeys: u32
)#
killPrefix(prefix: interface:
api.tx.system.killPrefix
summary: Kill all storage items with a key that starts with the given prefix.
NOTE: We rely on the Root origin to provide us the number of subkeys under the prefix we are removing to accurately calculate the weight of this function.
Vec<Bytes>
)#
killStorage(keys: - interface:
api.tx.system.killStorage
- summary: Kill some items from storage.
Bytes
)#
remark(remark: - interface:
api.tx.system.remark
- summary: Make some on-chain remark.
Bytes
)#
remarkWithEvent(remark: - interface:
api.tx.system.remarkWithEvent
- summary: Make some on-chain remark and emit event.
Bytes
)#
setCode(code: - interface:
api.tx.system.setCode
- summary: Set the new runtime code.
Bytes
)#
setCodeWithoutChecks(code: - interface:
api.tx.system.setCodeWithoutChecks
- summary: Set the new runtime code without doing any checks of the given
code
.
u64
)#
setHeapPages(pages: - interface:
api.tx.system.setHeapPages
- summary: Set the number of pages in the WebAssembly environment's heap.
Vec<(Bytes,Bytes)>
)#
setStorage(items: - interface:
api.tx.system.setStorage
- summary: Set some items of storage.
#
technicalCommitteeH256
, index: Compact<u32>
, proposal_weight_bound: Compact<u64>
, length_bound: Compact<u32>
)#
close(proposal_hash: interface:
api.tx.technicalCommittee.close
summary: Close a vote that is either approved, disapproved or whose voting period has ended.
May be called by any signed account in order to finish voting and close the proposal.
If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.
If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.
If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.
proposal_weight_bound
: The maximum amount of weight consumed by executing the closed proposal. +length_bound
: The upper bound for the length of the proposal in storage. Checked viastorage::read
so it issize_of::<u32>() == 4
larger than the pure length.
H256
)#
disapproveProposal(proposal_hash: interface:
api.tx.technicalCommittee.disapproveProposal
summary: Disapprove a proposal, close, and remove it from the system, regardless of its current state.
Must be called by the Root origin.
Parameters:
proposal_hash
: The hash of the proposal that should be disapproved.
Call
, length_bound: Compact<u32>
)#
execute(proposal: interface:
api.tx.technicalCommittee.execute
summary: Dispatch a proposal from a member using the
Member
origin.Origin must be a member of the collective.
Compact<u32>
, proposal: Call
, length_bound: Compact<u32>
)#
propose(threshold: interface:
api.tx.technicalCommittee.propose
summary: Add a new proposal to either be voted on or executed directly.
Requires the sender to be member.
threshold
determines whetherproposal
is executed directly (threshold < 2
) or put up for voting.
Vec<AccountId32>
, prime: Option<AccountId32>
, old_count: u32
)#
setMembers(new_members: interface:
api.tx.technicalCommittee.setMembers
summary: Set the collective's membership.
new_members
: The new member list. Be nice to the chain and provide it sorted.prime
: The prime member whose vote sets the default.old_count
: The upper bound for the previous number of members in storage. Used for weight estimation.Requires root origin.
NOTE: Does not enforce the expected
MaxMembers
limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.#
WARNING:The
pallet-collective
can also be managed by logic outside of the pallet through the implementation of the trait [ChangeMembers
]. Any call toset_members
must be careful that the member set doesn't get out of sync with other logic managing the member set.
H256
, index: Compact<u32>
, approve: bool
)#
vote(proposal: interface:
api.tx.technicalCommittee.vote
summary: Add an aye or nay vote for the sender to the given proposal.
Requires the sender to be a member.
Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.
#
technicalMembershipAccountId32
)#
addMember(who: interface:
api.tx.technicalMembership.addMember
summary: Add a member
who
to the set.May only be called from
T::AddOrigin
.
AccountId32
)#
changeKey(new: interface:
api.tx.technicalMembership.changeKey
summary: Swap out the sending member for some other key
new
.May only be called from
Signed
origin of a current member.Prime membership is passed from the origin account to
new
, if extant.
#
clearPrime()interface:
api.tx.technicalMembership.clearPrime
summary: Remove the prime member if it exists.
May only be called from
T::PrimeOrigin
.
AccountId32
)#
removeMember(who: interface:
api.tx.technicalMembership.removeMember
summary: Remove a member
who
from the set.May only be called from
T::RemoveOrigin
.
Vec<AccountId32>
)#
resetMembers(members: interface:
api.tx.technicalMembership.resetMembers
summary: Change the membership to a new set, disregarding the existing membership. Be nice and pass
members
pre-sorted.May only be called from
T::ResetOrigin
.
AccountId32
)#
setPrime(who: interface:
api.tx.technicalMembership.setPrime
summary: Set the prime member. Must be a current member.
May only be called from
T::PrimeOrigin
.
AccountId32
, add: AccountId32
)#
swapMember(remove: interface:
api.tx.technicalMembership.swapMember
summary: Swap out one member
remove
for anotheradd
.May only be called from
T::SwapOrigin
.Prime membership is not passed from
remove
toadd
, if extant.
#
timestampCompact<u64>
)#
set(now: interface:
api.tx.timestamp.set
summary: Set the current time.
This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time.
The timestamp should be greater than the previous one by the amount specified by
MinimumPeriod
.The dispatch origin for this call must be
Inherent
.
#
tipsH256
)#
closeTip(hash: interface:
api.tx.tips.closeTip
summary: Close and payout a tip.
The dispatch origin for this call must be Signed.
The tip identified by
hash
must have finished its countdown period.hash
: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the original tipreason
and the beneficiary account ID.
Bytes
, who: AccountId32
)#
reportAwesome(reason: interface:
api.tx.tips.reportAwesome
summary: Report something
reason
that deserves a tip and claim any eventual the finder's fee.The dispatch origin for this call must be Signed.
Payment:
TipReportDepositBase
will be reserved from the origin account, as well asDataDepositPerByte
for each byte inreason
.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.
H256
)#
retractTip(hash: interface:
api.tx.tips.retractTip
summary: Retract a prior tip-report from
report_awesome
, and cancel the process of tipping.If successful, the original deposit will be unreserved.
The dispatch origin for this call must be Signed and the tip identified by
hash
must have been reported by the signing account throughreport_awesome
(and not throughtip_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 tipreason
and the beneficiary account ID.Emits
TipRetracted
if successful.
H256
)#
slashTip(hash: interface:
api.tx.tips.slashTip
summary: Remove and slash an already-open tip.
May only be called from
T::RejectOrigin
.As a result, the finder is slashed and the deposits are lost.
Emits
TipSlashed
if successful.
H256
, tip_value: Compact<u128>
)#
tip(hash: interface:
api.tx.tips.tip
summary: Declare a tip value for an already-open tip.
The dispatch origin for this call must be Signed and the signing account must be a member of the
Tippers
set.hash
: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the hash of the original tipreason
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 thewho
.Emits
TipClosing
if the threshold of tippers has been reached and the countdown period has started.
Bytes
, who: AccountId32
, tip_value: Compact<u128>
)#
tipNew(reason: interface:
api.tx.tips.tipNew
summary: Give a tip for something new; no finder's fee will be taken.
The dispatch origin for this call must be Signed and the signing account must be a member of the
Tippers
set.reason
: The reason for, or the thing that deserves, the tip; generally this will be a UTF-8-encoded URL.who
: The account which should be credited for the tip.tip_value
: The amount of tip that the sender would like to give. The median tip value of active tippers will be given to thewho
.Emits
NewTip
if successful.
#
treasuryCompact<u32>
)#
approveProposal(proposal_id: interface:
api.tx.treasury.approveProposal
summary: Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.
May only be called from
T::ApproveOrigin
.
Compact<u128>
, beneficiary: MultiAddress
)#
proposeSpend(value: - interface:
api.tx.treasury.proposeSpend
- summary: Put forward a suggestion for spending. A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.
Compact<u32>
)#
rejectProposal(proposal_id: interface:
api.tx.treasury.rejectProposal
summary: Reject a proposed spend. The original deposit will be slashed.
May only be called from
T::RejectOrigin
.
#
uniquesCompact<u32>
, instance: Compact<u32>
, delegate: MultiAddress
)#
approveTransfer(class: interface:
api.tx.uniques.approveTransfer
summary: Approve an instance to be transferred by a delegated third-party account.
Origin must be Signed and must be the owner of the asset
instance
.class
: The class of the asset to be approved for delegated transfer.instance
: The instance of the asset to be approved for delegated transfer.delegate
: The account to delegate permission to transfer the asset.Emits
ApprovedTransfer
on success.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
, check_owner: Option<MultiAddress>
)#
burn(class: interface:
api.tx.uniques.burn
summary: Destroy a single asset instance.
Origin must be Signed and the sender should be the Admin of the asset
class
.class
: The class of the asset to be burned.instance
: The instance of the asset to be burned.check_owner
: IfSome
then the operation will fail withWrongOwner
unless the asset is owned by this value.Emits
Burned
with the actual amount burned.Weight:
O(1)
Modes:check_owner.is_some()
.
Compact<u32>
, instance: Compact<u32>
, maybe_check_delegate: Option<MultiAddress>
)#
cancelApproval(class: interface:
api.tx.uniques.cancelApproval
summary: Cancel the prior approval for the transfer of an asset by a delegate.
Origin must be either:
the
Force
origin;Signed
with the signer being the Admin of the assetclass
;Signed
with the signer being the Owner of the assetinstance
;Arguments:
class
: The class of the asset of whose approval will be cancelled.instance
: The instance of the asset of whose approval will be cancelled.maybe_check_delegate
: IfSome
will ensure that the given account is the one to which permission of transfer is delegated.Emits
ApprovalCancelled
on success.Weight:
O(1)
Compact<u32>
, maybe_instance: Option<u32>
, key: Bytes
)#
clearAttribute(class: interface:
api.tx.uniques.clearAttribute
summary: Set an attribute for an asset class or instance.
Origin must be either
ForceOrigin
or Signed and the sender should be the Owner of the assetclass
.If the origin is Signed, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * (key.len + value.len)
taking into account any already reserved funds.class
: The identifier of the asset class whose instance's metadata to set.instance
: The identifier of the asset instance whose metadata to set.key
: The key of the attribute.value
: The value to which to set the attribute.Emits
AttributeSet
.Weight:
O(1)
Compact<u32>
)#
clearClassMetadata(class: interface:
api.tx.uniques.clearClassMetadata
summary: Clear the metadata for an asset class.
Origin must be either
ForceOrigin
orSigned
and the sender should be the Owner of the assetclass
.Any deposit is freed for the asset class owner.
class
: The identifier of the asset class whose metadata to clear.Emits
ClassMetadataCleared
.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
)#
clearMetadata(class: interface:
api.tx.uniques.clearMetadata
summary: Clear the metadata for an asset instance.
Origin must be either
ForceOrigin
or Signed and the sender should be the Owner of the assetinstance
.Any deposit is freed for the asset class owner.
class
: The identifier of the asset class whose instance's metadata to clear.instance
: The identifier of the asset instance whose metadata to clear.Emits
MetadataCleared
.Weight:
O(1)
Compact<u32>
, admin: MultiAddress
)#
create(class: interface:
api.tx.uniques.create
summary: Issue a new class of non-fungible assets from a public origin.
This new asset class has no assets initially and its owner is the origin.
The origin must be Signed and the sender must have sufficient funds free.
AssetDeposit
funds of sender are reserved.Parameters:
class
: The identifier of the new asset class. This must not be currently in use.admin
: The admin of this class of assets. The admin is the initial address of each member of the asset class's admin team.Emits
Created
event when successful.Weight:
O(1)
Compact<u32>
, witness: PalletUniquesDestroyWitness
)#
destroy(class: interface:
api.tx.uniques.destroy
summary: Destroy a class of fungible assets.
The origin must conform to
ForceOrigin
or must beSigned
and the sender must be the owner of the assetclass
.class
: The identifier of the asset class to be destroyed.witness
: Information on the instances minted in the asset class. This must be correct.Emits
Destroyed
event when successful.Weight:
O(n + m)
where:n = witness.instances
m = witness.instance_metadatas
a = witness.attributes
Compact<u32>
, owner: MultiAddress
, issuer: MultiAddress
, admin: MultiAddress
, freezer: MultiAddress
, free_holding: bool
, is_frozen: bool
)#
forceAssetStatus(class: interface:
api.tx.uniques.forceAssetStatus
summary: Alter the attributes of a given asset.
Origin must be
ForceOrigin
.class
: The identifier of the asset.owner
: The new Owner of this asset.issuer
: The new Issuer of this asset.admin
: The new Admin of this asset.freezer
: The new Freezer of this asset.free_holding
: Whether a deposit is taken for holding an instance of this asset class.is_frozen
: Whether this asset class is frozen except for permissioned/admin instructions.Emits
AssetStatusChanged
with the identity of the asset.Weight:
O(1)
Compact<u32>
, owner: MultiAddress
, free_holding: bool
)#
forceCreate(class: interface:
api.tx.uniques.forceCreate
summary: Issue a new class of non-fungible assets from a privileged origin.
This new asset class has no assets initially.
The origin must conform to
ForceOrigin
.Unlike
create
, no funds are reserved.class
: The identifier of the new asset. This must not be currently in use.owner
: The owner of this class of assets. The owner has full superuser permissions over this asset, but may later change and configure the permissions usingtransfer_ownership
andset_team
.Emits
ForceCreated
event when successful.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
)#
freeze(class: interface:
api.tx.uniques.freeze
summary: Disallow further unprivileged transfer of an asset instance.
Origin must be Signed and the sender should be the Freezer of the asset
class
.class
: The class of the asset to be frozen.instance
: The instance of the asset to be frozen.Emits
Frozen
.Weight:
O(1)
Compact<u32>
)#
freezeClass(class: interface:
api.tx.uniques.freezeClass
summary: Disallow further unprivileged transfers for a whole asset class.
Origin must be Signed and the sender should be the Freezer of the asset
class
.class
: The asset class to be frozen.Emits
ClassFrozen
.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
, owner: MultiAddress
)#
mint(class: interface:
api.tx.uniques.mint
summary: Mint an asset instance of a particular class.
The origin must be Signed and the sender must be the Issuer of the asset
class
.class
: The class of the asset to be minted.instance
: The instance value of the asset to be minted.beneficiary
: The initial owner of the minted asset.Emits
Issued
event when successful.Weight:
O(1)
Compact<u32>
, instances: Vec<u32>
)#
redeposit(class: interface:
api.tx.uniques.redeposit
summary: Reevaluate the deposits on some assets.
Origin must be Signed and the sender should be the Owner of the asset
class
.class
: The class of the asset to be frozen.instances
: The instances of the asset class whose deposits will be reevaluated.NOTE: This exists as a best-effort function. Any asset instances which are unknown or in the case that the owner account does not have reservable funds to pay for a deposit increase are ignored. Generally the owner isn't going to call this on instances whose existing deposit is less than the refreshed deposit as it would only cost them, so it's of little consequence.
It will still return an error in the case that the class is unknown of the signer is not permitted to call it.
Weight:
O(instances.len())
Compact<u32>
, maybe_instance: Option<u32>
, key: Bytes
, value: Bytes
)#
setAttribute(class: interface:
api.tx.uniques.setAttribute
summary: Set an attribute for an asset class or instance.
Origin must be either
ForceOrigin
or Signed and the sender should be the Owner of the assetclass
.If the origin is Signed, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * (key.len + value.len)
taking into account any already reserved funds.class
: The identifier of the asset class whose instance's metadata to set.maybe_instance
: The identifier of the asset instance whose metadata to set.key
: The key of the attribute.value
: The value to which to set the attribute.Emits
AttributeSet
.Weight:
O(1)
Compact<u32>
, data: Bytes
, is_frozen: bool
)#
setClassMetadata(class: interface:
api.tx.uniques.setClassMetadata
summary: Set the metadata for an asset class.
Origin must be either
ForceOrigin
orSigned
and the sender should be the Owner of the assetclass
.If the origin is
Signed
, then funds of signer are reserved according to the formula:MetadataDepositBase + DepositPerByte * data.len
taking into account any already reserved funds.class
: The identifier of the asset whose metadata to update.data
: The general information of this asset. Limited in length byStringLimit
.is_frozen
: Whether the metadata should be frozen against further changes.Emits
ClassMetadataSet
.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
, data: Bytes
, is_frozen: bool
)#
setMetadata(class: interface:
api.tx.uniques.setMetadata
summary: Set the metadata for an asset instance.
Origin must be either
ForceOrigin
or Signed and the sender should be the Owner of the assetclass
.If the origin is Signed, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * data.len
taking into account any already reserved funds.class
: The identifier of the asset class whose instance's metadata to set.instance
: The identifier of the asset instance whose metadata to set.data
: The general information of this asset. Limited in length byStringLimit
.is_frozen
: Whether the metadata should be frozen against further changes.Emits
MetadataSet
.Weight:
O(1)
Compact<u32>
, issuer: MultiAddress
, admin: MultiAddress
, freezer: MultiAddress
)#
setTeam(class: interface:
api.tx.uniques.setTeam
summary: Change the Issuer, Admin and Freezer of an asset class.
Origin must be Signed and the sender should be the Owner of the asset
class
.class
: The asset class whose team should be changed.issuer
: The new Issuer of this asset class.admin
: The new Admin of this asset class.freezer
: The new Freezer of this asset class.Emits
TeamChanged
.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
)#
thaw(class: interface:
api.tx.uniques.thaw
summary: Re-allow unprivileged transfer of an asset instance.
Origin must be Signed and the sender should be the Freezer of the asset
class
.class
: The class of the asset to be thawed.instance
: The instance of the asset to be thawed.Emits
Thawed
.Weight:
O(1)
Compact<u32>
)#
thawClass(class: interface:
api.tx.uniques.thawClass
summary: Re-allow unprivileged transfers for a whole asset class.
Origin must be Signed and the sender should be the Admin of the asset
class
.class
: The class to be thawed.Emits
ClassThawed
.Weight:
O(1)
Compact<u32>
, instance: Compact<u32>
, dest: MultiAddress
)#
transfer(class: interface:
api.tx.uniques.transfer
summary: Move an asset from the sender account to another.
Origin must be Signed and the signing account must be either:
the Admin of the asset
class
;the Owner of the asset
instance
;the approved delegate for the asset
instance
(in this case, the approval is reset).Arguments:
class
: The class of the asset to be transferred.instance
: The instance of the asset to be transferred.dest
: The account to receive ownership of the asset.Emits
Transferred
.Weight:
O(1)
Compact<u32>
, owner: MultiAddress
)#
transferOwnership(class: interface:
api.tx.uniques.transferOwnership
summary: Change the Owner of an asset class.
Origin must be Signed and the sender should be the Owner of the asset
class
.class
: The asset class whose owner should be changed.owner
: The new Owner of this asset class.Emits
OwnerChanged
.Weight:
O(1)
#
utilityu16
, call: Call
)#
asDerivative(index: interface:
api.tx.utility.asDerivative
summary: Send a call through an indexed pseudonym of the sender.
Filter from origin are passed along. The call will be dispatched with an origin which use the same filter as the origin of this call.
NOTE: If you need to ensure that any account-based filtering is not honored (i.e. because you expect
proxy
to have been used prior in the call stack and you do not want the call restrictions to apply to any sub-accounts), then useas_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.
Vec<Call>
)#
batch(calls: interface:
api.tx.utility.batch
summary: Send a batch of dispatch calls.
May be called from any origin.
calls
: The calls to be dispatched from the same origin. The number of call must not exceed the constant:batched_calls_limit
(available in constant metadata).If origin is root then call are dispatch without checking origin filter. (This includes bypassing
frame_system::Config::BaseCallFilter
).
This will return Ok
in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterrupted
event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompleted
event is deposited.
Vec<Call>
)#
batchAll(calls: interface:
api.tx.utility.batchAll
summary: Send a batch of dispatch calls and atomically execute them. The whole transaction will rollback and fail if any of the calls failed.
May be called from any origin.
calls
: The calls to be dispatched from the same origin. The number of call must not exceed the constant:batched_calls_limit
(available in constant metadata).If origin is root then call are dispatch without checking origin filter. (This includes bypassing
frame_system::Config::BaseCallFilter
).
XxnetworkRuntimeOriginCaller
, call: Call
)#
dispatchAs(as_origin: interface:
api.tx.utility.dispatchAs
summary: Dispatches a function call with a provided origin.
The dispatch origin for this call must be Root.
#
vestingMultiAddress
, target: MultiAddress
, schedule: PalletVestingVestingInfo
)#
forceVestedTransfer(source: interface:
api.tx.vesting.forceVestedTransfer
summary: Force a vested transfer.
The dispatch origin for this call must be Root.
source
: The account whose funds should be transferred.target
: The account that should be transferred the vested funds.schedule
: The vesting schedule attached to the transfer.Emits
VestingCreated
.NOTE: This will unlock all schedules through the current block.
u32
, schedule2_index: u32
)#
mergeSchedules(schedule1_index: interface:
api.tx.vesting.mergeSchedules
summary: Merge two vesting schedules together, creating a new vesting schedule that unlocks over the highest possible start and end blocks. If both schedules have already started the current block will be used as the schedule start; with the caveat that if one schedule is finished by the current block, the other will be treated as the new merged schedule, unmodified.
NOTE: If
schedule1_index == schedule2_index
this is a no-op. NOTE: This will unlock all schedules through the current block prior to merging. NOTE: If both schedules have ended by the current block, no new schedule will be created and both will be removed.Merged schedule attributes:
starting_block
:MAX(schedule1.starting_block, scheduled2.starting_block, current_block)
.ending_block
:MAX(schedule1.ending_block, schedule2.ending_block)
.locked
:schedule1.locked_at(current_block) + schedule2.locked_at(current_block)
.The dispatch origin for this call must be Signed.
schedule1_index
: index of the first schedule to merge.schedule2_index
: index of the second schedule to merge.
#
vest()interface:
api.tx.vesting.vest
summary: Unlock any vested funds of the sender account.
The dispatch origin for this call must be Signed and the sender must have funds still locked under this pallet.
Emits either
VestingCompleted
orVestingUpdated
.
MultiAddress
)#
vestOther(target: interface:
api.tx.vesting.vestOther
summary: Unlock any vested funds of a
target
account.The dispatch origin for this call must be Signed.
target
: The account whose vested funds should be unlocked. Must have funds still locked under this pallet.Emits either
VestingCompleted
orVestingUpdated
.
MultiAddress
, schedule: PalletVestingVestingInfo
)#
vestedTransfer(target: interface:
api.tx.vesting.vestedTransfer
summary: Create a vested transfer.
The dispatch origin for this call must be Signed.
target
: The account receiving the vested funds.schedule
: The vesting schedule attached to the transfer.Emits
VestingCreated
.NOTE: This will unlock all schedules through the current block.
#
xxBetanetRewards#
approve()interface:
api.tx.xxBetanetRewards.approve
summary: Approve the BetaNet Staking Rewards program
The dispatch origin must be Root.
XxBetanetRewardsRewardOption
)#
selectOption(option: interface:
api.tx.xxBetanetRewards.selectOption
summary: Select desired option for BetaNet Staking Rewards
Only callable by accounts that have rewards and no vesting period
#
xxCmixu32
)#
setAdminPermission(permission: interface:
api.tx.xxCmix.setAdminPermission
summary: Set admin permission
permission
is the block number up to which the AdminOrigin will be allowed to call theset_cmix_hashes
function. It is expected thatpermission
will be modified by Democracy in 6-month periods.
u8
)#
setCmixAddressSpace(size: interface:
api.tx.xxCmix.setCmixAddressSpace
summary: Set cmix address space size
The dispatch origin must be
SchedulingAccount
XxCmixCmixSoftwareHashes
)#
setCmixHashes(hashes: interface:
api.tx.xxCmix.setCmixHashes
summary: Set cmix software hashes
The dispatch origin must be AdminOrigin. Furthermore, this call is only allowed if current block is lower than
AdminPermission
.
XxCmixCmixVariables
)#
setNextCmixVariables(variables: interface:
api.tx.xxCmix.setNextCmixVariables
summary: Set next cmix variables
The dispatch origin must be
CmixVariablesOrigin
. The new variables will be stored inNextCmixVariables
. Then, at the beginning of the next era,NextCmixVariables
is emptied and the value is written toCmixVariables
.
AccountId32
)#
setSchedulingAccount(who: interface:
api.tx.xxCmix.setSchedulingAccount
summary: Set scheduling server account
The dispatch origin must be AdminOrigin.
Vec<(AccountId32,u32)>
)#
submitCmixDeductions(data: interface:
api.tx.xxCmix.submitCmixDeductions
summary: Submit cmix performance points deductions
data
is a vector of tuples of (account, points) The dispatch origin must beSchedulingAccount
Vec<(AccountId32,u32)>
)#
submitCmixPoints(data: interface:
api.tx.xxCmix.submitCmixPoints
summary: Submit cmix performance points
data
is a vector of tuples of (account, points) The dispatch origin must beSchedulingAccount
#
xxCustodyAccountId32
)#
addCustodian(custodian: interface:
api.tx.xxCustody.addCustodian
summary: Add a custodian account
The dispatch origin must be AdminOrigin.
AccountId32
, controller: AccountId32
, value: Compact<u128>
)#
custodyBond(custody: interface:
api.tx.xxCustody.custodyBond
summary: Bond the given amount from the given custody account, with the specified controller
During the Custody period, the function is callable by Custodians only. After the Custody ends, the function is not callable anymore.
AccountId32
, value: Compact<u128>
)#
custodyBondExtra(custody: interface:
api.tx.xxCustody.custodyBondExtra
summary: Bond extra amount from the given custody account
During the Custody period, the function is callable by Custodians only. After the Custody ends, the function is not callable anymore.
AccountId32
, controller: AccountId32
)#
custodySetController(custody: interface:
api.tx.xxCustody.custodySetController
summary: Set the controller of a given custody account
During the Custody period, the function is callable by Custodians only. After the Custody ends, the function is not callable anymore.
AccountId32
, proxy: AccountId32
)#
custodySetProxy(custody: interface:
api.tx.xxCustody.custodySetProxy
summary: Set the governance proxy of a given custody account
Only one proxy account is allowed per custody account, so this function removes any proxies first, and then adds the new proxy
During the Governance Custody period, the function is callable by Custodians only. After the Governance Custody ends, the function is not callable anymore.
AccountId32
)#
payout(who: interface:
api.tx.xxCustody.payout
summary: Payout the amount already vested to the given team member account
Anyone can call this function since it is deterministic
AccountId32
)#
removeCustodian(custodian: interface:
api.tx.xxCustody.removeCustodian
summary: Remove a custodian account
The dispatch origin must be AdminOrigin.
AccountId32
, new: AccountId32
)#
replaceTeamMember(who: interface:
api.tx.xxCustody.replaceTeamMember
summary: Replace an existing team member account with a new account
The dispatch origin must be AdminOrigin.
AccountId32
)#
teamCustodySetProxy(proxy: interface:
api.tx.xxCustody.teamCustodySetProxy
summary: Allow the team member to set a governance proxy of their own custody account
During the Governance Custody period, the function is not callable. After the Governance Custody ends, the function is callable by team members only.
#
xxEconomicsXxEconomicsInflationInflationFixedParams
)#
setInflationParams(params: interface:
api.tx.xxEconomics.setInflationParams
summary: Set inflation fixed parameters
The dispatch origin must be AdminOrigin.
Vec<XxEconomicsInflationIdealInterestPoint>
)#
setInterestPoints(points: interface:
api.tx.xxEconomics.setInterestPoints
summary: Set ideal interest points
Overwrites the full list of points. Doesn't check if points are ordered per block. It's up to the caller to ensure the ordering, otherwise leads to unexpected behavior.
The dispatch origin must be AdminOrigin.
Compact<u128>
)#
setLiquidityRewardsBalance(amount: interface:
api.tx.xxEconomics.setLiquidityRewardsBalance
summary: Set balance of liquidity rewards
The dispatch origin must be AdminOrigin. This should only be used to make corrections to liquidity rewards balance according to data from ETH chain
Compact<u128>
)#
setLiquidityRewardsStake(amount: interface:
api.tx.xxEconomics.setLiquidityRewardsStake
summary: Set ideal liquidity rewards stake amount
The dispatch origin must be AdminOrigin. This can be used to adjust the ideal liquidity reward stake
#
xxPublicVec<XxPublicTransferData>
)#
saleDistribute(data: interface:
api.tx.xxPublic.saleDistribute
summary: Do a sale distribution
data
is a vector of TransferData The dispatch origin must beSaleManager
AccountId32
)#
setSaleManagerAccount(who: interface:
api.tx.xxPublic.setSaleManagerAccount
summary: Set the Sale manager account
The dispatch origin must be AdminOrigin.
AccountId32
)#
setTestnetManagerAccount(who: interface:
api.tx.xxPublic.setTestnetManagerAccount
summary: Set the Testnet manager account
The dispatch origin must be AdminOrigin.
Vec<XxPublicTransferData>
)#
testnetDistribute(data: interface:
api.tx.xxPublic.testnetDistribute
summary: Do a tesnet distribution
data
is a vector of TransferData The dispatch origin must beTestnetManager