Table of Contents

Class RawClient

Namespace
Concordium.Sdk.Client
Assembly
Concordium.Sdk.dll

The raw gRPC client interface exposing wrappers that abstract away connection handling and parameters present in the InternalClient which was generated from the protocol buffer definition files for the Concordium Node gRPC API V2.

public sealed class RawClient : IDisposable
Inheritance
RawClient
Implements
Inherited Members

Properties

InternalClient

The "internal" client instance generated from the Concordium gRPC API V2 protocol buffer definition.

public Queries.QueriesClient InternalClient { get; init; }

Property Value

Queries.QueriesClient

Options

Options used by the client at initialization. Some parameters, like Credentials, may be set if null when given to constructor. Hence properties in this are not neccessary equal to those given to constructor, but they equals those used for client initialization.

public ConcordiumClientOptions Options { get; init; }

Property Value

ConcordiumClientOptions

Methods

BanPeer(PeerToBan, CancellationToken)

Request the node to ban the specified peer. Throws a gRPC exception if the action failed.

public Empty BanPeer(PeerToBan input, CancellationToken token = default)

Parameters

input PeerToBan
token CancellationToken

Returns

Empty

BanPeerAsync(PeerToBan, CancellationToken)

Requests the node to ban the specified peer. Throws a gRPC exception if the action failed.

public AsyncUnaryCall<Empty> BanPeerAsync(PeerToBan input, CancellationToken token = default)

Parameters

input PeerToBan
token CancellationToken

Returns

AsyncUnaryCall<Empty>

Dispose()

Dispose the RawClient.

public void Dispose()

DumpStart(DumpRequest, CancellationToken)

Request the node to start dumping network packets into the specified file. This feature is enabled if the node was built with the network_dump feature. Returns a gRPC error if the network dump failed to start.

public Empty DumpStart(DumpRequest input, CancellationToken token = default)

Parameters

input DumpRequest
token CancellationToken

Returns

Empty

DumpStartAsync(DumpRequest, CancellationToken)

Requests the node to start dumping network packets into the specified file. This feature is enabled if the node was built with the network_dump feature. Returns a gRPC error if the network dump failed to start.

public AsyncUnaryCall<Empty> DumpStartAsync(DumpRequest input, CancellationToken token = default)

Parameters

input DumpRequest
token CancellationToken

Returns

AsyncUnaryCall<Empty>

DumpStop(CancellationToken)

Request the node to stop dumping packets, if configured to do so. This feature is enabled if the node was built with the @network_dump@ feature. Throws a gRPC error if the network dump could not be stopped.

public Empty DumpStop(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Empty

DumpStopAsync(CancellationToken)

Requests the node to stop dumping packets, if configured to do so. This feature is enabled if the node was built with the network_dump feature. Throws a gRPC error if the network dump could not be stopped.

public AsyncUnaryCall<Empty> DumpStopAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<Empty>

GetAccountInfo(AccountInfoRequest, CancellationToken)

Get information about an account.

public AccountInfo GetAccountInfo(AccountInfoRequest input, CancellationToken token = default)

Parameters

input AccountInfoRequest
token CancellationToken

Returns

AccountInfo

GetAccountInfoAsync(AccountInfoRequest, CancellationToken)

Returns information about an account.

public AsyncUnaryCall<AccountInfo> GetAccountInfoAsync(AccountInfoRequest input, CancellationToken token = default)

Parameters

input AccountInfoRequest
token CancellationToken

Returns

AsyncUnaryCall<AccountInfo>

GetAccountList(BlockHashInput, CancellationToken)

Get all accounts that exist at the end of a given block.

public AsyncServerStreamingCall<AccountAddress> GetAccountList(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<AccountAddress>

GetAccountNonFinalizedTransactions(AccountAddress, CancellationToken)

Get all hashes of non-finalized transactions for a given account.

public AsyncServerStreamingCall<TransactionHash> GetAccountNonFinalizedTransactions(AccountAddress input, CancellationToken token = default)

Parameters

input AccountAddress
token CancellationToken

Returns

AsyncServerStreamingCall<TransactionHash>

GetAncestors(AncestorsRequest, CancellationToken)

Get ancestors of a given block. The first element of the sequence is the requested block itself, and the block immediately following a block in the sequence is the parent of that block. The sequence contains at most @limit@ blocks, and if the sequence is strictly shorter, the last block in the list is the genesis block.

public AsyncServerStreamingCall<BlockHash> GetAncestors(AncestorsRequest input, CancellationToken token = default)

Parameters

input AncestorsRequest
token CancellationToken

Returns

AsyncServerStreamingCall<BlockHash>

GetAnonymityRevokers(BlockHashInput, CancellationToken)

Get all anonymity revokers registered at the end of a given block.

public AsyncServerStreamingCall<ArInfo> GetAnonymityRevokers(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<ArInfo>

GetBakerList(BlockHashInput, CancellationToken)

Get IDs of all bakers at the end of a given block.

public AsyncServerStreamingCall<BakerId> GetBakerList(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<BakerId>

GetBannedPeers(CancellationToken)

Get a list of peers banned by the node.

public BannedPeers GetBannedPeers(CancellationToken token = default)

Parameters

token CancellationToken

Returns

BannedPeers

GetBannedPeersAsync(CancellationToken)

Returns a list of peers banned by the node.

public AsyncUnaryCall<BannedPeers> GetBannedPeersAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<BannedPeers>

GetBlockChainParameters(BlockHashInput, CancellationToken)

Get values of block chain parameters in a given block.

public ChainParameters GetBlockChainParameters(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

ChainParameters

GetBlockChainParametersAsync(BlockHashInput, CancellationToken)

Returns values of block chain parameters in a given block.

public AsyncUnaryCall<ChainParameters> GetBlockChainParametersAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<ChainParameters>

GetBlockFinalizationSummary(BlockHashInput, CancellationToken)

Get a summary of the finalization data in a given block.

public BlockFinalizationSummary GetBlockFinalizationSummary(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

BlockFinalizationSummary

GetBlockFinalizationSummaryAsync(BlockHashInput, CancellationToken)

Returns a summary of the finalization data in a given block.

public AsyncUnaryCall<BlockFinalizationSummary> GetBlockFinalizationSummaryAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<BlockFinalizationSummary>

GetBlockInfo(BlockHashInput, CancellationToken)

Get information such as height, timings, and transaction counts for a given block.

public BlockInfo GetBlockInfo(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

BlockInfo

GetBlockInfoAsync(BlockHashInput, CancellationToken)

Returns information such as height, timings, and transaction counts for a given block.

public AsyncUnaryCall<BlockInfo> GetBlockInfoAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<BlockInfo>

GetBlockItemStatus(TransactionHash, CancellationToken)

Get the status of and information about a specific block item (transaction).

public BlockItemStatus GetBlockItemStatus(TransactionHash input, CancellationToken token = default)

Parameters

input TransactionHash
token CancellationToken

Returns

BlockItemStatus

GetBlockItemStatusAsync(TransactionHash, CancellationToken)

Returns the status of and information about a specific block item (transaction).

public AsyncUnaryCall<BlockItemStatus> GetBlockItemStatusAsync(TransactionHash input, CancellationToken token = default)

Parameters

input TransactionHash
token CancellationToken

Returns

AsyncUnaryCall<BlockItemStatus>

GetBlockItems(BlockHashInput, CancellationToken)

Get the items of a block.

public AsyncServerStreamingCall<BlockItem> GetBlockItems(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<BlockItem>

GetBlockPendingUpdates(BlockHashInput, CancellationToken)

Get all pending updates to chain parameters at the end of a given block.

public AsyncServerStreamingCall<PendingUpdate> GetBlockPendingUpdates(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<PendingUpdate>

GetBlockSpecialEvents(BlockHashInput, CancellationToken)

Get all special events in a given block. A special event is protocol generated event that is not directly caused by a transaction, such as minting, paying out rewards, etc.

public AsyncServerStreamingCall<BlockSpecialEvent> GetBlockSpecialEvents(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<BlockSpecialEvent>

GetBlockTransactionEvents(BlockHashInput, CancellationToken)

Get all transaction events in a given block.

public AsyncServerStreamingCall<BlockItemSummary> GetBlockTransactionEvents(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<BlockItemSummary>

GetBlocks(CancellationToken)

Process a stream of blocks that arrive from the time the query is made onward. This can be used to listen for incoming blocks. Note that this is non-terminating, and that blocks may be skipped if the client is unable to keep up with the stream.

public AsyncServerStreamingCall<ArrivedBlockInfo> GetBlocks(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncServerStreamingCall<ArrivedBlockInfo>

GetBlocksAtHeight(BlocksAtHeightRequest, CancellationToken)

Get a list of live blocks at a given height.

public BlocksAtHeightResponse GetBlocksAtHeight(BlocksAtHeightRequest input, CancellationToken token = default)

Parameters

input BlocksAtHeightRequest
token CancellationToken

Returns

BlocksAtHeightResponse

GetBlocksAtHeightAsync(BlocksAtHeightRequest, CancellationToken)

Returns a list of live blocks at a given height.

public AsyncUnaryCall<BlocksAtHeightResponse> GetBlocksAtHeightAsync(BlocksAtHeightRequest input, CancellationToken token = default)

Parameters

input BlocksAtHeightRequest
token CancellationToken

Returns

AsyncUnaryCall<BlocksAtHeightResponse>

GetBranches(CancellationToken)

Get the current branches of blocks starting from and including the last finalized block.

public Branch GetBranches(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Branch

GetBranchesAsync(CancellationToken)

Returns the current branches of blocks starting from and including the last finalized block.

public AsyncUnaryCall<Branch> GetBranchesAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<Branch>

GetConsensusInfo(CancellationToken)

Get information about the current state of consensus.

public ConsensusInfo GetConsensusInfo(CancellationToken token = default)

Parameters

token CancellationToken

Returns

ConsensusInfo

GetConsensusInfoAsync(CancellationToken)

Returns information about the current state of consensus.

public AsyncUnaryCall<ConsensusInfo> GetConsensusInfoAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<ConsensusInfo>

GetCryptographicParameters(BlockHashInput, CancellationToken)

Get cryptographic parameters in a given block.

public CryptographicParameters GetCryptographicParameters(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

CryptographicParameters

GetCryptographicParametersAsync(BlockHashInput, CancellationToken)

Returns the cryptographic parameters in a given block.

public AsyncUnaryCall<CryptographicParameters> GetCryptographicParametersAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<CryptographicParameters>

GetElectionInfo(BlockHashInput, CancellationToken)

Get information related to the baker election for a particular block.

public ElectionInfo GetElectionInfo(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

ElectionInfo

GetElectionInfoAsync(BlockHashInput, CancellationToken)

Returns information related to the baker election for a particular block.

public AsyncUnaryCall<ElectionInfo> GetElectionInfoAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<ElectionInfo>

GetFinalizedBlocks(CancellationToken)

Process a stream of blocks that are finalized from the time the query is made onward. This can be used to listen for newly finalized blocks. Note that this is non-terminating, and that blocks may be skipped if the client is unable to keep up with the stream, however blocks are guaranteed to arrive in order of increasing block height.

public AsyncServerStreamingCall<FinalizedBlockInfo> GetFinalizedBlocks(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncServerStreamingCall<FinalizedBlockInfo>

GetIdentityProviders(BlockHashInput, CancellationToken)

Get all identity providers registered at the end of a given block.

public AsyncServerStreamingCall<IpInfo> GetIdentityProviders(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<IpInfo>

GetInstanceInfo(InstanceInfoRequest, CancellationToken)

Get information about a smart contract instance as it appears at the end of a given block.

public InstanceInfo GetInstanceInfo(InstanceInfoRequest input, CancellationToken token = default)

Parameters

input InstanceInfoRequest
token CancellationToken

Returns

InstanceInfo

GetInstanceInfoAsync(InstanceInfoRequest, CancellationToken)

Returns information about a smart contract instance as it appears at the end of a given block.

public AsyncUnaryCall<InstanceInfo> GetInstanceInfoAsync(InstanceInfoRequest input, CancellationToken token = default)

Parameters

input InstanceInfoRequest
token CancellationToken

Returns

AsyncUnaryCall<InstanceInfo>

GetInstanceList(BlockHashInput, CancellationToken)

Get the addresses of all smart contract instances in a given block.

public AsyncServerStreamingCall<ContractAddress> GetInstanceList(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<ContractAddress>

GetInstanceState(InstanceInfoRequest, CancellationToken)

Get key-value pairs representing the entire state of a specific contract instance in a given block. The resulting sequence consists of key-value pairs ordered lexicographically according to the keys.

public AsyncServerStreamingCall<InstanceStateKVPair> GetInstanceState(InstanceInfoRequest input, CancellationToken token = default)

Parameters

input InstanceInfoRequest
token CancellationToken

Returns

AsyncServerStreamingCall<InstanceStateKVPair>

GetModuleList(BlockHashInput, CancellationToken)

Get all smart contract modules that exist at the end of a given block.

public AsyncServerStreamingCall<ModuleRef> GetModuleList(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<ModuleRef>

GetModuleSource(ModuleSourceRequest, CancellationToken)

Get the source of a smart contract module.

public VersionedModuleSource GetModuleSource(ModuleSourceRequest input, CancellationToken token = default)

Parameters

input ModuleSourceRequest
token CancellationToken

Returns

VersionedModuleSource

GetModuleSourceAsync(ModuleSourceRequest, CancellationToken)

Returns the source of a smart contract module.

public AsyncUnaryCall<VersionedModuleSource> GetModuleSourceAsync(ModuleSourceRequest input, CancellationToken token = default)

Parameters

input ModuleSourceRequest
token CancellationToken

Returns

AsyncUnaryCall<VersionedModuleSource>

GetNextAccountSequenceNumber(AccountAddress, CancellationToken)

Get the best guess as to what the next account sequence number (nonce) should be for the given account. If all account transactions are finalized then this information is reliable. Otherwise this is the best guess, assuming all other transactions will be committed to blocks and eventually finalized.

public NextAccountSequenceNumber GetNextAccountSequenceNumber(AccountAddress input, CancellationToken token = default)

Parameters

input AccountAddress
token CancellationToken

Returns

NextAccountSequenceNumber

GetNextAccountSequenceNumberAsync(AccountAddress, CancellationToken)

Returns the best guess as to what the next account sequence number (nonce) should be for the given account. If all account transactions are finalized then this information is reliable. Otherwise this is the best guess, assuming all other transactions will be committed to blocks and eventually finalized.

public AsyncUnaryCall<NextAccountSequenceNumber> GetNextAccountSequenceNumberAsync(AccountAddress input, CancellationToken token = default)

Parameters

input AccountAddress
token CancellationToken

Returns

AsyncUnaryCall<NextAccountSequenceNumber>

GetNextUpdateSequenceNumbers(BlockHashInput, CancellationToken)

Get next available sequence numbers for updating chain parameters after a given block.

public NextUpdateSequenceNumbers GetNextUpdateSequenceNumbers(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

NextUpdateSequenceNumbers

GetNextUpdateSequenceNumbersAsync(BlockHashInput, CancellationToken)

Returns the next available sequence numbers for updating chain parameters after a given block.

public AsyncUnaryCall<NextUpdateSequenceNumbers> GetNextUpdateSequenceNumbersAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<NextUpdateSequenceNumbers>

GetNodeInfo(CancellationToken)

Get information about the node.

public NodeInfo GetNodeInfo(CancellationToken token = default)

Parameters

token CancellationToken

Returns

NodeInfo

GetNodeInfoAsync(CancellationToken)

Returns information about the node.

public AsyncUnaryCall<NodeInfo> GetNodeInfoAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<NodeInfo>

GetPassiveDelegationInfo(BlockHashInput, CancellationToken)

Get information about the passive delegators at the end of a given block.

public PassiveDelegationInfo GetPassiveDelegationInfo(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

PassiveDelegationInfo

GetPassiveDelegationInfoAsync(BlockHashInput, CancellationToken)

Returns information about the passive delegators at the end of a given block.

public AsyncUnaryCall<PassiveDelegationInfo> GetPassiveDelegationInfoAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<PassiveDelegationInfo>

GetPassiveDelegators(BlockHashInput, CancellationToken)

Get all registered passive delegators at the end of a given block.

public AsyncServerStreamingCall<DelegatorInfo> GetPassiveDelegators(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<DelegatorInfo>

GetPassiveDelegatorsRewardPeriod(BlockHashInput, CancellationToken)

Get all fixed passive delegators for the reward period of a given block. In contrast to GetPassiveDelegators(BlockHashInput, CancellationToken) which returns all delegators registered at the end of a given block, this returns all fixed delegators contributing stake in the reward period containing the given block.

public AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPassiveDelegatorsRewardPeriod(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>

GetPeersInfo(CancellationToken)

Get a list of the peers that the node is connected to as well as network-related information for each such peer.

public PeersInfo GetPeersInfo(CancellationToken token = default)

Parameters

token CancellationToken

Returns

PeersInfo

GetPeersInfoAsync(CancellationToken)

Returns a list of the peers that the node is connected to as well as network-related information for each such peer.

public AsyncUnaryCall<PeersInfo> GetPeersInfoAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<PeersInfo>

GetPoolDelegators(GetPoolDelegatorsRequest, CancellationToken)

Get all registered delegators of a given pool at the end of a given block.

public AsyncServerStreamingCall<DelegatorInfo> GetPoolDelegators(GetPoolDelegatorsRequest input, CancellationToken token = default)

Parameters

input GetPoolDelegatorsRequest
token CancellationToken

Returns

AsyncServerStreamingCall<DelegatorInfo>

GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest, CancellationToken)

Get all fixed delegators of a given pool for the reward period of a given block. In contrast to @getPoolDelegators@ which returns all active delegators registered for the given block, this returns all the active fixed delegators contributing stake in the reward period containing the given block.

public AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest input, CancellationToken token = default)

Parameters

input GetPoolDelegatorsRequest
token CancellationToken

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>

GetPoolInfo(PoolInfoRequest, CancellationToken)

Get information about a given pool at the end of a given block.

public PoolInfoResponse GetPoolInfo(PoolInfoRequest input, CancellationToken token = default)

Parameters

input PoolInfoRequest
token CancellationToken

Returns

PoolInfoResponse

GetPoolInfoAsync(PoolInfoRequest, CancellationToken)

Returns information about a given pool at the end of a given block.

public AsyncUnaryCall<PoolInfoResponse> GetPoolInfoAsync(PoolInfoRequest input, CancellationToken token = default)

Parameters

input PoolInfoRequest
token CancellationToken

Returns

AsyncUnaryCall<PoolInfoResponse>

GetTokenomicsInfo(BlockHashInput, CancellationToken)

Get information about tokenomics at the end of a given block.

public TokenomicsInfo GetTokenomicsInfo(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

TokenomicsInfo

GetTokenomicsInfoAsync(BlockHashInput, CancellationToken)

Returns information about tokenomics at the end of a given block.

public AsyncUnaryCall<TokenomicsInfo> GetTokenomicsInfoAsync(BlockHashInput input, CancellationToken token = default)

Parameters

input BlockHashInput
token CancellationToken

Returns

AsyncUnaryCall<TokenomicsInfo>

InstanceStateLookup(InstanceStateLookupRequest, CancellationToken)

Get the value at a specific key of a contract state. In contrast to GetInstanceState(InstanceInfoRequest, CancellationToken) this is more efficient, but requires the user to know the specific key to look up in advance.

public InstanceStateValueAtKey InstanceStateLookup(InstanceStateLookupRequest input, CancellationToken token = default)

Parameters

input InstanceStateLookupRequest
token CancellationToken

Returns

InstanceStateValueAtKey

InstanceStateLookupAsync(InstanceStateLookupRequest, CancellationToken)

Returns the value at a specific key of a contract state. In contrast to GetInstanceState(InstanceInfoRequest, CancellationToken) this is more efficient, but requires the user to know the specific key to look up in advance.

public AsyncUnaryCall<InstanceStateValueAtKey> InstanceStateLookupAsync(InstanceStateLookupRequest input, CancellationToken token = default)

Parameters

input InstanceStateLookupRequest
token CancellationToken

Returns

AsyncUnaryCall<InstanceStateValueAtKey>

InvokeInstance(InvokeInstanceRequest, CancellationToken)

Instructs the node to run a smart contract entrypoint in the given context and state at the end of a given block.

public InvokeInstanceResponse InvokeInstance(InvokeInstanceRequest input, CancellationToken token = default)

Parameters

input InvokeInstanceRequest
token CancellationToken

Returns

InvokeInstanceResponse

InvokeInstanceAsync(InvokeInstanceRequest, CancellationToken)

Instructs the node to run a smart contract entrypoint in the given context and state at the end of a given block.

public AsyncUnaryCall<InvokeInstanceResponse> InvokeInstanceAsync(InvokeInstanceRequest input, CancellationToken token = default)

Parameters

input InvokeInstanceRequest
token CancellationToken

Returns

AsyncUnaryCall<InvokeInstanceResponse>

PeerConnect(IpSocketAddress, CancellationToken)

Request that the node connect to the peer with the specified details. If the request succeeds, the peer is added to the peer-list of the node. Otherwise a gRPC exception is thrown. Note that the peer may not be connected instantly, in which case the call will still succeed.

public Empty PeerConnect(IpSocketAddress input, CancellationToken token = default)

Parameters

input IpSocketAddress
token CancellationToken

Returns

Empty

PeerConnectAsync(IpSocketAddress, CancellationToken)

Requests that the node connect to the peer with the specified details. If the request succeeds, the peer is added to the peer-list of the node. Otherwise a gRPC exception is thrown. Note that the peer may not be connected instantly, in which case the call will still succeed.

public AsyncUnaryCall<Empty> PeerConnectAsync(IpSocketAddress input, CancellationToken token = default)

Parameters

input IpSocketAddress
token CancellationToken

Returns

AsyncUnaryCall<Empty>

PeerDisconnect(IpSocketAddress, CancellationToken)

Request the node to disconnect from the peer with the specified details. If the request was succesfully processed, the peer is removed from the peer-list. Otherwise a gRPC exception is returned.

public Empty PeerDisconnect(IpSocketAddress input, CancellationToken token = default)

Parameters

input IpSocketAddress
token CancellationToken

Returns

Empty

PeerDisconnectAsync(IpSocketAddress, CancellationToken)

Requests the node to disconnect from the peer with the specified details. If the request was succesfully processed, the peer is removed from the peer-list. Otherwise a gRPC exception is returned.

public AsyncUnaryCall<Empty> PeerDisconnectAsync(IpSocketAddress input, CancellationToken token = default)

Parameters

input IpSocketAddress
token CancellationToken

Returns

AsyncUnaryCall<Empty>

SendBlockItem(SendBlockItemRequest, CancellationToken)

Send a block item to the node. A block item is either an account transaction, which is a transaction signed and paid for by an account, a credential deployment, which creates a new account, or an update instruction, which is an instruction to change some parameters of the chain. Update instructions can only be sent by the governance committee.

Returns a hash of the sent block item, which can be used with GetBlockItemStatus(TransactionHash, CancellationToken).

public TransactionHash SendBlockItem(SendBlockItemRequest input, CancellationToken token = default)

Parameters

input SendBlockItemRequest
token CancellationToken

Returns

TransactionHash

SendBlockItemAsync(SendBlockItemRequest, CancellationToken)

Send a block item to the node. A block item is either an account transaction, which is a transaction signed and paid for by an account, a credential deployment, which creates a new account, or an update instruction, which is an instruction to change some parameters of the chain. Update instructions can only be sent by the governance committee.

Returns a hash of the sent block item, which can be used with GetBlockItemStatus(TransactionHash, CancellationToken).

public AsyncUnaryCall<TransactionHash> SendBlockItemAsync(SendBlockItemRequest input, CancellationToken token = default)

Parameters

input SendBlockItemRequest
token CancellationToken

Returns

AsyncUnaryCall<TransactionHash>

Shutdown(CancellationToken)

Request that the node shut down. Throws an exception if the shutdown failed.

public Empty Shutdown(CancellationToken token = default)

Parameters

token CancellationToken

Returns

Empty

ShutdownAsync(CancellationToken)

Requests that the node shut down. Throws an exception if the shutdown failed.

public AsyncUnaryCall<Empty> ShutdownAsync(CancellationToken token = default)

Parameters

token CancellationToken

Returns

AsyncUnaryCall<Empty>

UnbanPeer(BannedPeer, CancellationToken)

Request the node to unban the specified peer. Throws a gRPC error if the action failed.

public Empty UnbanPeer(BannedPeer input, CancellationToken token = default)

Parameters

input BannedPeer
token CancellationToken

Returns

Empty

UnbanPeerAsync(BannedPeer, CancellationToken)

Requests the node to unban the specified peer. Throws a gRPC error if the action failed.

public AsyncUnaryCall<Empty> UnbanPeerAsync(BannedPeer input, CancellationToken token = default)

Parameters

input BannedPeer
token CancellationToken

Returns

AsyncUnaryCall<Empty>
Edit this page