ClassSDK

Index

Constructors

Methods

account_put_deploy account_put_transaction call_entrypoint call_entrypoint_deploy chain_get_block chain_get_block_transfers chain_get_era_info_by_switch_block chain_get_era_summary chain_get_state_root_hash deploy free get_account get_account_options get_auction_info get_auction_info_options get_balance get_balance_options get_block get_block_options get_block_transfers get_block_transfers_options get_chainspec get_deploy get_deploy_options get_dictionary_item get_dictionary_item_options get_entity get_entity_options get_era_info get_era_info_options get_era_summary get_era_summary_options get_node_status get_peers get_speculative_exec_deploy_options get_speculative_exec_options get_state_root_hash get_state_root_hash_options get_transaction get_transaction_options get_validator_changes getRPCAddress getVerbosity info_get_chainspec info_get_deploy info_get_peers info_get_status info_get_transaction info_get_validator_change install install_deploy list_rpcs make_deploy make_transaction make_transfer make_transfer_transaction put_deploy put_transaction query_balance query_balance_details query_balance_details_options query_balance_options query_contract_dict query_contract_dict_options query_contract_key query_contract_key_options query_global_state query_global_state_options setRPCAddress setVerbosity sign_deploy sign_transaction speculative_deploy speculative_exec speculative_exec_deploy speculative_transaction speculative_transfer speculative_transfer_transaction state_get_account_info state_get_auction_info_js_alias state_get_balance state_get_dictionary_item state_get_entity transaction transfer transfer_transaction waitDeploy waitTransaction watchDeploy watchTransaction

Constructors

constructor

new SDK(rpc_address?, verbosity?): SDK
Parameters
- Optionalrpc_address: string
- Optionalverbosity: Verbosity
Returns SDK
- Defined in casper_rust_wasm_sdk.d.ts:2804

Methods

account_put_deploy

account_put_deploy(deploy, verbosity?, rpc_address?): Promise<PutDeployResult>
JavaScript Alias for put_deploy.
Parameters
- deploy: Deploy
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2635

account_put_transaction

account_put_transaction(transaction, verbosity?, rpc_address?): Promise<PutTransactionResult>
JavaScript Alias for put_transaction.
Parameters
- transaction: Transaction
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:3344

call_entrypoint

call_entrypoint(builder_params, transaction_params, rpc_address?): Promise<PutTransactionResult>
Calls a smart contract entry point with the specified parameters and returns the result.

Arguments
- transaction_params - Transaction parameters.
- builder_params - Transaction Builder parameters.
- rpc_address - An optional rpc address to send the request to.
Returns
A Result containing either a PutTransactionResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the call.
Parameters
- builder_params: TransactionBuilderParams
- transaction_params: TransactionStrParams
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:2844

call_entrypoint_deploy

call_entrypoint_deploy(deploy_params, session_params, payment_amount, rpc_address?): Promise<PutDeployResult>
Calls a smart contract entry point with the specified parameters and returns the result.

Arguments
- deploy_params - The deploy parameters.
- session_params - The session parameters.
- payment_amount - The payment amount as a string.
- rpc_address - An optional rpc address to send the request to.
Returns
A Result containing either a PutDeployResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the call.
Parameters
- deploy_params: DeployStrParams
- session_params: SessionStrParams
- payment_amount: string
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:3212

chain_get_block

chain_get_block(options?): Promise<GetBlockResult>
JavaScript Alias for the get_block.

Arguments
- options - An optional GetBlockOptions struct containing retrieval options.
Returns
A Result containing either a GetBlockResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getBlockOptions
Returns Promise<GetBlockResult>
- Defined in casper_rust_wasm_sdk.d.ts:2320

chain_get_block_transfers

chain_get_block_transfers(options?): Promise<GetBlockTransfersResult>
Parameters
- Optionaloptions: getBlockTransfersOptions
Returns Promise<GetBlockTransfersResult>
- Defined in casper_rust_wasm_sdk.d.ts:2964

chain_get_era_info_by_switch_block

chain_get_era_info_by_switch_block(options?): Promise<GetEraInfoResult>
Parameters
- Optionaloptions: getEraInfoOptions
Returns Promise<GetEraInfoResult>
- Defined in casper_rust_wasm_sdk.d.ts:2151

chain_get_era_summary

chain_get_era_summary(options?): Promise<GetEraSummaryResult>
Parameters
- Optionaloptions: getEraSummaryOptions
Returns Promise<GetEraSummaryResult>
- Defined in casper_rust_wasm_sdk.d.ts:2188

chain_get_state_root_hash

chain_get_state_root_hash(options?): Promise<GetStateRootHashResult>
Retrieves state root hash information using the provided options (alias for get_state_root_hash).

Arguments
- options - An optional GetStateRootHashOptions struct containing retrieval options.
Returns
A Result containing either a GetStateRootHashResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getStateRootHashOptions
Returns Promise<GetStateRootHashResult>
- Defined in casper_rust_wasm_sdk.d.ts:2605

deploy

deploy(deploy_params, session_params, payment_params, verbosity?, rpc_address?): Promise<PutDeployResult>
JavaScript function for deploying with deserialized parameters.

Arguments
- deploy_params - Deploy parameters.
- session_params - Session parameters.
- payment_params - Payment parameters.
- verbosity - An optional verbosity level.
- rpc_address - An optional rpc address.
Returns
A result containing PutDeployResult or a JsError.
Parameters
- deploy_params: DeployStrParams
- session_params: SessionStrParams
- payment_params: PaymentStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2890

free

free(): void
Returns void
- Defined in casper_rust_wasm_sdk.d.ts:2072

get_account

get_account(options?): Promise<GetAccountResult>
Retrieves account information using the provided options.

This function is an asynchronous JavaScript binding for the Rust get_account method.

Arguments
- options - An optional GetAccountOptions struct containing retrieval options, such as:
  - account_identifier: Identifier for the account.
  - account_identifier_as_string: String representation of the account identifier.
  - maybe_block_id_as_string: Optional string representation of the block ID.
  - maybe_block_identifier: Optional BlockIdentifierInput for specifying the block.
  - verbosity: Verbosity level for the output.
  - rpc_address: Address of the node to query.
Returns
A Result containing either a GetAccountResult on success or a JsError on failure.

Errors
Returns a JsError if there is an error during the retrieval process, such as issues with the provided options or network errors.
```
@param {getAccountOptions | undefined} [options]
@returns {Promise<GetAccountResult
```
Parameters
- Optionaloptions: getAccountOptions
Returns Promise<GetAccountResult>
- Defined in casper_rust_wasm_sdk.d.ts:2922

get_account_options

get_account_options(options): getAccountOptions
Parameters
- options: any
Returns getAccountOptions
- Defined in casper_rust_wasm_sdk.d.ts:2895

get_auction_info

get_auction_info(options?): Promise<GetAuctionInfoResult>
Retrieves auction information using the provided options.

Arguments
- options - An optional GetAuctionInfoOptions struct containing retrieval options.
Returns
A Result containing either a GetAuctionInfoResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getAuctionInfoOptions
Returns Promise<GetAuctionInfoResult>
- Defined in casper_rust_wasm_sdk.d.ts:2265

get_auction_info_options

get_auction_info_options(options): getAuctionInfoOptions
Parses auction info options from a JsValue.

Arguments
- options - A JsValue containing auction info options to be parsed.
Returns
Result containing parsed auction info options as a GetAuctionInfoOptions struct, or a JsError if deserialization fails.
Parameters
- options: any
Returns getAuctionInfoOptions
- Defined in casper_rust_wasm_sdk.d.ts:2247

get_balance

get_balance(options?): Promise<GetBalanceResult>
Retrieves balance information using the provided options.

Arguments
- options - An optional GetBalanceOptions struct containing retrieval options.
Returns
A Result containing either a GetBalanceResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getBalanceOptions
Returns Promise<GetBalanceResult>
- Defined in casper_rust_wasm_sdk.d.ts:2541

get_balance_options

get_balance_options(options): getBalanceOptions
Parses balance options from a JsValue.

Arguments
- options - A JsValue containing balance options to be parsed.
Returns
Parsed balance options as a GetBalanceOptions struct.
Parameters
- options: any
Returns getBalanceOptions
- Defined in casper_rust_wasm_sdk.d.ts:2523

get_block

get_block(options?): Promise<GetBlockResult>
Retrieves block information using the provided options.

Arguments
- options - An optional GetBlockOptions struct containing retrieval options.
Returns
A Result containing either a GetBlockResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getBlockOptions
Returns Promise<GetBlockResult>
- Defined in casper_rust_wasm_sdk.d.ts:2302

get_block_options

get_block_options(options): getBlockOptions
Parses block options from a JsValue.

Arguments
- options - A JsValue containing block options to be parsed.
Returns
Parsed block options as a GetBlockOptions struct.
Parameters
- options: any
Returns getBlockOptions
- Defined in casper_rust_wasm_sdk.d.ts:2284

get_block_transfers

get_block_transfers(options?): Promise<GetBlockTransfersResult>
Retrieves block transfers information using the provided options.

Arguments
- options - An optional GetBlockTransfersOptions struct containing retrieval options.
Returns
A Result containing either a GetBlockTransfersResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getBlockTransfersOptions
Returns Promise<GetBlockTransfersResult>
- Defined in casper_rust_wasm_sdk.d.ts:2959

get_block_transfers_options

get_block_transfers_options(options): getBlockTransfersOptions
Parses block transfers options from a JsValue.

Arguments
- options - A JsValue containing block transfers options to be parsed.
Returns
Parsed block transfers options as a GetBlockTransfersOptions struct.
Parameters
- options: any
Returns getBlockTransfersOptions
- Defined in casper_rust_wasm_sdk.d.ts:2941

get_chainspec

get_chainspec(verbosity?, rpc_address?): Promise<GetChainspecResult>
Asynchronously retrieves the chainspec.

Arguments
- verbosity - An optional Verbosity parameter.
- rpc_address - An optional rpc address as a string.
Returns
A Result containing either a GetChainspecResult or a JsError in case of an error.
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetChainspecResult>
- Defined in casper_rust_wasm_sdk.d.ts:2980

get_deploy

get_deploy(options?): Promise<GetDeployResult>
Retrieves deploy information using the provided options.

Arguments
- options - An optional GetDeployOptions struct containing retrieval options.
Returns
A Result containing either a GetDeployResult or an error.
Parameters
- Optionaloptions: getDeployOptions
Returns Promise<GetDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2348

get_deploy_options

get_deploy_options(options): getDeployOptions
Parses deploy options from a JsValue.

Arguments
- options - A JsValue containing deploy options to be parsed.
Returns
Parsed deploy options as a GetDeployOptions struct.
Parameters
- options: any
Returns getDeployOptions
- Defined in casper_rust_wasm_sdk.d.ts:2334

get_dictionary_item

get_dictionary_item(options?): Promise<GetDictionaryItemResult>
Retrieves dictionary item information using the provided options.

Arguments
- options - An optional GetDictionaryItemOptions struct containing retrieval options.
Returns
A Result containing either a GetDictionaryItemResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getDictionaryItemOptions
Returns Promise<GetDictionaryItemResult>
- Defined in casper_rust_wasm_sdk.d.ts:2130

get_dictionary_item_options

get_dictionary_item_options(options): getDictionaryItemOptions
Parses dictionary item options from a JsValue.

Arguments
- options - A JsValue containing dictionary item options to be parsed.
Returns
Parsed dictionary item options as a GetDictionaryItemOptions struct.
Parameters
- options: any
Returns getDictionaryItemOptions
- Defined in casper_rust_wasm_sdk.d.ts:2112

get_entity

get_entity(options?): Promise<GetAddressableEntityResult>
Retrieves entity information using the provided options.

This function is an asynchronous JavaScript binding for the Rust get_entity method.

Arguments
- options - An optional GetEntityOptions struct containing retrieval options, such as:
  - entity_identifier: Identifier for the entity.
  - entity_identifier_as_string: String representation of the entity identifier.
  - maybe_block_id_as_string: Optional string representation of the block ID.
  - maybe_block_identifier: Optional BlockIdentifierInput for specifying the block.
  - verbosity: Verbosity level for the output.
  - rpc_address: Address of the node to query.
Returns
A Result containing either a GetAddressableEntityResult on success or a JsError on failure.

Errors
Returns a JsError if there is an error during the retrieval process, such as issues with the provided options or network errors.
```
@param {getEntityOptions | undefined} [options]
@returns {Promise<GetAddressableEntityResult
```
Parameters
- Optionaloptions: getEntityOptions
Returns Promise<GetAddressableEntityResult>
- Defined in casper_rust_wasm_sdk.d.ts:2386

get_entity_options

get_entity_options(options): getEntityOptions
Parameters
- options: any
Returns getEntityOptions
- Defined in casper_rust_wasm_sdk.d.ts:2359

get_era_info

get_era_info(options?): Promise<GetEraInfoResult>
Parameters
- Optionaloptions: getEraInfoOptions
Returns Promise<GetEraInfoResult>
- Defined in casper_rust_wasm_sdk.d.ts:2146

get_era_info_options

get_era_info_options(options): getEraInfoOptions
Parameters
- options: any
Returns getEraInfoOptions
- Defined in casper_rust_wasm_sdk.d.ts:2141

get_era_summary

get_era_summary(options?): Promise<GetEraSummaryResult>
Retrieves era summary information using the provided options.

Arguments
- options - An optional GetEraSummaryOptions struct containing retrieval options.
Returns
A Result containing either a GetEraSummaryResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getEraSummaryOptions
Returns Promise<GetEraSummaryResult>
- Defined in casper_rust_wasm_sdk.d.ts:2183

get_era_summary_options

get_era_summary_options(options): getEraSummaryOptions
Parses era summary options from a JsValue.

Arguments
- options - A JsValue containing era summary options to be parsed.
Returns
Parsed era summary options as a GetEraSummaryOptions struct.
Parameters
- options: any
Returns getEraSummaryOptions
- Defined in casper_rust_wasm_sdk.d.ts:2165

get_node_status

get_node_status(verbosity?, rpc_address?): Promise<GetNodeStatusResult>
Retrieves node status information using the provided options.

Arguments
- verbosity - An optional Verbosity level for controlling the output verbosity.
- rpc_address - An optional string specifying the rpc address to use for the request.
Returns
A Result containing either a GetNodeStatusResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetNodeStatusResult>
- Defined in casper_rust_wasm_sdk.d.ts:2092

get_peers

get_peers(verbosity?, rpc_address?): Promise<GetPeersResult>
Retrieves peers asynchronously.

Arguments
- verbosity - Optional verbosity level.
- rpc_address - Optional rpc address.
Returns
A Result containing GetPeersResult or a JsError if an error occurs.
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetPeersResult>
- Defined in casper_rust_wasm_sdk.d.ts:2407

get_speculative_exec_deploy_options

get_speculative_exec_deploy_options(options): getSpeculativeExecDeployOptions
Get options for speculative execution from a JavaScript value.
Parameters
- options: any
Returns getSpeculativeExecDeployOptions
- Defined in casper_rust_wasm_sdk.d.ts:3070

get_speculative_exec_options

get_speculative_exec_options(options): getSpeculativeExecTxnOptions
Get options for speculative execution from a JavaScript value.
Parameters
- options: any
Returns getSpeculativeExecTxnOptions
- Defined in casper_rust_wasm_sdk.d.ts:2453

get_state_root_hash

get_state_root_hash(options?): Promise<GetStateRootHashResult>
Retrieves state root hash information using the provided options.

Arguments
- options - An optional GetStateRootHashOptions struct containing retrieval options.
Returns
A Result containing either a GetStateRootHashResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: getStateRootHashOptions
Returns Promise<GetStateRootHashResult>
- Defined in casper_rust_wasm_sdk.d.ts:2587

get_state_root_hash_options

get_state_root_hash_options(options): getStateRootHashOptions
Parses state root hash options from a JsValue.

Arguments
- options - A JsValue containing state root hash options to be parsed.
Returns
Parsed state root hash options as a GetStateRootHashOptions struct.
Parameters
- options: any
Returns getStateRootHashOptions
- Defined in casper_rust_wasm_sdk.d.ts:2569

get_transaction

get_transaction(options?): Promise<GetTransactionResult>
Retrieves transaction information using the provided options.

Arguments
- options - An optional GetTransactionOptions struct containing retrieval options.
Returns
A Result containing either a GetTransactionResult or an error.
Parameters
- Optionaloptions: getTransactionOptions
Returns Promise<GetTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:2441

get_transaction_options

get_transaction_options(options): getTransactionOptions
Parses transaction options from a JsValue.

Arguments
- options - A JsValue containing transaction options to be parsed.
Returns
Parsed transaction options as a GetTransactionOptions struct.
Parameters
- options: any
Returns getTransactionOptions
- Defined in casper_rust_wasm_sdk.d.ts:2427

get_validator_changes

get_validator_changes(verbosity?, rpc_address?): Promise<GetValidatorChangesResult>
Retrieves validator changes using the provided options.

Arguments
- verbosity - An optional Verbosity level for controlling the output verbosity.
- rpc_address - An optional string specifying the rpc address to use for the request.
Returns
A Result containing either a GetValidatorChangesResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetValidatorChangesResult>
- Defined in casper_rust_wasm_sdk.d.ts:3006

getRPCAddress

getRPCAddress(rpc_address?): string
Parameters
- Optionalrpc_address: string
Returns string
- Defined in casper_rust_wasm_sdk.d.ts:2809

getVerbosity

getVerbosity(verbosity?): Verbosity
Parameters
- Optionalverbosity: Verbosity
Returns Verbosity
- Defined in casper_rust_wasm_sdk.d.ts:2818

info_get_chainspec

info_get_chainspec(verbosity?, rpc_address?): Promise<GetChainspecResult>
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetChainspecResult>
- Defined in casper_rust_wasm_sdk.d.ts:2986

info_get_deploy

info_get_deploy(options?): Promise<GetDeployResult>
Retrieves deploy information using the provided options, alias for get_deploy.
Parameters
- Optionaloptions: getDeployOptions
Returns Promise<GetDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2354

info_get_peers

info_get_peers(verbosity?, rpc_address?): Promise<GetPeersResult>
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetPeersResult>
- Defined in casper_rust_wasm_sdk.d.ts:2413

info_get_status

info_get_status(verbosity?, rpc_address?): Promise<GetNodeStatusResult>
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetNodeStatusResult>
- Defined in casper_rust_wasm_sdk.d.ts:2098

info_get_transaction

info_get_transaction(options?): Promise<GetTransactionResult>
Retrieves transaction information using the provided options, alias for get_transaction.
Parameters
- Optionaloptions: getTransactionOptions
Returns Promise<GetTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:2447

info_get_validator_change

info_get_validator_change(verbosity?, rpc_address?): Promise<GetValidatorChangesResult>
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<GetValidatorChangesResult>
- Defined in casper_rust_wasm_sdk.d.ts:3012

install

install(transaction_params, transaction_bytes, rpc_address?): Promise<PutTransactionResult>
Installs a smart contract with the specified parameters and returns the result.

Arguments
.
- transaction_params - Transaction parameters.
- transaction_bytes - Transaction Bytes to install
- rpc_address - An optional rpc address to send the request to.
Returns
A Result containing either a PutTransactionResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the installation.
Parameters
- transaction_params: TransactionStrParams
- transaction_bytes: Bytes
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:2799

install_deploy

install_deploy(deploy_params, session_params, payment_amount, rpc_address?): Promise<PutDeployResult>
Installs a smart contract with the specified parameters and returns the result.

Arguments
- deploy_params - The deploy parameters.
- session_params - The session parameters.
- payment_amount - The payment amount as a string.
- rpc_address - An optional rpc address to send the request to.
Returns
A Result containing either a PutDeployResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the installation.
Parameters
- deploy_params: DeployStrParams
- session_params: SessionStrParams
- payment_amount: string
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2868

list_rpcs

list_rpcs(verbosity?, rpc_address?): Promise<ListRpcsResult>
Lists available RPCs using the provided options.

Arguments
- verbosity - An optional Verbosity level for controlling the output verbosity.
- rpc_address - An optional string specifying the rpc address to use for the request.
Returns
A Result containing either a ListRpcsResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the listing process.
Parameters
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<ListRpcsResult>
- Defined in casper_rust_wasm_sdk.d.ts:3032

make_deploy

make_deploy(deploy_params, session_params, payment_params): Deploy
JS function for make_deploy.

Arguments
- deploy_params - The deploy parameters.
- session_params - The session parameters.
- payment_params - The payment parameters.
Returns
A Result containing the created Deploy or a JsError in case of an error.
Parameters
- deploy_params: DeployStrParams
- session_params: SessionStrParams
- payment_params: PaymentStrParams
Returns Deploy
- Defined in casper_rust_wasm_sdk.d.ts:3128

make_transaction

make_transaction(builder_params, transaction_params): Transaction
JS function for make_transaction.

Arguments
- builder_params - Transaction Builder parameters.
- transaction_params - The transaction parameters.
Returns
A Result containing the created Transaction or a JsError in case of an error.
Parameters
- builder_params: TransactionBuilderParams
- transaction_params: TransactionStrParams
Returns Transaction
- Defined in casper_rust_wasm_sdk.d.ts:3166

make_transfer

make_transfer(amount, target_account, transfer_id, deploy_params, payment_params): Deploy
JS function for make_transfer.

Arguments
- amount - The transfer amount.
- target_account - The target account.
- transfer_id - Optional transfer identifier.
- deploy_params - The deploy parameters.
- payment_params - The payment parameters.
Returns
A Result containing the created Deploy or a JsError in case of an error.
Parameters
- amount: string
- target_account: string
- transfer_id: string
- deploy_params: DeployStrParams
- payment_params: PaymentStrParams
Returns Deploy
- Defined in casper_rust_wasm_sdk.d.ts:3150

make_transfer_transaction

make_transfer_transaction(maybe_source, target, amount, transaction_params, maybe_id?): Transaction
JS function for make_transfer_transaction.

Arguments
- maybe_source - Optional transfer source uref.
- amount - The transfer amount.
- target - The target account.
- transaction_params - The transaction parameters.
- maybe_id - Optional transfer identifier.
Returns
A Result containing the created Transaction or a JsError in case of an error.
Parameters
- maybe_source: URef
- target: string
- amount: string
- transaction_params: TransactionStrParams
- Optionalmaybe_id: string
Returns Transaction
- Defined in casper_rust_wasm_sdk.d.ts:3188

put_deploy

put_deploy(deploy, verbosity?, rpc_address?): Promise<PutDeployResult>
Puts a deploy using the provided options.

Arguments
- deploy - The Deploy object to be sent.
- verbosity - An optional Verbosity level for controlling the output verbosity.
- rpc_address - An optional string specifying the rpc address to use for the request.
Returns
A Result containing either a PutDeployResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the deploy process.
Parameters
- deploy: Deploy
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2627

put_transaction

put_transaction(transaction, verbosity?, rpc_address?): Promise<PutTransactionResult>
Puts a transaction using the provided options.

Arguments
- transaction - The Transaction object to be sent.
- verbosity - An optional Verbosity level for controlling the output verbosity.
- rpc_address - An optional string specifying the rpc address to use for the request.
Returns
A Result containing either a PutTransactionResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the transaction process.
Parameters
- transaction: Transaction
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:3336

query_balance

query_balance(options?): Promise<QueryBalanceResult>
Retrieves balance information using the provided options.

Arguments
- options - An optional QueryBalanceOptions struct containing retrieval options.
Returns
A Result containing either a QueryBalanceResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: queryBalanceOptions
Returns Promise<QueryBalanceResult>
- Defined in casper_rust_wasm_sdk.d.ts:2667

query_balance_details

query_balance_details(options?): Promise<QueryBalanceDetailsResult>
Retrieves balance information using the provided options.

Arguments
- options - An optional QueryBalanceDetailsOptions struct containing retrieval options.
Returns
A Result containing either a QueryBalanceDetailsResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: queryBalanceDetailsOptions
Returns Promise<QueryBalanceDetailsResult>
- Defined in casper_rust_wasm_sdk.d.ts:3064

query_balance_details_options

query_balance_details_options(options): queryBalanceDetailsOptions
Parses query balance options from a JsValue.

Arguments
- options - A JsValue containing query balance options to be parsed.
Returns
Parsed query balance options as a QueryBalanceDetailsOptions struct.
Parameters
- options: any
Returns queryBalanceDetailsOptions
- Defined in casper_rust_wasm_sdk.d.ts:3046

query_balance_options

query_balance_options(options): queryBalanceOptions
Parses query balance options from a JsValue.

Arguments
- options - A JsValue containing query balance options to be parsed.
Returns
Parsed query balance options as a QueryBalanceOptions struct.
Parameters
- options: any
Returns queryBalanceOptions
- Defined in casper_rust_wasm_sdk.d.ts:2649

query_contract_dict

query_contract_dict(options?): Promise<GetDictionaryItemResult>
JavaScript function for query_contract_dict with deserialized options.
Parameters
- Optionaloptions: queryContractDictOptions
Returns Promise<GetDictionaryItemResult>
- Defined in casper_rust_wasm_sdk.d.ts:2232

query_contract_dict_options

query_contract_dict_options(options): queryContractDictOptions
Deserialize query_contract_dict_options from a JavaScript object.
Parameters
- options: any
Returns queryContractDictOptions
- Defined in casper_rust_wasm_sdk.d.ts:2226

query_contract_key

query_contract_key(options?): Promise<QueryGlobalStateResult>
JavaScript function for query_contract_key with deserialized options.
Parameters
- Optionaloptions: queryContractKeyOptions
Returns Promise<QueryGlobalStateResult>
- Defined in casper_rust_wasm_sdk.d.ts:3288

query_contract_key_options

query_contract_key_options(options): queryContractKeyOptions
Deserialize query_contract_key_options from a JavaScript object.
Parameters
- options: any
Returns queryContractKeyOptions
- Defined in casper_rust_wasm_sdk.d.ts:3282

query_global_state

query_global_state(options?): Promise<QueryGlobalStateResult>
Retrieves global state information using the provided options.

Arguments
- options - An optional QueryGlobalStateOptions struct containing retrieval options.
Returns
A Result containing either a QueryGlobalStateResult or a JsError in case of an error.

Errors
Returns a JsError if there is an error during the retrieval process.
Parameters
- Optionaloptions: queryGlobalStateOptions
Returns Promise<QueryGlobalStateResult>
- Defined in casper_rust_wasm_sdk.d.ts:2220

query_global_state_options

query_global_state_options(options): queryGlobalStateOptions
Parses query global state options from a JsValue.

Arguments
- options - A JsValue containing query global state options to be parsed.
Returns
Parsed query global state options as a QueryGlobalStateOptions struct.
Parameters
- options: any
Returns queryGlobalStateOptions
- Defined in casper_rust_wasm_sdk.d.ts:2202

setRPCAddress

setRPCAddress(rpc_address?): void
Parameters
- Optionalrpc_address: string
Returns void
- Defined in casper_rust_wasm_sdk.d.ts:2813

setVerbosity

setVerbosity(verbosity?): void
Parameters
- Optionalverbosity: Verbosity
Returns void
- Defined in casper_rust_wasm_sdk.d.ts:2822

sign_deploy

sign_deploy(deploy, secret_key): Deploy
JS function for sign_deploy.

Arguments
- deploy - The deploy to sign.
- secret_key - The secret key for signing.
Returns
The signed Deploy.
Parameters
- deploy: Deploy
- secret_key: string
Returns Deploy
- Defined in casper_rust_wasm_sdk.d.ts:3276

sign_transaction

sign_transaction(transaction, secret_key): Transaction
JS function for sign_transaction.

Arguments
- transaction - The transaction to sign.
- secret_key - The secret key for signing.
Returns
The signed Transaction.
Parameters
- transaction: Transaction
- secret_key: string
Returns Transaction
- Defined in casper_rust_wasm_sdk.d.ts:2483

speculative_deploy

speculative_deploy(deploy_params, session_params, payment_params, verbosity?, rpc_address?): Promise<SpeculativeExecResult>
This function allows executing a deploy speculatively.

Arguments
- deploy_params - Deployment parameters for the deploy.
- session_params - Session parameters for the deploy.
- payment_params - Payment parameters for the deploy.
- verbosity - Optional verbosity level.
- rpc_address - Optional rpc address.
Returns
A Result containing either a SpeculativeExecResult or a JsError in case of an error.
Parameters
- deploy_params: DeployStrParams
- session_params: SessionStrParams
- payment_params: PaymentStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<SpeculativeExecResult>
- Defined in casper_rust_wasm_sdk.d.ts:3234

speculative_exec

speculative_exec(options?): Promise<SpeculativeExecTxnResult>
JS function for speculative execution.

Arguments
- options - The options for speculative execution.
Returns
A Result containing the result of the speculative execution or a JsError in case of an error.
Parameters
- Optionaloptions: getSpeculativeExecTxnOptions
Returns Promise<SpeculativeExecTxnResult>
- Defined in casper_rust_wasm_sdk.d.ts:2467

speculative_exec_deploy

speculative_exec_deploy(options?): Promise<SpeculativeExecResult>
JS function for speculative execution.

Arguments
- options - The options for speculative execution.
Returns
A Result containing the result of the speculative execution or a JsError in case of an error.
Parameters
- Optionaloptions: getSpeculativeExecDeployOptions
Returns Promise<SpeculativeExecResult>
- Defined in casper_rust_wasm_sdk.d.ts:3084

speculative_transaction

speculative_transaction(builder_params, transaction_params, verbosity?, rpc_address?): Promise<SpeculativeExecTxnResult>
This function allows executing a transaction speculatively.

Arguments
- builder_params - Transaction Builder parameters.
- transaction_params - Transactionment parameters for the transaction.
- verbosity - Optional verbosity level.
- rpc_address - Optional rpc address.
Returns
A Result containing either a SpeculativeExecTxnResult or a JsError in case of an error.
Parameters
- builder_params: TransactionBuilderParams
- transaction_params: TransactionStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<SpeculativeExecTxnResult>
- Defined in casper_rust_wasm_sdk.d.ts:2687

speculative_transfer

speculative_transfer(amount, target_account, transfer_id, deploy_params, payment_params, verbosity?, rpc_address?): Promise<SpeculativeExecResult>
JS function for speculative transfer.

Arguments
- amount - The amount to transfer.
- target_account - The target account.
- transfer_id - An optional transfer ID (defaults to a random number).
- deploy_params - The deployment parameters.
- payment_params - The payment parameters.
- verbosity - The verbosity level for logging (optional).
- rpc_address - The address of the node to connect to (optional).
Returns
A Result containing the result of the speculative transfer or a JsError in case of an error.
Parameters
- amount: string
- target_account: string
- transfer_id: string
- deploy_params: DeployStrParams
- payment_params: PaymentStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<SpeculativeExecResult>
- Defined in casper_rust_wasm_sdk.d.ts:3314

speculative_transfer_transaction

speculative_transfer_transaction(maybe_source, target_account, amount, transaction_params, maybe_id?, verbosity?, rpc_address?): Promise<SpeculativeExecTxnResult>
JS function for speculative transfer transaction.

Arguments
- maybe_source - Optional transfer source uref.
- target_account - The target account.
- amount - The amount to transfer.
- maybe_id - An optional transfer ID (defaults to a random number).
- transaction_params - The transactionment parameters.
- verbosity - The verbosity level for logging (optional).
- rpc_address - The address of the node to connect to (optional).
Returns
A Result containing the result of the speculative transfer or a JsError in case of an error.
Parameters
- maybe_source: URef
- target_account: string
- amount: string
- transaction_params: TransactionStrParams
- Optionalmaybe_id: string
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<SpeculativeExecTxnResult>
- Defined in casper_rust_wasm_sdk.d.ts:3260

state_get_account_info

state_get_account_info(options?): Promise<GetAccountResult>
Parameters
- Optionaloptions: getAccountOptions
Returns Promise<GetAccountResult>
- Defined in casper_rust_wasm_sdk.d.ts:2927

state_get_auction_info_js_alias

state_get_auction_info_js_alias(options?): Promise<GetAuctionInfoResult>
Parameters
- Optionaloptions: getAuctionInfoOptions
Returns Promise<GetAuctionInfoResult>
- Defined in casper_rust_wasm_sdk.d.ts:2270

state_get_balance

state_get_balance(options?): Promise<GetBalanceResult>
JavaScript Alias for get_balance.

Arguments
- options - An optional GetBalanceOptions struct containing retrieval options.
Returns
A Result containing either a GetBalanceResult or a JsError in case of an error.
Parameters
- Optionaloptions: getBalanceOptions
Returns Promise<GetBalanceResult>
- Defined in casper_rust_wasm_sdk.d.ts:2555

state_get_dictionary_item

state_get_dictionary_item(options?): Promise<GetDictionaryItemResult>
JavaScript Alias for get_dictionary_item
Parameters
- Optionaloptions: getDictionaryItemOptions
Returns Promise<GetDictionaryItemResult>
- Defined in casper_rust_wasm_sdk.d.ts:2136

state_get_entity

state_get_entity(options?): Promise<GetAddressableEntityResult>
Parameters
- Optionaloptions: getEntityOptions
Returns Promise<GetAddressableEntityResult>
- Defined in casper_rust_wasm_sdk.d.ts:2391

transaction

transaction(builder_params, transaction_params, verbosity?, rpc_address?): Promise<PutTransactionResult>
JavaScript function for transactioning with deserialized parameters.

Arguments
- transaction_params - Transaction parameters.
- builder_params - Session parameters.
- verbosity - An optional verbosity level.
- rpc_address - An optional rpc address.
Returns
A result containing PutTransactionResult or a JsError.
Parameters
- builder_params: TransactionBuilderParams
- transaction_params: TransactionStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:2707

transfer

transfer(amount, target_account, transfer_id, deploy_params, payment_params, verbosity?, rpc_address?): Promise<PutDeployResult>
JS function for transferring funds.

Arguments
- amount - The amount to transfer.
- target_account - The target account.
- transfer_id - An optional transfer ID (defaults to a random number).
- deploy_params - The deployment parameters.
- payment_params - The payment parameters.
- verbosity - The verbosity level for logging (optional).
- rpc_address - The address of the node to connect to (optional).
Returns
A Result containing the result of the transfer or a JsError in case of an error.
Parameters
- amount: string
- target_account: string
- transfer_id: string
- deploy_params: DeployStrParams
- payment_params: PaymentStrParams
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutDeployResult>
- Defined in casper_rust_wasm_sdk.d.ts:2509

transfer_transaction

transfer_transaction(maybe_source, target_account, amount, transaction_params, maybe_id?, verbosity?, rpc_address?): Promise<PutTransactionResult>
JS function for transaction transferring funds.

Arguments
- maybe_source - Optional transfer source uref.
- target_account - The target account.
- amount - The amount to transfer.
- transaction_params - The transaction parameters.
- maybe_id - An optional transfer ID (defaults to a random number).
- verbosity - The verbosity level for logging (optional).
- rpc_address - The address of the node to connect to (optional).
Returns
A Result containing the result of the transfer or a JsError in case of an error.
Parameters
- maybe_source: URef
- target_account: string
- amount: string
- transaction_params: TransactionStrParams
- Optionalmaybe_id: string
- Optionalverbosity: Verbosity
- Optionalrpc_address: string
Returns Promise<PutTransactionResult>
- Defined in casper_rust_wasm_sdk.d.ts:3110

waitDeploy

waitDeploy(events_url, deploy_hash, timeout_duration?): Promise<Promise<any>>
Waits for a deploy event to be processed asynchronously (JavaScript-friendly). Legacy alias

Arguments
- events_url - The URL to monitor for transaction events.
- deploy_hash - The deploy hash to wait for.
- timeout_duration - An optional timeout duration in seconds.
Returns
A JavaScript Promise resolving to either the processed EventParseResult or an error message.
Parameters
- events_url: string
- deploy_hash: string
- Optionaltimeout_duration: number
Returns Promise<Promise<any>>
- Defined in casper_rust_wasm_sdk.d.ts:2759

waitTransaction

waitTransaction(events_url, target_hash, timeout_duration?): Promise<Promise<any>>
Waits for a deploy event to be processed asynchronously (JavaScript-friendly).

Arguments
- events_url - The URL to monitor for transaction events.
- target_hash - The transaction hash to wait for.
- timeout_duration - An optional timeout duration in seconds.
Returns
A JavaScript Promise resolving to either the processed EventParseResult or an error message.
Parameters
- events_url: string
- target_hash: string
- Optionaltimeout_duration: number
Returns Promise<Promise<any>>
- Defined in casper_rust_wasm_sdk.d.ts:2777

watchDeploy

watchDeploy(events_url, timeout_duration?): Watcher
Creates a new Watcher instance to watch deploys (JavaScript-friendly). Legacy alias

Arguments
- events_url - The URL to monitor for transaction events.
- timeout_duration - An optional timeout duration in seconds.
Returns
A Watcher instance.
Parameters
- events_url: string
- Optionaltimeout_duration: number
Returns Watcher
- Defined in casper_rust_wasm_sdk.d.ts:2724

watchTransaction

watchTransaction(events_url, timeout_duration?): Watcher
Creates a new Watcher instance to watch deploys (JavaScript-friendly).

Arguments
- events_url - The URL to monitor for transaction events.
- timeout_duration - An optional timeout duration in seconds.
Returns
A Watcher instance.
Parameters
- events_url: string
- Optionaltimeout_duration: number
Returns Watcher
- Defined in casper_rust_wasm_sdk.d.ts:2740

ClassSDK

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SDK

Methods

account_put_deploy

Parameters

Returns Promise<PutDeployResult>

account_put_transaction

Parameters

Returns Promise<PutTransactionResult>

call_entrypoint

Arguments

Returns

Errors

Parameters

Returns Promise<PutTransactionResult>

call_entrypoint_deploy

Arguments

Returns

Errors

Parameters

Returns Promise<PutDeployResult>

chain_get_block

Arguments

Returns

Errors

Parameters

Returns Promise<GetBlockResult>

chain_get_block_transfers

Parameters

Returns Promise<GetBlockTransfersResult>

chain_get_era_info_by_switch_block

Parameters

Returns Promise<GetEraInfoResult>

chain_get_era_summary

Parameters

Returns Promise<GetEraSummaryResult>

chain_get_state_root_hash

Arguments

Returns

Errors

Parameters

Returns Promise<GetStateRootHashResult>

deploy

Arguments

Returns

Parameters

Returns Promise<PutDeployResult>

free

Returns void

get_account

Arguments

Returns

Errors

Parameters

Returns Promise<GetAccountResult>

get_account_options

Parameters

Returns getAccountOptions

get_auction_info

Arguments

Returns

Errors

Parameters

Returns Promise<GetAuctionInfoResult>

get_auction_info_options

Arguments

Returns

Parameters

Returns getAuctionInfoOptions

get_balance

Arguments

Returns

Errors

Parameters