Casper.Network.SDK
Show / Hide Table of Contents

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.

AssociatedKey

public key allowed to provide signatures on deploys for the account

AuctionState

Data structure summarizing auction contract data.

AvailableBlockRange

An unbroken, inclusive range of blocks.

BalanceKey

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

Bid

An entry in a founding validator map representing a bid.

BidKey

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

Block

A block in the network

BlockBody

A block body

BlockHeader

A block header

BlockProof

Block's finality signature.

BlockSynchronizerStatus

The status of the block synchronizer.

BlockSyncStatus

The status of syncing an individual block.

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

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.

CLValueException

Exception thrown during CLValue conversion errors.

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.

Delegator

A delegator associated with the given validator.

Deploy

DeployApproval

Signature and Public Key of the signer.

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.

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

EraEnd

Era end report and list of validator weights for next 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 and reward information to be included in the terminal block.

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.

ExecutionResult

The result of executing a single deploy.

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

KeyPair

A Private key. Provides signing functionality.

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.

NamedKey

A named key in an Account or Contract.

NextUpgrade

Information about the next protocol upgrade.

Operation

An operation performed while executing a deploy.

Parameter

Parameter to a method

Peer

A node in the network.

Proposer

Validator that proposed the block

PublicKey

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

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

A validator reward

SeigniorageAllocation

Information about a seigniorage allocation

Signature

A wrapper for a cryptographic signature.

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.

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

Transfer

Represents a 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-'.

Transform

A transformation performed while executing a deploy.

U64GlobalStateKey

UnbondingPurse

Information of an unbonding or delegation withdrawal

UnbondKey

Stores unbond information, Format: 32-byte length with prefix 'unbond-'.

Unit

Represents the unit Rust type. aka (). It is used when there is no other meaningful value that could be returned.

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.

ValidatorChanges

The changes in a validator's status.

ValidatorStatusChange

A single change to a validator's status in the given era.

ValidatorWeight

A validator's weight.

VestingSchedule

Vesting schedule for a genesis validator. None if non-genesis validator.

WithdrawKey

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

Enums

AccessRights

Access Rights associated with an URef address.

CLType

Casper types, i.e. types which can be stored and manipulated by smart contracts. Provides a description of the underlying data type of a CLValue.

EntryPointType

Defines whether the code runs in the contract's or the session context.

KeyAlgo

Enumeration of the different key algorithms supported

KeyIdentifier

Keys in the global state store information about different data types.

LockStatus

A enum to determine the lock status of the contract package.

OpKind

The type of operation performed while executing a deploy.

ReactorState

The state of the reactor.

TransformType

Enumeration of transformation types used in the execution of a deploy.

ValidatorChange

A change to a validator's status between two eras.

In This Article
Back to top Maintained by MAKE Technology LLC