Generated using TypeDoc
Generated using TypeDoc
Represents an account hash in the Casper network. +Extends the Hash class with additional functionality specific to account hashes.
+Creates a new AccountHash instance.
+The underlying Hash object.
+The prefix of the original hash string, if any.
+Private originThe prefix of the original hash string, if any.
+Static ByteThe length of the hash in bytes.
+Static StringThe length of the hash string representation in hexadecimal.
+Static createStatic fromStatic fromCreates a Hash from a byte array.
+ +A new Hash instance.
+ +Error if the byte array length is invalid.
+The byte array representing the hash.
+Static fromStatic fromJSONCreates an AccountHash instance from its JSON representation.
+ +A new AccountHash instance.
+ +If the input is not a valid JSON string.
+The JSON string representation of the AccountHash.
+Static fromCreates an AccountHash instance from a string representation.
+ +A new AccountHash instance.
+The string representation of the account hash.
+Generated using TypeDoc
Optional accountHash: AccountHashOptional publicKey: PublicKeyOptional accountOptional publicGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents an addressable entity hash in the Casper network. +Extends the Hash class with additional functionality specific to addressable entity hashes.
+Creates a new AddressableEntityHash instance.
+The byte array representing the hash.
+The prefix of the original hash string. Defaults to PrefixAddressableEntity.
+The prefix of the original hash string, if any.
+Static ByteThe length of the hash in bytes.
+Static StringThe length of the hash string representation in hexadecimal.
+Static createStatic fromStatic fromCreates a Hash from a byte array.
+ +A new Hash instance.
+ +Error if the byte array length is invalid.
+The byte array representing the hash.
+Static fromCreates an AddressableEntityHash instance from a hexadecimal string.
+ +A new AddressableEntityHash instance.
+The hexadecimal string representation of the hash.
+Static fromJSONCreates an AddressableEntityHash instance from its JSON representation.
+ +A new AddressableEntityHash instance.
+The JSON string representation of the AddressableEntityHash.
+Generated using TypeDoc
A struct containing a signature and the public key of the signer.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents a balance hold address.
+Optional gasThe gas hold, if any.
+Optional processingThe processing hold, if any.
+Static fromCreates a BalanceHoldAddr from its byte representation.
+ +A new BalanceHoldAddr instance.
+ +Error if the byte format is invalid.
+ +BalanceHoldAddrTagError if the hold type is unexpected.
+The byte representation of the BalanceHoldAddr.
+Static fromJSONCreates a BalanceHoldAddr from its JSON representation.
+ +A new BalanceHoldAddr instance.
+The JSON string representation of the BalanceHoldAddr.
+Static fromCreates a BalanceHoldAddr from a string representation.
+ +A new BalanceHoldAddr instance.
+The string representation of the BalanceHoldAddr.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional vestingGenerated using TypeDoc
Represents a bid address in the system.
+Creates a new BidAddr instance.
+Optional unified: HashThe unified hash.
+Optional validator: HashThe validator hash.
+Optional delegator: { The delegator information.
+Optional credit: { The credit information.
+Optional creditThe credit information, if this is a credit bid address.
+Optional delegatorThe delegator information, if this is a delegator bid address.
+Optional unifiedThe unified hash, if this is a unified bid address.
+Optional validatorThe validator hash, if this is a validator bid address.
+Private getStatic fromCreates a BidAddr from a byte array.
+ +A new BidAddr instance.
+ +If the format is invalid.
+The byte array.
+Static fromStatic fromJSONGenerated using TypeDoc
Utility class for BidAddrTag operations.
+Static fromConverts a byte to a BidAddrTag.
+ +The corresponding BidAddrTag.
+ +If the byte doesn't correspond to a valid BidAddrTag.
+The byte to convert.
+Generated using TypeDoc
Optional bridgeOptional creditOptional delegatorOptional unifiedOptional validatorGenerated using TypeDoc
Optional originBlockV1: BlockV1Optional originBlockV2: BlockV2Optional accumulatedOptional eraOptional originOptional originOptional protocolStatic newStatic newGenerated using TypeDoc
Generated using TypeDoc
Static fromJSONGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents a block global address in the system.
+Creates a new BlockGlobalAddr instance.
+Optional blockTime: objectThe block time object.
+Optional messageCount: objectThe message count object.
+Optional blockThe block time object, if this is a block time address.
+Optional messageThe message count object, if this is a message count address.
+Static fromCreates a BlockGlobalAddr from a byte array.
+ +A new BlockGlobalAddr instance.
+ +Error if the BlockGlobalAddr type is unexpected.
+The byte array.
+Static fromJSONCreates a BlockGlobalAddr from its JSON representation.
+ +A new BlockGlobalAddr instance.
+The JSON string.
+Static fromCreates a BlockGlobalAddr from a string representation.
+ +A new BlockGlobalAddr instance.
+ +Error if the format is invalid.
+The string representation of the block global address.
+Generated using TypeDoc
Custom error class for BlockGlobalAddrTag related errors.
+Optional stackStatic Optional prepareOptional override for formatting stack traces
+ +https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+Static stackStatic captureGenerated using TypeDoc
Optional accumulatedOptional eraPrivate Optional originPrivate Optional originOptional protocolStatic newStatic newGenerated using TypeDoc
Optional accumulatedOptional eraOptional protocolGenerated using TypeDoc
Optional accumulatedOptional eraOptional protocolGenerated using TypeDoc
Optional blockOptional blockGenerated using TypeDoc
Optional hash: stringOptional height: numberOptional hashOptional heightGenerated using TypeDoc
Generated using TypeDoc
Static fromJSONGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional versionGenerated using TypeDoc
Optional versionGenerated using TypeDoc
Represents a byte code in the system.
+Private Optional V1Private isStatic fromCreates a ByteCode from a byte array.
+ +A new ByteCode instance.
+ +ByteCodeError.ErrInvalidByteCodeFormat if the format is invalid.
+The byte array.
+Static fromJSONStatic newConverts a byte to a ByteCodeKind.
+ +The corresponding ByteCodeKind.
+ +ByteCodeError.ErrInvalidByteCodeKind if the byte doesn't correspond to a valid ByteCodeKind.
+The byte to convert.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Private innerGenerated using TypeDoc
Serializes the Option into an array of bytes.
Generated using TypeDoc
Static fromStatic fromTries to decode PublicKey from its hex-representation. -The hex format should be as produced by CLPublicKey.toHex
-public key hex string contains key tag
-throws an Error if true and given string is not checksummed
-Static fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Class representing a result of an operation that might have failed. Can contain either a value
-resulting from a successful completion of a calculation, or an error. Similar to Result in Rust
-or Either in Haskell.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Static boolStatic byteStatic i32Static i64Static keyStatic listStatic mapStatic optionStatic publicStatic stringStatic tuple1Static tuple2Static tuple3Static u128Static u256Static u32Static u512Static u64Static u8Static unitStatic urefGenerated using TypeDoc
Generated using TypeDoc
Represents a dynamic CLType in the CasperLabs type system. +This class allows for runtime determination of CLTypes.
+Constructs a new CLTypeDynamic instance.
+Generated using TypeDoc
Represents a List type in the CasperLabs type system. +This class implements the CLType interface for List types.
+Constructs a new CLTypeList instance.
+The CLType of elements in the list.
+The type of elements contained in the list.
+Converts the CLTypeList to a JSON representation.
+ +An object with a single key-value pair, where the key is "List" and the value is the JSON representation of the element type.
+Static fromJSONCreates a CLTypeList instance from a JSON representation.
+ +A new CLTypeList instance.
+The JSON representation of the CLTypeList.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
A utility class for parsing CLTypes from various formats.
+Static Readonly BufferError thrown when a buffer constructor is not detected.
+Static Readonly ComplexError thrown when a complex type format is invalid.
+Static Readonly ErrError thrown when a complex type format is not detected.
+Static Readonly ErrError thrown when a JSON constructor is not found.
+Static Readonly simpleA record of simple CLTypes indexed by their TypeID.
+Static Readonly simpleA record of simple CLTypes indexed by their TypeName.
+Static Private fromStatic fromStatic fromStatic getStatic matchParses a CLType from an ArrayBuffer.
+ +The parsed CLType.
+ +BufferConstructorNotDetectedError if the type is not recognized.
+Generated using TypeDoc
Represents a raw CLType message that can be parsed into a CLType. +This class is decorated with typedjson for JSON serialization/deserialization.
+The raw message string representing a CLType.
+Generated using TypeDoc
Generated using TypeDoc
Represents a Tuple1 type in the CasperLabs type system. +This class implements the CLType interface for Tuple1 types, which are tuples containing a single element.
+Constructs a new CLTypeTuple1 instance.
+The CLType of the single element in the Tuple1.
+The CLType of the single element in the Tuple1.
+Static fromJSONCreates a CLTypeTuple1 instance from a JSON representation.
+ +A new CLTypeTuple1 instance.
+ +Error if the JSON structure is invalid or the inner type is invalid.
+The JSON representation of the CLTypeTuple1.
+Generated using TypeDoc
Represents a Tuple2 type in the CasperLabs type system. +This class implements the CLType interface for Tuple2 types, which are tuples containing two elements.
+Constructs a new CLTypeTuple2 instance.
+The CLType of the first element in the Tuple2.
+The CLType of the second element in the Tuple2.
+Static fromJSONCreates a CLTypeTuple2 instance from a JSON representation.
+ +A new CLTypeTuple2 instance.
+ +Error if the JSON structure is invalid or the inner types are invalid.
+The JSON representation of the CLTypeTuple2.
+Generated using TypeDoc
Represents a Tuple3 type in the CasperLabs type system. +This class implements the CLType interface for Tuple3 types, which are tuples containing three elements.
+Constructs a new CLTypeTuple3 instance.
+The CLType of the first element in the Tuple3.
+The CLType of the second element in the Tuple3.
+The CLType of the third element in the Tuple3.
+Static fromJSONCreates a CLTypeTuple3 instance from a JSON representation.
+ +A new CLTypeTuple3 instance.
+ +Error if the JSON structure is invalid or the inner types are invalid.
+The JSON representation of the CLTypeTuple3.
+Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional originalGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Constructs new instance of URef.
-Access rights flag. Use AccessRights.NONE to indicate no permissions.
-Static fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Abstract Represents a CLValue in the CasperLabs type system. +CLValue is a container for various types of values used in smart contracts.
+Constructs a new CLValue instance.
+The CLType of the value.
+Abstract dataOptional ui512Optional ui64Optional ui8Optional unitOptional urefAbstract clPrivate getStatic newCLKeyAbstract valueStatic newCLPublicStatic newCLUrefGenerated using TypeDoc
Represents an 'Any' value in the CasperLabs type system. +This type can hold any arbitrary data as a byte array.
+Constructs a new CLValueAny instance.
+The Uint8Array to be stored as the 'Any' value.
+Private dataStatic newCLAnyGenerated using TypeDoc
Represents a boolean value in the CasperLabs type system.
+Constructs a new CLValueBool instance.
+The boolean value to be stored.
+Private valueStatic fromStatic fromCreates a CLValueBool instance from a Uint8Array.
+ +A new CLValueBool instance.
+ +Will throw an error if the source array is empty.
+The Uint8Array containing the byte representation of the boolean value.
+Generated using TypeDoc
Static boolStatic byteStatic i32Static i64Static keyStatic listStatic mapStatic optionStatic publicStatic stringStatic tuple1Static tuple2Static tuple3Static u128Static u256Static u32Static u512Static u64Static u8Static unitStatic urefGenerated using TypeDoc
Represents a byte array value in the CasperLabs type system.
+Constructs a new CLValueByteArray instance.
+The Uint8Array to be stored in the CLValueByteArray.
+Private dataStatic fromCreates a CLValueByteArray instance from a Uint8Array.
+ +A new CLValueByteArray instance.
+The Uint8Array containing the byte representation of the ByteArray value.
+The CLTypeByteArray representing the type of the ByteArray.
+Static newCLByteGenerated using TypeDoc
Abstract Abstract fromOptional innerType: CLTypeAbstract toGenerated using TypeDoc
Represents a 32-bit signed integer value in the CasperLabs type system.
+Constructs a new CLValueInt32 instance.
+The value to initialize the CLValueInt32 with. Should be a 32-bit integer.
+Private valueStatic fromCreates a CLValueInt32 instance from a Uint8Array.
+ +A new CLValueInt32 instance.
+ +Will throw an error if the source array is smaller than Int32ByteSize.
+The Uint8Array containing the byte representation of the Int32 value.
+Static newCLInt32Generated using TypeDoc
Represents a 64-bit signed integer value in the CasperLabs type system.
+Constructs a new CLValueInt64 instance.
+The value to initialize the CLValueInt64 with. Can be any BigNumberish type.
+Private valueStatic fromCreates a CLValueInt64 instance from a Uint8Array.
+ +A new CLValueInt64 instance.
+ +Will throw an error if the source array is smaller than Int64ByteSize.
+The Uint8Array containing the byte representation of the Int64 value.
+Static newCLInt64Generated using TypeDoc
Represents a List value in the CasperLabs type system.
+Constructs a new CLValueList instance.
+The CLTypeList representing the type of the list.
+Optional array of CLValues to initialize the list with.
+The elements contained in the list.
+The type of the list.
+Static fromCreates a CLValueList instance from a Uint8Array.
+ +A new CLValueList instance.
+The Uint8Array containing the byte representation of the List value.
+The CLTypeList representing the type of the list.
+Static newCLListGenerated using TypeDoc
Represents a Map value in the CasperLabs type system.
+Constructs a new CLValueMap instance.
+The CLTypeMap representing the type of the map.
+Optional data: CLValueTuple2[]Optional array of CLValueTuple2 representing the map entries.
+Optional indexedData: Map<string, CLValue>Optional Map of string keys to CLValues for faster lookups.
+Private dataThe data stored in the map as an array of CLValueTuple2.
+Private indexedAn indexed representation of the map data for faster lookups.
+Private typeThe type of the map.
+Finds any value in the map that matches one of the provided keys.
+ +A tuple containing the first found value (or undefined) and a boolean indicating if any key was found.
+An array of keys to search for.
+Returns the map data as an array of CLValueTuple2.
+ +An array of CLValueTuple2 representing the map entries.
+Static fromCreates a CLValueMap instance from a Uint8Array.
+ +A new CLValueMap instance.
+The Uint8Array containing the byte representation of the Map value.
+The CLTypeMap representing the type of the map.
+Static newCLMapGenerated using TypeDoc
Represents an optional value in the CasperLabs type system. +An option can either contain a value or be empty.
+Constructs a new CLValueOption instance.
+The CLValue contained in the option, or null if empty.
+Optional type: CLTypeOptionThe CLTypeOption representing the type of the option.
+Optional typeStatic fromCreates a CLValueOption instance from a Uint8Array.
+ +A new CLValueOption instance or null if parsing fails.
+The Uint8Array containing the byte representation of the Option value.
+The CLTypeOption representing the type of the option.
+Static newCLOptionGenerated using TypeDoc
A utility class for parsing CLValues from various formats.
+Static fromParses a CLValue from a Uint8Array given its type.
+ +The parsed CLValue.
+ +If an unsupported CLType is encountered.
+The Uint8Array containing the serialized CLValue.
+The CLType of the value to parse.
+Static fromJSONStatic toStatic toJSONConverts a CLValue to its JSON representation.
+ +An object with 'bytes' and 'cl_type' properties representing the CLValue.
+The CLValue to convert.
+Generated using TypeDoc
Static fromStatic fromStatic fromJSONStatic toStatic toStatic toJSONGenerated using TypeDoc
Represents a Result type in the CasperLabs type system. +A Result can either be a success (Ok) or an error (Err).
+Constructs a new CLValueResult instance.
+The CLTypeResult representing the type of the Result.
+A boolean indicating whether the Result is a success (true) or an error (false).
+The CLValue contained within the Result.
+Static fromCreates a CLValueResult instance from a Uint8Array.
+ +A new CLValueResult instance.
+The Uint8Array containing the byte representation of the Result value.
+The CLTypeResult representing the type of the Result.
+Static newCLResultGenerated using TypeDoc
Represents a string value in the CasperLabs type system.
+Constructs a new CLValueString instance.
+The string value to be represented.
+Private valuePrivate sizeStatic fromCreates a CLValueString instance from a Uint8Array.
+ +A new CLValueString instance.
+The Uint8Array containing the byte representation of the string value.
+Static newCLStringGenerated using TypeDoc
Represents a tuple of one CLValue in the CasperLabs type system.
+Constructs a new CLValueTuple1 instance.
+The CLTypeTuple1 representing the type of the tuple.
+The CLValue contained in the tuple.
+Private innerStatic fromCreates a CLValueTuple1 instance from a Uint8Array.
+ +A new CLValueTuple1 instance.
+The Uint8Array containing the byte representation of the Tuple1 value.
+The CLTypeTuple1 representing the type of the tuple.
+Static newCLTuple1Generated using TypeDoc
Represents a tuple of two CLValues in the CasperLabs type system.
+Constructs a new CLValueTuple2 instance.
+The CLTypeTuple2 representing the type of the tuple.
+The first CLValue in the tuple.
+The second CLValue in the tuple.
+Static fromCreates a CLValueTuple2 instance from a Uint8Array.
+ +A new CLValueTuple2 instance.
+The Uint8Array containing the byte representation of the Tuple2 value.
+The CLTypeTuple2 representing the type of the tuple.
+Static newCLTuple2Generated using TypeDoc
Represents a tuple of three CLValues in the CasperLabs type system.
+Constructs a new CLValueTuple3 instance.
+Static fromCreates a CLValueTuple3 instance from a Uint8Array.
+ +A new CLValueTuple3 instance or null if parsing fails.
+The Uint8Array containing the byte representation of the Tuple3 value.
+The CLTypeTuple3 representing the type of the tuple.
+Static newCLTuple3Generated using TypeDoc
Represents a 128-bit unsigned integer value in the CasperLabs type system.
+Constructs a new CLValueUInt128 instance.
+The value to initialize the CLValueUInt128 with. Can be a BigNumber or a string.
+Private valStatic fromCreates a CLValueUInt128 instance from a Uint8Array.
+ +A new CLValueUInt128 instance.
+The Uint8Array containing the byte representation of the UInt128 value.
+Static newCLUInt128Creates a new CLValue instance with a UInt128 value.
+ +A new CLValue instance with CLTypeUInt128 and a CLValueUInt128.
+The value to initialize the UInt128 with. Can be a BigNumber or a string.
+Generated using TypeDoc
Represents a 256-bit unsigned integer value in the CasperLabs type system.
+Constructs a new CLValueUInt256 instance.
+The value to initialize the CLValueUInt256 with. Can be a BigNumber or a string.
+Private valStatic fromCreates a CLValueUInt256 instance from a Uint8Array.
+ +A new CLValueUInt256 instance.
+The Uint8Array containing the byte representation of the UInt256 value.
+Static newCLUInt256Creates a new CLValue instance with a UInt256 value.
+ +A new CLValue instance with CLTypeUInt256 and a CLValueUInt256.
+The value to initialize the UInt256 with. Can be a BigNumber or a string.
+Generated using TypeDoc
Represents a 32-bit unsigned integer value in the CasperLabs type system.
+Constructs a new CLValueUInt32 instance.
+The value to initialize the CLValueUInt32 with.
+Private valueStatic fromCreates a CLValueUInt32 instance from a Uint8Array.
+ +A new CLValueUInt32 instance.
+The Uint8Array containing the byte representation of the UInt32 value.
+Static newCLUInt32Static sizeGenerated using TypeDoc
Represents a 512-bit unsigned integer value in the CasperLabs type system.
+Constructs a new CLValueUInt512 instance.
+The value to initialize the CLValueUInt512 with. Can be a BigNumber or a string.
+Static fromCreates a CLValueUInt512 instance from a Uint8Array.
+ +A new CLValueUInt512 instance.
+The Uint8Array containing the byte representation of the UInt512 value.
+Static fromJSONCreates a CLValueUInt512 instance from a JSON representation.
+ +A new CLValueUInt512 instance.
+ +Will throw an error if the input is not a valid integer or is negative.
+The JSON representation of the UInt512 value. Can be a string or a number.
+Static newCLUInt512Creates a new CLValue instance with a UInt512 value.
+ +A new CLValue instance with CLTypeUInt512 and a CLValueUInt512.
+The value to initialize the UInt512 with. Can be a BigNumber or a string.
+Generated using TypeDoc
Generated using TypeDoc
Represents an 8-bit unsigned integer value in the CasperLabs type system.
+Constructs a new CLValueUInt8 instance.
+The value to initialize the CLValueUInt8 with. Should be an integer between 0 and 255.
+Private valueStatic fromCreates a CLValueUInt8 instance from a Uint8Array.
+ +A new CLValueUInt8 instance.
+The Uint8Array containing the byte representation of the UInt8 value.
+Static newCLUint8Generated using TypeDoc
Generated using TypeDoc
Construct a CasperClient object
-The url of the node to be communicated with
-Get the CSPR balance of an account using its account hash
- -Promise that resolves to the balance of the account
-The account's account hash as a hexadecimal string
-Get the CSPR balance of an account using its public key
- -Promise that resolves to the balance of the account
-CLPublicKey representation of an account's public key
-Get the main purse uref for the specified publicKey
- -A Promise resolving to a hexadecimal string representation of the account's main purse uref
-The public key of the account
-Get deploy details using a deploy's transaction hash
- -Tuple of Deploy and raw RPC response
-The hexadecimal string representation of the deploy hash
-Load private key file to usable keypair
- -Usable keypair
-The path to the private key file
-The signature algorithm of the account
-Load private key to buffer
- -Uint8Array buffer of the private key
-The path to the private key file
-The signature algorithm of the account. Currently we support Ed25519 and Secp256K1
-Load public key from file
- -New key pair with the specified SignatureAlgorithm
-The path to the publicKey file
-The signature algorithm of the account. The possible values are SignatureAlgorithm.Ed25519 and SignatureAlgorithm.Secp256K1
Construct an unsigned Deploy object from the deploy parameters, session logic, and payment logic
- -An unsigned Deploy object
- -Deploy parameters
-Session logic
-Payment logic
-Construct a Deploy consisting of a standard CSPR transfer. Fails if the Deploy is not a Transfer
-The parameters of the Deploy
-Session logic
-Payment logic
-Create a new hierarchical deterministic wallet, supporting bip32 protocol
- -A new bip32 compliant hierarchical deterministic wallet
-The seed buffer for parent key
-Generate a new key pair
- -New key pair with the specified SignatureAlgorithm
-The signature algorithm of the account. The possible values are SignatureAlgorithm.Ed25519 and SignatureAlgorithm.Secp256K1
Compute public key from private key
- -Uint8Array buffer of the public key computed from the provided private key
-Private key buffer
-The signature algorithm of the account. Currently we support Ed25519 and Secp256K1
-Sign the deploy with the specified signKeyPair
- -A signed Deploy object
- -Unsigned Deploy object
-the keypair used to sign the Deploy object
-Estimate execution cost of the deploy without committing the execution result to the global state.
-By default, speculative_exec JSON RPC method is disabled on a node.
-Sending a request to a node with the endpoint disabled will result in an error message.
-If enabled, speculative_exec operates on a separate port from the primary JSON-RPC, using 7778.
casper-node 1.5
-Signed deploy object
-Generated using TypeDoc
JSON RPC service for interacting with Casper nodes
-Constructor for building a CasperServiceByJsonRPC
A provider uri
-Protected clientJSON RPC client
-Deploys a provided signed deploy
- -A deploy must not exceed 1 megabyte
-A signed Deploy object to be sent to a node
Optional props: RpcRequestProps & { optional request props
-Get the balance of an account using its main purse URef
- -since casper-node 1.5, use queryBalance method instead
An account's balance
-The state root hash at which the account balance will be queried
-The URef of an account's main purse URef
-Optional props: RpcRequestPropsoptional request props
-Get the reference to an account balance uref by an account's public key, so it may be cached
- -The account's main purse URef
- -The state root hash at which the main purse URef will be queried
-The public key of the account
-Optional props: RpcRequestPropsoptional request props
-Get the reference to an account balance uref by an account's account hash, so it may be cached
- -The account's main purse URef
-The state root hash at which the main purse URef will be queried
-The account hash of the account
-Optional props: RpcRequestPropsoptional request props
-Get block information
- -A Promise resolving to a GetBlockResult
A hexadecimal string representing the hash of a block
-Optional props: RpcRequestPropsoptional request props
-Get block info at a provided block height
- -A Promise resolving to a GetBlockResult
The block height at which to gather the block info
-Optional props: RpcRequestPropsoptional request props
-Get the global block state at a certain state root hash, path, and key
- -The block state at the state root hash, path, and key provided, as a StoredValue
The state root hash at which the block state will be queried
-The key at which to query the state
-An array of a path / paths at which to query the state
-Optional props: RpcRequestPropsoptional request props
-Retrieves all transfers for a block from the network
- -A Promise resolving to a Transfers containing block transfers
Optional blockHash: stringHexadecimal block hash. If not provided, the last block added to the chain, known as the given node, will be used
-Optional props: RpcRequestPropsoptional request props
-Returns raw bytes for chainspec files.
- -casper-node 1.5
- -chainspec files content in bytes
-Optional props: RpcRequestPropsoptional request props
-Get information about a deploy using its hexadecimal hash
- -A Promise that resolves to a GetDeployResult
Hex-encoded hash digest.
-Optional finalizedApprovals: booleanWhether 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.
Optional props: RpcRequestPropsoptional request props
-Get a dictionary item by its name from within a contract
- -A Promise resolving to a StoredValue containing the item
The state root hash at which the item will be queried
-The contract hash of the contract that stores the queried dictionary
-The name of the dictionary
-The key at which the item is stored
-Optional props: RpcRequestProps & { optional request props
-Get a dictionary item by its URef
- -A Promise resolving to a StoredValue containing the item
The state root hash at which the item will be queried
-The key at which the item is stored
-The seed URef of the dictionary
-Optional props: RpcRequestProps & { optional request props
-Retrieve era information at the block hash of a switch block
- -A Promise resolving to an EraSummary containing the era information
Optional blockHash: stringHexadecimal block hash. If not provided, the last block added to the chain, known as the given node, will be used
-Optional props: RpcRequestPropsoptional request props
-Retrieve era information by switch block height
- -A Promise resolving to an EraSummary containing the era information
The height of the switch block
-Optional props: RpcRequestPropsoptional request props
-Retrieve era summary information by block hash (if provided) or most recently added block
- -A Promise resolving to an EraSummary containing the era information
Optional blockHash: stringHexadecimal block hash. If not provided, the last block added to the chain, known as the given node, will be used
-Retrieve era summary information by block height (if provided) or most recently added block
- -A Promise resolving to an EraSummary containing the era information
Optional blockHeight: numberThe height of the switch block
-Get the block info of the latest block added
- -A Promise that resolves to a GetBlockResult
Optional props: RpcRequestPropsoptional request props
-Get the attached node's current peers
- -A Promise that resolves to a GetPeersResult
Optional props: RpcRequestPropsoptional request props
-Get the state root hash at a specific block hash
- -A Promise resolving to a state root hash hexadecimal string
Optional blockHashBase16: stringThe hexadecimal string representation of a block hash
-Optional props: RpcRequestPropsoptional request props
-Get the state root hash at a specific block height
- -A Promise resolving to a state root hash hexadecimal string
The height of a block hash
-Optional props: RpcRequestPropsoptional request props
-Get the status of a node
- -A Promise that resolves to a GetStatusResult
Optional props: RpcRequestPropsoptional request props
-Get information on the current validators
- -A Promise that resolves to a ValidatorsInfoResult
Optional blockHash: string(optional) blockHash that you want to check
-Optional props: RpcRequestPropsoptional request props
-Get information on the network validators of at a certain block height
- -A Promise that resolves to a ValidatorsInfoResult
The block height at which to query the validators' info
-Optional props: RpcRequestPropsoptional request props
-Returns balance using a purse identifier and a state identifier
- -casper-node 1.5
- -const client = new CasperServiceByJsonRPC("http://localhost:11101/rpc");
const balance = await client.queryBalance(PurseIdentifier.MainPurseUnderAccountHash, "account-hash-0909090909090909090909090909090909090909090909090909090909090909");
-Purse balance
-purse type enum
-purse identifier
-Optional stateIdentifier: StateIdentifierOptional props: RpcRequestPropsoptional request props
-Estimate execution cost of the deploy without committing the execution result to the global state.
-By default, speculative_exec JSON RPC method is DISABLED on a node.
-Sending a request to a node with the endpoint disabled will result in an error message.
-If enabled, speculative_exec operates on a separate port from the primary JSON-RPC, using 7778.
casper-node 1.5
- -deploy execution result
-signed deploy object
-Optional blockIdentifier: BlockIdentifierblock identifier
-Optional props: RpcRequestPropsoptional request props
-Wait for deploy to be confirmed on-chain
- -GetDepoyResult
-deploy instance or deploy hash
-optional parameter for timeout
-Generated using TypeDoc
Optional options: CasperWalletProviderOptionsProtected Optional activePrivate casperGet the connection status of the Casper Wallet extension
- -true value when currently connected at least one account, false otherwise.
Request the connect interface with the Casper Wallet extension. -Will not show UI for already connected accounts and return true immediately
-emits event of type Connected when successfully connected.
true value when connection request is accepted by the user or when account is already connected, false otherwise.
Request the sign deploy interface with the Casper Wallet extension
- -a payload response when user responded to transaction request, it will contain signature if approved, or cancelled === true flag when rejected.
-stringified json of a deploy can be generated by DeployUtil.deployToJson
public key (in hex format)
-Request the sign message interface with the Casper Wallet extension
- -a payload response when user responded to transaction request, it will contain signature if approved, or cancelled === true flag when rejected.
-message to sign as string
-public key (in hex format)
-Protected connectedProtected lockedProtected emitPrivate handlePrivate handlePrivate handlePrivate handlePrivate handlePrivate handlePrivate updateGenerated using TypeDoc
Optional rawJSONStatic fromJSONStatic newGenerated using TypeDoc
Optional blockOptional blockOptional rawJSONGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Private consumerPrivate consumerPrivate consumerPrivate eventPrivate middlewaresPrivate streamPrivate streamPrivate streamerPrivate workersPrivate logGenerated using TypeDoc
Private handlersGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents a contract hash in the system.
+Creates a new ContractHash instance.
+The Hash object representing the contract hash.
+The original prefix of the contract hash string.
+The hash of the contract.
+The original prefix of the contract hash string, if any.
+Static fromJSONCreates a ContractHash instance from its JSON representation.
+ +A new ContractHash instance.
+The JSON string representation of the ContractHash.
+Static newCreates a new ContractHash instance from a string representation.
+ +A new ContractHash instance.
+The string representation of the contract hash.
+Generated using TypeDoc
Generated using TypeDoc
Represents a contract package hash in the system.
+Creates a new ContractPackageHash instance.
+The Hash object representing the contract package hash.
+The original prefix of the contract package hash string.
+The hash of the contract package.
+The original prefix of the contract package hash string, if any.
+Static fromJSONCreates a ContractPackageHash instance from its JSON representation.
+ +A new ContractPackageHash instance.
+The JSON string representation of the ContractPackageHash.
+Static newCreates a new ContractPackageHash instance from a string representation.
+ +A new ContractPackageHash instance.
+The string representation of the contract package hash.
+Generated using TypeDoc
Generated using TypeDoc
Smart contract object for interacting with contracts on the Casper Network
-Constructor
-Optional casperClient: CasperClientThe CasperClient object connected to a live node
Optional casperThe CasperClient object connected to a live node
Optional contractOptional contractCall an entrypoint of a smart contract.
- -A Deploy object that can be sent to a node to call an entrypoint
-The name of an entrypoint of a smart contract that you wish to call
-The runtime arguments for the deploy
-CLPublicKey of the sender of the deploy
The name of the network the installment deploy will be sent to. You can get the network name of a node by calling the REST endpoint :8888/status
The gas payment in motes, where 1 mote = 10^-9 CSPR. Use a stringified base-10 integer
-An array of keypairs used to sign the deploy. If you are signing with one key, use an array with only the one keypair. If instead you are utilizing multi-sig functionality, provide multiple keypair objects in the array.
-The time that the deploy has to live. If the deploy awaits execution longer than this interval, in seconds, then the deploy will fail. This parameter will default to the DEFAULT_DEPLOY_TTL if not specified.
-Private checkInstall a smart contract on a Casper Network
- -The installment deploy, to be sent to a node.
- -In the future, this method will be an alias to a different method: callModuleBytesEntrypoint
Uint8Array representation of a WebAssembly compiled smart contract
The runtime arguments for the installment deploy
-The gas payment in motes, where 1 mote = 10^-9 CSPR. Use a stringified base-10 integer
-CLPublicKey of the sender of the installment deploy
The name of the network the installment deploy will be sent to. You can get the network name of a node by calling the REST endpoint :8888/status
An array of keypairs used to sign the deploy. If you are signing with one key, use an array with only the one keypair. If instead you are utilizing multi-sig functionality, provide multiple keypair objects in the array.
-Query data from a smart contract.
- -A Promise that resolves to a stored CLValue within the smart contract. This Promise will be rejected if there is no CasperClient to use, or if the stored value is unavailable or invalid
Path to the data requested
-Optional casperClient: CasperClientA CasperClient object with a connected node. This parameter is not required if there is an existing CasperClient object attached to this Contract instance
Optional stateRootHash: stringThe state root hash at which to query this data. If no state root hash is provided, the most recent one will be queried and used.
-Query a dictionary associated with a smart contract to obtain stored key-value pairs.
- -A Promise which resolves to a CLValue. This Promise will be rejected if there is no CasperClient to use, or if the value in the dictionaryName at the key dictionaryItemKey is unavailable or invalid
The name of the dictionary to be queried
-The key of the key-value pair to be obtained
-Optional stateRootHash: stringThe state root hash at which to query this data. If no state root hash is provided, the most recent one will be queried and used.
-Optional casperClient: CasperClientA CasperClient object with a connected node. This parameter is not required if there is an existing CasperClient object attached to this Contract instance
Attaches an on-chain smart contract to this Contract object using its hexadecimal string typed hash. The contract hash must include the prefix "hash-"
The hexadecimal smart contract hash, with the prefix "hash-"
-Optional contractPackageHash: stringThe hexadecimal smart contract package hash, with the prefix "hash-". This parameter is optional, and only used when there is event processing present.
-Generated using TypeDoc
A utility class for various data conversions used in the CasperLabs ecosystem.
+Static base64to16Converts a Base-64 encoded string to a Base-16 (hexadecimal) encoded string.
+ +A Base-16 encoded string.
+ +const base64 = "SGVsbG8=";
const base16 = Conversions.base64to16(base64);
console.log(base16); // Outputs: "48656c6c6f"
+The Base-64 encoded string to be converted.
+Static csprConverts a CSPR amount to its mote equivalent.
+ +A BigNumber containing the equivalent amount in motes.
1 CSPR = 10^9 motes
+ +const cspr = 1;
const motes = Conversions.csprToMotes(cspr);
console.log(motes.toString()); // Outputs: "1000000000"
+A BigNumberish amount of CSPR to convert to motes.
Static decodeDecodes a Base-16 (hexadecimal) encoded string and returns a Uint8Array of bytes.
+ +A Uint8Array containing the decoded bytes.
+ +const base16 = "48656c6c6f";
const bytes = Conversions.decodeBase16(base16);
console.log(bytes); // Outputs: Uint8Array(5) [72, 101, 108, 108, 111]
+The Base-16 encoded string to be decoded.
+Static decodeDecodes a Base-64 encoded string and returns a Uint8Array of bytes.
+ +A Uint8Array containing the decoded bytes.
+ +const base64 = "SGVsbG8=";
const bytes = Conversions.decodeBase64(base64);
console.log(bytes); // Outputs: Uint8Array(5) [72, 101, 108, 108, 111]
+The Base-64 encoded string to be decoded.
+Static encodeEncodes a Uint8Array into a string using Base-16 (hexadecimal) encoding.
+ +A Base-16 encoded string representation of the input bytes.
+ +const bytes = new Uint8Array([72, 101, 108, 108, 111]);
const base16 = Conversions.encodeBase16(bytes);
console.log(base16); // Outputs: "48656c6c6f"
+The Uint8Array to be encoded.
+Static encodeEncodes a Uint8Array into a string using Base-64 encoding.
+ +A Base-64 encoded string representation of the input bytes.
+ +const bytes = new Uint8Array([72, 101, 108, 108, 111]);
const base64 = Conversions.encodeBase64(bytes);
console.log(base64); // Outputs: "SGVsbG8="
+The Uint8Array to be encoded.
+Static motesConverts an amount in motes to its CSPR equivalent.
+ +A BigNumber containing the equivalent amount in CSPR.
This function will round to the nearest whole integer. +1 mote = 10^-9 CSPR
+ +const motes = BigNumber.from('1000000000');
const cspr = Conversions.motesToCSPR(motes);
console.log(cspr.toString()); // Outputs: "1"
+A BigNumberish amount of motes to convert to CSPR.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional vestingSchedule: VestingScheduleOptional vestingStatic newGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional vestingGenerated using TypeDoc
Constructs a Deploy object
The DeployHash identifying this Deploy
+The deploy header
+An ExecutableDeployItem representing the payment logic
+An ExecutableDeployItem representing the session logic
+An array of signatures and associated accounts who have approved this deploy
+Static createStatic fromStatic fromJSONStatic newStatic setStatic toConvert the deploy object to a JSON representation
+ +A JSON version of the Deploy, which can be converted back later
The Deploy object to convert to JSON
Generated using TypeDoc
Generated using TypeDoc
Static fromOptional height: numberGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional accountOptional bodyStatic defaultGenerated using TypeDoc
Generated using TypeDoc
The parameters of a Deploy object
The parameters of a Deploy object. Use Deploy.fromHeaderAndItems
Container for Deploy construction options.
The public key of the deploying account as a CLPublicKey
The public key of the deploying account as a PublicKey
Optional timestamp: numberNote that timestamp is UTC, not local.
The public key of the deploying account as a CLPublicKey
The public key of the deploying account as a PublicKey
Name of the chain, to avoid the Deploy from being accidentally or maliciously included in a different chain.
Hex-encoded Deploy hashes of deploys which must be executed before this one.
Conversion rate between the cost of Wasm opcodes and the motes sent by the payment code, where 1 mote = 1 * 10^-9 CSPR
Optional timestampOptional timestampNote that timestamp is UTC, not local.
Time that the Deploy will remain valid for, in milliseconds. The default value is 1800000, which is 30 minutes
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
A deploy containing a smart contract along with the requester's signature(s).
-Constructs a Deploy object
The DeployHash identifying this Deploy
-The deploy header
-An ExecutableDeployItem representing the payment logic
-An ExecutableDeployItem representing the session logic
-An array of signatures and associated accounts who have approved this deploy
-An array of approvals in the form of signatures from an account or multiple accounts
-The deploy hash
-The header of the deploy
-The payment logic of the deploy
-The session code of the deploy
-Can be used to send the Deploy to an online Casper node
The deploy hash of the Deploy
Works by instantiating a CasperClient with the provided nodeUrl and calling putDeploy on it
The url of a live Casper node
-Signs the Deploy using the provided AsymmetricKey(s)
The original Deploy signed by the provided AsymmetricKey(s)
An array consisting of one or many AsymmetricKey(s)
Generated using TypeDoc
Header data of a Deploy object that contains information like the transacting account, timestamp, gas price, and other relevent deploy information
Constructs the header portion of a deploy
-The CLPublicKey representation of the transacting account.
The UNIX timestamp at which the deploy was created
-The amount of time in milliseconds that the deploy is given to live before it is dropped and rejected by validators
-Price per gas unit for this deploy, measured in motes, where 1 mote = 10^-9 CSPR
-Hash of the compiled WebAssembly logic
-Zero, one, or many instances of session code that is/are required to execute before this deploy
-The chain for which the deploy should be deployed on. For the Casper mainnet, use "casper" and for the testnet, use "casper-test"
-Converts DeployHeader to ToBytesResult.
Ok result, consisting of the account's byte representation, the timestamp, ttl, gasPrice, bodyHash, dependencies, and chainName concatenated together in a byte array
Generated using TypeDoc
Represents an executable deploy object that can be deployed on-chain. ModuleBytes, StoredContractByHash, StoredContractByName, StoredVersionedContractByHash, StoredVersionedContractByName, and Transfer objects can all be casted as ExecutableDeployItems.
Optional moduleOptional ModuleBytes object representing the ExecutableDeployItem if applicable.
Optional storedOptional StoredContractByHash object representing the ExecutableDeployItem if applicable.
Optional storedOptional StoredContractByName object representing the ExecutableDeployItem if applicable.
Optional storedOptional StoredVersionedContractByHash object representing the ExecutableDeployItem if applicable.
Optional storedOptional StoredVersionedContractByName object representing the ExecutableDeployItem if applicable.
Optional transferOptional Transfer object representing the ExecutableDeployItem if applicable.
Casts the ExecutableDeployItem to ModuleBytes if possible
ModuleBytes representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Casts the ExecutableDeployItem to StoredContractByHash if possible
StoredContractByHash representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Casts the ExecutableDeployItem to StoredContractByName if possible
StoredContractByName representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Casts the ExecutableDeployItem to StoredVersionedContractByHash if possible
StoredVersionedContractByHash representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Casts the ExecutableDeployItem to StoredVersionedContractByName if possible
StoredVersionedContractByName representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Gets a CLValue argument via its name, returns undefined if the argument does not exist. Throws an error if it cannot serialize the ExecutableDeployItem from its original type.
A CLValue runtime argument
The name of the argument
-Sets an argument given an argument name and a value typed as a CLValue. Throws an error if it cannot serialize the ExecutableDeployItem from its original type.
The success status of setting the argument
-The name of the argument being set
-The CLValue that will be stored under the new argument name
Converts ExecutableDeployItem to ToBytesResult depending on the ExecutableDeployItem's type. Throws an error if it cannot serialize the ExecutableDeployItem from its parent type.
ModuleBytes, or StoredContractByHash, or StoredContractByName, or StoredVersionedContractByHash, or StoredVersionedContractByName, or Transfer depending on the original type.
Static fromBuilds an ExecutableDeployItem from an ExecutableDeployItemInternal. The ExecutableDeployItemInternal abstract class is inherited by ModuleBytes, StoredContractByHash, StoredContractByName, StoredVersionedContractByHash, StoredVersionedContractByName, and Transfer, so you may pass in an object of any of these types.
The ExecutableDeployItemInternal to build into an ExecutableDeployItem
Static newCreates a new ModuleBytes object from a Uint8Array of module bytes and a set of RuntimeArgs
A new ExecutableDeployItem created from a new ModuleBytes object built using moduleBytes and args
A set of module bytes as a Uint8Array
The runtime arguments for the new ModuleBytes object
Static newCreates a new StoredContractByHash object from a Uint8Array contract hash, entrypoint, and runtime arguments
A new ExecutableDeployItem created from a new StoredContractByHash object built using hash, entryPoint and args
Uint8Array representation of a smart contract hash
Name of an entrypoint of the stored contract
-The runtime arguments for the new StoredContractByHash object
Static newCreates a new StoredContractByName object from a contract name, entrypoint, and runtime arguments
A new ExecutableDeployItem created from a new StoredContractByName object built using name, entryPoint and args
The name of the stored smart contract
-Name of an entrypoint of the stored contract
-The runtime arguments for the new StoredContractByHash object
Static newCreates a new StoredVersionedContractByHash object from a Uint8Array contract hash, version number, entrypoint, and runtime arguments
A new ExecutableDeployItem created from a new StoredVersionedContractByHash object built using hash, version, entryPoint and args
Uint8Array representation of a smart contract hash
The version of the stored contract
-Name of an entrypoint of the stored contract
-The runtime arguments for the new StoredContractByHash object
Static newCreates a new StoredVersionedContractByName object from a contract name, version number, entrypoint, and runtime arguments
A new ExecutableDeployItem created from a new StoredVersionedContractByName object built using name, version, entryPoint and args
The name of the stored smart contract
-The version of the stored contract
-Name of an entrypoint of the stored contract
-The runtime arguments for the new StoredContractByHash object
Static newCreates a new Transfer object
New Transfer object which can be deployed to execute a standard CSPR transferral
The number of motes to transfer, where 1 mote = 1 * 10^-9 CSPR
-URef of the target purse or the public key of target account, as a CLUref or CLPublicKey respectively
URef of the source purse. If this is omitted, the main purse of the account creating this transfer will be used as the source purse
-User-defined transfer id
-Static newConstructor for Transfer deploy item using UniqAddress.
- -A new Deploy representing a transferral to a unique address
CLPublicKey of source account
UniqAddress of target account
The amount of motes to transfer, where 1 mote = 1 * 10^-9 CSPR
-The number of motes paid to execution engine, where 1 mote = 1 * 10^-9 CSPR
-Name of the chain, to avoid the Deploy from being accidentally or maliciously included in a different chain.
The gas price at which to execute the deploy
-Time that the Deploy will remain valid for, in milliseconds. The default value is 1800000, which is 30 minutes
Optional sourcePurse: CLURefURef of the source purse. If this is omitted, the main purse of the account creating this
transfer will be used as the source purse
Static newCreates a new Transfer object with an optional transfer id
New Transfer object which can be deployed to execute a standard CSPR transferral
The number of motes to transfer, where 1 mote = 1 * 10^-9 CSPR
-URef of the target purse or the public key of target account, as a CLUref or CLPublicKey respectively
Optional sourcePurse: null | CLURefURef of the source purse. If this is omitted, the main purse of the account creating this transfer will be used as the source purse
-Optional id: BigNumberishUser-defined transfer id, which if not provided will be created on the fly
-Generated using TypeDoc
An object which can be passed along in a deploy, including session code and runtime arguments.
-Constructs a ModuleBytes object from the Uint8Array typed session code and a RuntimeArgs object.
The Uint8Array representation of the session code
Runtime arguments as RuntimeArgs
A RuntimeArgs object containing the runtime arguments passed along with the deploy.
A Uint8Array typed representation of the session code.
Converts ModuleBytes to ToBytesResult
Ok result, consisting of the ModuleBytes as a byte array
Generated using TypeDoc
The StoredContractByHash class, when instantiated, represents a stored smart contract referenced by it's hash
Constructs a StoredContractByHash object from the Uint8Array typed hash, entrypoint of the contract, and associated runtime arguments
Uint8Array typed smart contract hash
An entrypoint of the smart contract
-The runtime arguments for interaction on the entryPoint
A RuntimeArgs object containing the runtime arguments to be passed along with the deploy.
An entrypoint of the stored smart contract
-The Uint8Array typed hash of the stored smart contract
An identifier that other functions use to recognize that StoredContractByHash objects are indeed stored contracts by hash during deserialization
Converts StoredContractByHash to ToBytesResult
Ok result, consisting of the tag, contract hash, entrypoint, and runtime arguments as a byte array
Generated using TypeDoc
The StoredContractByName class, when instantiated, represents a stored smart contract referenced by it's name
Constructs a StoredContractByName object from the name, entrypoint of the contract, and associated runtime arguments
The name of the smart contract
-An entrypoint of the smart contract
-The runtime arguments for interaction on the entryPoint
A RuntimeArgs object containing the runtime arguments to be passed along with the deploy.
An entrypoint of the smart contract
-The name of the smart contract
-An identifier that other functions use to recognize that StoredContractByName objects are indeed stored contracts by name during deserialization
Converts StoredContractByName to ToBytesResult
Ok result, consisting of the tag, name, entrypoint, and runtime arguments as a byte array
Generated using TypeDoc
The StoredVersionedContractByHash class, when instantiated, represents a stored versioned smart contract referenced by it's hash
Constructs a StoredContractByHash object from the Uint8Array typed hash, entrypoint of the contract, and associated runtime arguments
Uint8Array typed smart contract hash
The version of the smart contract
-An entrypoint of the smart contract
-The runtime arguments for interaction on the entryPoint
A RuntimeArgs object containing the runtime arguments to be passed along with the deploy.
An entrypoint of the stored smart contract
-The Uint8Array typed hash of the stored smart contract
An identifier that other functions use to recognize that StoredVersionedContractByHash objects are indeed stored versioned contracts by hash during deserialization
The version of the contract
-Converts StoredVersionedContractByHash to ToBytesResult
Ok result, consisting of the tag, hash, serialized version, entrypoint, and runtime arguments as a byte array
Generated using TypeDoc
The StoredVersionedContractByName class, when instantiated, represents a stored smart contract referenced by it's name
Constructs a StoredContractByName object from the name, entrypoint of the contract, and associated runtime arguments
The name of the smart contract
-The version of the named smart contract
-An entrypoint of the smart contract
-The runtime arguments for interaction on the entryPoint
A RuntimeArgs object containing the runtime arguments to be passed along with the deploy.
An entrypoint of the smart contract
-The name of the stored versioned contract
-An identifier that other functions use to recognize that StoredVersionedContractByName objects are indeed stored versioned contracts by name during deserialization
The version of the contract
-Converts StoredVersionedContractByName to ToBytesResult
Ok result, consisting of the tag, name, serialized version, entrypoint, and runtime arguments as a byte array
Generated using TypeDoc
Represents a transferral deploy. Construct and deploy to execute a standard CSPR transfer
-Constructor for Transfer deploy item.
- -The RuntimeArgs should contain the arguments amount, target, sourcePurse, and id
RuntimeArgs containing the transfer amount in motes, the URef of the target purse or the public key of the target account, the URef of the source purse, and the transfer id
Runtime arguments necessary for building the transfer deploy
-An identifier that other functions use to recognize that Transfer objects are indeed transfers during deserialization
Converts Transfer to ToBytesResult
Ok result, consisting of the tag and runtime arguments concatenated in a byte array
Generated using TypeDoc
An object containing a unique address constructed from the transferId of a Deploy
Constructs UniqAddress from the transacting account's CLPublicKey and unique transferId.
CLPublicKey instance
-BigNumberish value (can be also string representing number). Max U64.
-The CLPublicKey representation of the transacting account
A transaction nonce
-Static fromBuilds UniqAddress from string
- -A new UniqAddress
UniqAddress string representation in the format "accountHex-transferIdHex"
Generated using TypeDoc
Static fromJSONStatic parseGenerated using TypeDoc
Generated using TypeDoc
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
+Static Readonly [species]Returns an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement.
+Combines two or more arrays. +This method returns a new array without modifying any existing arrays.
+Rest ...items: ConcatArray<Transform>[]Additional arrays and/or items to add to the end of the array.
+Combines two or more arrays. +This method returns a new array without modifying any existing arrays.
+Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target
+If target is negative, it is treated as length+target where length is the +length of the array.
+If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.
+Optional end: numberIf not specified, length of the this object is used as its default value.
+Determines whether all the members of an array satisfy the specified test.
+A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+Determines whether all the members of an array satisfy the specified test.
+A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+Changes all array elements from start to end index to a static value and returns the modified array
value to fill array section with
+Optional start: numberindex to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.
+Optional end: numberindex to stop filling the array at. If end is negative, it is treated as +length+end.
+Returns the elements of an array that meet the condition specified in a callback function.
+A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+Returns the elements of an array that meet the condition specified in a callback function.
+A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+Returns the value of the first element in the array where predicate is true, and undefined +otherwise.
+find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.
+Optional thisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+Returns the index of the first element in the array where predicate is true, and -1 +otherwise.
+find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.
+Optional thisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+Performs the specified action for each element in an array.
+A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+Determines whether an array includes a certain element, returning true or false as appropriate.
+The element to search for.
+Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
+Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
+The value to locate in the array.
+Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+Adds all the elements of an array into a string, separated by the specified separator string.
+Optional separator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
+Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
+The value to locate in the array.
+Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
+Calls a defined callback function on each element of an array, and returns an array that contains the results.
+A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+Returns a copy of a section of an array. +For both start and end, a negative index can be used to indicate an offset from the end of the array. +For example, -2 refers to the second to last element of the array.
+Optional start: numberThe beginning index of the specified portion of the array. +If start is undefined, then the slice begins at index 0.
+Optional end: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'. +If end is undefined, then the slice extends to the end of the array.
+Determines whether the specified callback function returns true for any element of an array.
+A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.
+Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+Sorts an array in place. +This method mutates the array and returns a reference to the same array.
+Optional compareFn: ((a: Transform, b: Transform) => number)Function used to determine the order of the elements. It is expected to return +a negative value if the first argument is less than the second argument, zero if they're equal, and a positive +value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
+[11,2,22,1].sort((a, b) => a - b)
+Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+ +An array containing the elements that were deleted.
+The zero-based location in the array from which to start removing elements.
+Optional deleteCount: numberThe number of elements to remove.
+Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+ +An array containing the elements that were deleted.
+The zero-based location in the array from which to start removing elements.
+The number of elements to remove.
+Rest ...items: Transform[]Elements to insert into the array in place of the deleted elements.
+Static fromCreates an array from an array-like object.
+An array-like object to convert to an array.
+Creates an array from an iterable object.
+An array-like object to convert to an array.
+A mapping function to call on every element of the array.
+Optional thisArg: anyValue of 'this' used to invoke the mapfn.
+Creates an array from an iterable object.
+An iterable object to convert to an array.
+Creates an array from an iterable object.
+An iterable object to convert to an array.
+A mapping function to call on every element of the array.
+Optional thisArg: anyValue of 'this' used to invoke the mapfn.
+Static isStatic ofGenerated using TypeDoc
Generated using TypeDoc
Represents an entity address in the system.
+Creates a new EntityAddr instance.
+Optional accountThe account hash, if this is an account entity.
+Optional smartThe smart contract hash, if this is a smart contract entity.
+Optional systemThe system hash, if this is a system entity.
+Static fromCreates an EntityAddr from a byte array.
+ +A new EntityAddr instance.
+ +If the buffer is empty or the format is invalid.
+The byte array.
+Static fromJSONCreates an EntityAddr from its JSON representation.
+ +A new EntityAddr instance.
+The JSON string representation of the EntityAddr.
+Static fromCreates an EntityAddr from a prefixed string representation.
+ +A new EntityAddr instance.
+ +If the format is invalid.
+The prefixed string representation of the EntityAddr.
+Static Private getConverts a byte to an EntityKind.
+ +The corresponding EntityKind.
+ +If the byte doesn't correspond to a valid EntityKind.
+The byte to convert.
+Generated using TypeDoc
Optional accountHash: AccountHashOptional publicKey: PublicKeyOptional entityAddr: EntityAddrOptional accountOptional entityOptional publicStatic fromStatic fromStatic fromGenerated using TypeDoc
Optional accountOptional smartOptional systemGenerated using TypeDoc
Optional addressableOptional legacyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents an entry point address in the system.
+Optional vmCasperV1: VmCasperV1Optional vmCasperV2: VmCasperV2Optional vmOptional vmStatic fromCreates an EntryPointAddr from a byte array.
+ +A new EntryPointAddr instance.
+ +EntryPointError if the EntryPointAddr type is unexpected.
+The byte array.
+Static fromJSONCreates an EntryPointAddr from its JSON representation.
+ +A new EntryPointAddr instance.
+The JSON string representation of the EntryPointAddr.
+Static fromCreates an EntryPointAddr from a string representation.
+ +A new EntryPointAddr instance.
+ +EntryPointError if the format is invalid.
+The string representation of the entry point address.
+Generated using TypeDoc
Generated using TypeDoc
Custom error class for EntryPoint related errors.
+Optional stackStatic Optional prepareOptional override for formatting stack traces
+ +https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+Static stackStatic captureGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional v1CasperVm: EntryPointV1Optional v2CasperVm: EntryPointV2Optional v1Optional v2Generated using TypeDoc
Represents an Era in the system. +An Era is a period of time in the blockchain, typically used for consensus and reward distribution.
+The numeric value of the Era.
+Static fromStatic fromJSONGenerated using TypeDoc
Static fromStatic fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional block: BlockIdentifierOptional era: numberOptional blockOptional eraGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Object to represent era specific information
-A StoredValue
The hash of the block when the era was encountered
-The id of the era
-The state root hash when the era was encountered
-Generated using TypeDoc
Generated using TypeDoc
Optional stackStatic Optional prepareOptional override for formatting stack traces
+ +https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+Static stackStatic captureGenerated using TypeDoc
Private eventsPrivate hasPrivate splitGenerated using TypeDoc
Private runGenerated using TypeDoc
Private maxPrivate scannerPrivate createGenerated using TypeDoc
Optional moduleOptional storedOptional storedOptional storedOptional storedOptional transferCasts the ExecutableDeployItem to ModuleBytes if possible
ModuleBytes representation of ExecutableDeployItem, or undefined if the ExecutableDeployItem cannot be cast
Static standardGenerated using TypeDoc
Generated using TypeDoc
Optional errorOptional originOptional originOptional paymentStatic fromJSONStatic fromGenerated using TypeDoc
Generated using TypeDoc
Optional failureOptional successGenerated using TypeDoc
Optional errorOptional paymentGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional blockOptional chainOptional originGenerated using TypeDoc
Static deserializeGenerated using TypeDoc
Generated using TypeDoc
Optional blockOptional chainGenerated using TypeDoc
Optional v1Optional v2Generated using TypeDoc
Optional finalityOptional finalityGenerated using TypeDoc
Generated using TypeDoc
Optional blockHash: stringOptional blockHeight: numberOptional stateRoot: stringOptional blockOptional blockOptional stateGenerated using TypeDoc
Abstract Static Readonly bip44Abstract deriveAbstract privateAbstract publicAbstract signAbstract verifyStatic bip44Static getStatic getStatic mnemonicStatic newStatic newStatic setStatic validateGenerated using TypeDoc
Casper HD Key for Ed25519.
-Examples
- const mn = Ed25519HDKey.newMnemonic();
const hdKey = Ed25519HDKey.fromMnemonic(mn);
const key0 = hdKey.deriveChild(0);
-Private hdStatic Readonly bip44Static bip44Static fromStatic getStatic getStatic mnemonicStatic newStatic newStatic newStatic setStatic validateGenerated using TypeDoc
Casper HD Key for Secp256K1.
-Examples
- const mn = Secp256K1HDKey.newMnemonic();
const hdKey = Secp256K1HDKey.fromMnemonic(mn);
const key0 = hdKey.deriveChild(0);
-Private hdStatic Readonly bip44Static bip44Static fromStatic getStatic getStatic mnemonicStatic newStatic newStatic newStatic setStatic validateGenerated using TypeDoc
Represents a cryptographic hash. +This class provides methods for creating, manipulating, and comparing hash values.
+Private hashStatic ByteThe length of the hash in bytes.
+Static StringThe length of the hash string representation in hexadecimal.
+Static createStatic fromStatic fromCreates a Hash from a byte array.
+ +A new Hash instance.
+ +Error if the byte array length is invalid.
+The byte array representing the hash.
+Static fromStatic fromJSONGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Private httpGenerated using TypeDoc
Optional stackStatic Optional prepareOptional override for formatting stack traces
+ +https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+Static stackStatic captureGenerated using TypeDoc
Optional client: AxiosInstancePrivate customPrivate endpointPrivate httpGenerated using TypeDoc
Private intPrivate isPrivate strStatic fromStatic fromJSONStatic fromGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Optional blockOptional blockGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional delegator: PublicKeyOptional eraIdentifier: EraIdentifierOptional delegatorOptional eraGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional nextGenerated using TypeDoc
Optional executionInfo: ExecutionInfoOptional executionStatic fromJSONGenerated using TypeDoc
Optional blockOptional blockOptional deployOptional executionOptional rawJSONOptional transactionStatic newGenerated using TypeDoc
Generated using TypeDoc
Optional publicKey: PublicKeyOptional accountHash: AccountHashOptional accountOptional publicStatic fromJSONGenerated using TypeDoc
Represents a Key that can identify different types of entities in the system.
+Optional accountOptional addressableOptional balanceOptional balanceOptional bidOptional bidOptional blockOptional byteOptional chainspecOptional checksumOptional deployOptional dictionaryOptional entryOptional eraOptional eraOptional hashOptional messageOptional namedOptional packageOptional systemOptional transferOptional uOptional unbondOptional withdrawStatic Private concatConcatenates the type and field bytes.
+ +A Uint8Array with concatenated type and field bytes.
+The bytes representing the type.
+The bytes representing the field.
+Static createCreates a Key instance based on the type ID and source string.
+ +A new Key instance.
+ +Error if the type is not found or invalid.
+The string containing the key data.
+The TypeID of the key.
+Static findFinds the prefix name by matching the source string with a map of prefixes.
+ +The matching PrefixName or undefined if not found.
+The string to check for a matching prefix.
+The map of prefix names to TypeID.
+Static fromCreates a Key instance from a byte array.
+ +A new Key instance.
+ +Error if deserialization fails.
+The byte array containing serialized key data.
+Static fromJSONStatic newStatic parseGenerated using TypeDoc
Abstract Public/private keypair object for representing an account
-Constructs an AsymmetricKey inherited object
An account's public key as a byte array
-An account's private key as a byte array
-The signature algorithm of the key. Currently supported are Ed25519 and Secp256k1
-Readonly privateReadonly publicReadonly signatureGets the hexadecimal public key of the account
- -The public key of the AsymmetricKey as a hexadecimal string
Indicates whether the public key should be checksummed, default: true
Abstract exportAbstract exportAbstract signProtected toAbstract verifyValidate the signature by comparing it to the provided message
- -true if the signature is valid, false otherwise
The signature as a byte array
-The original message to be validated
-Generated using TypeDoc
Constructs a new Ed25519 object from a SignKeyPair
An object containing the keys "publicKey" and "secretKey" with corresponding ByteArray values
Readonly privateReadonly publicReadonly signatureGets the hexadecimal public key of the account
- -The public key of the AsymmetricKey as a hexadecimal string
Indicates whether the public key should be checksummed, default: true
Protected toVerifies a signature given the signature and the original message
- -'true' if the message if valid, false otherwise
The signed message as a byte array
-The original message as a byte array
-Static accountStatic accountStatic loadStatic newStatic Private parseParses and validates a key in a certain range "from" to "to"
- -The parsed key
- -Error if the key is of an unexpected length
The key to be parsed and validated
-The starting index from which to parse the key
-The ending index from which to parse the key
-Static parseParse the key pair from a public key file and the corresponding private key file
- -A new AsymmetricKey
Path of public key file
-Path of private key file
-Static parseConstruct a keypair from a public key and corresponding private key
- -A new Ed25519 keypair
The public key of an Ed25519 account
-The private key of the same Ed25519 account
-Static parseStatic parseStatic parseStatic parseStatic privateDerive a public key from private key or seed phrase
- -A Uint8Array public key generated deterministically from the provided private key or seed phrase
Both secret keys and seed phrases may be used to derive the public key
-The private key or seed phrase from which to derive the public key
-Static Private readRead the Base64 content of a file, ignoring PEM frames
- -The result of readBase64WithPEM after reading in the content as a string with fs
The path to the PEM file
-Static readCalls global readBase64WithPEM and returns the result
- -The result of global readBase64WithPEM
A .pem private key string with a header and footer
-Generated using TypeDoc
Readonly privateReadonly publicReadonly signatureGets the hexadecimal public key of the account
- -The public key of the AsymmetricKey as a hexadecimal string
Indicates whether the public key should be checksummed, default: true
Protected toVerifies a signature given the signature and the original message
- -'true' if the message if valid, false otherwise
The signed message as a byte array
-The original message as a byte array
-Static accountStatic accountStatic loadRestore secp256k1 keyPair from private key file
- -A secp256k1 AsymmetricKey
The path to the private key file
-Static newStatic parseParse the key pair from a public key file and the corresponding private key file
- -A new Secp256K1 object
Path of public key file
-Path of private key file
-Static parseConstruct a keypair from a public key and corresponding private key
- -A new AsymmetricKey keypair
The public key of a secp256k1 account
-The private key of the same secp256k1 account
-Static parseParses a byte array containing a secp256k1 private key
- -A validated byte array containing the provided secp256k1 private key
-A private key as a byte array
-Optional originalFormat: "raw" | "der" = 'der'The original format of the private key. -Options are "der" or "raw", meaning "derived" or "raw", indicating a seed phrase and -a raw private key respectively.
-Static parseStatic parseParses a byte array containing an Ed25519 public key
- -A validated byte array containing the provided Ed25519 public key
-A public key in bytes
-Optional originalFormat: "raw" | "der" = 'der'The original format of the private key. -Options are "der" or "raw", meaning "derived" or "raw", indicating a seed phrase and -a raw private key respectively.
-Static parseStatic privateDerive a public key from private key
- -A Uint8Array public key generated deterministically from the provided private key
The private key from which to derive the public key
-Static Private readRead the Base64 content of a file, ignoring PEM frames
- -The result of readBase64WithPEM after reading in the content as a string with fs
The path to the PEM file
-Static readCalls global readBase64WithPEM and returns the result
- -The result of global readBase64WithPEM
A .pem private key string with a header and footer
-Generated using TypeDoc
Generated using TypeDoc
Represents a message address within the system, identified by an entity address, +a topic name hash, and an optional message index.
+Creates an instance of MessageAddr.
+The address of the associated entity.
+The hash of the topic name.
+Optional messageIndex: numberOptional index of the message.
+The address of the associated entity.
+Optional messageThe optional index of the message.
+The hash of the topic name.
+Static fromCreates a MessageAddr instance from a byte array.
+ +A new MessageAddr instance.
+The byte array representing the MessageAddr.
+Static fromCreates a MessageAddr instance from a string representation.
+ +A new MessageAddr instance.
+ +Error if the format is invalid.
+The string representation of the MessageAddr.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Static fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional blockIdentifier: BlockIdentifierOptional blockStatic byStatic byGenerated using TypeDoc
Optional deployHash: stringOptional finalizedApprovals: booleanOptional deployOptional finalizedGenerated using TypeDoc
Optional accountNamedKey: AccountNamedKeyOptional contractNamedKey: ParamDictionaryIdentifierContractNamedKeyOptional uRef: ParamDictionaryIdentifierURefOptional dictionary: stringOptional accountOptional contractOptional dictionaryOptional uGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional blockIdentifier: BlockIdentifierOptional blockGenerated using TypeDoc
Optional path: string[]Optional pathOptional stateStatic newOptional id: ParamQueryGlobalStateIDGenerated using TypeDoc
Generated using TypeDoc
Optional path: string[]Optional pathGenerated using TypeDoc
Optional transactionHash: TransactionHashOptional finalizedApprovals: booleanOptional finalizedOptional transactionGenerated using TypeDoc
Optional classicOptional fixedOptional reservedGenerated using TypeDoc
Generated using TypeDoc
Optional publicStatic fromJSONStatic fromGenerated using TypeDoc
Represents a public key with cryptographic algorithm and key data.
+The cryptographic algorithm used for the key.
+The key data associated with the public key.
+Generates an account hash for the public key.
+ +An AccountHash representing the account associated with this public key.
+Verifies a signature for a given message.
+ +A promise that resolves to a boolean indicating the validity of the signature.
+ +Error if the signature or public key is empty, or if the signature is invalid.
+The message to verify.
+The signature to verify.
+Static fromStatic fromCreates a PublicKey instance from a byte array.
+ +A new PublicKey instance.
+ +Error if the public key algorithm is invalid.
+The byte array.
+Static fromStatic fromJSONStatic newGenerated using TypeDoc
Generated using TypeDoc
Represents a list of public keys with utility methods for checking membership.
+Creates an instance of PublicKeyList.
+An optional array of PublicKey instances.
+Private keysGenerated using TypeDoc
Optional mainPurseUnderPublicKey: PublicKeyOptional mainPurseUnderAccountHash: AccountHashOptional mainPurseUnderEntityAddr: EntityAddrOptional purseUref: URefOptional mainOptional mainOptional mainOptional purseStatic fromStatic fromStatic fromStatic fromGenerated using TypeDoc
Generated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional stateIdentifier: GlobalStateIdentifierOptional stateGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional blockOptional rawJSONGenerated using TypeDoc
Optional blockGenerated using TypeDoc
Private parseGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Private handlerPrivate parsePrivate processGenerated using TypeDoc
Generated using TypeDoc
Optional idStatic defaultGenerated using TypeDoc
Optional errorOptional idGenerated using TypeDoc
Information about a seigniorage allocation
-Optional validator: ValidatorAllocationOptional delegator: DelegatorAllocationOptional DelegatorGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Private handlerOptional identifier: BlockIdentifierStatic newGenerated using TypeDoc
Optional blockIdentifier: BlockIdentifierOptional blockGenerated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Generated using TypeDoc
Optional rawJSONGenerated using TypeDoc
Optional purseURefGenerated using TypeDoc
Generated using TypeDoc
Optional dictionaryIdentifier: ParamDictionaryIdentifierOptional dictionaryGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional AccountOptional CLValueOptional ContractOptional ContractOptional ContractWASMOptional DeployOptional EraOptional TransferOptional accountOptional addressableOptional bidOptional bidOptional byteOptional clOptional contractOptional contractOptional contractWASMOptional deployOptional entryOptional eraOptional legacyOptional messageOptional messageOptional namedOptional packageOptional reservationOptional unbondingOptional withdrawGenerated using TypeDoc
Optional version: numberOptional versionGenerated using TypeDoc
Optional version: numberOptional versionGenerated using TypeDoc
Private blockedPrivate connectionPrivate eventPrivate streamPrivate addPrivate eventStatic defaultGenerated using TypeDoc
Static fromJSONGenerated using TypeDoc
Optional originTransactionV1: TransactionV1Optional originDeployV1: DeployPrivate Optional originPrivate Optional originStatic fromGenerated using TypeDoc
Static fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional custom: stringOptional transfer: Record<string, unknown>Optional addBid: Record<string, unknown>Optional withdrawBid: Record<string, unknown>Optional delegate: Record<string, unknown>Optional undelegate: Record<string, unknown>Optional redelegate: Record<string, unknown>Optional activateBid: Record<string, unknown>Optional changeBidPublicKey: Record<string, unknown>Optional call: Record<string, unknown>Optional activateOptional addOptional callOptional changeOptional customOptional delegateOptional redelegateOptional transferOptional undelegateOptional withdrawPrivate tagStatic fromJSONGenerated using TypeDoc
Optional message: stringOptional stackStatic Optional prepareOptional override for formatting stack traces
+ +https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+Static stackStatic captureGenerated using TypeDoc
Static deserializeGenerated using TypeDoc
Generated using TypeDoc
Optional deployOptional transactionGenerated using TypeDoc
Generated using TypeDoc
Optional byOptional byOptional byOptional byGenerated using TypeDoc
Static fromGenerated using TypeDoc
Generated using TypeDoc
Optional standard: objectOptional futureEra: FutureEraSchedulingOptional futureTimestamp: FutureTimestampSchedulingOptional futureOptional futureOptional standardStatic fromJSONGenerated using TypeDoc
Optional native: objectOptional stored: StoredTargetOptional session: SessionTargetOptional nativeOptional sessionOptional storedPrivate hexPrivate uint32Static fromJSONStatic newGenerated using TypeDoc
Private arrayStatic fromJSONConvert a JSON representation of a transactionV1 to a TransactionV1 object
A TransactionV1 object if successful, or throws an error if parsing fails
A JSON representation of a TransactionV1
Static makeStatic newStatic setSets already generated signature
+the TransactionV1 instance
+the Ed25519 or Secp256K1 signature
+the public key used to generate the signature
+Static toConvert the transactionV1 object to a JSON representation
+ +A JSON version of the TransactionV1, which can be converted back later
The TransactionV1 object to convert to JSON
Generated using TypeDoc
Static buildGenerated using TypeDoc
Static buildOptional bodyGenerated using TypeDoc
Optional deploy: DeployOptional transactionV1: TransactionV1Optional deployOptional transactionGenerated using TypeDoc
Optional idPrivate Optional originPrivate Optional originOptional toStatic fromJSONStatic Private fromGenerated using TypeDoc
Static newGenerated using TypeDoc
Represents a transfer hash, extending the Hash class, with an additional prefix for transfer entities.
+Creates an instance of TransferHash.
+A hex string or Uint8Array representing the hash.
+The origin prefix used to identify transfer-related hashes.
+Static ByteThe length of the hash in bytes.
+Static StringThe length of the hash string representation in hexadecimal.
+Static createStatic fromStatic fromCreates a Hash from a byte array.
+ +A new Hash instance.
+ +Error if the byte array length is invalid.
+The byte array representing the hash.
+Static fromStatic fromJSONCreates a TransferHash instance from a JSON string.
+ +A new TransferHash instance.
+The JSON string representing the TransferHash.
+Static Private initializeInitializes the TransferHash from a source string.
+ +An object containing the hash bytes and the origin prefix.
+The source string representing the transfer hash.
+Generated using TypeDoc
Optional idOptional toGenerated using TypeDoc
Optional idOptional toGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Private dataStatic fromJSONGenerated using TypeDoc
Represents an Unforgeable Reference (URef) with associated access permissions.
+Creates an instance of URef.
+ +Error if the data length is not equal to ByteHashLen.
The data (hash) of the URef.
+The access permissions for the URef.
+The access permissions for the URef.
+The data (hash) of the URef.
+Sets the access permissions for the URef.
+The new access permission to set.
+Static fromStatic fromCreates a URef from a byte array.
+ +A new URef instance.
+ +Error if the byte array length is invalid.
+The byte array representing the URef.
+Static fromJSONStatic fromGenerated using TypeDoc
Optional newGenerated using TypeDoc
Generated using TypeDoc
Optional vestingGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional idOptional toGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Can be fetched in /events/main path
Can be fetched in /events/deploys path
Can be fetched in /events/main path
Can be fetched in /events/sigs path
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Convert a contract hash hexadecimal string to a byte array
- -Uint8Array representation of the contract hash
Hexadecimal string of a contract hash, without the "hash-" prefix
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Returns duration in milliseconds
- -The time-to-live in milliseconds
-Human-readable string generated by humanizerTTL
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Convert the deploy object to a JSON representation
- -A JSON version of the Deploy, which can be converted back later
The Deploy object to convert to JSON
Generated using TypeDoc
Generated using TypeDoc
Builds a Deploy object from DeployParams, session logic, and payment logic
A new Deploy object
The parameters of the deploy, see DeployParams
-The session logic of the deploy
-The payment logic of the deploy
-Generated using TypeDoc
Builds a Deploy object from DeployParams, session logic, and payment logic.
-If there is no timestamp in DeployParams it fetches it from the TimeService.
-Recommened to use in browser environment.
A new Deploy object
The parameters of the deploy, see DeployParams
-The session logic of the deploy
-The payment logic of the deploy
-Generated using TypeDoc
Serializes an array of Approvals into a Uint8Array typed byte array
Uint8Array typed byte array that can be deserialized to an array of Approvals
An array of Approvals to be serialized
Generated using TypeDoc
Serializes the body of a deploy into an array of bytes
- -Uint8Array typed byte array, containing the payment and session logic of a deploy
Payment logic for use in a deployment
-Session logic of a deploy
-Generated using TypeDoc
Serializes a DeployHeader into an array of bytes
A serialized representation of the provided DeployHeader
Generated using TypeDoc
Sets the algorithm of the already generated signature
-A Deploy to be signed with sig
the Ed25519 or Secp256K1 signature
-the public key used to generate the signature
-Generated using TypeDoc
Uses the provided key pair to sign the Deploy message
-Either an unsigned Deploy object or one with other signatures
The keypair used to sign the Deploy
Generated using TypeDoc
Creates an instance of standard payment logic
- -A standard payment, as an ExecutableDeployItem to be attached to a Deploy
The amount of motes to be used to pay for gas
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Reads in a base64 private key, ignoring the header: -----BEGIN PUBLIC KEY-----
-and footer: -----END PUBLIC KEY-----
A base64 private key as a Uint8Array
If the provided base64 content string does not include a header/footer,
-it will pass through this function unaffected
Example PEM:
------BEGIN PUBLIC KEY-----\r\n
MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEj1fgdbpNbt06EY/8C+wbBXq6VvG+vCVD\r\n
Nl74LvVAmXfpdzCWFKbdrnIlX3EFDxkd9qpk35F/kLcqV3rDn/u3dg==\r\n
-----END PUBLIC KEY-----\r\n
-A .pem private key string with a header and footer
-Generated using TypeDoc
Generated using TypeDoc
Parse a set of Results, returning an array of all Ok values.
-Short circuits with the first Err found, if any
Rest ...results: TGenerated using TypeDoc
Parse a set of Results, short-circuits when an input value is Ok.
-If no Ok is found, returns an Err containing the collected error values
Rest ...results: TGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Wrap an async operation that may throw an Error (try-catch style) into checked exception style
The operation function
-Generated using TypeDoc
Combine multiple arguments.
-so, what you want to send isVec(PublicKey, u64):
-• PublicKey serializes tobyte array of the key,
-• u64 serializes to8 byte array,
so, what we have is(for example):
- Vec([32, 0, 0, 0, {public key bytes}], [1, 2, 3, 4, 0, 0, 0, 0])
Which gives us:
-[2, 0, 0, 0 - for the number of elements in the external vector
-32, 0, 0, 0, 1, 1, … - public key
-8, 0, 0, 0, - for the number of bytes in the second element of the vector.
-That was serialized u64 ([1, 2, 3, 4, 0, 0, 0, 0])
-1, 2, 3, 4, 0, 0, 0, 0]
Rest ...args: Uint8Array[]Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Serialize public key
-A public key is the same as array but it's expected to be 32 bytes long exactly.
-It's [u8; 32] (32 element byte array) but serializes to (32.toBytes() ++ array.toBytes())
-We serialize 32(literally, number 32) to 4 bytes instead of 1 byte, little endianness.
-This is how111..11 public key looks like when serialized:
-[32, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
Generated using TypeDoc
Generated using TypeDoc
Initiates a request to create a new vault within the Signer
- -A Promise that resolves to void
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
The password of the new vault
-Generated using TypeDoc
Initiates a request to create a test account within the Signer
- -A Promise that resolves to void
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
The name of the test account
-The private key of the new test account
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Retrieve the active public key.
- -Hex-encoded public key with algorithm prefix, where 01 indicates an Ed25519 key and 02 indicates Secp256k1
- -Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
Generated using TypeDoc
Gets the public key currently selected in the Signer in base64 format
- -in favour of getActivePublicKey.
- -Promise that resolves to a base64 encoded public key string of the currently selected account
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Query the Signer to check if the user has created a vault
- -A Promise that resolves to a boolean indicating whether the user has or hasn't created a vault
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Send Deploy in JSON format to Signer extension to be signed.
- -A signed JSON deploy object
- -Errors if the Signer extension is not connected.
- -Errors if signingPublicKeyHex is not available or does not match the Active Key in the Signer.
- -Errors if targetPublicKeyHex is not the same as the key (or corresponding account hash) that is used as target in deploy.
-A deploy in JSON format
-Hex-formatted public key. The corresponding secret key is used to sign the deploy.
-Optional targetPublicKeyHex: stringHex-formatted target public key.
-If the target in the deploy is an account hash this can be used to verify it and display the hex-formatted public key in the UI.
Generated using TypeDoc
Initiates a signature request with the Signer. Used for signing messages
- -A Promise that resolves to the signed message
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
The message to sign
-The public key of the signing account
-Generated using TypeDoc
Sign a test deploy with a given id (nonce)
- -A Promise that resolves to void
Error if the JavaScript client isn't connected to the CasperLabs Signer browser extension
The transaction id
-Generated using TypeDoc
Generated using TypeDoc
Converts an ArrayBuffer containing a byte representation of a BigNumber back to a BigNumber.
+The input ArrayBuffer should have the following structure:
+The BigNumber reconstructed from the byte representation.
+ +const buffer = new Uint8Array([4, 7, 91, 205, 21]).buffer;
const bigNum = bigFromBuffer(buffer);
console.log(bigNum.toString()); // '123456789'
+The ArrayBuffer containing the byte representation of a BigNumber.
+Generated using TypeDoc
Converts a BigNumber to a Uint8Array representation.
+The resulting Uint8Array has the following structure:
+A Uint8Array representation of the BigNumber.
+ +const bigNum = BigNumber.from('123456789');
const bytes = bigToBytes(bigNum);
console.log(bytes); // Uint8Array [ 4, 7, 91, 205, 21 ]
+The BigNumber to convert.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Validates and returns the BalanceHoldAddrTag for a given tag number.
+ +The corresponding BalanceHoldAddrTag.
+ +BalanceHoldAddrTagError if the tag is invalid.
+The tag number to validate.
+Generated using TypeDoc
Validates and returns the BlockGlobalAddrTag for a given tag number.
+ +The corresponding BlockGlobalAddrTag.
+ +BlockGlobalAddrTagError if the tag is invalid.
+The tag number to validate.
+Generated using TypeDoc
Validates and returns the EntryPointTag for a given tag number.
+ +The corresponding EntryPointTag.
+ +EntryPointError if the tag is invalid.
+The tag number to validate.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Use Deploy.fromHeaderAndItems
+Builds a Deploy object from DeployParams, session logic, and payment logic
A new Deploy object
The parameters of the deploy, see DeployParams
+The session logic of the deploy
+The payment logic of the deploy
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Convert an amount in motes to its CSPR equivalent
- -A BigNumber containing the CSPR amount
Note that this function will round to the nearest whole integer -1 mote = 10^-9 CSPR
-A BigNumberish amount of motes to convert to the CSPR equivalent
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional arg2: Uint8ArrayGenerated using TypeDoc
Serializes an array of Approvals into a Uint8Array typed byte array
Uint8Array typed byte array that can be deserialized to an array of Approvals
An array of Approvals to be serialized
Generated using TypeDoc
Generated using TypeDoc
Method for signing formatted message in bytes format.
- -Uint8Array Signature in byte format
-AsymmetricKey used to sign the message
-Bytes of the formatted message. (Strings can be formatted using the formatMessageWithHeaders() method)
Generated using TypeDoc
Method for signing string message.
- -Uint8Array Signature in byte format
-AsymmetricKey used to sign the message
-Message that will be signed
-Generated using TypeDoc
Splits the array at a given index.
+ +A new Uint8Array from the start to index i.
+ +Error if the index is out of bounds.
+The index to split the array.
+The Uint8Array to split.
+Generated using TypeDoc
Creates an instance of standard payment logic
+ +Use {ExecutableDeployItem.standardPayment} instead
+ +A standard payment, as an ExecutableDeployItem to be attached to a Deploy
The amount of motes to be used to pay for gas
+Generated using TypeDoc
Method to verify signature
- -boolean Verification result
-Public key of private key used to signed.
-Message that was signed
-Signature in byte format
-Generated using TypeDoc
Please see v2-v3 migration guide.
+Generated using TypeDoc
Generated using TypeDoc
Interface describing a validator auction bid
-Generated using TypeDoc
Interface describing auction bidding information
-Generated using TypeDoc
The status of the block synchronizer.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Result interface for a account_put_deploy call
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Result interface for an execution result body
-Optional error_Generated using TypeDoc
RPC result interface
-Hex-encoded raw bytes of the current chainspec.toml file.
-Hex-encoded raw bytes of the current genesis accounts.toml file.
-Hex-encoded raw bytes of the current global_state.toml file.
-Generated using TypeDoc
Result interface for a get-deploy call
-Generated using TypeDoc
A peers result interface defining peers as an array of Peers
Generated using TypeDoc
Result interface for a get-state-root-hash call
-Generated using TypeDoc
Result interface for a get-status call
-The available block range in storage.
-The inclusive upper bound of the range.
-The inclusive lower bound of the range.
-The status of syncing a forward block, if any.
-The compiled node version.
-The chainspec name.
-The minimal info of the last block from the linear chain.
-Timestamp of the last recorded progress in the reactor.
-Information about the next scheduled upgrade.
-Our public signing key.
-casper-node 1.5
-The next round length if this node is a validator.
-The state root hash of the lowest block in the available block range.
-Time that passed since the node has started.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface describing a JSON represented deploy
-Generated using TypeDoc
JSON deploy header interface that acts as a schema for JSON deploy headers
-Generated using TypeDoc
Interface describing a JSON ExecutableDeployItem
-Optional ModuleOptional StoredOptional StoredOptional StoredOptional StoredOptional TransferGenerated using TypeDoc
Interface describing a JSON represented deploy header
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface for information on the most recently appended block on the network
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Util methods for making Deploy message
-Generated using TypeDoc
Generated using TypeDoc
Used to represent account keypairs
-Generated using TypeDoc
Generated using TypeDoc
Functions to convert data to the FFI
-Generated using TypeDoc
Provide methods to communicate with CasperLabs Signer Extension. -Works only on browser.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Type alias for the string representation of a type name.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
from account hash
-source uref
-target uref
-to account hash, null if the target is URef
Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Length of a URef hash in bytes.
+Generated using TypeDoc
Const Represents an Any type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a Boolean type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 32-bit signed integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 64-bit signed integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a Key type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a PublicKey type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a String type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 128-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 256-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 32-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 512-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a 64-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents an 8-bit unsigned integer type in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a Unit type (similar to void) in the CasperLabs type system.
+Generated using TypeDoc
Const Represents a URef (Unforgeable Reference) type in the CasperLabs type system.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Error thrown when the URef format is incorrect.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Error thrown when the BidAddr format is invalid.
+Generated using TypeDoc
Const Error thrown when an invalid BidAddrTag is encountered.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Error thrown when the EntityAddr format is invalid.
+Generated using TypeDoc
Const Error thrown when the EntityKind is invalid.
+Generated using TypeDoc
Const Error thrown when the JSON format for a Result type is invalid.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Error thrown when an unexpected BidAddrTag is found in a BidAddr.
+Generated using TypeDoc
Const Error thrown when an unsupported CLType is encountered.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const The size of a 32-bit integer in bytes.
+Generated using TypeDoc
Const The size of a 64-bit integer in bytes.
+Generated using TypeDoc
Const Default byte length for keys.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Error thrown when there's an issue parsing the Map type from JSON.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Prefix for transfer hashes in TransferHash.
+Generated using TypeDoc
Const Prefix for URef strings.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Object containing string constants for type names in the CasperLabs type system.
+Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
The status of syncing an individual block.
-