Class AccessAPI.AccessAPIClient

Client for AccessAPI

Inheritance

Object

Grpc.Core.ClientBase

Grpc.Core.ClientBase<AccessAPI.AccessAPIClient>

AccessAPI.AccessAPIClient

Inherited Members

Grpc.Core.ClientBase<Flow.Net.Sdk.Protos.access.AccessAPI.AccessAPIClient>.WithHost(System.String)

Grpc.Core.ClientBase.CallInvoker

Namespace: Flow.Net.Sdk.Protos.access

Assembly: Flow.Net.Sdk.Client.Grpc.dll

Syntax

public class AccessAPIClient : ClientBase<AccessAPI.AccessAPIClient>

Constructors

AccessAPIClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected AccessAPIClient()

AccessAPIClient(CallInvoker)

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

Declaration

public AccessAPIClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
Grpc.Core.CallInvoker	callInvoker	The callInvoker to use to make remote calls.

AccessAPIClient(ChannelBase)

Creates a new client for AccessAPI

Declaration

public AccessAPIClient(ChannelBase channel)

Parameters

Type	Name	Description
Grpc.Core.ChannelBase	channel	The channel to use to make remote calls.

AccessAPIClient(ClientBase.ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected AccessAPIClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
Grpc.Core.ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest, CallOptions)

ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtBlockHeightAsync(ExecuteScriptAtBlockHeightRequest, CallOptions)

ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtBlockHeightAsync(ExecuteScriptAtBlockHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

ExecuteScriptAtBlockHeightAsync(ExecuteScriptAtBlockHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtBlockHeightAsync(ExecuteScriptAtBlockHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest, CallOptions)

ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtBlockIDAsync(ExecuteScriptAtBlockIDRequest, CallOptions)

ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtBlockIDAsync(ExecuteScriptAtBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

ExecuteScriptAtBlockIDAsync(ExecuteScriptAtBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtBlockIDAsync(ExecuteScriptAtBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest, CallOptions)

ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.

Declaration

public virtual ExecuteScriptResponse ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
ExecuteScriptResponse	The response received from the server.

ExecuteScriptAtLatestBlockAsync(ExecuteScriptAtLatestBlockRequest, CallOptions)

ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtLatestBlockAsync(ExecuteScriptAtLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
ExecuteScriptAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

ExecuteScriptAtLatestBlockAsync(ExecuteScriptAtLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.

Declaration

public virtual AsyncUnaryCall<ExecuteScriptResponse> ExecuteScriptAtLatestBlockAsync(ExecuteScriptAtLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ExecuteScriptAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<ExecuteScriptResponse>	The call object.

GetAccount(GetAccountRequest, CallOptions)

GetAccount is an alias for GetAccountAtLatestBlock.

Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.

Declaration

public virtual GetAccountResponse GetAccount(GetAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
GetAccountResponse	The response received from the server.

GetAccount(GetAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccount is an alias for GetAccountAtLatestBlock.

Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.

Declaration

public virtual GetAccountResponse GetAccount(GetAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
GetAccountResponse	The response received from the server.

GetAccountAsync(GetAccountRequest, CallOptions)

GetAccount is an alias for GetAccountAtLatestBlock.

Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.

Declaration

public virtual AsyncUnaryCall<GetAccountResponse> GetAccountAsync(GetAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<GetAccountResponse>	The call object.

GetAccountAsync(GetAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccount is an alias for GetAccountAtLatestBlock.

Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.

Declaration

public virtual AsyncUnaryCall<GetAccountResponse> GetAccountAsync(GetAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<GetAccountResponse>	The call object.

GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest, CallOptions)

GetAccountAtBlockHeight gets an account by address at the given block height

Declaration

public virtual AccountResponse GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
AccountResponse	The response received from the server.

GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccountAtBlockHeight gets an account by address at the given block height

Declaration

public virtual AccountResponse GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
AccountResponse	The response received from the server.

GetAccountAtBlockHeightAsync(GetAccountAtBlockHeightRequest, CallOptions)

GetAccountAtBlockHeight gets an account by address at the given block height

Declaration

public virtual AsyncUnaryCall<AccountResponse> GetAccountAtBlockHeightAsync(GetAccountAtBlockHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<AccountResponse>	The call object.

GetAccountAtBlockHeightAsync(GetAccountAtBlockHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccountAtBlockHeight gets an account by address at the given block height

Declaration

public virtual AsyncUnaryCall<AccountResponse> GetAccountAtBlockHeightAsync(GetAccountAtBlockHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountAtBlockHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<AccountResponse>	The call object.

GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest, CallOptions)

GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.

Declaration

public virtual AccountResponse GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
AccountResponse	The response received from the server.

GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.

Declaration

public virtual AccountResponse GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
AccountResponse	The response received from the server.

GetAccountAtLatestBlockAsync(GetAccountAtLatestBlockRequest, CallOptions)

GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.

Declaration

public virtual AsyncUnaryCall<AccountResponse> GetAccountAtLatestBlockAsync(GetAccountAtLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<AccountResponse>	The call object.

GetAccountAtLatestBlockAsync(GetAccountAtLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.

Declaration

public virtual AsyncUnaryCall<AccountResponse> GetAccountAtLatestBlockAsync(GetAccountAtLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetAccountAtLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<AccountResponse>	The call object.

GetBlockByHeight(GetBlockByHeightRequest, CallOptions)

GetBlockByHeight gets a full block by height.

Declaration

public virtual BlockResponse GetBlockByHeight(GetBlockByHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockByHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockResponse	The response received from the server.

GetBlockByHeight(GetBlockByHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockByHeight gets a full block by height.

Declaration

public virtual BlockResponse GetBlockByHeight(GetBlockByHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockByHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockResponse	The response received from the server.

GetBlockByHeightAsync(GetBlockByHeightRequest, CallOptions)

GetBlockByHeight gets a full block by height.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetBlockByHeightAsync(GetBlockByHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockByHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetBlockByHeightAsync(GetBlockByHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockByHeight gets a full block by height.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetBlockByHeightAsync(GetBlockByHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockByHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetBlockByID(GetBlockByIDRequest, CallOptions)

GetBlockByID gets a full block by ID.

Declaration

public virtual BlockResponse GetBlockByID(GetBlockByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockResponse	The response received from the server.

GetBlockByID(GetBlockByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockByID gets a full block by ID.

Declaration

public virtual BlockResponse GetBlockByID(GetBlockByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockResponse	The response received from the server.

GetBlockByIDAsync(GetBlockByIDRequest, CallOptions)

GetBlockByID gets a full block by ID.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetBlockByIDAsync(GetBlockByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetBlockByIDAsync(GetBlockByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockByID gets a full block by ID.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetBlockByIDAsync(GetBlockByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest, CallOptions)

GetBlockHeaderByHeight gets a block header by height.

Declaration

public virtual BlockHeaderResponse GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockHeaderByHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockHeaderResponse	The response received from the server.

GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockHeaderByHeight gets a block header by height.

Declaration

public virtual BlockHeaderResponse GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockHeaderByHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockHeaderResponse	The response received from the server.

GetBlockHeaderByHeightAsync(GetBlockHeaderByHeightRequest, CallOptions)

GetBlockHeaderByHeight gets a block header by height.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetBlockHeaderByHeightAsync(GetBlockHeaderByHeightRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockHeaderByHeightRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetBlockHeaderByHeightAsync(GetBlockHeaderByHeightRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockHeaderByHeight gets a block header by height.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetBlockHeaderByHeightAsync(GetBlockHeaderByHeightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockHeaderByHeightRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetBlockHeaderByID(GetBlockHeaderByIDRequest, CallOptions)

GetBlockHeaderByID gets a block header by ID.

Declaration

public virtual BlockHeaderResponse GetBlockHeaderByID(GetBlockHeaderByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockHeaderByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockHeaderResponse	The response received from the server.

GetBlockHeaderByID(GetBlockHeaderByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockHeaderByID gets a block header by ID.

Declaration

public virtual BlockHeaderResponse GetBlockHeaderByID(GetBlockHeaderByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockHeaderByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockHeaderResponse	The response received from the server.

GetBlockHeaderByIDAsync(GetBlockHeaderByIDRequest, CallOptions)

GetBlockHeaderByID gets a block header by ID.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetBlockHeaderByIDAsync(GetBlockHeaderByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetBlockHeaderByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetBlockHeaderByIDAsync(GetBlockHeaderByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetBlockHeaderByID gets a block header by ID.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetBlockHeaderByIDAsync(GetBlockHeaderByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetBlockHeaderByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetCollectionByID(GetCollectionByIDRequest, CallOptions)

GetCollectionByID gets a collection by ID.

Declaration

public virtual CollectionResponse GetCollectionByID(GetCollectionByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetCollectionByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
CollectionResponse	The response received from the server.

GetCollectionByID(GetCollectionByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetCollectionByID gets a collection by ID.

Declaration

public virtual CollectionResponse GetCollectionByID(GetCollectionByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetCollectionByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
CollectionResponse	The response received from the server.

GetCollectionByIDAsync(GetCollectionByIDRequest, CallOptions)

GetCollectionByID gets a collection by ID.

Declaration

public virtual AsyncUnaryCall<CollectionResponse> GetCollectionByIDAsync(GetCollectionByIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetCollectionByIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<CollectionResponse>	The call object.

GetCollectionByIDAsync(GetCollectionByIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetCollectionByID gets a collection by ID.

Declaration

public virtual AsyncUnaryCall<CollectionResponse> GetCollectionByIDAsync(GetCollectionByIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetCollectionByIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<CollectionResponse>	The call object.

GetEventsForBlockIDs(GetEventsForBlockIDsRequest, CallOptions)

GetEventsForBlockIDs retrieves events for the specified block IDs and event type.

Declaration

public virtual EventsResponse GetEventsForBlockIDs(GetEventsForBlockIDsRequest request, CallOptions options)

Parameters

Type	Name	Description
GetEventsForBlockIDsRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
EventsResponse	The response received from the server.

GetEventsForBlockIDs(GetEventsForBlockIDsRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetEventsForBlockIDs retrieves events for the specified block IDs and event type.

Declaration

public virtual EventsResponse GetEventsForBlockIDs(GetEventsForBlockIDsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetEventsForBlockIDsRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
EventsResponse	The response received from the server.

GetEventsForBlockIDsAsync(GetEventsForBlockIDsRequest, CallOptions)

GetEventsForBlockIDs retrieves events for the specified block IDs and event type.

Declaration

public virtual AsyncUnaryCall<EventsResponse> GetEventsForBlockIDsAsync(GetEventsForBlockIDsRequest request, CallOptions options)

Parameters

Type	Name	Description
GetEventsForBlockIDsRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<EventsResponse>	The call object.

GetEventsForBlockIDsAsync(GetEventsForBlockIDsRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetEventsForBlockIDs retrieves events for the specified block IDs and event type.

Declaration

public virtual AsyncUnaryCall<EventsResponse> GetEventsForBlockIDsAsync(GetEventsForBlockIDsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetEventsForBlockIDsRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<EventsResponse>	The call object.

GetEventsForHeightRange(GetEventsForHeightRangeRequest, CallOptions)

GetEventsForHeightRange retrieves events emitted within the specified block range.

Declaration

public virtual EventsResponse GetEventsForHeightRange(GetEventsForHeightRangeRequest request, CallOptions options)

Parameters

Type	Name	Description
GetEventsForHeightRangeRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
EventsResponse	The response received from the server.

GetEventsForHeightRange(GetEventsForHeightRangeRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetEventsForHeightRange retrieves events emitted within the specified block range.

Declaration

public virtual EventsResponse GetEventsForHeightRange(GetEventsForHeightRangeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetEventsForHeightRangeRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
EventsResponse	The response received from the server.

GetEventsForHeightRangeAsync(GetEventsForHeightRangeRequest, CallOptions)

GetEventsForHeightRange retrieves events emitted within the specified block range.

Declaration

public virtual AsyncUnaryCall<EventsResponse> GetEventsForHeightRangeAsync(GetEventsForHeightRangeRequest request, CallOptions options)

Parameters

Type	Name	Description
GetEventsForHeightRangeRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<EventsResponse>	The call object.

GetEventsForHeightRangeAsync(GetEventsForHeightRangeRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetEventsForHeightRange retrieves events emitted within the specified block range.

Declaration

public virtual AsyncUnaryCall<EventsResponse> GetEventsForHeightRangeAsync(GetEventsForHeightRangeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetEventsForHeightRangeRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<EventsResponse>	The call object.

GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest, CallOptions)

GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change

Declaration

public virtual ExecutionResultForBlockIDResponse GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetExecutionResultForBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
ExecutionResultForBlockIDResponse	The response received from the server.

GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change

Declaration

public virtual ExecutionResultForBlockIDResponse GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetExecutionResultForBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
ExecutionResultForBlockIDResponse	The response received from the server.

GetExecutionResultForBlockIDAsync(GetExecutionResultForBlockIDRequest, CallOptions)

GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change

Declaration

public virtual AsyncUnaryCall<ExecutionResultForBlockIDResponse> GetExecutionResultForBlockIDAsync(GetExecutionResultForBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetExecutionResultForBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<ExecutionResultForBlockIDResponse>	The call object.

GetExecutionResultForBlockIDAsync(GetExecutionResultForBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change

Declaration

public virtual AsyncUnaryCall<ExecutionResultForBlockIDResponse> GetExecutionResultForBlockIDAsync(GetExecutionResultForBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetExecutionResultForBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<ExecutionResultForBlockIDResponse>	The call object.

GetLatestBlock(GetLatestBlockRequest, CallOptions)

GetLatestBlock gets the full payload of the latest sealed or unsealed block.

Declaration

public virtual BlockResponse GetLatestBlock(GetLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockResponse	The response received from the server.

GetLatestBlock(GetLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestBlock gets the full payload of the latest sealed or unsealed block.

Declaration

public virtual BlockResponse GetLatestBlock(GetLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockResponse	The response received from the server.

GetLatestBlockAsync(GetLatestBlockRequest, CallOptions)

GetLatestBlock gets the full payload of the latest sealed or unsealed block.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetLatestBlockAsync(GetLatestBlockRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestBlockRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetLatestBlockAsync(GetLatestBlockRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestBlock gets the full payload of the latest sealed or unsealed block.

Declaration

public virtual AsyncUnaryCall<BlockResponse> GetLatestBlockAsync(GetLatestBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestBlockRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockResponse>	The call object.

GetLatestBlockHeader(GetLatestBlockHeaderRequest, CallOptions)

GetLatestBlockHeader gets the latest sealed or unsealed block header.

Declaration

public virtual BlockHeaderResponse GetLatestBlockHeader(GetLatestBlockHeaderRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestBlockHeaderRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
BlockHeaderResponse	The response received from the server.

GetLatestBlockHeader(GetLatestBlockHeaderRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestBlockHeader gets the latest sealed or unsealed block header.

Declaration

public virtual BlockHeaderResponse GetLatestBlockHeader(GetLatestBlockHeaderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestBlockHeaderRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
BlockHeaderResponse	The response received from the server.

GetLatestBlockHeaderAsync(GetLatestBlockHeaderRequest, CallOptions)

GetLatestBlockHeader gets the latest sealed or unsealed block header.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetLatestBlockHeaderAsync(GetLatestBlockHeaderRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestBlockHeaderRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetLatestBlockHeaderAsync(GetLatestBlockHeaderRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestBlockHeader gets the latest sealed or unsealed block header.

Declaration

public virtual AsyncUnaryCall<BlockHeaderResponse> GetLatestBlockHeaderAsync(GetLatestBlockHeaderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestBlockHeaderRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<BlockHeaderResponse>	The call object.

GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest, CallOptions)

GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.

Declaration

public virtual ProtocolStateSnapshotResponse GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestProtocolStateSnapshotRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
ProtocolStateSnapshotResponse	The response received from the server.

GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.

Declaration

public virtual ProtocolStateSnapshotResponse GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestProtocolStateSnapshotRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
ProtocolStateSnapshotResponse	The response received from the server.

GetLatestProtocolStateSnapshotAsync(GetLatestProtocolStateSnapshotRequest, CallOptions)

GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.

Declaration

public virtual AsyncUnaryCall<ProtocolStateSnapshotResponse> GetLatestProtocolStateSnapshotAsync(GetLatestProtocolStateSnapshotRequest request, CallOptions options)

Parameters

Type	Name	Description
GetLatestProtocolStateSnapshotRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<ProtocolStateSnapshotResponse>	The call object.

GetLatestProtocolStateSnapshotAsync(GetLatestProtocolStateSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.

Declaration

public virtual AsyncUnaryCall<ProtocolStateSnapshotResponse> GetLatestProtocolStateSnapshotAsync(GetLatestProtocolStateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetLatestProtocolStateSnapshotRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<ProtocolStateSnapshotResponse>	The call object.

GetNetworkParameters(GetNetworkParametersRequest, CallOptions)

GetNetworkParameters retrieves the Flow network details

Declaration

public virtual GetNetworkParametersResponse GetNetworkParameters(GetNetworkParametersRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNetworkParametersRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
GetNetworkParametersResponse	The response received from the server.

GetNetworkParameters(GetNetworkParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetNetworkParameters retrieves the Flow network details

Declaration

public virtual GetNetworkParametersResponse GetNetworkParameters(GetNetworkParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetNetworkParametersRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
GetNetworkParametersResponse	The response received from the server.

GetNetworkParametersAsync(GetNetworkParametersRequest, CallOptions)

GetNetworkParameters retrieves the Flow network details

Declaration

public virtual AsyncUnaryCall<GetNetworkParametersResponse> GetNetworkParametersAsync(GetNetworkParametersRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNetworkParametersRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<GetNetworkParametersResponse>	The call object.

GetNetworkParametersAsync(GetNetworkParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetNetworkParameters retrieves the Flow network details

Declaration

public virtual AsyncUnaryCall<GetNetworkParametersResponse> GetNetworkParametersAsync(GetNetworkParametersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetNetworkParametersRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<GetNetworkParametersResponse>	The call object.

GetTransaction(GetTransactionRequest, CallOptions)

GetTransaction gets a transaction by ID.

Declaration

public virtual TransactionResponse GetTransaction(GetTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
TransactionResponse	The response received from the server.

GetTransaction(GetTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransaction gets a transaction by ID.

Declaration

public virtual TransactionResponse GetTransaction(GetTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
TransactionResponse	The response received from the server.

GetTransactionAsync(GetTransactionRequest, CallOptions)

GetTransaction gets a transaction by ID.

Declaration

public virtual AsyncUnaryCall<TransactionResponse> GetTransactionAsync(GetTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResponse>	The call object.

GetTransactionAsync(GetTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransaction gets a transaction by ID.

Declaration

public virtual AsyncUnaryCall<TransactionResponse> GetTransactionAsync(GetTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResponse>	The call object.

GetTransactionResult(GetTransactionRequest, CallOptions)

GetTransactionResult gets the result of a transaction.

Declaration

public virtual TransactionResultResponse GetTransactionResult(GetTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
TransactionResultResponse	The response received from the server.

GetTransactionResult(GetTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResult gets the result of a transaction.

Declaration

public virtual TransactionResultResponse GetTransactionResult(GetTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
TransactionResultResponse	The response received from the server.

GetTransactionResultAsync(GetTransactionRequest, CallOptions)

GetTransactionResult gets the result of a transaction.

Declaration

public virtual AsyncUnaryCall<TransactionResultResponse> GetTransactionResultAsync(GetTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultResponse>	The call object.

GetTransactionResultAsync(GetTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResult gets the result of a transaction.

Declaration

public virtual AsyncUnaryCall<TransactionResultResponse> GetTransactionResultAsync(GetTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultResponse>	The call object.

GetTransactionResultByIndex(GetTransactionByIndexRequest, CallOptions)

GetTransactionResultByIndex gets the result of a transaction at a specified block and index

Declaration

public virtual TransactionResultResponse GetTransactionResultByIndex(GetTransactionByIndexRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionByIndexRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
TransactionResultResponse	The response received from the server.

GetTransactionResultByIndex(GetTransactionByIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResultByIndex gets the result of a transaction at a specified block and index

Declaration

public virtual TransactionResultResponse GetTransactionResultByIndex(GetTransactionByIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionByIndexRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
TransactionResultResponse	The response received from the server.

GetTransactionResultByIndexAsync(GetTransactionByIndexRequest, CallOptions)

GetTransactionResultByIndex gets the result of a transaction at a specified block and index

Declaration

public virtual AsyncUnaryCall<TransactionResultResponse> GetTransactionResultByIndexAsync(GetTransactionByIndexRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionByIndexRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultResponse>	The call object.

GetTransactionResultByIndexAsync(GetTransactionByIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResultByIndex gets the result of a transaction at a specified block and index

Declaration

public virtual AsyncUnaryCall<TransactionResultResponse> GetTransactionResultByIndexAsync(GetTransactionByIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionByIndexRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultResponse>	The call object.

GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest, CallOptions)

GetTransactionResultsByBlockID gets all the transaction results for a specified block

Declaration

public virtual TransactionResultsResponse GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
TransactionResultsResponse	The response received from the server.

GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResultsByBlockID gets all the transaction results for a specified block

Declaration

public virtual TransactionResultsResponse GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
TransactionResultsResponse	The response received from the server.

GetTransactionResultsByBlockIDAsync(GetTransactionsByBlockIDRequest, CallOptions)

GetTransactionResultsByBlockID gets all the transaction results for a specified block

Declaration

public virtual AsyncUnaryCall<TransactionResultsResponse> GetTransactionResultsByBlockIDAsync(GetTransactionsByBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultsResponse>	The call object.

GetTransactionResultsByBlockIDAsync(GetTransactionsByBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionResultsByBlockID gets all the transaction results for a specified block

Declaration

public virtual AsyncUnaryCall<TransactionResultsResponse> GetTransactionResultsByBlockIDAsync(GetTransactionsByBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionResultsResponse>	The call object.

GetTransactionsByBlockID(GetTransactionsByBlockIDRequest, CallOptions)

GetTransactionsByBlockID gets all the transactions for a specified block

Declaration

public virtual TransactionsResponse GetTransactionsByBlockID(GetTransactionsByBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
TransactionsResponse	The response received from the server.

GetTransactionsByBlockID(GetTransactionsByBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionsByBlockID gets all the transactions for a specified block

Declaration

public virtual TransactionsResponse GetTransactionsByBlockID(GetTransactionsByBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
TransactionsResponse	The response received from the server.

GetTransactionsByBlockIDAsync(GetTransactionsByBlockIDRequest, CallOptions)

GetTransactionsByBlockID gets all the transactions for a specified block

Declaration

public virtual AsyncUnaryCall<TransactionsResponse> GetTransactionsByBlockIDAsync(GetTransactionsByBlockIDRequest request, CallOptions options)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionsResponse>	The call object.

GetTransactionsByBlockIDAsync(GetTransactionsByBlockIDRequest, Metadata, Nullable<DateTime>, CancellationToken)

GetTransactionsByBlockID gets all the transactions for a specified block

Declaration

public virtual AsyncUnaryCall<TransactionsResponse> GetTransactionsByBlockIDAsync(GetTransactionsByBlockIDRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<TransactionsResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override AccessAPI.AccessAPIClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
Grpc.Core.ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
AccessAPI.AccessAPIClient

Overrides

Grpc.Core.ClientBase<Flow.Net.Sdk.Protos.access.AccessAPI.AccessAPIClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Ping(PingRequest, CallOptions)

Ping is used to check if the access node is alive and healthy.

Declaration

public virtual PingResponse Ping(PingRequest request, CallOptions options)

Parameters

Type	Name	Description
PingRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
PingResponse	The response received from the server.

Ping(PingRequest, Metadata, Nullable<DateTime>, CancellationToken)

Ping is used to check if the access node is alive and healthy.

Declaration

public virtual PingResponse Ping(PingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
PingRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
PingResponse	The response received from the server.

PingAsync(PingRequest, CallOptions)

Ping is used to check if the access node is alive and healthy.

Declaration

public virtual AsyncUnaryCall<PingResponse> PingAsync(PingRequest request, CallOptions options)

Parameters

Type	Name	Description
PingRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<PingResponse>	The call object.

PingAsync(PingRequest, Metadata, Nullable<DateTime>, CancellationToken)

Ping is used to check if the access node is alive and healthy.

Declaration

public virtual AsyncUnaryCall<PingResponse> PingAsync(PingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
PingRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<PingResponse>	The call object.

SendTransaction(SendTransactionRequest, CallOptions)

SendTransaction submits a transaction to the network.

Declaration

public virtual SendTransactionResponse SendTransaction(SendTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
SendTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
SendTransactionResponse	The response received from the server.

SendTransaction(SendTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

SendTransaction submits a transaction to the network.

Declaration

public virtual SendTransactionResponse SendTransaction(SendTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
SendTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
SendTransactionResponse	The response received from the server.

SendTransactionAsync(SendTransactionRequest, CallOptions)

SendTransaction submits a transaction to the network.

Declaration

public virtual AsyncUnaryCall<SendTransactionResponse> SendTransactionAsync(SendTransactionRequest request, CallOptions options)

Parameters

Type	Name	Description
SendTransactionRequest	request	The request to send to the server.
Grpc.Core.CallOptions	options	The options for the call.

Returns

Type	Description
Grpc.Core.AsyncUnaryCall<SendTransactionResponse>	The call object.

SendTransactionAsync(SendTransactionRequest, Metadata, Nullable<DateTime>, CancellationToken)

SendTransaction submits a transaction to the network.

Declaration

public virtual AsyncUnaryCall<SendTransactionResponse> SendTransactionAsync(SendTransactionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
SendTransactionRequest	request	The request to send to the server.
Grpc.Core.Metadata	headers	The initial metadata to send with the call. This parameter is optional.
Nullable<DateTime>	deadline	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

Type	Description
Grpc.Core.AsyncUnaryCall<SendTransactionResponse>	The call object.