Interface ICasperClient

Namespace: Casper.Network.SDK

Assembly: Casper.Network.SDK.dll

Syntax

public interface ICasperClient

Methods

| Edit this page View Source

GetAccountInfo(AccountHashKey, string)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(AccountHashKey accountHash, string blockHash = null)

Parameters

Type	Name	Description
AccountHashKey	accountHash
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAccountInfo(AccountHashKey, ulong)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(AccountHashKey accountHash, ulong blockHeight)

Parameters

Type	Name	Description
AccountHashKey	accountHash
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAccountInfo(PublicKey, string)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(PublicKey publicKey, string blockHash = null)

Parameters

Type	Name	Description
PublicKey	publicKey
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAccountInfo(PublicKey, ulong)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(PublicKey publicKey, ulong blockHeight)

Parameters

Type	Name	Description
PublicKey	publicKey
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAccountInfo(string, string)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(string publicKey, string blockHash = null)

Parameters

Type	Name	Description
string	publicKey
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAccountInfo(string, ulong)

Declaration

Task<RpcResponse<GetAccountInfoResult>> GetAccountInfo(string publicKey, ulong blockHeight)

Parameters

Type	Name	Description
string	publicKey
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetAccountInfoResult>>

| Edit this page View Source

GetAuctionInfo(string)

Declaration

Task<RpcResponse<GetAuctionInfoResult>> GetAuctionInfo(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetAuctionInfoResult>>

| Edit this page View Source

GetAuctionInfo(ulong)

Declaration

Task<RpcResponse<GetAuctionInfoResult>> GetAuctionInfo(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetAuctionInfoResult>>

| Edit this page View Source

GetBalance(string, string)

Declaration

Task<RpcResponse<GetBalanceResult>> GetBalance(string purseURef, string stateRootHash = null)

Parameters

Type	Name	Description
string	purseURef
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<GetBalanceResult>>

| Edit this page View Source

GetBlock(string)

Declaration

Task<RpcResponse<GetBlockResult>> GetBlock(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetBlockResult>>

| Edit this page View Source

GetBlock(ulong)

Declaration

Task<RpcResponse<GetBlockResult>> GetBlock(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetBlockResult>>

| Edit this page View Source

GetBlockTransfers(string)

Declaration

Task<RpcResponse<GetBlockTransfersResult>> GetBlockTransfers(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetBlockTransfersResult>>

| Edit this page View Source

GetBlockTransfers(ulong)

Declaration

Task<RpcResponse<GetBlockTransfersResult>> GetBlockTransfers(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetBlockTransfersResult>>

| Edit this page View Source

GetChainspec()

Declaration

Task<RpcResponse<GetChainspecResult>> GetChainspec()

Returns

Type	Description
Task<RpcResponse<GetChainspecResult>>

| Edit this page View Source

GetDelegatorReward(PublicKey, PublicKey, string)

Declaration

Task<RpcResponse<GetRewardResult>> GetDelegatorReward(PublicKey validator, PublicKey delegator, string blockHash = null)

Parameters

Type	Name	Description
PublicKey	validator
PublicKey	delegator
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

GetDelegatorReward(PublicKey, PublicKey, ulong)

Declaration

Task<RpcResponse<GetRewardResult>> GetDelegatorReward(PublicKey validator, PublicKey delegator, ulong blockHeight)

Parameters

Type	Name	Description
PublicKey	validator
PublicKey	delegator
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

GetDelegatorRewardWithEraId(PublicKey, PublicKey, ulong)

Declaration

Task<RpcResponse<GetRewardResult>> GetDelegatorRewardWithEraId(PublicKey validator, PublicKey delegator, ulong eraId)

Parameters

Type	Name	Description
PublicKey	validator
PublicKey	delegator
ulong	eraId

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

GetDeploy(string, bool, CancellationToken)

Declaration

Task<RpcResponse<GetDeployResult>> GetDeploy(string deployHash, bool finalizedApprovals, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	deployHash
bool	finalizedApprovals
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetDeployResult>>

| Edit this page View Source

GetDeploy(string, CancellationToken)

Declaration

Task<RpcResponse<GetDeployResult>> GetDeploy(string deployHash, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	deployHash
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetDeployResult>>

| Edit this page View Source

GetDictionaryItem(string, string)

Declaration

Task<RpcResponse<GetDictionaryItemResult>> GetDictionaryItem(string dictionaryItem, string stateRootHash = null)

Parameters

Type	Name	Description
string	dictionaryItem
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<GetDictionaryItemResult>>

| Edit this page View Source

GetDictionaryItemByAccount(string, string, string, string)

Declaration

Task<RpcResponse<GetDictionaryItemResult>> GetDictionaryItemByAccount(string accountKey, string dictionaryName, string dictionaryItem, string stateRootHash = null)

Parameters

Type	Name	Description
string	accountKey
string	dictionaryName
string	dictionaryItem
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<GetDictionaryItemResult>>

| Edit this page View Source

GetDictionaryItemByContract(string, string, string, string)

Declaration

Task<RpcResponse<GetDictionaryItemResult>> GetDictionaryItemByContract(string contractKey, string dictionaryName, string dictionaryItem, string stateRootHash = null)

Parameters

Type	Name	Description
string	contractKey
string	dictionaryName
string	dictionaryItem
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<GetDictionaryItemResult>>

| Edit this page View Source

GetDictionaryItemByURef(string, string, string)

Declaration

Task<RpcResponse<GetDictionaryItemResult>> GetDictionaryItemByURef(string seedURef, string dictionaryItem, string stateRootHash = null)

Parameters

Type	Name	Description
string	seedURef
string	dictionaryItem
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<GetDictionaryItemResult>>

| Edit this page View Source

GetEntity(IEntityIdentifier, string)

Declaration

Task<RpcResponse<GetEntityResult>> GetEntity(IEntityIdentifier entityIdentifier, string blockHash = null)

Parameters

Type	Name	Description
IEntityIdentifier	entityIdentifier
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetEntityResult>>

| Edit this page View Source

GetEntity(IEntityIdentifier, ulong)

Declaration

Task<RpcResponse<GetEntityResult>> GetEntity(IEntityIdentifier entityIdentifier, ulong blockHeight)

Parameters

Type	Name	Description
IEntityIdentifier	entityIdentifier
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetEntityResult>>

| Edit this page View Source

GetEntity(string, string)

Declaration

Task<RpcResponse<GetEntityResult>> GetEntity(string entityAddr, string blockHash = null)

Parameters

Type	Name	Description
string	entityAddr
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetEntityResult>>

| Edit this page View Source

GetEntity(string, ulong)

Declaration

Task<RpcResponse<GetEntityResult>> GetEntity(string entityAddr, ulong blockHeight)

Parameters

Type	Name	Description
string	entityAddr
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetEntityResult>>

| Edit this page View Source

GetEraInfoBySwitchBlock(string)

Declaration

Task<RpcResponse<GetEraInfoBySwitchBlockResult>> GetEraInfoBySwitchBlock(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetEraInfoBySwitchBlockResult>>

| Edit this page View Source

GetEraInfoBySwitchBlock(ulong)

Declaration

Task<RpcResponse<GetEraInfoBySwitchBlockResult>> GetEraInfoBySwitchBlock(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetEraInfoBySwitchBlockResult>>

| Edit this page View Source

GetEraSummary(string)

Declaration

Task<RpcResponse<GetEraSummaryResult>> GetEraSummary(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetEraSummaryResult>>

| Edit this page View Source

GetEraSummary(ulong)

Declaration

Task<RpcResponse<GetEraSummaryResult>> GetEraSummary(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetEraSummaryResult>>

| Edit this page View Source

GetNodePeers()

Declaration

Task<RpcResponse<GetNodePeersResult>> GetNodePeers()

Returns

Type	Description
Task<RpcResponse<GetNodePeersResult>>

| Edit this page View Source

GetNodeStatus()

Declaration

Task<RpcResponse<GetNodeStatusResult>> GetNodeStatus()

Returns

Type	Description
Task<RpcResponse<GetNodeStatusResult>>

| Edit this page View Source

GetPackage(string, string)

Declaration

Task<RpcResponse<GetPackageResult>> GetPackage(string packageHash, string blockHash = null)

Parameters

Type	Name	Description
string	packageHash
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetPackageResult>>

| Edit this page View Source

GetRpcSchema()

Declaration

Task<string> GetRpcSchema()

Returns

Type	Description
Task<string>

| Edit this page View Source

GetStateRootHash(string)

Declaration

Task<string> GetStateRootHash(string blockHash = null)

Parameters

Type	Name	Description
string	blockHash

Returns

Type	Description
Task<string>

| Edit this page View Source

GetStateRootHash(ulong)

Declaration

Task<string> GetStateRootHash(ulong blockHeight)

Parameters

Type	Name	Description
ulong	blockHeight

Returns

Type	Description
Task<string>

| Edit this page View Source

GetTransaction(TransactionHash, bool, CancellationToken)

Declaration

Task<RpcResponse<GetTransactionResult>> GetTransaction(TransactionHash transactionHash, bool finalizedApprovals, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TransactionHash	transactionHash
bool	finalizedApprovals
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetTransactionResult>>

| Edit this page View Source

GetTransaction(TransactionHash, CancellationToken)

Declaration

Task<RpcResponse<GetTransactionResult>> GetTransaction(TransactionHash transactionHash, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TransactionHash	transactionHash
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetTransactionResult>>

| Edit this page View Source

GetTransaction(string, bool, CancellationToken)

Declaration

Task<RpcResponse<GetTransactionResult>> GetTransaction(string transactionV1Hash, bool finalizedApprovals, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	transactionV1Hash
bool	finalizedApprovals
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetTransactionResult>>

| Edit this page View Source

GetTransaction(string, CancellationToken)

Declaration

Task<RpcResponse<GetTransactionResult>> GetTransaction(string transactionV1Hash, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	transactionV1Hash
CancellationToken	cancellationToken

Returns

Type	Description
Task<RpcResponse<GetTransactionResult>>

| Edit this page View Source

GetValidatorChanges()

Declaration

Task<RpcResponse<GetValidatorChangesResult>> GetValidatorChanges()

Returns

Type	Description
Task<RpcResponse<GetValidatorChangesResult>>

| Edit this page View Source

GetValidatorReward(PublicKey, string)

Declaration

Task<RpcResponse<GetRewardResult>> GetValidatorReward(PublicKey validator, string blockHash = null)

Parameters

Type	Name	Description
PublicKey	validator
string	blockHash

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

GetValidatorReward(PublicKey, ulong)

Declaration

Task<RpcResponse<GetRewardResult>> GetValidatorReward(PublicKey validator, ulong blockHeight)

Parameters

Type	Name	Description
PublicKey	validator
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

GetValidatorRewardWithEraId(PublicKey, ulong)

Declaration

Task<RpcResponse<GetRewardResult>> GetValidatorRewardWithEraId(PublicKey validator, ulong eraId)

Parameters

Type	Name	Description
PublicKey	validator
ulong	eraId

Returns

Type	Description
Task<RpcResponse<GetRewardResult>>

| Edit this page View Source

PutDeploy(Deploy)

Declaration

Task<RpcResponse<PutDeployResult>> PutDeploy(Deploy deploy)

Parameters

Type	Name	Description
Deploy	deploy

Returns

Type	Description
Task<RpcResponse<PutDeployResult>>

| Edit this page View Source

PutTransaction(TransactionV1)

Declaration

Task<RpcResponse<PutTransactionResult>> PutTransaction(TransactionV1 transaction)

Parameters

Type	Name	Description
TransactionV1	transaction

Returns

Type	Description
Task<RpcResponse<PutTransactionResult>>

| Edit this page View Source

QueryBalance(IPurseIdentifier, string)

Declaration

Task<RpcResponse<QueryBalanceResult>> QueryBalance(IPurseIdentifier purseIdentifier, string blockHash = null)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
string	blockHash

Returns

Type	Description
Task<RpcResponse<QueryBalanceResult>>

| Edit this page View Source

QueryBalance(IPurseIdentifier, ulong)

Declaration

Task<RpcResponse<QueryBalanceResult>> QueryBalance(IPurseIdentifier purseIdentifier, ulong blockHeight)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<QueryBalanceResult>>

| Edit this page View Source

QueryBalanceDetails(IPurseIdentifier, string)

Declaration

Task<RpcResponse<QueryBalanceDetailsResult>> QueryBalanceDetails(IPurseIdentifier purseIdentifier, string blockHash = null)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
string	blockHash

Returns

Type	Description
Task<RpcResponse<QueryBalanceDetailsResult>>

| Edit this page View Source

QueryBalanceDetails(IPurseIdentifier, ulong)

Declaration

Task<RpcResponse<QueryBalanceDetailsResult>> QueryBalanceDetails(IPurseIdentifier purseIdentifier, ulong blockHeight)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
ulong	blockHeight

Returns

Type	Description
Task<RpcResponse<QueryBalanceDetailsResult>>

| Edit this page View Source

QueryBalanceDetailsWithStateRootHash(IPurseIdentifier, string)

Declaration

Task<RpcResponse<QueryBalanceDetailsResult>> QueryBalanceDetailsWithStateRootHash(IPurseIdentifier purseIdentifier, string stateRootHash)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<QueryBalanceDetailsResult>>

| Edit this page View Source

QueryBalanceWithStateRootHash(IPurseIdentifier, string)

Declaration

Task<RpcResponse<QueryBalanceResult>> QueryBalanceWithStateRootHash(IPurseIdentifier purseIdentifier, string stateRootHash)

Parameters

Type	Name	Description
IPurseIdentifier	purseIdentifier
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<QueryBalanceResult>>

| Edit this page View Source

QueryGlobalState(GlobalStateKey, string, string)

Declaration

Task<RpcResponse<QueryGlobalStateResult>> QueryGlobalState(GlobalStateKey key, string stateRootHash = null, string path = null)

Parameters

Type	Name	Description
GlobalStateKey	key
string	stateRootHash
string	path

Returns

Type	Description
Task<RpcResponse<QueryGlobalStateResult>>

| Edit this page View Source

QueryGlobalState(string, string, string)

Declaration

Task<RpcResponse<QueryGlobalStateResult>> QueryGlobalState(string key, string stateRootHash = null, string path = null)

Parameters

Type	Name	Description
string	key
string	stateRootHash
string	path

Returns

Type	Description
Task<RpcResponse<QueryGlobalStateResult>>

| Edit this page View Source

QueryGlobalState(string, ulong, string)

Declaration

Task<RpcResponse<QueryGlobalStateResult>> QueryGlobalState(string key, ulong height, string path = null)

Parameters

Type	Name	Description
string	key
ulong	height
string	path

Returns

Type	Description
Task<RpcResponse<QueryGlobalStateResult>>

| Edit this page View Source

QueryGlobalStateWithBlockHash(GlobalStateKey, string, string)

Declaration

Task<RpcResponse<QueryGlobalStateResult>> QueryGlobalStateWithBlockHash(GlobalStateKey key, string blockHash, string path = null)

Parameters

Type	Name	Description
GlobalStateKey	key
string	blockHash
string	path

Returns

Type	Description
Task<RpcResponse<QueryGlobalStateResult>>

| Edit this page View Source

QueryGlobalStateWithBlockHash(string, string, string)

Declaration

Task<RpcResponse<QueryGlobalStateResult>> QueryGlobalStateWithBlockHash(string key, string blockHash, string path = null)

Parameters

Type	Name	Description
string	key
string	blockHash
string	path

Returns

Type	Description
Task<RpcResponse<QueryGlobalStateResult>>

| Edit this page View Source

SpeceulativeExecution(Deploy, string)

Declaration

Task<RpcResponse<SpeculativeExecutionResult>> SpeceulativeExecution(Deploy deploy, string stateRootHash = null)

Parameters

Type	Name	Description
Deploy	deploy
string	stateRootHash

Returns

Type	Description
Task<RpcResponse<SpeculativeExecutionResult>>

| Edit this page View Source

SpeceulativeExecutionWithBlockHash(Deploy, string)

Declaration

Task<RpcResponse<PutDeployResult>> SpeceulativeExecutionWithBlockHash(Deploy deploy, string blockHash = null)

Parameters

Type	Name	Description
Deploy	deploy
string	blockHash

Returns

Type	Description
Task<RpcResponse<PutDeployResult>>