Class AccessAPI.AccessAPIBase

Base class for server-side implementations of AccessAPI

Inheritance

Object

AccessAPI.AccessAPIBase

Namespace: Flow.Net.Sdk.Protos.access

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

Syntax

[BindServiceMethod(typeof(AccessAPI), "BindService")]
public abstract class AccessAPIBase

Methods

ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest, ServerCallContext)

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

Declaration

public virtual Task<ExecuteScriptResponse> ExecuteScriptAtBlockHeight(ExecuteScriptAtBlockHeightRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ExecuteScriptAtBlockHeightRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ExecuteScriptResponse>	The response to send back to the client (wrapped by a task).

ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest, ServerCallContext)

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

Declaration

public virtual Task<ExecuteScriptResponse> ExecuteScriptAtBlockID(ExecuteScriptAtBlockIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ExecuteScriptAtBlockIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ExecuteScriptResponse>	The response to send back to the client (wrapped by a task).

ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest, ServerCallContext)

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

Declaration

public virtual Task<ExecuteScriptResponse> ExecuteScriptAtLatestBlock(ExecuteScriptAtLatestBlockRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ExecuteScriptAtLatestBlockRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ExecuteScriptResponse>	The response to send back to the client (wrapped by a task).

GetAccount(GetAccountRequest, ServerCallContext)

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 Task<GetAccountResponse> GetAccount(GetAccountRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetAccountRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<GetAccountResponse>	The response to send back to the client (wrapped by a task).

GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest, ServerCallContext)

GetAccountAtBlockHeight gets an account by address at the given block height

Declaration

public virtual Task<AccountResponse> GetAccountAtBlockHeight(GetAccountAtBlockHeightRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetAccountAtBlockHeightRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AccountResponse>	The response to send back to the client (wrapped by a task).

GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest, ServerCallContext)

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

Declaration

public virtual Task<AccountResponse> GetAccountAtLatestBlock(GetAccountAtLatestBlockRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetAccountAtLatestBlockRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<AccountResponse>	The response to send back to the client (wrapped by a task).

GetBlockByHeight(GetBlockByHeightRequest, ServerCallContext)

GetBlockByHeight gets a full block by height.

Declaration

public virtual Task<BlockResponse> GetBlockByHeight(GetBlockByHeightRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetBlockByHeightRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockResponse>	The response to send back to the client (wrapped by a task).

GetBlockByID(GetBlockByIDRequest, ServerCallContext)

GetBlockByID gets a full block by ID.

Declaration

public virtual Task<BlockResponse> GetBlockByID(GetBlockByIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetBlockByIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockResponse>	The response to send back to the client (wrapped by a task).

GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest, ServerCallContext)

GetBlockHeaderByHeight gets a block header by height.

Declaration

public virtual Task<BlockHeaderResponse> GetBlockHeaderByHeight(GetBlockHeaderByHeightRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetBlockHeaderByHeightRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockHeaderResponse>	The response to send back to the client (wrapped by a task).

GetBlockHeaderByID(GetBlockHeaderByIDRequest, ServerCallContext)

GetBlockHeaderByID gets a block header by ID.

Declaration

public virtual Task<BlockHeaderResponse> GetBlockHeaderByID(GetBlockHeaderByIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetBlockHeaderByIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockHeaderResponse>	The response to send back to the client (wrapped by a task).

GetCollectionByID(GetCollectionByIDRequest, ServerCallContext)

GetCollectionByID gets a collection by ID.

Declaration

public virtual Task<CollectionResponse> GetCollectionByID(GetCollectionByIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetCollectionByIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<CollectionResponse>	The response to send back to the client (wrapped by a task).

GetEventsForBlockIDs(GetEventsForBlockIDsRequest, ServerCallContext)

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

Declaration

public virtual Task<EventsResponse> GetEventsForBlockIDs(GetEventsForBlockIDsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetEventsForBlockIDsRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<EventsResponse>	The response to send back to the client (wrapped by a task).

GetEventsForHeightRange(GetEventsForHeightRangeRequest, ServerCallContext)

GetEventsForHeightRange retrieves events emitted within the specified block range.

Declaration

public virtual Task<EventsResponse> GetEventsForHeightRange(GetEventsForHeightRangeRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetEventsForHeightRangeRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<EventsResponse>	The response to send back to the client (wrapped by a task).

GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest, ServerCallContext)

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 Task<ExecutionResultForBlockIDResponse> GetExecutionResultForBlockID(GetExecutionResultForBlockIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetExecutionResultForBlockIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ExecutionResultForBlockIDResponse>	The response to send back to the client (wrapped by a task).

GetLatestBlock(GetLatestBlockRequest, ServerCallContext)

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

Declaration

public virtual Task<BlockResponse> GetLatestBlock(GetLatestBlockRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetLatestBlockRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockResponse>	The response to send back to the client (wrapped by a task).

GetLatestBlockHeader(GetLatestBlockHeaderRequest, ServerCallContext)

GetLatestBlockHeader gets the latest sealed or unsealed block header.

Declaration

public virtual Task<BlockHeaderResponse> GetLatestBlockHeader(GetLatestBlockHeaderRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetLatestBlockHeaderRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<BlockHeaderResponse>	The response to send back to the client (wrapped by a task).

GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest, ServerCallContext)

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 Task<ProtocolStateSnapshotResponse> GetLatestProtocolStateSnapshot(GetLatestProtocolStateSnapshotRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetLatestProtocolStateSnapshotRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ProtocolStateSnapshotResponse>	The response to send back to the client (wrapped by a task).

GetNetworkParameters(GetNetworkParametersRequest, ServerCallContext)

GetNetworkParameters retrieves the Flow network details

Declaration

public virtual Task<GetNetworkParametersResponse> GetNetworkParameters(GetNetworkParametersRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetNetworkParametersRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<GetNetworkParametersResponse>	The response to send back to the client (wrapped by a task).

GetTransaction(GetTransactionRequest, ServerCallContext)

GetTransaction gets a transaction by ID.

Declaration

public virtual Task<TransactionResponse> GetTransaction(GetTransactionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TransactionResponse>	The response to send back to the client (wrapped by a task).

GetTransactionResult(GetTransactionRequest, ServerCallContext)

GetTransactionResult gets the result of a transaction.

Declaration

public virtual Task<TransactionResultResponse> GetTransactionResult(GetTransactionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTransactionRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TransactionResultResponse>	The response to send back to the client (wrapped by a task).

GetTransactionResultByIndex(GetTransactionByIndexRequest, ServerCallContext)

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

Declaration

public virtual Task<TransactionResultResponse> GetTransactionResultByIndex(GetTransactionByIndexRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTransactionByIndexRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TransactionResultResponse>	The response to send back to the client (wrapped by a task).

GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest, ServerCallContext)

GetTransactionResultsByBlockID gets all the transaction results for a specified block

Declaration

public virtual Task<TransactionResultsResponse> GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TransactionResultsResponse>	The response to send back to the client (wrapped by a task).

GetTransactionsByBlockID(GetTransactionsByBlockIDRequest, ServerCallContext)

GetTransactionsByBlockID gets all the transactions for a specified block

Declaration

public virtual Task<TransactionsResponse> GetTransactionsByBlockID(GetTransactionsByBlockIDRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetTransactionsByBlockIDRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<TransactionsResponse>	The response to send back to the client (wrapped by a task).

Ping(PingRequest, ServerCallContext)

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

Declaration

public virtual Task<PingResponse> Ping(PingRequest request, ServerCallContext context)

Parameters

Type	Name	Description
PingRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<PingResponse>	The response to send back to the client (wrapped by a task).

SendTransaction(SendTransactionRequest, ServerCallContext)

SendTransaction submits a transaction to the network.

Declaration

public virtual Task<SendTransactionResponse> SendTransaction(SendTransactionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
SendTransactionRequest	request	The request received from the client.
Grpc.Core.ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<SendTransactionResponse>	The response to send back to the client (wrapped by a task).