• Api Documentation
Show / Hide Table of Contents
  • Algorand
    • Address
    • ApiException
    • ApiException<TResult>
    • Digest
    • HttpClientConfigurator
    • LogicsigSignature
    • MultisigAddress
    • MultisigSignature
    • MultisigSubsig
    • ParticipationPublicKey
    • Signature
    • TEALProgram
    • TxGroup
    • VRFPublicKey
  • Algorand.Algod
    • DefaultApi
    • DefaultApi.ObjectResponseResult<T>
    • IDefaultApi
  • Algorand.Algod.Model
    • Account
    • AccountApplicationResponse
    • AccountAssetResponse
    • AccountBalanceRecord
    • AccountDeltas
    • AccountParticipation
    • AccountSigType
    • AccountStateDelta
    • AccountTotals
    • Application
    • ApplicationLocalState
    • ApplicationParams
    • ApplicationStateSchema
    • AppResourceRecord
    • Asset
    • AssetHolding
    • AssetParams
    • AssetResourceRecord
    • Block
    • BlockHashResponse
    • Box
    • BoxDescriptor
    • BoxesResponse
    • BuildVersion
    • CertifiedBlock
    • CompileResponse
    • DisassembleResponse
    • DryrunRequest
    • DryrunResponse
    • DryrunSource
    • DryrunState
    • DryrunTxnResult
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • FileParameter
    • Format
    • GetSyncRoundResponse
    • KvDelta
    • LedgerStateDelta
    • LightBlockHeaderProof
    • ModifiedApp
    • ModifiedAsset
    • NodeStatusResponse
    • ParticipationKey
    • PendingTransactions
    • PostTransactionsResponse
    • ProofResponse
    • SimulateResponse
    • SimulateTransactionGroupResult
    • SimulateTransactionResult
    • StateDelta
    • StateProof
    • StateProofMessage
    • SupplyResponse
    • TealKeyValue
    • TealValue
    • TransactionParametersResponse
    • TransactionProofResponse
    • TxLease
    • Version
  • Algorand.Algod.Model.Transactions
    • ApplicationCallTransaction
    • ApplicationClearStateTransaction
    • ApplicationCloseOutTransaction
    • ApplicationCreateTransaction
    • ApplicationDeleteTransaction
    • ApplicationNoopTransaction
    • ApplicationOptInTransaction
    • ApplicationUpdateTransaction
    • AssetAcceptTransaction
    • AssetChangeTransaction
    • AssetClawbackTransaction
    • AssetConfigurationTransaction
    • AssetCreateTransaction
    • AssetDestroyTransaction
    • AssetFreezeTransaction
    • AssetMovementsTransaction
    • AssetTransferTransaction
    • AssetUpdateTransaction
    • IReturnableTransaction
    • KeyRegisterOfflineTransaction
    • KeyRegisterOnlineTransaction
    • KeyRegistrationTransaction
    • OnCompletion
    • PaymentTransaction
    • SignedTransaction
    • StateSchema
    • Transaction
  • Algorand.Algod.Test
    • TestHttpMessageHandler
  • Algorand.Crypto
    • KeyPair
  • Algorand.Indexer
    • CommonApi
    • CommonApi.ObjectResponseResult<T>
    • ICommonApi
    • ILookupApi
    • ISearchApi
    • LookupApi
    • LookupApi.ObjectResponseResult<T>
    • SearchApi
    • SearchApi.ObjectResponseResult<T>
  • Algorand.Indexer.Model
    • Account
    • AccountParticipation
    • AccountResponse
    • AccountsResponse
    • AccountStateDelta
    • Application
    • ApplicationLocalState
    • ApplicationLocalStatesResponse
    • ApplicationLogData
    • ApplicationLogsResponse
    • ApplicationParams
    • ApplicationResponse
    • ApplicationsResponse
    • ApplicationStateSchema
    • Asset
    • AssetBalancesResponse
    • AssetHolding
    • AssetHoldingsResponse
    • AssetParams
    • AssetResponse
    • AssetsResponse
    • Block
    • BlockRewards
    • BlockUpgradeState
    • BlockUpgradeVote
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • HealthCheck
    • MiniAssetHolding
    • StateSchema
    • TealKeyValue
    • TealValue
    • Transaction
    • TransactionApplication
    • TransactionAssetConfig
    • TransactionAssetFreeze
    • TransactionAssetTransfer
    • TransactionKeyreg
    • TransactionPayment
    • TransactionResponse
    • TransactionSignature
    • TransactionSignatureLogicsig
    • TransactionSignatureMultisig
    • TransactionSignatureMultisigSubsignature
    • TransactionsResponse
  • Algorand.KMD
    • Api
    • Api.ObjectResponseResult<T>
    • ApiException
    • ApiException<TResult>
    • APIV1DELETEKeyResponse
    • APIV1DELETEMultisigResponse
    • APIV1GETWalletsResponse
    • APIV1POSTKeyExportResponse
    • APIV1POSTKeyImportResponse
    • APIV1POSTKeyListResponse
    • APIV1POSTKeyResponse
    • APIV1POSTMasterKeyExportResponse
    • APIV1POSTMultisigExportResponse
    • APIV1POSTMultisigImportResponse
    • APIV1POSTMultisigListResponse
    • APIV1POSTMultisigProgramSignResponse
    • APIV1POSTMultisigTransactionSignResponse
    • APIV1POSTProgramSignResponse
    • APIV1POSTTransactionSignResponse
    • APIV1POSTWalletInfoResponse
    • APIV1POSTWalletInitResponse
    • APIV1POSTWalletReleaseResponse
    • APIV1POSTWalletRenameResponse
    • APIV1POSTWalletRenewResponse
    • APIV1POSTWalletResponse
    • APIV1Wallet
    • APIV1WalletHandle
    • CreateWalletRequest
    • DeleteKeyRequest
    • DeleteMultisigRequest
    • ExportKeyRequest
    • ExportMasterKeyRequest
    • ExportMultisigRequest
    • GenerateKeyRequest
    • IApi
    • ImportKeyRequest
    • ImportMultisigRequest
    • InitWalletHandleTokenRequest
    • ListKeysRequest
    • ListMultisigRequest
    • MultisigSig
    • MultisigSubsig
    • ReleaseWalletHandleTokenRequest
    • RenameWalletRequest
    • RenewWalletHandleTokenRequest
    • SignMultisigRequest
    • SignProgramMultisigRequest
    • SignProgramRequest
    • SignTransactionRequest
    • VersionsResponse
    • WalletInfoRequest
  • Algorand.Utils
    • ByteConstBlock
    • BytesConverter
    • Digester
    • Encoder
    • IntConstBlock
    • Logic
    • Logic.Uvarint
    • Mnemonic
    • MultisigAddressConverter
    • OrderedContractResolver
    • ProgramData
    • ReturnedTransactionConverter
    • Utils
    • VarintResult
    • Wordlist
  • Algorand.Utils.Crypto
    • FixedSecureRandom

Interface IDefaultApi

Namespace: Algorand.Algod
Assembly: Algorand.dll
Syntax
public interface IDefaultApi

Methods

| Improve this Doc View Source

AccountApplicationInformationAsync(string, ulong, Format?)

Declaration
Task<AccountApplicationResponse> AccountApplicationInformationAsync(string address, ulong applicationId, Format? format = null)
Parameters
Type Name Description
string address
ulong applicationId
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><AccountApplicationResponse>
| Improve this Doc View Source

AccountApplicationInformationAsync(CancellationToken, string, ulong, Format?)

Declaration
Task<AccountApplicationResponse> AccountApplicationInformationAsync(CancellationToken cancellationToken, string address, ulong applicationId, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

AccountAssetInformationAsync(string, ulong, Format?)

Declaration
Task<AccountAssetResponse> AccountAssetInformationAsync(string address, ulong assetId, Format? format = null)
Parameters
Type Name Description
string address
ulong assetId
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><AccountAssetResponse>
| Improve this Doc View Source

AccountAssetInformationAsync(CancellationToken, string, ulong, Format?)

Declaration
Task<AccountAssetResponse> AccountAssetInformationAsync(CancellationToken cancellationToken, string address, ulong assetId, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

AccountInformationAsync(string, string?, Format?)

Declaration
Task<Account> AccountInformationAsync(string address, string? exclude = null, Format? format = null)
Parameters
Type Name Description
string address
string exclude
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><Account>
| Improve this Doc View Source

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

Declaration
Task<Account> AccountInformationAsync(CancellationToken cancellationToken, string address, string? exclude = null, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

ExperimentalCheckAsync()

Declaration
Task<string> ExperimentalCheckAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

ExperimentalCheckAsync(CancellationToken)

Declaration
Task<string> ExperimentalCheckAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

GetApplicationBoxByNameAsync(CancellationToken, ulong, string?)

Declaration
Task<Box> GetApplicationBoxByNameAsync(CancellationToken cancellationToken, ulong applicationId, string? name = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetApplicationBoxByNameAsync(ulong, string?)

Declaration
Task<Box> GetApplicationBoxByNameAsync(ulong applicationId, string? name = null)
Parameters
Type Name Description
ulong applicationId
string name
Returns
Type Description
System.Threading.Tasks.Task<TResult><Box>
| Improve this Doc View Source

GetApplicationBoxesAsync(CancellationToken, ulong, ulong?)

Declaration
Task<BoxesResponse> GetApplicationBoxesAsync(CancellationToken cancellationToken, ulong applicationId, ulong? max = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetApplicationBoxesAsync(ulong, ulong?)

Declaration
Task<BoxesResponse> GetApplicationBoxesAsync(ulong applicationId, ulong? max = null)
Parameters
Type Name Description
ulong applicationId
ulong? max
Returns
Type Description
System.Threading.Tasks.Task<TResult><BoxesResponse>
| Improve this Doc View Source

GetApplicationByIDAsync(CancellationToken, ulong)

Declaration
Task<Application> GetApplicationByIDAsync(CancellationToken cancellationToken, ulong applicationId)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong applicationId
Returns
Type Description
System.Threading.Tasks.Task<TResult><Application>
| Improve this Doc View Source

GetApplicationByIDAsync(ulong)

Declaration
Task<Application> GetApplicationByIDAsync(ulong applicationId)
Parameters
Type Name Description
ulong applicationId
Returns
Type Description
System.Threading.Tasks.Task<TResult><Application>
| Improve this Doc View Source

GetAssetByIDAsync(CancellationToken, ulong)

Declaration
Task<Asset> GetAssetByIDAsync(CancellationToken cancellationToken, ulong assetId)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong assetId
Returns
Type Description
System.Threading.Tasks.Task<TResult><Asset>
| Improve this Doc View Source

GetAssetByIDAsync(ulong)

Declaration
Task<Asset> GetAssetByIDAsync(ulong assetId)
Parameters
Type Name Description
ulong assetId
Returns
Type Description
System.Threading.Tasks.Task<TResult><Asset>
| Improve this Doc View Source

GetBlockAsync(CancellationToken, ulong, Format?)

Declaration
Task<CertifiedBlock> GetBlockAsync(CancellationToken cancellationToken, ulong round, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetBlockAsync(ulong, Format?)

Declaration
Task<CertifiedBlock> GetBlockAsync(ulong round, Format? format = null)
Parameters
Type Name Description
ulong round
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><CertifiedBlock>
| Improve this Doc View Source

GetBlockHashAsync(CancellationToken, ulong)

Declaration
Task<BlockHashResponse> GetBlockHashAsync(CancellationToken cancellationToken, ulong round)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong round

The round from which to fetch block hash information.

Returns
Type Description
System.Threading.Tasks.Task<TResult><BlockHashResponse>
| Improve this Doc View Source

GetBlockHashAsync(ulong)

Declaration
Task<BlockHashResponse> GetBlockHashAsync(ulong round)
Parameters
Type Name Description
ulong round
Returns
Type Description
System.Threading.Tasks.Task<TResult><BlockHashResponse>
| Improve this Doc View Source

GetGenesisAsync()

Declaration
Task<string> GetGenesisAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

GetGenesisAsync(CancellationToken)

Declaration
Task<string> GetGenesisAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

GetLedgerStateDeltaAsync(CancellationToken, ulong, Format?)

Declaration
Task<LedgerStateDelta> GetLedgerStateDeltaAsync(CancellationToken cancellationToken, ulong round, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetLedgerStateDeltaAsync(ulong, Format?)

Declaration
Task<LedgerStateDelta> GetLedgerStateDeltaAsync(ulong round, Format? format = null)
Parameters
Type Name Description
ulong round
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><LedgerStateDelta>
| Improve this Doc View Source

GetLightBlockHeaderProofAsync(CancellationToken, ulong)

Declaration
Task<LightBlockHeaderProof> GetLightBlockHeaderProofAsync(CancellationToken cancellationToken, ulong round)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong round

The round to which the light block header belongs.

Returns
Type Description
System.Threading.Tasks.Task<TResult><LightBlockHeaderProof>
| Improve this Doc View Source

GetLightBlockHeaderProofAsync(ulong)

Declaration
Task<LightBlockHeaderProof> GetLightBlockHeaderProofAsync(ulong round)
Parameters
Type Name Description
ulong round
Returns
Type Description
System.Threading.Tasks.Task<TResult><LightBlockHeaderProof>
| Improve this Doc View Source

GetPendingTransactionsAsync(Format?, ulong?)

Declaration
Task<PendingTransactions> GetPendingTransactionsAsync(Format? format = null, ulong? max = null)
Parameters
Type Name Description
Format? format
ulong? max
Returns
Type Description
System.Threading.Tasks.Task<TResult><PendingTransactions>
| Improve this Doc View Source

GetPendingTransactionsAsync(CancellationToken, Format?, ulong?)

Declaration
Task<PendingTransactions> GetPendingTransactionsAsync(CancellationToken cancellationToken, Format? format = null, ulong? max = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetPendingTransactionsByAddressAsync(string, Format?, ulong?)

Declaration
Task<PendingTransactions> GetPendingTransactionsByAddressAsync(string address, Format? format = null, ulong? max = null)
Parameters
Type Name Description
string address
Format? format
ulong? max
Returns
Type Description
System.Threading.Tasks.Task<TResult><PendingTransactions>
| Improve this Doc View Source

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

Declaration
Task<PendingTransactions> GetPendingTransactionsByAddressAsync(CancellationToken cancellationToken, string address, Format? format = null, ulong? max = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

GetStateProofAsync(CancellationToken, ulong)

Declaration
Task<StateProof> GetStateProofAsync(CancellationToken cancellationToken, ulong round)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong round

The round for which a state proof is desired.

Returns
Type Description
System.Threading.Tasks.Task<TResult><StateProof>
| Improve this Doc View Source

GetStateProofAsync(ulong)

Declaration
Task<StateProof> GetStateProofAsync(ulong round)
Parameters
Type Name Description
ulong round
Returns
Type Description
System.Threading.Tasks.Task<TResult><StateProof>
| Improve this Doc View Source

GetStatusAsync()

Declaration
Task<NodeStatusResponse> GetStatusAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>
| Improve this Doc View Source

GetStatusAsync(CancellationToken)

Declaration
Task<NodeStatusResponse> GetStatusAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>
| Improve this Doc View Source

GetSupplyAsync()

Declaration
Task<SupplyResponse> GetSupplyAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><SupplyResponse>
| Improve this Doc View Source

GetSupplyAsync(CancellationToken)

Declaration
Task<SupplyResponse> GetSupplyAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><SupplyResponse>
| Improve this Doc View Source

GetSyncRoundAsync()

Declaration
Task<GetSyncRoundResponse> GetSyncRoundAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><GetSyncRoundResponse>
| Improve this Doc View Source

GetSyncRoundAsync(CancellationToken)

Declaration
Task<GetSyncRoundResponse> GetSyncRoundAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><GetSyncRoundResponse>
| Improve this Doc View Source

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

Declaration
Task<TransactionProofResponse> GetTransactionProofAsync(CancellationToken cancellationToken, ulong round, string txid, Format? format = null, string? hashtype = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

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

Declaration
Task<TransactionProofResponse> GetTransactionProofAsync(ulong round, string txid, Format? format = null, string? hashtype = null)
Parameters
Type Name Description
ulong round
string txid
Format? format
string hashtype
Returns
Type Description
System.Threading.Tasks.Task<TResult><TransactionProofResponse>
| Improve this Doc View Source

GetVersionAsync()

Declaration
Task<Version> GetVersionAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><Version>
| Improve this Doc View Source

GetVersionAsync(CancellationToken)

Declaration
Task<Version> GetVersionAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><Version>
| Improve this Doc View Source

HealthCheckAsync()

Declaration
Task<string> HealthCheckAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

HealthCheckAsync(CancellationToken)

Declaration
Task<string> HealthCheckAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

MetricsAsync()

Declaration
Task<string> MetricsAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

MetricsAsync(CancellationToken)

Declaration
Task<string> MetricsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

PendingTransactionInformationAsync(string, Format?)

Declaration
Task<IReturnableTransaction> PendingTransactionInformationAsync(string txid, Format? format = null)
Parameters
Type Name Description
string txid
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><IReturnableTransaction>
| Improve this Doc View Source

PendingTransactionInformationAsync(CancellationToken, string, Format?)

Declaration
Task<IReturnableTransaction> PendingTransactionInformationAsync(CancellationToken cancellationToken, string txid, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

SetSyncRoundAsync(CancellationToken, ulong)

Declaration
Task<string> SetSyncRoundAsync(CancellationToken cancellationToken, ulong round)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong round

The round for which the deltas are desired.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

SetSyncRoundAsync(ulong)

Declaration
Task<string> SetSyncRoundAsync(ulong round)
Parameters
Type Name Description
ulong round
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

SimulateTransactionAsync(List<SignedTransaction>, Format?)

Declaration
Task<SimulateResponse> SimulateTransactionAsync(List<SignedTransaction> rawtxn, Format? format = null)
Parameters
Type Name Description
System.Collections.Generic.List<T><SignedTransaction> rawtxn
Format? format
Returns
Type Description
System.Threading.Tasks.Task<TResult><SimulateResponse>
| Improve this Doc View Source

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

Declaration
Task<SimulateResponse> SimulateTransactionAsync(CancellationToken cancellationToken, List<SignedTransaction> rawtxn, Format? format = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

SwaggerJSONAsync()

Declaration
Task<string> SwaggerJSONAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

SwaggerJSONAsync(CancellationToken)

Declaration
Task<string> SwaggerJSONAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

TealCompileAsync(Stream, bool?)

Declaration
Task<CompileResponse> TealCompileAsync(Stream source, bool? sourcemap = null)
Parameters
Type Name Description
System.IO.Stream source
bool? sourcemap
Returns
Type Description
System.Threading.Tasks.Task<TResult><CompileResponse>
| Improve this Doc View Source

TealCompileAsync(CancellationToken, Stream, bool?)

Declaration
Task<CompileResponse> TealCompileAsync(CancellationToken cancellationToken, Stream source, bool? sourcemap = null)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

TealDisassembleAsync(Stream)

Declaration
Task<DisassembleResponse> TealDisassembleAsync(Stream source)
Parameters
Type Name Description
System.IO.Stream source
Returns
Type Description
System.Threading.Tasks.Task<TResult><DisassembleResponse>
| Improve this Doc View Source

TealDisassembleAsync(CancellationToken, Stream)

Declaration
Task<DisassembleResponse> TealDisassembleAsync(CancellationToken cancellationToken, Stream source)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

System.IO.Stream source

TEAL program binary to be disassembled

Returns
Type Description
System.Threading.Tasks.Task<TResult><DisassembleResponse>
| Improve this Doc View Source

TealDryrunAsync(DryrunRequest)

Declaration
Task<DryrunResponse> TealDryrunAsync(DryrunRequest request)
Parameters
Type Name Description
DryrunRequest request
Returns
Type Description
System.Threading.Tasks.Task<TResult><DryrunResponse>
| Improve this Doc View Source

TealDryrunAsync(CancellationToken, DryrunRequest)

Declaration
Task<DryrunResponse> TealDryrunAsync(CancellationToken cancellationToken, DryrunRequest request)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

DryrunRequest request

Transaction (or group) and any accompanying state-simulation data.

Returns
Type Description
System.Threading.Tasks.Task<TResult><DryrunResponse>
| Improve this Doc View Source

TransactionParamsAsync()

Declaration
Task<TransactionParametersResponse> TransactionParamsAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><TransactionParametersResponse>
| Improve this Doc View Source

TransactionParamsAsync(CancellationToken)

Declaration
Task<TransactionParametersResponse> TransactionParamsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><TransactionParametersResponse>
| Improve this Doc View Source

TransactionsAsync(List<SignedTransaction>)

Declaration
Task<PostTransactionsResponse> TransactionsAsync(List<SignedTransaction> rawtxn)
Parameters
Type Name Description
System.Collections.Generic.List<T><SignedTransaction> rawtxn
Returns
Type Description
System.Threading.Tasks.Task<TResult><PostTransactionsResponse>
| Improve this Doc View Source

TransactionsAsync(CancellationToken, List<SignedTransaction>)

Declaration
Task<PostTransactionsResponse> TransactionsAsync(CancellationToken cancellationToken, List<SignedTransaction> rawtxn)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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>
| Improve this Doc View Source

UnsetSyncRoundAsync()

Declaration
Task<string> UnsetSyncRoundAsync()
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

UnsetSyncRoundAsync(CancellationToken)

Declaration
Task<string> UnsetSyncRoundAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<TResult><string>
| Improve this Doc View Source

WaitForBlockAsync(CancellationToken, ulong)

Declaration
Task<NodeStatusResponse> WaitForBlockAsync(CancellationToken cancellationToken, ulong round)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

ulong round

The round to wait until returning status

Returns
Type Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>
| Improve this Doc View Source

WaitForBlockAsync(ulong)

Declaration
Task<NodeStatusResponse> WaitForBlockAsync(ulong round)
Parameters
Type Name Description
ulong round
Returns
Type Description
System.Threading.Tasks.Task<TResult><NodeStatusResponse>
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾