Class Queries.QueriesClient

Namespace: Concordium.Grpc.V2

Assembly: Concordium.Sdk.dll

Client for Queries

public class Queries.QueriesClient : ClientBase<Queries.QueriesClient>

Inheritance: object

ClientBase

ClientBase<Queries.QueriesClient>

Queries.QueriesClient

Inherited Members: ClientBase<Queries.QueriesClient>.WithHost(string)

ClientBase.CallInvoker

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

QueriesClient()

Protected parameterless constructor to allow creation of test doubles.

protected QueriesClient()

QueriesClient(CallInvoker)

Creates a new client for Queries that uses a custom CallInvoker.

public QueriesClient(CallInvoker callInvoker)

Parameters

callInvoker CallInvoker: The callInvoker to use to make remote calls.

QueriesClient(ChannelBase)

Creates a new client for Queries

public QueriesClient(ChannelBase channel)

Parameters

channel ChannelBase: The channel to use to make remote calls.

QueriesClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

protected QueriesClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration: The client configuration.

Methods

BanPeer(PeerToBan, CallOptions)

Ban the given peer. Returns a GRPC error if the action failed.

public virtual Empty BanPeer(PeerToBan request, CallOptions options)

Parameters

request PeerToBan: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

BanPeer(PeerToBan, Metadata, DateTime?, CancellationToken)

Ban the given peer. Returns a GRPC error if the action failed.

public virtual Empty BanPeer(PeerToBan request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PeerToBan: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

BanPeerAsync(PeerToBan, CallOptions)

Ban the given peer. Returns a GRPC error if the action failed.

public virtual AsyncUnaryCall<Empty> BanPeerAsync(PeerToBan request, CallOptions options)

Parameters

request PeerToBan: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

BanPeerAsync(PeerToBan, Metadata, DateTime?, CancellationToken)

Ban the given peer. Returns a GRPC error if the action failed.

public virtual AsyncUnaryCall<Empty> BanPeerAsync(PeerToBan request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PeerToBan: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

DryRun(CallOptions)

Dry run a series of transactions and operations on a state derived from a specified block. The server should send a single DryRunResponse for each DryRunRequest received, unless the call fails with an error status code. If a request produces a DryRunErrorResponse, then the server will still process subsequent requests, just as if the request causing the error did not happen.

The first request should be load_block_at_state to determine the block state that will be used for the dry run.

The server associates each request with an energy cost, and limits the total energy that may be expended in a single invocation of DryRun. This limit is reported as quota in the initial metadata returned by the server. If executing an operation exceeds the limit, the server terminates the session with RESOURCE_EXHAUSTED.

The server also imposes a timeout for a dry-run session to complete. The server reports the timeout duration in milliseconds in the initial metadata field timeout. If the session is not completed before the timeout elapses, the server terminates the session with DEADLINE_EXCEEDED.

The following error cases are possible:

INVALID_ARGUMENT if any DryRunRequest is malformed.
RESOURCE_EXHAUSTED if the energy quota is exceeded.
DEADLINE_EXCEEDED if the session does not complete before the server-imposed timeout.
RESOURCE_EXHAUSTED if the server is not currently accepting new DryRun sessions. (The server may impose a limit on the number of concurrent sessions.)
INTERNAL if an interal server error occurs. This should not happen, and likely indicates a bug.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncDuplexStreamingCall<DryRunRequest, DryRunResponse> DryRun(CallOptions options)

Parameters

options CallOptions: The options for the call.

Returns

AsyncDuplexStreamingCall<DryRunRequest, DryRunResponse>: The call object.

DryRun(Metadata, DateTime?, CancellationToken)

The first request should be load_block_at_state to determine the block state that will be used for the dry run.

The following error cases are possible:

INVALID_ARGUMENT if any DryRunRequest is malformed.
RESOURCE_EXHAUSTED if the energy quota is exceeded.
DEADLINE_EXCEEDED if the session does not complete before the server-imposed timeout.
RESOURCE_EXHAUSTED if the server is not currently accepting new DryRun sessions. (The server may impose a limit on the number of concurrent sessions.)
INTERNAL if an interal server error occurs. This should not happen, and likely indicates a bug.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncDuplexStreamingCall<DryRunRequest, DryRunResponse> DryRun(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncDuplexStreamingCall<DryRunRequest, DryRunResponse>: The call object.

DumpStart(DumpRequest, CallOptions)

Start dumping packages into the specified file. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to start.

public virtual Empty DumpStart(DumpRequest request, CallOptions options)

Parameters

request DumpRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

DumpStart(DumpRequest, Metadata, DateTime?, CancellationToken)

Start dumping packages into the specified file. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to start.

public virtual Empty DumpStart(DumpRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request DumpRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

DumpStartAsync(DumpRequest, CallOptions)

Start dumping packages into the specified file. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to start.

public virtual AsyncUnaryCall<Empty> DumpStartAsync(DumpRequest request, CallOptions options)

Parameters

request DumpRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

DumpStartAsync(DumpRequest, Metadata, DateTime?, CancellationToken)

Start dumping packages into the specified file. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to start.

public virtual AsyncUnaryCall<Empty> DumpStartAsync(DumpRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request DumpRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

DumpStop(Empty, CallOptions)

Stop dumping packages. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to be stopped.

public virtual Empty DumpStop(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

DumpStop(Empty, Metadata, DateTime?, CancellationToken)

Stop dumping packages. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to be stopped.

public virtual Empty DumpStop(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

DumpStopAsync(Empty, CallOptions)

Stop dumping packages. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to be stopped.

public virtual AsyncUnaryCall<Empty> DumpStopAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

DumpStopAsync(Empty, Metadata, DateTime?, CancellationToken)

Stop dumping packages. Only enabled if the node was built with the network_dump feature. Returns a GRPC error if the network dump failed to be stopped.

public virtual AsyncUnaryCall<Empty> DumpStopAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

GetAccountInfo(AccountInfoRequest, CallOptions)

Retrieve the information about the given account in the given block.

public virtual AccountInfo GetAccountInfo(AccountInfoRequest request, CallOptions options)

Parameters

request AccountInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AccountInfo: The response received from the server.

GetAccountInfo(AccountInfoRequest, Metadata, DateTime?, CancellationToken)

Retrieve the information about the given account in the given block.

public virtual AccountInfo GetAccountInfo(AccountInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AccountInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AccountInfo: The response received from the server.

GetAccountInfoAsync(AccountInfoRequest, CallOptions)

Retrieve the information about the given account in the given block.

public virtual AsyncUnaryCall<AccountInfo> GetAccountInfoAsync(AccountInfoRequest request, CallOptions options)

Parameters

request AccountInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<AccountInfo>: The call object.

GetAccountInfoAsync(AccountInfoRequest, Metadata, DateTime?, CancellationToken)

Retrieve the information about the given account in the given block.

public virtual AsyncUnaryCall<AccountInfo> GetAccountInfoAsync(AccountInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AccountInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<AccountInfo>: The call object.

GetAccountList(BlockHashInput, CallOptions)

Retrieve the list of accounts that exist at the end of the given block.

public virtual AsyncServerStreamingCall<AccountAddress> GetAccountList(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<AccountAddress>: The call object.

GetAccountList(BlockHashInput, Metadata, DateTime?, CancellationToken)

Retrieve the list of accounts that exist at the end of the given block.

public virtual AsyncServerStreamingCall<AccountAddress> GetAccountList(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<AccountAddress>: The call object.

GetAccountNonFinalizedTransactions(AccountAddress, CallOptions)

Get a list of non-finalized transaction hashes for a given account. This endpoint is not expected to return a large amount of data in most cases, but in bad network condtions it might. The stream will end when all the non-finalized transaction hashes have been returned.

public virtual AsyncServerStreamingCall<TransactionHash> GetAccountNonFinalizedTransactions(AccountAddress request, CallOptions options)

Parameters

request AccountAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<TransactionHash>: The call object.

GetAccountNonFinalizedTransactions(AccountAddress, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<TransactionHash> GetAccountNonFinalizedTransactions(AccountAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AccountAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<TransactionHash>: The call object.

GetAccountTransactionSignHash(PreAccountTransaction, CallOptions)

Get the hash to be signed for an account transaction. The hash returned should be signed and the signatures included as an AccountTransactionSignature when calling SendBlockItem. This is provided as a convenience to support cases where the right SDK is not available for interacting with the node. If an SDK is available then it is strongly recommended to compute this hash off-line using it. That reduces the trust in the node, removes networking failure modes, and will perform better.

public virtual AccountTransactionSignHash GetAccountTransactionSignHash(PreAccountTransaction request, CallOptions options)

Parameters

request PreAccountTransaction: The request to send to the server.
options CallOptions: The options for the call.

Returns

AccountTransactionSignHash: The response received from the server.

GetAccountTransactionSignHash(PreAccountTransaction, Metadata, DateTime?, CancellationToken)

public virtual AccountTransactionSignHash GetAccountTransactionSignHash(PreAccountTransaction request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PreAccountTransaction: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AccountTransactionSignHash: The response received from the server.

GetAccountTransactionSignHashAsync(PreAccountTransaction, CallOptions)

public virtual AsyncUnaryCall<AccountTransactionSignHash> GetAccountTransactionSignHashAsync(PreAccountTransaction request, CallOptions options)

Parameters

request PreAccountTransaction: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<AccountTransactionSignHash>: The call object.

GetAccountTransactionSignHashAsync(PreAccountTransaction, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AccountTransactionSignHash> GetAccountTransactionSignHashAsync(PreAccountTransaction request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PreAccountTransaction: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<AccountTransactionSignHash>: The call object.

GetAncestors(AncestorsRequest, CallOptions)

Get a stream of ancestors for the provided block. Starting with the provided block itself, moving backwards until no more ancestors or the requested number of ancestors has been returned.

public virtual AsyncServerStreamingCall<BlockHash> GetAncestors(AncestorsRequest request, CallOptions options)

Parameters

request AncestorsRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BlockHash>: The call object.

GetAncestors(AncestorsRequest, Metadata, DateTime?, CancellationToken)

Get a stream of ancestors for the provided block. Starting with the provided block itself, moving backwards until no more ancestors or the requested number of ancestors has been returned.

public virtual AsyncServerStreamingCall<BlockHash> GetAncestors(AncestorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AncestorsRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BlockHash>: The call object.

GetAnonymityRevokers(BlockHashInput, CallOptions)

Get the anonymity revokers registered as of the end of a given block. The stream will end when all the anonymity revokers have been returned.

public virtual AsyncServerStreamingCall<ArInfo> GetAnonymityRevokers(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<ArInfo>: The call object.

GetAnonymityRevokers(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the anonymity revokers registered as of the end of a given block. The stream will end when all the anonymity revokers have been returned.

public virtual AsyncServerStreamingCall<ArInfo> GetAnonymityRevokers(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<ArInfo>: The call object.

GetBakerEarliestWinTime(BakerId, CallOptions)

Get the projected earliest time at which a particular baker will be required to bake a block. If the current consensus version is 0, this returns the status 'Unavailable', as the endpoint is only supported by consensus version 1.

If the baker is not a baker for the current reward period, this returns a timestamp at the start of the next reward period. If the baker is a baker for the current reward period, the earliest win time is projected from the current round forward, assuming that each round after the last finalized round will take the minimum block time. (If blocks take longer, or timeouts occur, the actual time may be later, and the reported time in subsequent queries may reflect this.) At the end of an epoch (or if the baker is not projected to bake before the end of the epoch) the earliest win time for a (current) baker will be projected as the start of the next epoch. This is because the seed for the leader election is updated at the epoch boundary, and so the winners cannot be predicted beyond that. Note that in some circumstances the returned timestamp can be in the past, especially at the end of an epoch.

public virtual Timestamp GetBakerEarliestWinTime(BakerId request, CallOptions options)

Parameters

request BakerId: The request to send to the server.
options CallOptions: The options for the call.

Returns

Timestamp: The response received from the server.

GetBakerEarliestWinTime(BakerId, Metadata, DateTime?, CancellationToken)

public virtual Timestamp GetBakerEarliestWinTime(BakerId request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BakerId: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Timestamp: The response received from the server.

GetBakerEarliestWinTimeAsync(BakerId, CallOptions)

public virtual AsyncUnaryCall<Timestamp> GetBakerEarliestWinTimeAsync(BakerId request, CallOptions options)

Parameters

request BakerId: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Timestamp>: The call object.

GetBakerEarliestWinTimeAsync(BakerId, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Timestamp> GetBakerEarliestWinTimeAsync(BakerId request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BakerId: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Timestamp>: The call object.

GetBakerList(BlockHashInput, CallOptions)

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

public virtual AsyncServerStreamingCall<BakerId> GetBakerList(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BakerId>: The call object.

GetBakerList(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncServerStreamingCall<BakerId> GetBakerList(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BakerId>: The call object.

GetBakersRewardPeriod(BlockHashInput, CallOptions)

Get all bakers in the reward period of a block. This endpoint is only supported for protocol version 6 and onwards. If the protocol does not support the endpoint then an 'IllegalArgument' error is returned.

public virtual AsyncServerStreamingCall<BakerRewardPeriodInfo> GetBakersRewardPeriod(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BakerRewardPeriodInfo>: The call object.

GetBakersRewardPeriod(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<BakerRewardPeriodInfo> GetBakersRewardPeriod(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BakerRewardPeriodInfo>: The call object.

GetBannedPeers(Empty, CallOptions)

Get a list of banned peers.

public virtual BannedPeers GetBannedPeers(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

BannedPeers: The response received from the server.

GetBannedPeers(Empty, Metadata, DateTime?, CancellationToken)

Get a list of banned peers.

public virtual BannedPeers GetBannedPeers(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BannedPeers: The response received from the server.

GetBannedPeersAsync(Empty, CallOptions)

Get a list of banned peers.

public virtual AsyncUnaryCall<BannedPeers> GetBannedPeersAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BannedPeers>: The call object.

GetBannedPeersAsync(Empty, Metadata, DateTime?, CancellationToken)

Get a list of banned peers.

public virtual AsyncUnaryCall<BannedPeers> GetBannedPeersAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BannedPeers>: The call object.

GetBlockCertificates(BlockHashInput, CallOptions)

For a non-genesis block, this returns the quorum certificate, a timeout certificate (if present) and epoch finalization entry (if present). Note that, if the block being pointed to is not a product of ConcordiumBFT, then the response will be a grpc error (invalid argument). If the endpoint is not enabled by the node, then an 'unimplemented' error will be returned.

public virtual BlockCertificates GetBlockCertificates(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlockCertificates: The response received from the server.

GetBlockCertificates(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual BlockCertificates GetBlockCertificates(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlockCertificates: The response received from the server.

GetBlockCertificatesAsync(BlockHashInput, CallOptions)

public virtual AsyncUnaryCall<BlockCertificates> GetBlockCertificatesAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlockCertificates>: The call object.

GetBlockCertificatesAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BlockCertificates> GetBlockCertificatesAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlockCertificates>: The call object.

GetBlockChainParameters(BlockHashInput, CallOptions)

Get the values of chain parameters in effect in the given block.

public virtual ChainParameters GetBlockChainParameters(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

ChainParameters: The response received from the server.

GetBlockChainParameters(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the values of chain parameters in effect in the given block.

public virtual ChainParameters GetBlockChainParameters(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

ChainParameters: The response received from the server.

GetBlockChainParametersAsync(BlockHashInput, CallOptions)

Get the values of chain parameters in effect in the given block.

public virtual AsyncUnaryCall<ChainParameters> GetBlockChainParametersAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<ChainParameters>: The call object.

GetBlockChainParametersAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the values of chain parameters in effect in the given block.

public virtual AsyncUnaryCall<ChainParameters> GetBlockChainParametersAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<ChainParameters>: The call object.

GetBlockFinalizationSummary(BlockHashInput, CallOptions)

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

public virtual BlockFinalizationSummary GetBlockFinalizationSummary(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlockFinalizationSummary: The response received from the server.

GetBlockFinalizationSummary(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual BlockFinalizationSummary GetBlockFinalizationSummary(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlockFinalizationSummary: The response received from the server.

GetBlockFinalizationSummaryAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<BlockFinalizationSummary> GetBlockFinalizationSummaryAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlockFinalizationSummary>: The call object.

GetBlockFinalizationSummaryAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<BlockFinalizationSummary> GetBlockFinalizationSummaryAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlockFinalizationSummary>: The call object.

GetBlockInfo(BlockHashInput, CallOptions)

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

public virtual BlockInfo GetBlockInfo(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlockInfo: The response received from the server.

GetBlockInfo(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual BlockInfo GetBlockInfo(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlockInfo: The response received from the server.

GetBlockInfoAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<BlockInfo> GetBlockInfoAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlockInfo>: The call object.

GetBlockInfoAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<BlockInfo> GetBlockInfoAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlockInfo>: The call object.

GetBlockItemStatus(TransactionHash, CallOptions)

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

public virtual BlockItemStatus GetBlockItemStatus(TransactionHash request, CallOptions options)

Parameters

request TransactionHash: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlockItemStatus: The response received from the server.

GetBlockItemStatus(TransactionHash, Metadata, DateTime?, CancellationToken)

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

public virtual BlockItemStatus GetBlockItemStatus(TransactionHash request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request TransactionHash: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlockItemStatus: The response received from the server.

GetBlockItemStatusAsync(TransactionHash, CallOptions)

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

public virtual AsyncUnaryCall<BlockItemStatus> GetBlockItemStatusAsync(TransactionHash request, CallOptions options)

Parameters

request TransactionHash: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlockItemStatus>: The call object.

GetBlockItemStatusAsync(TransactionHash, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<BlockItemStatus> GetBlockItemStatusAsync(TransactionHash request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request TransactionHash: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlockItemStatus>: The call object.

GetBlockItems(BlockHashInput, CallOptions)

Get the items of a block.

public virtual AsyncServerStreamingCall<BlockItem> GetBlockItems(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BlockItem>: The call object.

GetBlockItems(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the items of a block.

public virtual AsyncServerStreamingCall<BlockItem> GetBlockItems(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BlockItem>: The call object.

GetBlockPendingUpdates(BlockHashInput, CallOptions)

Get the pending updates to chain parameters at the end of a given block. The stream will end when all the pending updates for a given block have been returned.

public virtual AsyncServerStreamingCall<PendingUpdate> GetBlockPendingUpdates(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<PendingUpdate>: The call object.

GetBlockPendingUpdates(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the pending updates to chain parameters at the end of a given block. The stream will end when all the pending updates for a given block have been returned.

public virtual AsyncServerStreamingCall<PendingUpdate> GetBlockPendingUpdates(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<PendingUpdate>: The call object.

GetBlockSpecialEvents(BlockHashInput, CallOptions)

Get a list of special events in a given block. These are events generated by the protocol, such as minting and reward payouts. They are not directly generated by any transaction. The stream will end when all the special events for a given block have been returned.

public virtual AsyncServerStreamingCall<BlockSpecialEvent> GetBlockSpecialEvents(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BlockSpecialEvent>: The call object.

GetBlockSpecialEvents(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<BlockSpecialEvent> GetBlockSpecialEvents(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BlockSpecialEvent>: The call object.

GetBlockTransactionEvents(BlockHashInput, CallOptions)

Get a list of transaction events in a given block. The stream will end when all the transaction events for a given block have been returned.

public virtual AsyncServerStreamingCall<BlockItemSummary> GetBlockTransactionEvents(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<BlockItemSummary>: The call object.

GetBlockTransactionEvents(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get a list of transaction events in a given block. The stream will end when all the transaction events for a given block have been returned.

public virtual AsyncServerStreamingCall<BlockItemSummary> GetBlockTransactionEvents(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<BlockItemSummary>: The call object.

GetBlocks(Empty, CallOptions)

Return a stream of blocks that arrive from the time the query is made onward. This can be used to listen for incoming blocks.

public virtual AsyncServerStreamingCall<ArrivedBlockInfo> GetBlocks(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<ArrivedBlockInfo>: The call object.

GetBlocks(Empty, Metadata, DateTime?, CancellationToken)

Return a stream of blocks that arrive from the time the query is made onward. This can be used to listen for incoming blocks.

public virtual AsyncServerStreamingCall<ArrivedBlockInfo> GetBlocks(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<ArrivedBlockInfo>: The call object.

GetBlocksAtHeight(BlocksAtHeightRequest, CallOptions)

Get a list of live blocks at a given height.

public virtual BlocksAtHeightResponse GetBlocksAtHeight(BlocksAtHeightRequest request, CallOptions options)

Parameters

request BlocksAtHeightRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlocksAtHeightResponse: The response received from the server.

GetBlocksAtHeight(BlocksAtHeightRequest, Metadata, DateTime?, CancellationToken)

Get a list of live blocks at a given height.

public virtual BlocksAtHeightResponse GetBlocksAtHeight(BlocksAtHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlocksAtHeightRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlocksAtHeightResponse: The response received from the server.

GetBlocksAtHeightAsync(BlocksAtHeightRequest, CallOptions)

Get a list of live blocks at a given height.

public virtual AsyncUnaryCall<BlocksAtHeightResponse> GetBlocksAtHeightAsync(BlocksAtHeightRequest request, CallOptions options)

Parameters

request BlocksAtHeightRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlocksAtHeightResponse>: The call object.

GetBlocksAtHeightAsync(BlocksAtHeightRequest, Metadata, DateTime?, CancellationToken)

Get a list of live blocks at a given height.

public virtual AsyncUnaryCall<BlocksAtHeightResponse> GetBlocksAtHeightAsync(BlocksAtHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlocksAtHeightRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlocksAtHeightResponse>: The call object.

GetBranches(Empty, CallOptions)

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

public virtual Branch GetBranches(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

Branch: The response received from the server.

GetBranches(Empty, Metadata, DateTime?, CancellationToken)

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

public virtual Branch GetBranches(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Branch: The response received from the server.

GetBranchesAsync(Empty, CallOptions)

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

public virtual AsyncUnaryCall<Branch> GetBranchesAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Branch>: The call object.

GetBranchesAsync(Empty, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<Branch> GetBranchesAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Branch>: The call object.

GetConsensusInfo(Empty, CallOptions)

Get information about the current state of consensus.

public virtual ConsensusInfo GetConsensusInfo(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

ConsensusInfo: The response received from the server.

GetConsensusInfo(Empty, Metadata, DateTime?, CancellationToken)

Get information about the current state of consensus.

public virtual ConsensusInfo GetConsensusInfo(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

ConsensusInfo: The response received from the server.

GetConsensusInfoAsync(Empty, CallOptions)

Get information about the current state of consensus.

public virtual AsyncUnaryCall<ConsensusInfo> GetConsensusInfoAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<ConsensusInfo>: The call object.

GetConsensusInfoAsync(Empty, Metadata, DateTime?, CancellationToken)

Get information about the current state of consensus.

public virtual AsyncUnaryCall<ConsensusInfo> GetConsensusInfoAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<ConsensusInfo>: The call object.

GetCryptographicParameters(BlockHashInput, CallOptions)

Get the cryptographic parameters in a given block.

public virtual CryptographicParameters GetCryptographicParameters(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

CryptographicParameters: The response received from the server.

GetCryptographicParameters(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the cryptographic parameters in a given block.

public virtual CryptographicParameters GetCryptographicParameters(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

CryptographicParameters: The response received from the server.

GetCryptographicParametersAsync(BlockHashInput, CallOptions)

Get the cryptographic parameters in a given block.

public virtual AsyncUnaryCall<CryptographicParameters> GetCryptographicParametersAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<CryptographicParameters>: The call object.

GetCryptographicParametersAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the cryptographic parameters in a given block.

public virtual AsyncUnaryCall<CryptographicParameters> GetCryptographicParametersAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<CryptographicParameters>: The call object.

GetElectionInfo(BlockHashInput, CallOptions)

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

public virtual ElectionInfo GetElectionInfo(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

ElectionInfo: The response received from the server.

GetElectionInfo(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual ElectionInfo GetElectionInfo(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

ElectionInfo: The response received from the server.

GetElectionInfoAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<ElectionInfo> GetElectionInfoAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<ElectionInfo>: The call object.

GetElectionInfoAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<ElectionInfo> GetElectionInfoAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<ElectionInfo>: The call object.

GetFinalizedBlocks(Empty, CallOptions)

Return 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 there is no guarantee that blocks will not be skipped if the client is too slow in processing the stream, however blocks will always be sent by increasing block height.

public virtual AsyncServerStreamingCall<FinalizedBlockInfo> GetFinalizedBlocks(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<FinalizedBlockInfo>: The call object.

GetFinalizedBlocks(Empty, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<FinalizedBlockInfo> GetFinalizedBlocks(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<FinalizedBlockInfo>: The call object.

GetFirstBlockEpoch(EpochRequest, CallOptions)

Get the block hash of the first finalized block in a specified epoch.

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch with no finalized blocks for a past genesis index.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual BlockHash GetFirstBlockEpoch(EpochRequest request, CallOptions options)

Parameters

request EpochRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

BlockHash: The response received from the server.

GetFirstBlockEpoch(EpochRequest, Metadata, DateTime?, CancellationToken)

Get the block hash of the first finalized block in a specified epoch.

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch with no finalized blocks for a past genesis index.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual BlockHash GetFirstBlockEpoch(EpochRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request EpochRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

BlockHash: The response received from the server.

GetFirstBlockEpochAsync(EpochRequest, CallOptions)

Get the block hash of the first finalized block in a specified epoch.

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch with no finalized blocks for a past genesis index.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncUnaryCall<BlockHash> GetFirstBlockEpochAsync(EpochRequest request, CallOptions options)

Parameters

request EpochRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<BlockHash>: The call object.

GetFirstBlockEpochAsync(EpochRequest, Metadata, DateTime?, CancellationToken)

Get the block hash of the first finalized block in a specified epoch.

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch with no finalized blocks for a past genesis index.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncUnaryCall<BlockHash> GetFirstBlockEpochAsync(EpochRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request EpochRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<BlockHash>: The call object.

GetIdentityProviders(BlockHashInput, CallOptions)

Get the identity providers registered as of the end of a given block. The stream will end when all the identity providers have been returned.

public virtual AsyncServerStreamingCall<IpInfo> GetIdentityProviders(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<IpInfo>: The call object.

GetIdentityProviders(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get the identity providers registered as of the end of a given block. The stream will end when all the identity providers have been returned.

public virtual AsyncServerStreamingCall<IpInfo> GetIdentityProviders(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<IpInfo>: The call object.

GetInstanceInfo(InstanceInfoRequest, CallOptions)

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

public virtual InstanceInfo GetInstanceInfo(InstanceInfoRequest request, CallOptions options)

Parameters

request InstanceInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

InstanceInfo: The response received from the server.

GetInstanceInfo(InstanceInfoRequest, Metadata, DateTime?, CancellationToken)

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

public virtual InstanceInfo GetInstanceInfo(InstanceInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InstanceInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

InstanceInfo: The response received from the server.

GetInstanceInfoAsync(InstanceInfoRequest, CallOptions)

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

public virtual AsyncUnaryCall<InstanceInfo> GetInstanceInfoAsync(InstanceInfoRequest request, CallOptions options)

Parameters

request InstanceInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<InstanceInfo>: The call object.

GetInstanceInfoAsync(InstanceInfoRequest, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<InstanceInfo> GetInstanceInfoAsync(InstanceInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InstanceInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<InstanceInfo>: The call object.

GetInstanceList(BlockHashInput, CallOptions)

Get a list of addresses for all smart contract instances. The stream will end when all instances that exist in the state at the end of the given block has been returned.

public virtual AsyncServerStreamingCall<ContractAddress> GetInstanceList(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<ContractAddress>: The call object.

GetInstanceList(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get a list of addresses for all smart contract instances. The stream will end when all instances that exist in the state at the end of the given block has been returned.

public virtual AsyncServerStreamingCall<ContractAddress> GetInstanceList(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<ContractAddress>: The call object.

GetInstanceState(InstanceInfoRequest, CallOptions)

Get the exact state of a specific contract instance, streamed as a list of key-value pairs. The list is streamed in lexicographic order of keys.

public virtual AsyncServerStreamingCall<InstanceStateKVPair> GetInstanceState(InstanceInfoRequest request, CallOptions options)

Parameters

request InstanceInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<InstanceStateKVPair>: The call object.

GetInstanceState(InstanceInfoRequest, Metadata, DateTime?, CancellationToken)

Get the exact state of a specific contract instance, streamed as a list of key-value pairs. The list is streamed in lexicographic order of keys.

public virtual AsyncServerStreamingCall<InstanceStateKVPair> GetInstanceState(InstanceInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InstanceInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<InstanceStateKVPair>: The call object.

GetModuleList(BlockHashInput, CallOptions)

Get a list of all smart contract modules. The stream will end when all modules that exist in the state at the end of the given block have been returned.

public virtual AsyncServerStreamingCall<ModuleRef> GetModuleList(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<ModuleRef>: The call object.

GetModuleList(BlockHashInput, Metadata, DateTime?, CancellationToken)

Get a list of all smart contract modules. The stream will end when all modules that exist in the state at the end of the given block have been returned.

public virtual AsyncServerStreamingCall<ModuleRef> GetModuleList(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<ModuleRef>: The call object.

GetModuleSource(ModuleSourceRequest, CallOptions)

Get the source of a smart contract module.

public virtual VersionedModuleSource GetModuleSource(ModuleSourceRequest request, CallOptions options)

Parameters

request ModuleSourceRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

VersionedModuleSource: The response received from the server.

GetModuleSource(ModuleSourceRequest, Metadata, DateTime?, CancellationToken)

Get the source of a smart contract module.

public virtual VersionedModuleSource GetModuleSource(ModuleSourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request ModuleSourceRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

VersionedModuleSource: The response received from the server.

GetModuleSourceAsync(ModuleSourceRequest, CallOptions)

Get the source of a smart contract module.

public virtual AsyncUnaryCall<VersionedModuleSource> GetModuleSourceAsync(ModuleSourceRequest request, CallOptions options)

Parameters

request ModuleSourceRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<VersionedModuleSource>: The call object.

GetModuleSourceAsync(ModuleSourceRequest, Metadata, DateTime?, CancellationToken)

Get the source of a smart contract module.

public virtual AsyncUnaryCall<VersionedModuleSource> GetModuleSourceAsync(ModuleSourceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request ModuleSourceRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<VersionedModuleSource>: The call object.

GetNextAccountSequenceNumber(AccountAddress, CallOptions)

Get the best guess as to what the next account sequence number should be. 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 virtual NextAccountSequenceNumber GetNextAccountSequenceNumber(AccountAddress request, CallOptions options)

Parameters

request AccountAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

NextAccountSequenceNumber: The response received from the server.

GetNextAccountSequenceNumber(AccountAddress, Metadata, DateTime?, CancellationToken)

public virtual NextAccountSequenceNumber GetNextAccountSequenceNumber(AccountAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AccountAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

NextAccountSequenceNumber: The response received from the server.

GetNextAccountSequenceNumberAsync(AccountAddress, CallOptions)

public virtual AsyncUnaryCall<NextAccountSequenceNumber> GetNextAccountSequenceNumberAsync(AccountAddress request, CallOptions options)

Parameters

request AccountAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<NextAccountSequenceNumber>: The call object.

GetNextAccountSequenceNumberAsync(AccountAddress, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NextAccountSequenceNumber> GetNextAccountSequenceNumberAsync(AccountAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request AccountAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<NextAccountSequenceNumber>: The call object.

GetNextUpdateSequenceNumbers(BlockHashInput, CallOptions)

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

public virtual NextUpdateSequenceNumbers GetNextUpdateSequenceNumbers(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

NextUpdateSequenceNumbers: The response received from the server.

GetNextUpdateSequenceNumbers(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual NextUpdateSequenceNumbers GetNextUpdateSequenceNumbers(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

NextUpdateSequenceNumbers: The response received from the server.

GetNextUpdateSequenceNumbersAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<NextUpdateSequenceNumbers> GetNextUpdateSequenceNumbersAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<NextUpdateSequenceNumbers>: The call object.

GetNextUpdateSequenceNumbersAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<NextUpdateSequenceNumbers> GetNextUpdateSequenceNumbersAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<NextUpdateSequenceNumbers>: The call object.

GetNodeInfo(Empty, CallOptions)

Get information about the node. The NodeInfo includes information of

Meta information such as the, version of the node, type of the node, uptime and the local time of the node.
NetworkInfo which yields data such as the node id, packets sent/received, average bytes per second sent/received.
ConsensusInfo. The ConsensusInfo returned depends on if the node supports the protocol on chain and whether the node is configured as a baker or not.

public virtual NodeInfo GetNodeInfo(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

NodeInfo: The response received from the server.

GetNodeInfo(Empty, Metadata, DateTime?, CancellationToken)

Get information about the node. The NodeInfo includes information of

Meta information such as the, version of the node, type of the node, uptime and the local time of the node.
NetworkInfo which yields data such as the node id, packets sent/received, average bytes per second sent/received.
ConsensusInfo. The ConsensusInfo returned depends on if the node supports the protocol on chain and whether the node is configured as a baker or not.

public virtual NodeInfo GetNodeInfo(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

NodeInfo: The response received from the server.

GetNodeInfoAsync(Empty, CallOptions)

Get information about the node. The NodeInfo includes information of

Meta information such as the, version of the node, type of the node, uptime and the local time of the node.
NetworkInfo which yields data such as the node id, packets sent/received, average bytes per second sent/received.
ConsensusInfo. The ConsensusInfo returned depends on if the node supports the protocol on chain and whether the node is configured as a baker or not.

public virtual AsyncUnaryCall<NodeInfo> GetNodeInfoAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<NodeInfo>: The call object.

GetNodeInfoAsync(Empty, Metadata, DateTime?, CancellationToken)

Get information about the node. The NodeInfo includes information of

Meta information such as the, version of the node, type of the node, uptime and the local time of the node.
NetworkInfo which yields data such as the node id, packets sent/received, average bytes per second sent/received.
ConsensusInfo. The ConsensusInfo returned depends on if the node supports the protocol on chain and whether the node is configured as a baker or not.

public virtual AsyncUnaryCall<NodeInfo> GetNodeInfoAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<NodeInfo>: The call object.

GetPassiveDelegationInfo(BlockHashInput, CallOptions)

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

public virtual PassiveDelegationInfo GetPassiveDelegationInfo(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

PassiveDelegationInfo: The response received from the server.

GetPassiveDelegationInfo(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual PassiveDelegationInfo GetPassiveDelegationInfo(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

PassiveDelegationInfo: The response received from the server.

GetPassiveDelegationInfoAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<PassiveDelegationInfo> GetPassiveDelegationInfoAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<PassiveDelegationInfo>: The call object.

GetPassiveDelegationInfoAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<PassiveDelegationInfo> GetPassiveDelegationInfoAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<PassiveDelegationInfo>: The call object.

GetPassiveDelegators(BlockHashInput, CallOptions)

Get the registered passive delegators at the end of a given block. In contrast to the GetPassiveDelegatorsRewardPeriod which returns delegators that are fixed for the reward period of the block, this endpoint returns the list of delegators that are registered in the block. Any changes to delegators are immediately visible in this list. The stream will end when all the delegators has been returned.

public virtual AsyncServerStreamingCall<DelegatorInfo> GetPassiveDelegators(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<DelegatorInfo>: The call object.

GetPassiveDelegators(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<DelegatorInfo> GetPassiveDelegators(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<DelegatorInfo>: The call object.

GetPassiveDelegatorsRewardPeriod(BlockHashInput, CallOptions)

Get the fixed passive delegators for the reward period of the given block. In contracts to the GetPassiveDelegators which returns delegators registered for the given block, this endpoint returns the fixed delegators contributing stake in the reward period containing the given block. The stream will end when all the delegators has been returned.

public virtual AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPassiveDelegatorsRewardPeriod(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>: The call object.

GetPassiveDelegatorsRewardPeriod(BlockHashInput, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPassiveDelegatorsRewardPeriod(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>: The call object.

GetPeersInfo(Empty, CallOptions)

Get a list of the peers that the node is connected to and assoicated network related information for each peer.

public virtual PeersInfo GetPeersInfo(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

PeersInfo: The response received from the server.

GetPeersInfo(Empty, Metadata, DateTime?, CancellationToken)

Get a list of the peers that the node is connected to and assoicated network related information for each peer.

public virtual PeersInfo GetPeersInfo(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

PeersInfo: The response received from the server.

GetPeersInfoAsync(Empty, CallOptions)

Get a list of the peers that the node is connected to and assoicated network related information for each peer.

public virtual AsyncUnaryCall<PeersInfo> GetPeersInfoAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<PeersInfo>: The call object.

GetPeersInfoAsync(Empty, Metadata, DateTime?, CancellationToken)

Get a list of the peers that the node is connected to and assoicated network related information for each peer.

public virtual AsyncUnaryCall<PeersInfo> GetPeersInfoAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<PeersInfo>: The call object.

GetPoolDelegators(GetPoolDelegatorsRequest, CallOptions)

Get the registered delegators of a given pool at the end of a given block. In contrast to the GetPoolDelegatorsRewardPeriod which returns delegators that are fixed for the reward period of the block, this endpoint returns the list of delegators that are registered in the block. Any changes to delegators are immediately visible in this list. The stream will end when all the delegators has been returned.

public virtual AsyncServerStreamingCall<DelegatorInfo> GetPoolDelegators(GetPoolDelegatorsRequest request, CallOptions options)

Parameters

request GetPoolDelegatorsRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<DelegatorInfo>: The call object.

GetPoolDelegators(GetPoolDelegatorsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<DelegatorInfo> GetPoolDelegators(GetPoolDelegatorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetPoolDelegatorsRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<DelegatorInfo>: The call object.

GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest, CallOptions)

Get the fixed delegators of a given pool for the reward period of the given block. In contracts to the GetPoolDelegators which returns delegators registered for the given block, this endpoint returns the fixed delegators contributing stake in the reward period containing the given block. The stream will end when all the delegators has been returned.

public virtual AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest request, CallOptions options)

Parameters

request GetPoolDelegatorsRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>: The call object.

GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<DelegatorRewardPeriodInfo> GetPoolDelegatorsRewardPeriod(GetPoolDelegatorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetPoolDelegatorsRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<DelegatorRewardPeriodInfo>: The call object.

GetPoolInfo(PoolInfoRequest, CallOptions)

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

public virtual PoolInfoResponse GetPoolInfo(PoolInfoRequest request, CallOptions options)

Parameters

request PoolInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

PoolInfoResponse: The response received from the server.

GetPoolInfo(PoolInfoRequest, Metadata, DateTime?, CancellationToken)

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

public virtual PoolInfoResponse GetPoolInfo(PoolInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PoolInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

PoolInfoResponse: The response received from the server.

GetPoolInfoAsync(PoolInfoRequest, CallOptions)

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

public virtual AsyncUnaryCall<PoolInfoResponse> GetPoolInfoAsync(PoolInfoRequest request, CallOptions options)

Parameters

request PoolInfoRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<PoolInfoResponse>: The call object.

GetPoolInfoAsync(PoolInfoRequest, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<PoolInfoResponse> GetPoolInfoAsync(PoolInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request PoolInfoRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<PoolInfoResponse>: The call object.

GetTokenomicsInfo(BlockHashInput, CallOptions)

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

public virtual TokenomicsInfo GetTokenomicsInfo(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

TokenomicsInfo: The response received from the server.

GetTokenomicsInfo(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual TokenomicsInfo GetTokenomicsInfo(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

TokenomicsInfo: The response received from the server.

GetTokenomicsInfoAsync(BlockHashInput, CallOptions)

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

public virtual AsyncUnaryCall<TokenomicsInfo> GetTokenomicsInfoAsync(BlockHashInput request, CallOptions options)

Parameters

request BlockHashInput: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<TokenomicsInfo>: The call object.

GetTokenomicsInfoAsync(BlockHashInput, Metadata, DateTime?, CancellationToken)

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

public virtual AsyncUnaryCall<TokenomicsInfo> GetTokenomicsInfoAsync(BlockHashInput request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BlockHashInput: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<TokenomicsInfo>: The call object.

GetWinningBakersEpoch(EpochRequest, CallOptions)

Get the list of bakers that won the lottery in a particular historical epoch (i.e. the last finalized block is in a later epoch). This lists the winners for each round in the epoch, starting from the round after the last block in the previous epoch, running to the round before the first block in the next epoch. It also indicates if a block in each round was included in the finalized chain.

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch that is not finalized for a past genesis index.
INVALID_ARGUMENT if the query is for a genesis index at consensus version 0.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncServerStreamingCall<WinningBaker> GetWinningBakersEpoch(EpochRequest request, CallOptions options)

Parameters

request EpochRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncServerStreamingCall<WinningBaker>: The call object.

GetWinningBakersEpoch(EpochRequest, Metadata, DateTime?, CancellationToken)

The following error cases are possible:

NOT_FOUND if the query specifies an unknown block.
UNAVAILABLE if the query is for an epoch that is not finalized in the current genesis index, or is for a future genesis index.
INVALID_ARGUMENT if the query is for an epoch that is not finalized for a past genesis index.
INVALID_ARGUMENT if the query is for a genesis index at consensus version 0.
INVALID_ARGUMENT if the input EpochRequest is malformed.
UNIMPLEMENTED if the endpoint is disabled on the node.

public virtual AsyncServerStreamingCall<WinningBaker> GetWinningBakersEpoch(EpochRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request EpochRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncServerStreamingCall<WinningBaker>: The call object.

InstanceStateLookup(InstanceStateLookupRequest, CallOptions)

Get the value at a specific key of a contract state. In contrast to GetInstanceState this is more efficient, but requires the user to know the specific key to look for.

public virtual InstanceStateValueAtKey InstanceStateLookup(InstanceStateLookupRequest request, CallOptions options)

Parameters

request InstanceStateLookupRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

InstanceStateValueAtKey: The response received from the server.

InstanceStateLookup(InstanceStateLookupRequest, Metadata, DateTime?, CancellationToken)

Get the value at a specific key of a contract state. In contrast to GetInstanceState this is more efficient, but requires the user to know the specific key to look for.

public virtual InstanceStateValueAtKey InstanceStateLookup(InstanceStateLookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InstanceStateLookupRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

InstanceStateValueAtKey: The response received from the server.

InstanceStateLookupAsync(InstanceStateLookupRequest, CallOptions)

Get the value at a specific key of a contract state. In contrast to GetInstanceState this is more efficient, but requires the user to know the specific key to look for.

public virtual AsyncUnaryCall<InstanceStateValueAtKey> InstanceStateLookupAsync(InstanceStateLookupRequest request, CallOptions options)

Parameters

request InstanceStateLookupRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<InstanceStateValueAtKey>: The call object.

InstanceStateLookupAsync(InstanceStateLookupRequest, Metadata, DateTime?, CancellationToken)

Get the value at a specific key of a contract state. In contrast to GetInstanceState this is more efficient, but requires the user to know the specific key to look for.

public virtual AsyncUnaryCall<InstanceStateValueAtKey> InstanceStateLookupAsync(InstanceStateLookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InstanceStateLookupRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<InstanceStateValueAtKey>: The call object.

InvokeInstance(InvokeInstanceRequest, CallOptions)

Run the smart contract entrypoint in a given context and in the state at the end of the given block.

public virtual InvokeInstanceResponse InvokeInstance(InvokeInstanceRequest request, CallOptions options)

Parameters

request InvokeInstanceRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

InvokeInstanceResponse: The response received from the server.

InvokeInstance(InvokeInstanceRequest, Metadata, DateTime?, CancellationToken)

Run the smart contract entrypoint in a given context and in the state at the end of the given block.

public virtual InvokeInstanceResponse InvokeInstance(InvokeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InvokeInstanceRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

InvokeInstanceResponse: The response received from the server.

InvokeInstanceAsync(InvokeInstanceRequest, CallOptions)

Run the smart contract entrypoint in a given context and in the state at the end of the given block.

public virtual AsyncUnaryCall<InvokeInstanceResponse> InvokeInstanceAsync(InvokeInstanceRequest request, CallOptions options)

Parameters

request InvokeInstanceRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<InvokeInstanceResponse>: The call object.

InvokeInstanceAsync(InvokeInstanceRequest, Metadata, DateTime?, CancellationToken)

Run the smart contract entrypoint in a given context and in the state at the end of the given block.

public virtual AsyncUnaryCall<InvokeInstanceResponse> InvokeInstanceAsync(InvokeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InvokeInstanceRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<InvokeInstanceResponse>: The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

protected override Queries.QueriesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

Returns

Queries.QueriesClient

PeerConnect(IpSocketAddress, CallOptions)

Suggest to a peer to connect to the submitted peer details. This, if successful, adds the peer to the list of given addresses. Otherwise return a GRPC error. Note. The peer might not be connected to instantly, in that case the node will try to establish the connection in near future. This function returns a GRPC status 'Ok' in this case.

public virtual Empty PeerConnect(IpSocketAddress request, CallOptions options)

Parameters

request IpSocketAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

PeerConnect(IpSocketAddress, Metadata, DateTime?, CancellationToken)

public virtual Empty PeerConnect(IpSocketAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request IpSocketAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

PeerConnectAsync(IpSocketAddress, CallOptions)

public virtual AsyncUnaryCall<Empty> PeerConnectAsync(IpSocketAddress request, CallOptions options)

Parameters

request IpSocketAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

PeerConnectAsync(IpSocketAddress, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> PeerConnectAsync(IpSocketAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request IpSocketAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

PeerDisconnect(IpSocketAddress, CallOptions)

Disconnect from the peer and remove them from the given addresses list if they are on it. Return if the request was processed successfully. Otherwise return a GRPC error.

public virtual Empty PeerDisconnect(IpSocketAddress request, CallOptions options)

Parameters

request IpSocketAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

PeerDisconnect(IpSocketAddress, Metadata, DateTime?, CancellationToken)

Disconnect from the peer and remove them from the given addresses list if they are on it. Return if the request was processed successfully. Otherwise return a GRPC error.

public virtual Empty PeerDisconnect(IpSocketAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request IpSocketAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

PeerDisconnectAsync(IpSocketAddress, CallOptions)

Disconnect from the peer and remove them from the given addresses list if they are on it. Return if the request was processed successfully. Otherwise return a GRPC error.

public virtual AsyncUnaryCall<Empty> PeerDisconnectAsync(IpSocketAddress request, CallOptions options)

Parameters

request IpSocketAddress: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

PeerDisconnectAsync(IpSocketAddress, Metadata, DateTime?, CancellationToken)

Disconnect from the peer and remove them from the given addresses list if they are on it. Return if the request was processed successfully. Otherwise return a GRPC error.

public virtual AsyncUnaryCall<Empty> PeerDisconnectAsync(IpSocketAddress request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request IpSocketAddress: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

SendBlockItem(SendBlockItemRequest, CallOptions)

Send a block item. A block item is either an AccountTransaction, which is a transaction signed and paid for by an account, a CredentialDeployment, which creates a new account, or UpdateInstruction, 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 block item, which can be used with GetBlockItemStatus.

public virtual TransactionHash SendBlockItem(SendBlockItemRequest request, CallOptions options)

Parameters

request SendBlockItemRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

TransactionHash: The response received from the server.

SendBlockItem(SendBlockItemRequest, Metadata, DateTime?, CancellationToken)

Returns a hash of the block item, which can be used with GetBlockItemStatus.

public virtual TransactionHash SendBlockItem(SendBlockItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SendBlockItemRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

TransactionHash: The response received from the server.

SendBlockItemAsync(SendBlockItemRequest, CallOptions)

Returns a hash of the block item, which can be used with GetBlockItemStatus.

public virtual AsyncUnaryCall<TransactionHash> SendBlockItemAsync(SendBlockItemRequest request, CallOptions options)

Parameters

request SendBlockItemRequest: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<TransactionHash>: The call object.

SendBlockItemAsync(SendBlockItemRequest, Metadata, DateTime?, CancellationToken)

Returns a hash of the block item, which can be used with GetBlockItemStatus.

public virtual AsyncUnaryCall<TransactionHash> SendBlockItemAsync(SendBlockItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SendBlockItemRequest: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<TransactionHash>: The call object.

Shutdown(Empty, CallOptions)

Shut down the node. Return a GRPC error if the shutdown failed.

public virtual Empty Shutdown(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

Shutdown(Empty, Metadata, DateTime?, CancellationToken)

Shut down the node. Return a GRPC error if the shutdown failed.

public virtual Empty Shutdown(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

ShutdownAsync(Empty, CallOptions)

Shut down the node. Return a GRPC error if the shutdown failed.

public virtual AsyncUnaryCall<Empty> ShutdownAsync(Empty request, CallOptions options)

Parameters

request Empty: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

ShutdownAsync(Empty, Metadata, DateTime?, CancellationToken)

Shut down the node. Return a GRPC error if the shutdown failed.

public virtual AsyncUnaryCall<Empty> ShutdownAsync(Empty request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request Empty: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

UnbanPeer(BannedPeer, CallOptions)

Unban the banned peer. Returns a GRPC error if the action failed.

public virtual Empty UnbanPeer(BannedPeer request, CallOptions options)

Parameters

request BannedPeer: The request to send to the server.
options CallOptions: The options for the call.

Returns

Empty: The response received from the server.

UnbanPeer(BannedPeer, Metadata, DateTime?, CancellationToken)

Unban the banned peer. Returns a GRPC error if the action failed.

public virtual Empty UnbanPeer(BannedPeer request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BannedPeer: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

Empty: The response received from the server.

UnbanPeerAsync(BannedPeer, CallOptions)

Unban the banned peer. Returns a GRPC error if the action failed.

public virtual AsyncUnaryCall<Empty> UnbanPeerAsync(BannedPeer request, CallOptions options)

Parameters

request BannedPeer: The request to send to the server.
options CallOptions: The options for the call.

Returns

AsyncUnaryCall<Empty>: The call object.

UnbanPeerAsync(BannedPeer, Metadata, DateTime?, CancellationToken)

Unban the banned peer. Returns a GRPC error if the action failed.

public virtual AsyncUnaryCall<Empty> UnbanPeerAsync(BannedPeer request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request BannedPeer: The request to send to the server.
headers Metadata: The initial metadata to send with the call. This parameter is optional.
deadline DateTime?: An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken: An optional token for canceling the call.

Returns

AsyncUnaryCall<Empty>: The call object.

Table of Contents

Class Queries.QueriesClient

Constructors

QueriesClient()

QueriesClient(CallInvoker)

Parameters

QueriesClient(ChannelBase)

Parameters

QueriesClient(ClientBaseConfiguration)

Parameters

Methods

BanPeer(PeerToBan, CallOptions)

Parameters

Returns

BanPeer(PeerToBan, Metadata, DateTime?, CancellationToken)

Parameters

Returns

BanPeerAsync(PeerToBan, CallOptions)

Parameters

Returns

BanPeerAsync(PeerToBan, Metadata, DateTime?, CancellationToken)

Parameters

Returns

DryRun(CallOptions)

Parameters

Returns

DryRun(Metadata, DateTime?, CancellationToken)

Parameters

Returns

DumpStart(DumpRequest, CallOptions)

Parameters

Returns

DumpStart(DumpRequest, Metadata, DateTime?, CancellationToken)

Parameters

Returns

DumpStartAsync(DumpRequest, CallOptions)

Parameters

Returns

DumpStartAsync(DumpRequest, Metadata, DateTime?, CancellationToken)

Parameters

Returns

DumpStop(Empty, CallOptions)

Parameters

Returns

DumpStop(Empty, Metadata, DateTime?, CancellationToken)

Parameters

Returns

DumpStopAsync(Empty, CallOptions)

Parameters

Returns

DumpStopAsync(Empty, Metadata, DateTime?, CancellationToken)

Parameters

Returns

GetAccountInfo(AccountInfoRequest, CallOptions)

Parameters

Returns

GetAccountInfo(AccountInfoRequest, Metadata, DateTime?, CancellationToken)

Parameters

Returns

GetAccountInfoAsync(AccountInfoRequest, CallOptions)

Parameters

Returns

GetAccountInfoAsync(AccountInfoRequest, Metadata, DateTime?, CancellationToken)

Parameters

Returns

GetAccountList(BlockHashInput, CallOptions)

Parameters

Returns

GetAccountList(BlockHashInput, Metadata, DateTime?, CancellationToken)

Parameters

Returns

GetAccountNonFinalizedTransactions(AccountAddress, CallOptions)

Parameters

Returns

GetAccountNonFinalizedTransactions(AccountAddress, Metadata, DateTime?, CancellationToken)

Parameters

Returns

GetAccountTransactionSignHash(PreAccountTransaction, CallOptions)

Parameters

Returns