Interface IDefaultApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Algorand.V2.Algod
Assembly: Algorand.dll
Syntax
public interface IDefaultApi : IApiAccessor
Methods
| Improve this Doc View SourceAccountInformation(String, String)
Get account information.
Declaration
Account AccountInformation(string address, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
Account | Account |
Remarks
Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AccountInformationAsync(String, String)
Get account information.
Declaration
Task<Account> AccountInformationAsync(string address, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Account> | Task of Account |
Remarks
Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AccountInformationAsyncWithHttpInfo(String, String)
Get account information.
Declaration
Task<ApiResponse<Account>> AccountInformationAsyncWithHttpInfo(string address, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<Account>> | Task of ApiResponse (Account) |
Remarks
Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AccountInformationWithHttpInfo(String, String)
Get account information.
Declaration
ApiResponse<Account> AccountInformationWithHttpInfo(string address, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<Account> | ApiResponse of Account |
Remarks
Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetApplicationByID(Nullable<Int64>)
Get application information.
Declaration
Application GetApplicationByID(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId | An application identifier |
Returns
Type | Description |
---|---|
Application | Application |
Remarks
Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetApplicationByIDAsync(Nullable<Int64>)
Get application information.
Declaration
Task<Application> GetApplicationByIDAsync(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId | An application identifier |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Application> | Task of Application |
Remarks
Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetApplicationByIDAsyncWithHttpInfo(Nullable<Int64>)
Get application information.
Declaration
Task<ApiResponse<Application>> GetApplicationByIDAsyncWithHttpInfo(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId | An application identifier |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<Application>> | Task of ApiResponse (Application) |
Remarks
Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetApplicationByIDWithHttpInfo(Nullable<Int64>)
Get application information.
Declaration
ApiResponse<Application> GetApplicationByIDWithHttpInfo(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId | An application identifier |
Returns
Type | Description |
---|---|
ApiResponse<Application> | ApiResponse of Application |
Remarks
Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAssetByID(Nullable<Int64>)
Get asset information.
Declaration
Asset GetAssetByID(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | An asset identifier |
Returns
Type | Description |
---|---|
Asset | Asset |
Remarks
Given a asset id, it returns asset information including creator, name, total supply and special addresses.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAssetByIDAsync(Nullable<Int64>)
Get asset information.
Declaration
Task<Asset> GetAssetByIDAsync(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | An asset identifier |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Asset> | Task of Asset |
Remarks
Given a asset id, it returns asset information including creator, name, total supply and special addresses.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAssetByIDAsyncWithHttpInfo(Nullable<Int64>)
Get asset information.
Declaration
Task<ApiResponse<Asset>> GetAssetByIDAsyncWithHttpInfo(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | An asset identifier |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<Asset>> | Task of ApiResponse (Asset) |
Remarks
Given a asset id, it returns asset information including creator, name, total supply and special addresses.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAssetByIDWithHttpInfo(Nullable<Int64>)
Get asset information.
Declaration
ApiResponse<Asset> GetAssetByIDWithHttpInfo(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | An asset identifier |
Returns
Type | Description |
---|---|
ApiResponse<Asset> | ApiResponse of Asset |
Remarks
Given a asset id, it returns asset information including creator, name, total supply and special addresses.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetBlock(Nullable<Int64>, String)
Get the block for the given round.
Declaration
BlockResponse GetBlock(long? round, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round from which to fetch block information. |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
BlockResponse | BlockResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetBlockAsync(Nullable<Int64>, String)
Get the block for the given round.
Declaration
Task<BlockResponse> GetBlockAsync(long? round, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round from which to fetch block information. |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<BlockResponse> | Task of BlockResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetBlockAsyncWithHttpInfo(Nullable<Int64>, String)
Get the block for the given round.
Declaration
Task<ApiResponse<BlockResponse>> GetBlockAsyncWithHttpInfo(long? round, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round from which to fetch block information. |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<BlockResponse>> | Task of ApiResponse (BlockResponse) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetBlockWithHttpInfo(Nullable<Int64>, String)
Get the block for the given round.
Declaration
ApiResponse<BlockResponse> GetBlockWithHttpInfo(long? round, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round from which to fetch block information. |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<BlockResponse> | ApiResponse of BlockResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactions(Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool.
Declaration
PendingTransactionsResponse GetPendingTransactions(long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
PendingTransactionsResponse | PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsAsync(Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool.
Declaration
Task<PendingTransactionsResponse> GetPendingTransactionsAsync(long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PendingTransactionsResponse> | Task of PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsAsyncWithHttpInfo(Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool.
Declaration
Task<ApiResponse<PendingTransactionsResponse>> GetPendingTransactionsAsyncWithHttpInfo(long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<PendingTransactionsResponse>> | Task of ApiResponse (PendingTransactionsResponse) |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsByAddress(String, Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool by address.
Declaration
PendingTransactionsResponse GetPendingTransactionsByAddress(string address, long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
PendingTransactionsResponse | PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsByAddressAsync(String, Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool by address.
Declaration
Task<PendingTransactionsResponse> GetPendingTransactionsByAddressAsync(string address, long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PendingTransactionsResponse> | Task of PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsByAddressAsyncWithHttpInfo(String, Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool by address.
Declaration
Task<ApiResponse<PendingTransactionsResponse>> GetPendingTransactionsByAddressAsyncWithHttpInfo(string address, long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<PendingTransactionsResponse>> | Task of ApiResponse (PendingTransactionsResponse) |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsByAddressWithHttpInfo(String, Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool by address.
Declaration
ApiResponse<PendingTransactionsResponse> GetPendingTransactionsByAddressWithHttpInfo(string address, long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | address | An account public key |
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<PendingTransactionsResponse> | ApiResponse of PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPendingTransactionsWithHttpInfo(Nullable<Int64>, String)
Get a list of unconfirmed transactions currently in the transaction pool.
Declaration
ApiResponse<PendingTransactionsResponse> GetPendingTransactionsWithHttpInfo(long? max = default(long? ), string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | max | Truncated number of transactions to display. If max=0, returns all pending txns. (optional) |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<PendingTransactionsResponse> | ApiResponse of PendingTransactionsResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetStatus()
Gets the current node status.
Declaration
NodeStatusResponse GetStatus()
Returns
Type | Description |
---|---|
NodeStatusResponse | NodeStatusResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetStatusAsync()
Gets the current node status.
Declaration
Task<NodeStatusResponse> GetStatusAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NodeStatusResponse> | Task of NodeStatusResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetStatusAsyncWithHttpInfo()
Gets the current node status.
Declaration
Task<ApiResponse<NodeStatusResponse>> GetStatusAsyncWithHttpInfo()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<NodeStatusResponse>> | Task of ApiResponse (NodeStatusResponse) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetStatusWithHttpInfo()
Gets the current node status.
Declaration
ApiResponse<NodeStatusResponse> GetStatusWithHttpInfo()
Returns
Type | Description |
---|---|
ApiResponse<NodeStatusResponse> | ApiResponse of NodeStatusResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSupply()
Get the current supply reported by the ledger.
Declaration
SupplyResponse GetSupply()
Returns
Type | Description |
---|---|
SupplyResponse | SupplyResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSupplyAsync()
Get the current supply reported by the ledger.
Declaration
Task<SupplyResponse> GetSupplyAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SupplyResponse> | Task of SupplyResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSupplyAsyncWithHttpInfo()
Get the current supply reported by the ledger.
Declaration
Task<ApiResponse<SupplyResponse>> GetSupplyAsyncWithHttpInfo()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<SupplyResponse>> | Task of ApiResponse (SupplyResponse) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSupplyWithHttpInfo()
Get the current supply reported by the ledger.
Declaration
ApiResponse<SupplyResponse> GetSupplyWithHttpInfo()
Returns
Type | Description |
---|---|
ApiResponse<SupplyResponse> | ApiResponse of SupplyResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
PendingTransactionInformation(String, String)
Get a specific pending transaction.
Declaration
PendingTransactionResponse PendingTransactionInformation(string txid, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid | A transaction id |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
PendingTransactionResponse | PendingTransactionResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
PendingTransactionInformationAsync(String, String)
Get a specific pending transaction.
Declaration
Task<PendingTransactionResponse> PendingTransactionInformationAsync(string txid, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid | A transaction id |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PendingTransactionResponse> | Task of PendingTransactionResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
PendingTransactionInformationAsyncWithHttpInfo(String, String)
Get a specific pending transaction.
Declaration
Task<ApiResponse<PendingTransactionResponse>> PendingTransactionInformationAsyncWithHttpInfo(string txid, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid | A transaction id |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<PendingTransactionResponse>> | Task of ApiResponse (PendingTransactionResponse) |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
PendingTransactionInformationWithHttpInfo(String, String)
Get a specific pending transaction.
Declaration
ApiResponse<PendingTransactionResponse> PendingTransactionInformationWithHttpInfo(string txid, string format = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid | A transaction id |
System.String | format | Configures whether the response object is JSON or MessagePack encoded. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<PendingTransactionResponse> | ApiResponse of PendingTransactionResponse |
Remarks
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.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RawTransaction(Byte[])
Broadcasts a raw transaction to the network.
Declaration
PostTransactionsResponse RawTransaction(byte[] rawtxn)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | rawtxn | The byte encoded signed transaction to broadcast to network |
Returns
Type | Description |
---|---|
PostTransactionsResponse | PostTransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RawTransactionAsync(Byte[])
Broadcasts a raw transaction to the network.
Declaration
Task<PostTransactionsResponse> RawTransactionAsync(byte[] rawtxn)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | rawtxn | The byte encoded signed transaction to broadcast to network |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PostTransactionsResponse> | Task of PostTransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RawTransactionAsyncWithHttpInfo(Byte[])
Broadcasts a raw transaction to the network.
Declaration
Task<ApiResponse<PostTransactionsResponse>> RawTransactionAsyncWithHttpInfo(byte[] rawtxn)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | rawtxn | The byte encoded signed transaction to broadcast to network |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<PostTransactionsResponse>> | Task of ApiResponse (PostTransactionsResponse) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RawTransactionWithHttpInfo(Byte[])
Broadcasts a raw transaction to the network.
Declaration
ApiResponse<PostTransactionsResponse> RawTransactionWithHttpInfo(byte[] rawtxn)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | rawtxn | The byte encoded signed transaction to broadcast to network |
Returns
Type | Description |
---|---|
ApiResponse<PostTransactionsResponse> | ApiResponse of PostTransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealCompile(Byte[])
Compile TEAL source code to binary, produce its hash
Declaration
CompileResponse TealCompile(byte[] source)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | source | TEAL source code to be compiled |
Returns
Type | Description |
---|---|
CompileResponse | CompileResponse |
Remarks
Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealCompileAsync(Byte[])
Compile TEAL source code to binary, produce its hash
Declaration
Task<CompileResponse> TealCompileAsync(byte[] source)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | source | TEAL source code to be compiled |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<CompileResponse> | Task of CompileResponse |
Remarks
Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealCompileAsyncWithHttpInfo(Byte[])
Compile TEAL source code to binary, produce its hash
Declaration
Task<ApiResponse<CompileResponse>> TealCompileAsyncWithHttpInfo(byte[] source)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | source | TEAL source code to be compiled |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<CompileResponse>> | Task of ApiResponse (CompileResponse) |
Remarks
Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealCompileWithHttpInfo(Byte[])
Compile TEAL source code to binary, produce its hash
Declaration
ApiResponse<CompileResponse> TealCompileWithHttpInfo(byte[] source)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | source | TEAL source code to be compiled |
Returns
Type | Description |
---|---|
ApiResponse<CompileResponse> | ApiResponse of CompileResponse |
Remarks
Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealDryrun(DryrunRequest)
Provide debugging information for a transaction (or group).
Declaration
DryrunResponse TealDryrun(DryrunRequest request = null)
Parameters
Type | Name | Description |
---|---|---|
DryrunRequest | request | Transaction (or group) and any accompanying state-simulation data. (optional) |
Returns
Type | Description |
---|---|
DryrunResponse | DryrunResponse |
Remarks
Executes TEAL program(s) in context and returns debugging information about the execution.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealDryrunAsync(DryrunRequest)
Provide debugging information for a transaction (or group).
Declaration
Task<DryrunResponse> TealDryrunAsync(DryrunRequest request = null)
Parameters
Type | Name | Description |
---|---|---|
DryrunRequest | request | Transaction (or group) and any accompanying state-simulation data. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DryrunResponse> | Task of DryrunResponse |
Remarks
Executes TEAL program(s) in context and returns debugging information about the execution.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealDryrunAsyncWithHttpInfo(DryrunRequest)
Provide debugging information for a transaction (or group).
Declaration
Task<ApiResponse<DryrunResponse>> TealDryrunAsyncWithHttpInfo(DryrunRequest request = null)
Parameters
Type | Name | Description |
---|---|---|
DryrunRequest | request | Transaction (or group) and any accompanying state-simulation data. (optional) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<DryrunResponse>> | Task of ApiResponse (DryrunResponse) |
Remarks
Executes TEAL program(s) in context and returns debugging information about the execution.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TealDryrunWithHttpInfo(DryrunRequest)
Provide debugging information for a transaction (or group).
Declaration
ApiResponse<DryrunResponse> TealDryrunWithHttpInfo(DryrunRequest request = null)
Parameters
Type | Name | Description |
---|---|---|
DryrunRequest | request | Transaction (or group) and any accompanying state-simulation data. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<DryrunResponse> | ApiResponse of DryrunResponse |
Remarks
Executes TEAL program(s) in context and returns debugging information about the execution.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TransactionParams()
Get parameters for constructing a new transaction
Declaration
TransactionParametersResponse TransactionParams()
Returns
Type | Description |
---|---|
TransactionParametersResponse | TransactionParametersResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TransactionParamsAsync()
Get parameters for constructing a new transaction
Declaration
Task<TransactionParametersResponse> TransactionParamsAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TransactionParametersResponse> | Task of TransactionParametersResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TransactionParamsAsyncWithHttpInfo()
Get parameters for constructing a new transaction
Declaration
Task<ApiResponse<TransactionParametersResponse>> TransactionParamsAsyncWithHttpInfo()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<TransactionParametersResponse>> | Task of ApiResponse (TransactionParametersResponse) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
TransactionParamsWithHttpInfo()
Get parameters for constructing a new transaction
Declaration
ApiResponse<TransactionParametersResponse> TransactionParamsWithHttpInfo()
Returns
Type | Description |
---|---|
ApiResponse<TransactionParametersResponse> | ApiResponse of TransactionParametersResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForBlock(Nullable<Int64>)
Gets the node status after waiting for the given round.
Declaration
NodeStatusResponse WaitForBlock(long? round)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round to wait until returning status |
Returns
Type | Description |
---|---|
NodeStatusResponse | NodeStatusResponse |
Remarks
Waits for a block to appear after round {round} and returns the node's status at the time.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForBlockAsync(Nullable<Int64>)
Gets the node status after waiting for the given round.
Declaration
Task<NodeStatusResponse> WaitForBlockAsync(long? round)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round to wait until returning status |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NodeStatusResponse> | Task of NodeStatusResponse |
Remarks
Waits for a block to appear after round {round} and returns the node's status at the time.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForBlockAsyncWithHttpInfo(Nullable<Int64>)
Gets the node status after waiting for the given round.
Declaration
Task<ApiResponse<NodeStatusResponse>> WaitForBlockAsyncWithHttpInfo(long? round)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round to wait until returning status |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ApiResponse<NodeStatusResponse>> | Task of ApiResponse (NodeStatusResponse) |
Remarks
Waits for a block to appear after round {round} and returns the node's status at the time.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForBlockWithHttpInfo(Nullable<Int64>)
Gets the node status after waiting for the given round.
Declaration
ApiResponse<NodeStatusResponse> WaitForBlockWithHttpInfo(long? round)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | round | The round to wait until returning status |
Returns
Type | Description |
---|---|
ApiResponse<NodeStatusResponse> | ApiResponse of NodeStatusResponse |
Remarks
Waits for a block to appear after round {round} and returns the node's status at the time.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |