Class DefaultApi

Inheritance

object

DefaultApi

Implements

IDefaultApi

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Algorand.Algod

Assembly: Algorand.dll

Syntax

public class DefaultApi : IDefaultApi

Constructors

| Improve this Doc View Source

DefaultApi(HttpClient)

Declaration

public DefaultApi(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

| Improve this Doc View Source

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

Methods

| Improve this Doc View Source

AccountApplicationInformationAsync(string, ulong, Format?)

Given a specific account public key and application ID, this call returns the account's application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application's creator.

Declaration

public Task<AccountApplicationResponse> AccountApplicationInformationAsync(string address, ulong applicationId, Format? format = null)

Parameters

Type	Name	Description
string	address	An account public key
ulong	applicationId
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountApplicationResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

AccountApplicationInformationAsync(CancellationToken, string, ulong, Format?)

Declaration

public Task<AccountApplicationResponse> AccountApplicationInformationAsync(CancellationToken cancellationToken, string address, ulong applicationId, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	address
ulong	applicationId
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountApplicationResponse>

| Improve this Doc View Source

AccountAssetInformationAsync(string, ulong, Format?)

Given a specific account public key and asset ID, this call returns the account's asset holding and asset parameters (if either exist). Asset parameters will only be returned if the provided address is the asset's creator.

Declaration

public Task<AccountAssetResponse> AccountAssetInformationAsync(string address, ulong assetId, Format? format = null)

Parameters

Type	Name	Description
string	address	An account public key
ulong	assetId
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountAssetResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

AccountAssetInformationAsync(CancellationToken, string, ulong, Format?)

Declaration

public Task<AccountAssetResponse> AccountAssetInformationAsync(CancellationToken cancellationToken, string address, ulong assetId, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	address
ulong	assetId
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountAssetResponse>

| Improve this Doc View Source

AccountInformationAsync(string, string?, Format?)

Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Declaration

public Task<Account> AccountInformationAsync(string address, string? exclude = null, Format? format = null)

Parameters

Type	Name	Description
string	address	An account public key
string	exclude	When set to `all` will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to `none`.
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Account>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

AccountInformationAsync(CancellationToken, string, string?, Format?)

Declaration

public Task<Account> AccountInformationAsync(CancellationToken cancellationToken, string address, string? exclude = null, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	address
string	exclude
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Account>

| Improve this Doc View Source

ExperimentalCheckAsync()

Returns OK if experimental API is enabled.

Declaration

public Task<string> ExperimentalCheckAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExperimentalCheckAsync(CancellationToken)

Declaration

public Task<string> ExperimentalCheckAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

GetApplicationBoxByNameAsync(CancellationToken, ulong, string?)

Declaration

public Task<Box> GetApplicationBoxByNameAsync(CancellationToken cancellationToken, ulong applicationId, string? name = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	applicationId
string	name

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Box>

| Improve this Doc View Source

GetApplicationBoxByNameAsync(ulong, string?)

Given an application ID and box name, it returns the box name and value (each base64 encoded). Box names must be in the goal app call arg encoding form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Declaration

public Task<Box> GetApplicationBoxByNameAsync(ulong applicationId, string? name = null)

Parameters

Type	Name	Description
ulong	applicationId
string	name	A box name, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Box>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetApplicationBoxesAsync(CancellationToken, ulong, ulong?)

Declaration

public Task<BoxesResponse> GetApplicationBoxesAsync(CancellationToken cancellationToken, ulong applicationId, ulong? max = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	applicationId
ulong?	max

Returns

Type	Description
System.Threading.Tasks.Task<TResult><BoxesResponse>

| Improve this Doc View Source

GetApplicationBoxesAsync(ulong, ulong?)

Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.

Declaration

public Task<BoxesResponse> GetApplicationBoxesAsync(ulong applicationId, ulong? max = null)

Parameters

Type	Name	Description
ulong	applicationId
ulong?	max	Max number of box names to return. If max is not set, or max == 0, returns all box-names.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><BoxesResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetApplicationByIDAsync(CancellationToken, ulong)

Declaration

public Task<Application> GetApplicationByIDAsync(CancellationToken cancellationToken, ulong applicationId)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	applicationId

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Application>

| Improve this Doc View Source

GetApplicationByIDAsync(ulong)

Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Declaration

public Task<Application> GetApplicationByIDAsync(ulong applicationId)

Parameters

Type	Name	Description
ulong	applicationId

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Application>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAssetByIDAsync(CancellationToken, ulong)

Declaration

public Task<Asset> GetAssetByIDAsync(CancellationToken cancellationToken, ulong assetId)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	assetId

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Asset>

| Improve this Doc View Source

GetAssetByIDAsync(ulong)

Given a asset ID, it returns asset information including creator, name, total supply and special addresses.

Declaration

public Task<Asset> GetAssetByIDAsync(ulong assetId)

Parameters

Type	Name	Description
ulong	assetId

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Asset>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetBlockAsync(CancellationToken, ulong, Format?)

Declaration

public Task<CertifiedBlock> GetBlockAsync(CancellationToken cancellationToken, ulong round, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><CertifiedBlock>

| Improve this Doc View Source

GetBlockAsync(ulong, Format?)

Get the block for the given round.

Declaration

public Task<CertifiedBlock> GetBlockAsync(ulong round, Format? format = null)

Parameters

Type	Name	Description
ulong	round	The round from which to fetch block information.
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><CertifiedBlock>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetBlockHashAsync(CancellationToken, ulong)

Declaration

public Task<BlockHashResponse> GetBlockHashAsync(CancellationToken cancellationToken, ulong round)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><BlockHashResponse>

| Improve this Doc View Source

GetBlockHashAsync(ulong)

Get the block hash for the block on the given round.

Declaration

public Task<BlockHashResponse> GetBlockHashAsync(ulong round)

Parameters

Type	Name	Description
ulong	round	The round from which to fetch block hash information.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><BlockHashResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGenesisAsync()

Returns the entire genesis file in json.

Declaration

public Task<string> GetGenesisAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGenesisAsync(CancellationToken)

Declaration

public Task<string> GetGenesisAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

GetLedgerStateDeltaAsync(CancellationToken, ulong, Format?)

Declaration

public Task<LedgerStateDelta> GetLedgerStateDeltaAsync(CancellationToken cancellationToken, ulong round, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><LedgerStateDelta>

| Improve this Doc View Source

GetLedgerStateDeltaAsync(ulong, Format?)

Get ledger deltas for a round.

Declaration

public Task<LedgerStateDelta> GetLedgerStateDeltaAsync(ulong round, Format? format = null)

Parameters

Type	Name	Description
ulong	round	The round for which the deltas are desired.
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><LedgerStateDelta>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetLightBlockHeaderProofAsync(CancellationToken, ulong)

Declaration

public Task<LightBlockHeaderProof> GetLightBlockHeaderProofAsync(CancellationToken cancellationToken, ulong round)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><LightBlockHeaderProof>

| Improve this Doc View Source

GetLightBlockHeaderProofAsync(ulong)

Gets a proof for a given light block header inside a state proof commitment

Declaration

public Task<LightBlockHeaderProof> GetLightBlockHeaderProofAsync(ulong round)

Parameters

Type	Name	Description
ulong	round	The round to which the light block header belongs.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><LightBlockHeaderProof>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetPendingTransactionsAsync(Format?, ulong?)

Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration

public Task<PendingTransactions> GetPendingTransactionsAsync(Format? format = null, ulong? max = null)

Parameters

Type	Name	Description
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
ulong?	max	Truncated number of transactions to display. If max=0, returns all pending txns.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PendingTransactions>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetPendingTransactionsAsync(CancellationToken, Format?, ulong?)

Declaration

public Task<PendingTransactions> GetPendingTransactionsAsync(CancellationToken cancellationToken, Format? format = null, ulong? max = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
Format?	format
ulong?	max

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PendingTransactions>

| Improve this Doc View Source

GetPendingTransactionsByAddressAsync(string, Format?, ulong?)

Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration

public Task<PendingTransactions> GetPendingTransactionsByAddressAsync(string address, Format? format = null, ulong? max = null)

Parameters

Type	Name	Description
string	address	An account public key
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
ulong?	max	Truncated number of transactions to display. If max=0, returns all pending txns.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PendingTransactions>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetPendingTransactionsByAddressAsync(CancellationToken, string, Format?, ulong?)

Declaration

public Task<PendingTransactions> GetPendingTransactionsByAddressAsync(CancellationToken cancellationToken, string address, Format? format = null, ulong? max = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	address
Format?	format
ulong?	max

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PendingTransactions>

| Improve this Doc View Source

GetStateProofAsync(CancellationToken, ulong)

Declaration

public Task<StateProof> GetStateProofAsync(CancellationToken cancellationToken, ulong round)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><StateProof>

| Improve this Doc View Source

GetStateProofAsync(ulong)

Get a state proof that covers a given round

Declaration

public Task<StateProof> GetStateProofAsync(ulong round)

Parameters

Type	Name	Description
ulong	round	The round for which a state proof is desired.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><StateProof>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetStatusAsync()

Gets the current node status.

Declaration

public Task<NodeStatusResponse> GetStatusAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetStatusAsync(CancellationToken)

Declaration

public Task<NodeStatusResponse> GetStatusAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>

| Improve this Doc View Source

GetSupplyAsync()

Get the current supply reported by the ledger.

Declaration

public Task<SupplyResponse> GetSupplyAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><SupplyResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetSupplyAsync(CancellationToken)

Declaration

public Task<SupplyResponse> GetSupplyAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><SupplyResponse>

| Improve this Doc View Source

GetSyncRoundAsync()

Gets the minimum sync round for the ledger.

Declaration

public Task<GetSyncRoundResponse> GetSyncRoundAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><GetSyncRoundResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetSyncRoundAsync(CancellationToken)

Declaration

public Task<GetSyncRoundResponse> GetSyncRoundAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><GetSyncRoundResponse>

| Improve this Doc View Source

GetTransactionProofAsync(CancellationToken, ulong, string, Format?, string?)

Declaration

public Task<TransactionProofResponse> GetTransactionProofAsync(CancellationToken cancellationToken, ulong round, string txid, Format? format = null, string? hashtype = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round
string	txid
Format?	format
string	hashtype

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionProofResponse>

| Improve this Doc View Source

GetTransactionProofAsync(ulong, string, Format?, string?)

Get a proof for a transaction in a block.

Declaration

public Task<TransactionProofResponse> GetTransactionProofAsync(ulong round, string txid, Format? format = null, string? hashtype = null)

Parameters

Type	Name	Description
ulong	round	The round in which the transaction appears.
string	txid	The transaction ID for which to generate a proof.
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
string	hashtype	The type of hash function used to create the proof, must be one of: sha512_256 sha256

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionProofResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVersionAsync()

Retrieves the supported API versions, binary build versions, and genesis information.

Declaration

public Task<Version> GetVersionAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Version>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVersionAsync(CancellationToken)

Declaration

public Task<Version> GetVersionAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Version>

| Improve this Doc View Source

HealthCheckAsync()

Returns OK if healthy.

Declaration

public Task<string> HealthCheckAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

HealthCheckAsync(CancellationToken)

Declaration

public Task<string> HealthCheckAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

MetricsAsync()

Return metrics about algod functioning.

Declaration

public Task<string> MetricsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

MetricsAsync(CancellationToken)

Declaration

public Task<string> MetricsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

PendingTransactionInformationAsync(string, Format?)

Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:

transaction committed (committed round > 0)
transaction still in the pool (committed round = 0, pool error = "")
transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Declaration

public Task<IReturnableTransaction> PendingTransactionInformationAsync(string txid, Format? format = null)

Parameters

Type	Name	Description
string	txid	A transaction ID
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><IReturnableTransaction>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

PendingTransactionInformationAsync(CancellationToken, string, Format?)

Declaration

public Task<IReturnableTransaction> PendingTransactionInformationAsync(CancellationToken cancellationToken, string txid, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	txid
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><IReturnableTransaction>

| Improve this Doc View Source

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<DefaultApi.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><string, System.Collections.Generic.IEnumerable<T><string>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><DefaultApi.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

| Improve this Doc View Source

SetSyncRoundAsync(CancellationToken, ulong)

Declaration

public Task<string> SetSyncRoundAsync(CancellationToken cancellationToken, ulong round)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

SetSyncRoundAsync(ulong)

Sets the minimum sync round on the ledger.

Declaration

public Task<string> SetSyncRoundAsync(ulong round)

Parameters

Type	Name	Description
ulong	round	The round for which the deltas are desired.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SimulateTransactionAsync(List<SignedTransaction>, Format?)

Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.

Declaration

public Task<SimulateResponse> SimulateTransactionAsync(List<SignedTransaction> rawtxn, Format? format = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<T><SignedTransaction>	rawtxn	The byte encoded transaction to simulate
Format?	format	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><SimulateResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SimulateTransactionAsync(CancellationToken, List<SignedTransaction>, Format?)

Declaration

public Task<SimulateResponse> SimulateTransactionAsync(CancellationToken cancellationToken, List<SignedTransaction> rawtxn, Format? format = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
System.Collections.Generic.List<T><SignedTransaction>	rawtxn
Format?	format

Returns

Type	Description
System.Threading.Tasks.Task<TResult><SimulateResponse>

| Improve this Doc View Source

SwaggerJSONAsync()

Returns the entire swagger spec in json.

Declaration

public Task<string> SwaggerJSONAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SwaggerJSONAsync(CancellationToken)

Declaration

public Task<string> SwaggerJSONAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

TealCompileAsync(Stream, bool?)

Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Declaration

public Task<CompileResponse> TealCompileAsync(Stream source, bool? sourcemap = null)

Parameters

Type	Name	Description
System.IO.Stream	source	TEAL source code to be compiled
bool?	sourcemap	When set to `true`, returns the source map of the program as a JSON. Defaults to `false`.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><CompileResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

TealCompileAsync(CancellationToken, Stream, bool?)

Declaration

public Task<CompileResponse> TealCompileAsync(CancellationToken cancellationToken, Stream source, bool? sourcemap = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
System.IO.Stream	source
bool?	sourcemap

Returns

Type	Description
System.Threading.Tasks.Task<TResult><CompileResponse>

| Improve this Doc View Source

TealDisassembleAsync(Stream)

Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Declaration

public Task<DisassembleResponse> TealDisassembleAsync(Stream source)

Parameters

Type	Name	Description
System.IO.Stream	source	TEAL program binary to be disassembled

Returns

Type	Description
System.Threading.Tasks.Task<TResult><DisassembleResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

TealDisassembleAsync(CancellationToken, Stream)

Declaration

public Task<DisassembleResponse> TealDisassembleAsync(CancellationToken cancellationToken, Stream source)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
System.IO.Stream	source

Returns

Type	Description
System.Threading.Tasks.Task<TResult><DisassembleResponse>

| Improve this Doc View Source

TealDryrunAsync(DryrunRequest)

Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Declaration

public Task<DryrunResponse> TealDryrunAsync(DryrunRequest request)

Parameters

Type	Name	Description
DryrunRequest	request	Transaction (or group) and any accompanying state-simulation data.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><DryrunResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

TealDryrunAsync(CancellationToken, DryrunRequest)

Declaration

public Task<DryrunResponse> TealDryrunAsync(CancellationToken cancellationToken, DryrunRequest request)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
DryrunRequest	request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><DryrunResponse>

| Improve this Doc View Source

TransactionParamsAsync()

Get parameters for constructing a new transaction

Declaration

public Task<TransactionParametersResponse> TransactionParamsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionParametersResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

TransactionParamsAsync(CancellationToken)

Declaration

public Task<TransactionParametersResponse> TransactionParamsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionParametersResponse>

| Improve this Doc View Source

TransactionsAsync(List<SignedTransaction>)

Broadcasts a raw transaction or transaction group to the network.

Declaration

public Task<PostTransactionsResponse> TransactionsAsync(List<SignedTransaction> rawtxn)

Parameters

Type	Name	Description
System.Collections.Generic.List<T><SignedTransaction>	rawtxn	The byte encoded signed transaction to broadcast to network

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PostTransactionsResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

TransactionsAsync(CancellationToken, List<SignedTransaction>)

Declaration

public Task<PostTransactionsResponse> TransactionsAsync(CancellationToken cancellationToken, List<SignedTransaction> rawtxn)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
System.Collections.Generic.List<T><SignedTransaction>	rawtxn

Returns

Type	Description
System.Threading.Tasks.Task<TResult><PostTransactionsResponse>

| Improve this Doc View Source

UnsetSyncRoundAsync()

Unset the ledger sync round.

Declaration

public Task<string> UnsetSyncRoundAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UnsetSyncRoundAsync(CancellationToken)

Declaration

public Task<string> UnsetSyncRoundAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>

| Improve this Doc View Source

WaitForBlockAsync(CancellationToken, ulong)

Declaration

public Task<NodeStatusResponse> WaitForBlockAsync(CancellationToken cancellationToken, ulong round)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>

| Improve this Doc View Source

WaitForBlockAsync(ulong)

Waits for a block to appear after round {round} and returns the node's status at the time.

Declaration

public Task<NodeStatusResponse> WaitForBlockAsync(ulong round)

Parameters

Type	Name	Description
ulong	round	The round to wait until returning status

Returns

Type	Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

Implements

IDefaultApi