Types
The following definitions expand on parameters seen elsewhere within the SDK standard and are provided for clarity and completeness.
Account
Structure representing a user's Account, stored in global state.
Required Parameters:
AccountHash
The AccountHash is a 32-byte hash derived from a supported PublicKey. Its role is to standardize keys that can vary in length.
AccountIdentifier
Identifier of an account.
Contains one of:
ActionThresholds
Thresholds that have to be met when executing an action of a certain type.
Required Parameters:
deployment
upgrade_management
key_management
ActivationPoint
The first era to which the associated protocol version applies.
AddressableEntity
AddressableEntityHash
The hex-encoded address of the addressable entity.
Approval
A struct containing a signature and the public key of the signer.
Required Parameters:
Array_of_AssociatedKey
An array of AssociatedKeys.
Array_of_BlockProof
An array of BlockProofs
.
Array_of_EntityVersionAndHash
An array of EntityVersionAndHashes.
Array_of_EraReward
An array of EraRewards.
Array_of_MessageTopic
An array of MessageTopics.
Array_of_NamedEntryPoint
An array of named entry points.
Array_of_NamedKey
An array of NamedKeys.
Array_of_NamedUserGroup
An array of NamedUserGroups.
Array_of_PublicKeyAndBid
An array of bids associated with given public keys.
Array_of_PublicKeyAndDelegator
An array consisting of PublicKeyAndDelegators.
Array_of_ValidatorWeight
An array of ValidatorWeights
.
AssociatedKey
A key granted limited permissions to an Account, for purposes such as multisig.
Required Parameters:
AssociatedKeys
A collection of weighted public keys (represented as account hashes) associated with an account.
AuctionState
Data structure summarizing auction contract data.
Required Parameters:
bids
All bids contained within a vector.block_height
Block height.era_validators
Era validators.state_root_hash
Global state hash.
AvailableBlockRange
low
The inclusive lower bound of the range.high
The inclusive upper bound of the range.
Bid
An entry in the validator map.
Required Parameters:
bonding_purse
The purse that was used for bonding.delegation_rate
The delegation rate.delegators
The validator's delegators, indexed by their public keys.inactive
true
if validator has been "evicted".staked_amount
The amount of tokens staked by a validator (not including delegators).validator_public_key
Validator's public key.
Additional Parameters:
vesting_schedule
Vesting schedule for a genesis validator.None
if non-genesis validator.
BidKind
Auction bid variants.
One of:
Unified
A unified record indexed on validator data, with an embedded collection of all delegator bids assigned to that validator. The `Unified`` variant is for legacy retrograde support; new instances will not be created going forward.Validator
A bid record containing only validator data.Delegator
A bid record containing only delegator data.
Block
A block after execution.
One of:
BlockBodyV1
The body portion of a block prior to Casper 2.0.
Required Parameters:
BlockBodyV2
The body portion of a block.
Required Parameters:
auction
The hashes of the auction transactions within the block.install_upgrade
The hashes of the installer/upgrader transactions within the block.mint
The hashes of the mint transactions within the block.standard
The hashes of all other transactions within the block.
BlockHash
A cryptographic hash identifying a Block
.
BlockHeader
The versioned header portion of a block. It encapsulates different variants of the BlockHeader
struct.
One of:
BlockHeaderV1
The header portion of a block prior to Casper 2.0.
Required Parameters:
height
The height of this block.random_bit
A random bit needed for initializing a future era.
Additional Parameters:
BlockHeaderV2
The header portion of a block.
Required Parameters:
height
The height of this block.random_bit
A random bit needed for initializing a future era.
Additional Parameters:
BlockIdentifier
Identifier for possible ways to retrieve a Block.
Hash
Identify and retrieve the Block with its hash.Height
Identify and retrieve the Block with its height.
BlockProof
A validator's public key paired with a corresponding signature of a given block hash.
Required Parameters:
BlockSynchronizerStatus
The status of the block synchronizer.
Historical
The status of syncing a historical block, if any.Forward
The status of syncing a forward block, if any.
BlockSyncStatus
The status of syncing an individual block.
Required Parameters:
acquisition_state
The state of acquisition of the data associated with the block as a string.
Additional Parameters:
block_height
The height of the block, if known.
BlockTime
A newtype wrapping a u64
, which represents the block time.
BlockV1
A block after execution with the resulting global state root hash prior to Casper 2.0. This is the core component of the Casper linear blockchain.
Required Parameters:
BlockV2
A block after execution, with the resulting global state root hash. This is the core component of the Casper linear blockchain.
Required Parameters:
Bytes
Hex-encoded bytes.
ByteCode
A container for a contract's Wasm bytes.
Required Parameters:
ByteCodeHash
The hex-encoded address of a smart contract AddressableEntity
ByteCodeKind
The type of byte code.
One of:
Empty
Empty byte code.V1CasperWasm
Byte code to be executed with the version 1 Casper execution engine.
BytesreprError
Serialization and deserialization errors.
EarlyEndOfStream
Early end of stream while deserializing.Formatting
Formatting error while deserializing.LeftOverBytes
Not all input bytes were consumed.OutOfMemory
Out of memory error.NotRepresentable
No serialized representation is available for a value.ExceededRecursionDepth
Exceeded a recursion depth limit.
ChainspecRawBytes
The raw bytes of the chainspec.toml, genesis accounts.toml, and global_state.toml files.
chainspec_bytes
Hex-encoded raw bytes of the current chainspec.toml file.maybe_genesis_accounts_bytes
Hex-encoded raw bytes of the current genesis accounts.toml file.maybe_global_state_bytes
Hex-encoded raw bytes of the current global_state.toml file.
Contract
A contract struct that can be serialized as a JSON object.
Required Parameters:
protocol_version
ContractHash
The hash address of the contract.
ContractPackage
Contract definition, metadata and security container.
Required Parameters:
ContractPackageHash
The hash address of the contract package.
ContractPackageStatus
An enum to determine the lock status of the contract package.
One of:
Locked
The package is locked and cannot be versioned.Unlocked
The package is unlocked and can be versioned.
ContractVersion
The version of the contract.
Required Parameters:
contract_version
protocol_version_major
ContractVersionKey
Major element of ProtocolVersion
combined with ContractVersion
.
ContractWasm
A container for a contract's Wasm bytes.
Required Parameter:
ContractWasmHash
The hash address of the contract Wasm.
Delegator
Represents a party delegating their stake to a validator (or "delegatee").
Required Parameters:
Additional Parameters:
Deploy
A Deploy; an item containing a smart contract along with the requester's signature(s).
Required properties:
DeployApproval
A struct containing a signature of a deploy hash and the public key of the signer.
Required parameters:
DeployHash
Hex-encoded Deploy hash.
DeployHeader
The header portion of a Deploy.
Required Parameters:
chain_name
A user defined string.gas_price
Defined as an integer in UInt64 format.
DeployInfo
Information relating to the given Deploy.
Required Parameters:
deploy_hash
The relevant Deploy.from
Account identifier of the creator of the Deploy.gas
Gas cost of executing the Deploy.source
Source purse used for payment of the Deploy.transfers
Transfers performed by the Deploy.
DictionaryIdentifier
Options for dictionary item lookups.
AccountNamedKey
Lookup a dictionary item via an Account's named keys.Required Parameters:
key
The Account key as a formatted string whose named keys contain dictionary_name.dictionary_name
The named key under which the dictionary seed URef is stored.dictionary_item_key
The dictionary item key formatted as a string.ContractNamedKey
Lookup a dictionary item via a Contract's named keys.key
The contract key as a formatted string whose named keys contains dictionary_name.dictionary_name
The named key under which the dictionary seed URef is stored.dictionary_item_key
The dictionary item key formatted as a string.URef
Lookup a dictionary item via its seed URef.seed_uref
The dictionary's seed URef.dictionary_item_key
The dictionary item key formatted as a string.Dictionary
Lookup a dictionary item via its unique key.
Digest
Hex-encoded hash digest.
DisabledVersions
Required Parameters:
contract_version
protocol_version_major
Effects
A log of all transforms produced during execution.
EntityIdentifier
Identifier of an addressable entity.
EntityKind
The type of Package
.
One of:
EntityOrAccount
An addressable entity or a legacy account.
One of:
EntityVersionAndHash
An entity version associated with the given hash.
Required Parameters:
EntityVersionKey
Major element of ProtocolVersion
combined with EntityVersion
.
Required Parameters:
entity_version
protocol_version_major
EntryPoint
Metadata describing a callable entry point and its return value, if any. All required parameters should be declared, whereas all non-required parameters should not be declared. Non-required parameters should not be confused with optional parameters.
Required Parameters:
EntryPointAccess
Enum describing the possible access control options for a contract entry point.
Public
A public entry point is callable by any caller.Groups
Only callers from the authorized, listed groups may call this entry point. Note: If this list is empty then this entry point is not callable from outside the contract.
EntryPointType
Context of an entry point execution.
Session
Runs as session code in the context of the caller. Deprecated and retained to allow read back of legacy stored session.AddressableEntity
Runs within the called entity's context.Factory
This entry point is intended to extract a subset of bytecode. Runs within the called entity's context.
EraEndV1
Information related to the end of an era and validator weights for the following era prior to Casper 2.0.
Required Parameters:
EraEndV2
Information related to the end of an era and validator weights for the following era.
Required Parameters:
EraID
Era ID newtype.
EraIdentifier
Identifier for an era.
One of:
EraInfo
Auction metadata. Intended to be recorded at each era.
Required Parameters:
seigniorage_allocation
Information about a seigniorage allocation.
EraReport_for_PublicKey
Equivocation, reward and validator inactivity information.
Required Parameters:
EraReward
A validator's public key paired with a measure of the value of its contribution to consensus, as a fraction of the configured maximum block reward.
Required Parameters:
amount
EraSummary
The summary of an era.
Required Parameters:
block_hash
The Block hash.era_id
The era id.merkle_proof
The merkle proof.state_root_hash
Hex-encoded hash of the state root.stored_value
The StoredValue containing era information.
ExecutableDeployItem
Represents possible variants of an executable Deploy.
ModuleBytes
Executable specified as raw bytes that represent Wasm code and an instance of RuntimeArgs
.
Required Parameters:
module_bytes
Hex-encoded raw Wasm bytes. There are some special cases around passingmodule_bytes
for payment code.
Additional Parameters:
args
Runtime arguments.
StoredContractByHash
Stored contract referenced by its ContractHash
, entry point and an instance of RuntimeArgs
.
Required Parameters:
args
Runtime arguments.entry_point
The name of an entry point.hash
A hex-encoded hash.
StoredContractByName
Stored contract referenced by a named key existing in the signer's Account context, entry point and an instance of RuntimeArgs
.
Required Parameters:
args
Runtime arguments.entry_point
The name of an entry point.name
A named key.
StoredVersionContractByHash
Stored versioned contract referenced by its ContractPackageHash
, entry point and an instance of RuntimeArgs
.
Required Parameters:
args
Runtime arguments.entry_point
The name of an entry point.hash
A hex-encoded hash.
Additional Parameters:
version
An optional version of the contract to call. It will default to the highest enabled version if no value is specified.
StoredVersionContractByName
Stored versioned contract referenced by a named key existing in the signer's Account context, entry point and an instance of RuntimeArgs
.
Required Parameters:
args
Runtime arguments.entry_point
The name of an entry point.name
A named key.
Additional Parameters:
version
An optional version of the contract to call. It will default to the highest enabled version if no value is specified.
Transfer
A native transfer which does not contain or reference a Wasm code.
Required Parameters:
ExecutionEffect
The journal of execution transforms from a single Deploy.
Required Parameters:
ExecutionResult
The versioned result of executing a single Deploy.
One of:
ExecutionResultV1
The result of executing a single deploy prior to Casper 2.0.
One of:
Failure
The result of a failed executionRequired Parameters:
error_message
The error message associated with executing the Deploy.Success
The result of a successful execution.Required Parameters:
ExecutionResultV2
The result of executing a single deploy.
One of:
Failure
The result of a failed execution.Required Parameters:
error_message
The error message associated with executing the deploy.Success
The result of a successful execution.Required Parameters:
FinalizedApprovals
A boolean value that determines whether to return the deploy with the finalized approvals substituted. If false
or omitted, returns the deploy with the approvals that were originally received by the node.
GlobalStateIdentifier
Identifier for possible ways to query global state.
BlockHash
Query using a block hash.BlockHeight
Query using a block height.StateRootHash
Query using the state root hash.
Group
A (labelled) "user group". Each entry point of a versioned contract may be associated with one or more user groups which are allowed to call it.
Groups
Required Parameters:
group
InitiatorAddr
The address of the initiator of a TransactionV1.
Contains one of:
publickey
The public key of the initiator.accounthash
The account hash derived from the public key of the initiator.entityaddr
The hex-encoded entity address of the initiator.
JsonBid
An entry in a founding validator map representing a bid.
Required Parameters:
bonding_purse
The purse that was used for bonding.delegation_rate
The delegation rate.delegators
The delegators.inactive
Is this an inactive validator.staked_amount
The amount of tokens staked by a validator (not including delegators).
JsonBids
A Json representation of a single bid.
Required Parameters:
JsonBlock
A JSON-friendly representation of Block
.
Required Parameters:
body
JSON-friendly Block body.hash
BlockHash.header
JSON-friendly Block header.proofs
JSON-friendly list of proofs for this Block.
JsonBlockBody
A JSON-friendly representation of Body
.
Required Parameters:
JsonBlockHeader
JSON representation of a Block header.
accumulated_seed
Accumulated seed.body_hash
The body hash.era_id
The Block era id.height
The Block height.parent_hash
The parent hash.protocol_version
The protocol version.random_bit
Randomness bit.state_root_hash
The state root hash.timestamp
The Block timestamp.
Additional Parameters:
era_end
The era end.
JsonBlockWithSignatures
A JSON-friendly representation of a block and the signatures for that block.
Required Parameters:
JsonDelegator
A delegator associated with the given validator.
Required Parameters:
JsonEraEnd
Required Parameters:
JsonEraReport
Equivocation and reward information to be included in the terminal Block.
Required Parameters:
JsonEraValidators
The validators for the given era.
Required Parameters:
JsonExecutionResult
The execution result of a single Deploy.
JsonProof
A JSON-friendly representation of a proof, i.e. a Block's finality signature.
Required Parameters:
JsonValidatorChanges
The changes in a validator's status.
Required Parameters:
public_key
The public key of the validator.status_changes
The set of changes to the validator's status.
JsonValidatorStatusChange
A single change to a validator's status in the given era.
Required Parameters:
era_id
The era in which the change occurred.validator_change
The change in validator status.
JsonValidatorsWeights
A validator's weight.
Required Parameters:
Key
The key as a formatted string, under which data can be stored in global state.
Merkle_Proof
A Merkle proof is a construction created using a Merkle trie that allows verification of the associated hashes.
MessageChecksum
Message checksum as a formatted string.
MessageTopic
A topic for contract-level messages.
Required Parameters:
topic_name
A string used to identify the message topic.
MessageTopicSummary
Summary of a message topic that will be stored in global state.
Required Parameters:
message_count
The number of messages in this topic.
MinimalBlockInfo
Minimal info of a Block
.
Required Parameters:
NamedArg
Named arguments to a contract.
NamedEntryPoint
A named entry point.
Required Parameters:
name
A string identifying the entry point.
NamedKey
A named key.
Required Parameters:
key
The value of the entry: a casperKey
type.name
The name of the entry.
NamedKeys
NamedKeyValue
A NamedKey
value.
name
The name of theKey
encoded as aCLValue
.named_key
The actualKey
encoded as aCLValue
.
NamedUserGroup
A named group
.
Required Parameters:
NextUpgrade
Information about the next protocol upgrade.
Required Parameters:
protocol_version
NewValidator
The public key for the new validator in a redelegation using UnbondingPurse.
Operation
An operation performed while executing a Deploy.
Required Parameters:
key
The formatted string of theKey
.
OpKind
The type of operation performed while executing a Deploy.
One of:
Read
A read operation.Write
A write operation.Add
An addition.NoOp
An operation which has no effect.Prune
A prune operation.
Package
Entity definition, metadata and security container.
Required Parameters:
Parameter
Parameter to an entry point.
Required Parameters:
name
PackageHash
The hex-encoded address of a package associated with an AddressableEntity
.
PackageKind
The type of Package
.
One of:
System
Package associated with a native contract implementation.Account
Package associated with an Account hash.SmartContract
Packages associated with Wasm stored on chain.
PackageStatus
An enum to determine the lock status of the package.
One of:
Locked
The package is locked and cannot be versioned.Unlocked
The package is unlocked and can be versioned.
Peer
Map of peer IDs to network addresses.
PeerEntry
Required Parameters:
address
node_id
PricingMode
The pricing mode of a transaction.
One of:
Classic
The original payment model, where the creator of the transaction specifies how much they will pay, at what gas price.Fixed
The cost of the transaction is determined by the cost table, per the transaction kind.Reserved
The payment for this transaction was previously reserved (Not currently implemented).
ProtocolVersion
Casper Platform protocol version.
PublicKey
Hex-encoded cryptographic public key, including the algorithm tag prefix.
PublicKeyAndBid
A bid associated with the given public key.
Required Parameters:
PublicKeyAndDelegator
A delegator associated with the given validator.
Required Parameters:
PurseIdentifier
The identifier to obtain the purse corresponding to a balance query. Valid identifiers include:
main_purse_under_public_key
The main purse under a providedPublicKey
.main_purse_under_account_hash
The main purse under a providedAccountHash
.purse_uref
A specific purse identified by the associatedURef
.
ReactorState
The state of the reactor, which will return one of the following:
Initialize
Get all components and reactor state set up on start.CatchUp
Orient to the network and attempt to catch up to tip.Upgrading
Running commit upgrade and creating immediate switch block.KeepUp
Stay caught up with tip.Validate
Node is currently caught up and is an active validator.ShutdownForUpgrade
Node should be shut down for upgrade.
Reward
Required Parameters:
amount
RewardedSigantures
Describes finality signatures that will be rewarded in a block. Consists of a vector of SingleBlockRewardedSignatures
, each of which describes signatures for a single ancestor block. The first entry represents the signatures for the parent block, the second for the parent of the parent, and so on.
RuntimeArgs
Represents a collection of arguments passed to a smart contract.
SeigniorageAllocation
Information about a seigniorage allocation.
One of:
Validator
Info about a seigniorage allocation for a validator.Required Parameters:
amount
Allocated amount.validator_public_key
Validator's public key.Delegator
Info about a seigniorage allocation for a delegator.Require Parameters:
amount
Allocated amount.delegator_public_key
Delegator's public key.validator_public_key
Validator's public key.
Signature
Hex-encoded cryptographic signature, including the algorithm tag prefix.
SingleBlockRewardedSignatures
List of identifiers for finality signatures for a particular past block. That past block height is equal to current_height
minus signature_rewards_max_delay
, the latter being defined in the chainspec.
StoredValue
Representation of a value stored in global state.
CLValue
A Casper-specific value.Account
An Account.ContractWasm
A contract's Wasm.Contract
Entry points supported by a contract.ContractPackage
A contract definition, metadata, and security container.Transfer
A record of a transfer.DeployInfo
A record of a Deploy.EraInfo
Auction metadata.Bid
A bid.Withdraw
A withdraw.Unbonding
Unbonding information.AddressableEntity
An AddressableEntity.BidKind
A variant that storedBidKind
.[
Package
] APackage
.[
ByteCode
] A record of byte code.MessageTopic
A variant that stores a message topic.Message
A variant that stores a message digest.NamedKey
A NamedKey record.
SystemEntityType
System contract types.
Mint
HandlePayment
StandardPayment
Auction
TimeDiff
Human-readable duration.
Timestamp
Timestamp formatted as per RFC 3339.
TopicNameHash
The hash of the name of the message topic.
Transaction
A versioned wrapper for a transaction or deploy.
Contains one of:
or
TransactionEntryPoint
An entry point of a transaction.
One of:
Custom
A non-native, arbitrary entry point.Transfer
Thetransfer
native entry point, used to reference motes from a source purse to a target purse.AddBid
Theadd_bid
native entry point, used to create or top off a bid purse.WithdrawBid
Thewithdraw_bid
native entry point, used to decrease a validator's stake.Delegate
Thedelegate
native entry point, used to add a new delegator or increase an existing delegator's stake.Undelegate
Theundelegate
native entry point, used to reduce a delegator's stake or remove the delegator if the remaining stake is zero.Redelegate
theredelegate
native entry point, used to reduce a delegator's stake or remove the delegator if the remaining stake is zero. After the unbonding delay, it will automatically delegate to a new validator.
TransactionHash
A versioned wrapper for a transaction hash or deploy hash.
One of:
TransactionInvocationTarget
The identifier of a stored
transaction target.
One of:
InvocableEntity
The hex-encoded entity address identifying the invocable entity.InvocableEntityAlias
The alias identifying the invocable entity.Package
The address and optional version identifying the package.Required parameters for
package
addr
The hex-encoded address of the package.
Optional parameters:
version
The package version. IfNone
, the latest enabled version is implied.
PackageAlias
The alias and optional version identifying the package.Required parameters for
packagealias
alias
The package alias.
Optional parameters:
version
The package version. IfNone
, the latest enabled version is implied.
TransactionRuntime
Runtime used to execute a transaction.
Parameters:
VmCasperV1
The Casper Version 1 Virtual Machine.
TransactionScheduling
The scheduling mode of a transaction.
One of:
Standard
No special scheduling applied.FutureEra
Execution should be scheduled for the specific era.Required parameters for
FutureEra
:FutureTimestamp
Execution should be scheduled for the specific timestamp or later.Required parameters for
FutureTimestamp
:
TransactionSessionKind
Session kind of a transaction.
One of:
standard
A standard (non-special-case) session. This kind of session is not allowed to install or upgrade a stored contract, but can call stored contracts.installer
A session which installs a stored contract.upgrader
A session which upgrades a previously-installed stored contract.Upgrader
sessions must have thepackage_id: PackageIdentifier
runtime arg present.isolated
A session which doesn't call any stored contracts. This kind of session is not allowed to install or upgrade a stored contract.
TransactionTarget
The execution target of a Transaction.
One of:
native
The execution target is a native operation.stored
The execution target is a stored entity or package.Required parameters for a
stored
target:session
The execution target is the included module bytes.Required parameters for a
session
target:
TransactionV1
A unit of work sent by a client to the network, which when executed can cause global state to be altered.
Required Parameters:
TransactionV1Approval
A struct containing a signature of a transaction hash and the public key of the signer.
Required Parameters:
TransactionV1Body
The body of a TransactionV1.
Required Parameters:
TransactionV1Hash
A hex-encoded TransactionV1 hash.
TransactionV1Header
The header portion of a TransactionV1.
Required Parameters:
Transfer
Represents a transfer from one purse to another.
Required Parameters:
amount
Transfer amount.deploy_hash
Deploy that created the transfer.from
Account from which transfer was executed.source
Source purse.target
Target purse.
Additional Parameters:
id
User-defined ID.to
Account to which funds are transferred.
TransferAddr
Hex-encoded transfer address.
TransformError
Error type for applying and combining transforms. A TypeMismatch
occurs when a transform cannot be applied because the types are not compatible (e.g. trying to add a number to a string).
One of:
deprecated
Type no longer supported.
TransformV1
A transformation performed while executing a Deploy.
Required Parameters:
key
The formatted string of theKey
.transforms
The transformation.
Transformv2
A transformation performed while executing a Deploy.
Required Parameters:
key
The formatted string of theKey
.kind
The transformation.
TransformKindV1
The actual transformation performed while executing a Deploy in version 1.
One of:
Identity
A transform having no effect.WriteCLValue
Writes the given CLValue to global state.WriteAccount
Writes the given Account to global state.WriteContractWasm
Writes a smart contract as Wasm to global state.WriteContract
Writes a smart contract to global state.WriteContractPackage
Writes a smart contract package to global state.WriteDeployInfo
Writes the given DeployInfo to global state.WriteEraInfo
Writes the given EraInfo to global state.WriteTransfer
Writes the given Transfer to global state.WriteBid
Writes the given Bid to global state.WriteWithdraw
Writes the given Withdraw to global state.WriteUnbonding
Writes the given Unbonding to global state.WriteAddressableEntity
Writes the addressable entity to global state.WriteBidKind
Writes the given BidKind to global state.AddInt32
Adds the giveni32
.AddUInt64
Adds the givenu64
.AddUInt128
Adds the givenU128
.AddUInt256
Adds the givenU256
.AddUInt512
Adds the givenU512
.AddKeys
Adds the given collection of named keys.Prune
Removes the pathing to the global state entry of the specified key. The pruned element remains reachable from previously generated global state root hashes, but will not be included in the next generated global state root hash and subsequent states.Failure
A failed transformation, containing an error message.
TransformKindV1
The actual transformation performed while executing a Deploy in version 2.
One of:
Identity
A transform having no effect.Write
Writes the new value in global state.AddInt32
Adds the giveni32
.AddUInt64
Adds the givenu64
.AddUInt128
Adds the givenU128
.AddUInt256
Adds the givenU256
.AddUInt512
Adds the givenU512
.AddKeys
Adds the given collection of named keys.Prune
Removes the pathing to the global state entry of the specified key. The pruned element remains reachable from previously generated global state root hashes, but will not be included in the next generated global state root hash and subsequent states.Failure
A failed transformation, containing an error message.
TypeMismatch
An error struct representing a type mismatch in StoredValue
operations.
expected
The name of the expected type.found
The actual type found.
U128
Decimal representation of a 128-bit integer.
U256
Decimal representation of a 256-bit integer.
U512
Decimal representation of a 512-bit integer.
UnbondingPurse
Unbonding purse.
Required Parameters:
amount
Unbonding amount.bonding_purse
Bonding purse.era_of_creation
Era in which the unbonding request was created.unbonder_public_key
Unbonder's public key.validator_public_key
The original validator's public key.new_validator
The redelegated validator's public key.
URef
Hex-encoded, formatted URef.
ValidatorBid
An entry in the validator map.
bonding_purse
Bonding purse.delegation_rate
The delegation rate.inactive
true
if the validator has been "evicted".staked_amount
The amount of tokens staked by a validator.validator_public_key
The validator's public key.
ValidatorChange
A change to a validator's status between two eras.
Added
Removed
Banned
CannotPropose
SeenAsFaulty
ValidatorWeight
Required Parameters:
VestingSchedule
Vesting schedule for a genesis validator.
initial_release_timestamp_millies
Timestamp of the initial release.locked_amounts
The amount of locked motes.
Weight
The weight associated with public keys in an account's associated keys.
WithdrawPurse
Withdraw purse, previously known as unbonding purse prior to 1.5. Withdraw purses remain as historical data.
Required Parameters:
amount
Unbonding amount.bonding_purse
Bonding purse.era_of_creation
Era in which the unbonding request was created.unbonder_public_key
Unbonder's public key.validator_public_key
The original validator's public key.