Namespace Casper.Network.SDK.Types

Classes

Account

Structure representing a user's account, stored in global state.

AccountHashKey

Stores an account in the global state. Format: 32-byte length with prefix 'account-hash-'.

ActionThresholds

Thresholds that have to be met when executing an action of a certain type.

AddInt32TransformKind

A wrapping addition of an i32 to an existing numeric value (not necessarily an i32) in the global state.

AddKeysTransformKind

Adds new named keys to an existing entry in the global state.\n\nThis transform assumes that the existing stored value is either an Account or a Contract.

AddUInt128TransformKind

A wrapping addition of a U128 to an existing numeric value (not necessarily an U128) in the global state.

AddUInt256TransformKind

A wrapping addition of a U256 to an existing numeric value (not necessarily an U256) in the global state.

AddUInt512TransformKind

A wrapping addition of a U512 to an existing numeric value (not necessarily an U512) in the global state.

AddUInt64TransformKind

A wrapping addition of a u64 to an existing numeric value (not necessarily an u64) in the global state.

AssociatedKey

public key allowed to provide signatures on deploys for the account

AuctionState

Data structure summarizing auction contract data.

BalanceKey

Stores information related to the balance of a given purse. Format: 32-byte length with prefix 'balance-'.

BidKey

Stores information related to auction bids in the global state. Format: 32-byte length with prefix 'bid-'.

Address for singleton values associated to specific block. These are values which are calculated or set during the execution of a block such as the block timestamp, or the total count of messages emitted during the execution of the block, and so on.

BlockGlobalAddrTagExtensions

BlockHeader

A block header (alias for BlockHeaderV2)

BlockHeaderV1

A block header

BlockHeaderV2

BlockIdentifier

A block identified by its hash or its height.

BlockProof

A validator's public key paired with a corresponding signature of a given block hash.

BlockSyncStatus

The status of syncing an individual block.

BlockSynchronizerStatus

The status of the block synchronizer.

BlockTransaction

BlockV1

A block in the network

BlockV2

A block in the network

Bridge

A bridge record pointing to a new ValidatorBid after the public key was changed.

ByHashInvocationTarget

ByNameInvocationTarget

ByPackageHashInvocationTarget

ByPackageNameInvocationTarget

ByteCode

A container for contract's Wasm bytes.

ByteCodeKey

ByteCodeKindExtensions

CLByteArrayTypeInfo

A CLTypeInfo specific for byte arrays.

CLKeyTypeInfo

A CLTypeInfo specific for keys.

CLListTypeInfo

A CLTypeInfo specific for lists.

CLMapTypeInfo

A CLTypeInfo specific for maps.

CLOptionTypeInfo

A CLTypeInfo specific for the Option CLType.

CLResultTypeInfo

A CLTypeInfo specific for the Result CLType.

CLTuple1TypeInfo

A CLTypeInfo specific for the Tuple1 CLType.

CLTuple2TypeInfo

A CLTypeInfo specific for the Tuple2 CLType.

CLTuple3TypeInfo

A CLTypeInfo specific for the Tuple3 CLType.

CLTypeInfo

Extends the information of a CLType and provides conversion helpers. Used also as a base class for ByteArrays, Keys, Lists, Maps, Options, Results and Tuples.

CLValue

The type used in deploy input arguments. And it can also be returned as a result of a query to the network or a contract call.

CLValueDictionary

Represents a parsed CLValue dictionary entry containing a raw value, a seed URef, and an item key string.

CLValueException

Exception thrown during CLValue conversion errors.

CLValueReader

Reads a CLValue from a binary stream given a CLTypeInfo descriptor. The caller is responsible for knowing the type layout of the stream; no type tag bytes are read.

ChainspecRawBytes

The raw bytes of the chainspec.toml, genesis accounts.toml, and global_state.toml files.

ChainspecRegistryKey

Stores a mapping of file names to the hash of the file itself. These files include Chainspec.toml and may also include Accounts.toml and GlobalState.toml. Format: 32-byte length with prefix 'chainspec-registry-'.

ChecksumRegistryKey

Stores a registry of checksums. Format: 32-byte length with prefix 'chainspec-registry-'.

Contract

Information, entry points and named keys belonging to a Contract

ContractPackage

Contract definition, metadata, and security container.

ContractVersion

Information related to an active version of a contract.

ContractWasm

A container for contract's WASM bytes.

CustomTransactionV1EntryPoint

Delegator

A delegator associated with the given validator.

DelegatorBid

Represents a party delegating their stake to a validator (or "delegatee

DelegatorKind

Auction bid variants. Kinds of delegation bids.

Deploy

DeployHeader

Header information of a Deploy.

DeployInfo

Information relating to the given Deploy.

DeployInfoKey

Stores information for a Deploy in the global state. Format: 32-byte length with prefix 'deploy-'.

DictionaryKey

Stores dictionary items in the global state. Format: 32-byte length with prefix 'dictionary-'.

DisabledVersion

A disabled version of a contract.

EntityKinEnumExtensions

EntityKind

EntityVersion

Major element of ProtocolVersion combined with EntityVersion.

EntityVersionAndHash

EntryPoint

Type signature of a method. Order of arguments matter since can be referenced by index as well as name.

EntryPointAccess

Access control options for a contract entry point (method).

EntryPointKey

EntryPointV2

EraEnd

Information related to the end of an era, and validator weights for the following era (alias for EraEndV2).

EraEndV1

Information related to the end of an era, and validator weights for the following era.

EraEndV2

Information related to the end of an era, and validator weights for the following era.

EraInfo

Auction metadata. Intended to be recorded at each era.

EraInfoKey

Stores information related to the Auction metadata for a particular era.. Format: u64 number with prefix 'era-' (e.g. 'era-3407').

EraReport

Equivocation, reward and validator inactivity information.

EraSummary

The summary of an era

EraSummaryKey

Key used to query current era info. Format: 32-byte length with prefix 'era-summary-'.

EraValidators

Validator and weights for an Era.

ExecutableDeployItem

Base class for the possible variants of an executable deploy.

ExecutionEffect

The journal of execution transforms from a single deploy.

ExecutionInfo

ExecutionResult

ExecutionResultV1

The result of executing a single deploy.

FailureTransformKind

Represents the case where applying a transform would cause an error.

FixedPricingMode

FutureEraTransactionScheduling

FutureEraTransactionV1Scheduling

FutureTimestampTransactionScheduling

FutureTimestampTransactionV1Scheduling

GlobalStateKey

Base class for the different global state keys.

Group

Groups associate a set of URefs with a label.

HashKey

Stores a contract inmutably in the global state. Format: 32-byte length with prefix 'hash-'.

IdentityTransformKind

An identity transformation that does not modify a value in the global state. Created as a result of reading from the global state.

InitiatorAddr

The address of the initiator of a TransactionV1

KeyPair

A Private key. Provides signing functionality.

Message

Message that was emitted by an addressable entity during execution.

MessageKey

MessagePayload

The payload of a message.

MessageTopic

A message topic.

MessageTopicSummary

Summary of a message topic that will be stored in global state.

MinimalBlockInfo

Minimal info of a Block.

ModuleBytesDeployItem

Deploy item with the capacity to contain executable code (e.g. a contract).

NamedArg

Named arguments passed as input in a Deploy item.

NamedEntryPoint

NamedKey

A named key in an Account or Contract.

NamedKeyKey

NamedKeyValue

A named key in an addressable entity.

NamedUserGroup

NativeTransactionV1EntryPoint

NativeTransactionV1Target

NextUpgrade

Information about the next protocol upgrade.

Operation

An operation performed while executing a deploy.

Package

Entity definition, metadata, and security container.

PackageIdentifier

Identifier of a package by its contract package hash or its addressable entity package address.

PackageKey

Parameter

Parameter to a method

PayloadFields

PaymentLimitedPricingMode

Peer

A node in the network.

PrepaidPricingMode

Prepayment

Container for bytes recording location, type and data for a gas pre-payment.

PricingMode

Pricing mode of a Transaction.

Proposer

Validator that proposed the block

PruneTransformKind

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 state accumulated from it.

PublicKey

A wrapper for a Public Key. Provides signature verification functionality.

Reservation

Represents a validator reserving a slot for specific delegator

Result<TOk, TErr>

Equivalent to the Result type in Rust. It can wrap a value with type TOk when the returning method returns successfully. Or an error with type TErr when the method needs to return an error.

Reward

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.

SeigniorageAllocation

Information about a seigniorage allocation

SessionTransactionV1Target

Signature

A wrapper for a cryptographic signature.

StandardTransactionScheduling

StandardTransactionV1Scheduling

StateIdentifier

Step

The journal of execution transforms from an Era

StoredContractByHashDeployItem

Deploy item to call an entry point in a contract. The contract is referenced by its hash.

StoredContractByNameDeployItem

Deploy item to call an entry point in a contract. The contract is referenced by a named key in the caller account pointing to the contract hash.

StoredTransactionV1Target

StoredValue

A wrapper class for different types of values stored in the global state.

StoredVersionedContractByHashDeployItem

Deploy item to call an entry point in a contract. The contract is referenced by a contract package hash and a version number.

StoredVersionedContractByNameDeployItem

Deploy item to call an entry point in a contract. The contract is referenced by a named key in the caller account pointing to the contract package hash and a version number.

SystemContractRegistryKey

Stores a list of system contract hashes (auction, handle payment, mint and standard payment). Format: 32-byte length with prefix 'system-contract-registry-'.

Transaction

A versioned wrapper for a TransactionV1 or Deploy.

Transaction.ContractCallBuilder

Transaction.NativeActivateBidBuilder

Transaction.NativeAddBidBuilder

Transaction.NativeAddReservationsBuilder

Transaction.NativeCancelReservationsBuilder

Transaction.NativeChangeBidPublicKeyBuilder

Transaction.NativeDelegateBuilder

Transaction.NativeRedelegateBuilder

Transaction.NativeTransactionInvocation

Transaction.NativeTransferBuilder

Transaction.NativeUndelegateBuilder

Transaction.NativeWithdrawBidBuilder

Transaction.RequiredArgAttribute

Transaction.SessionBuilder

Transaction.SessionTransactionInvocation

Transaction.StoredTransactionInvocation

Transaction.TransactionInvocation

Transaction.TransactionV1Builder<T>

TransactionHash

TransactionRuntime

TransactionScheduling

TransactionV1

A unit of work sent by a client to the network, which when executed can cause global state to be altered.

TransactionV1EntryPoint

A native or custom entry point to call within a transaction.

TransactionV1Payload

The payload portion of a TransactionV1.

TransactionV1PayloadJson

TransactionV1Scheduling

TransactionV1Target

Transfer

Represents a version 2 transfer from one purse to another

TransferDeployItem

Deploy item for transferring funds to a target account.

TransferKey

Stores information for a transfer in the global state. Format: 32-byte length with prefix 'transfer-'.

TransferV1

Represents a transfer from one purse to another

Transform

A transformation performed while executing a deploy.

TransformKind

TransformKind<T>

TransformV1

A transformation performed while executing a deploy.

U64GlobalStateKey

URef

Unforgeable Reference. This key type is used for storing any type of value except Account. Additionally, URefs used in contracts carry permission information to prevent unauthorized usage of the value stored under the key.