Class Api

Inheritance

object

Api

Implements

IApi

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Algorand.KMD

Assembly: Algorand.dll

Syntax

public class Api : IApi

Constructors

| Improve this Doc View Source

Api(HttpClient)

Declaration

public Api(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
string

| 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

CreateWalletAsync(CreateWalletRequest, CancellationToken)

Create a wallet

Declaration

public virtual Task<APIV1POSTWalletResponse> CreateWalletAsync(CreateWalletRequest create_Wallet_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateWalletRequest	create_Wallet_Request
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><APIV1POSTWalletResponse>	Response to `POST /v1/wallet`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

CreateWalletAsync(CreateWalletRequest)

Create a wallet

Declaration

public virtual Task<APIV1POSTWalletResponse> CreateWalletAsync(CreateWalletRequest create_Wallet_Request)

Parameters

Type	Name	Description
CreateWalletRequest	create_Wallet_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletResponse>	Response to `POST /v1/wallet`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

DeleteKeyAsync(DeleteKeyRequest, CancellationToken)

Delete a key

Declaration

public virtual Task<APIV1DELETEKeyResponse> DeleteKeyAsync(DeleteKeyRequest delete_Key_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DeleteKeyRequest	delete_Key_Request
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><APIV1DELETEKeyResponse>	Response to `DELETE /v1/key`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

DeleteKeyAsync(DeleteKeyRequest)

Delete a key

Declaration

public virtual Task<APIV1DELETEKeyResponse> DeleteKeyAsync(DeleteKeyRequest delete_Key_Request)

Parameters

Type	Name	Description
DeleteKeyRequest	delete_Key_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1DELETEKeyResponse>	Response to `DELETE /v1/key`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

DeleteMultisigAsync(DeleteMultisigRequest, CancellationToken)

Delete a multisig

Declaration

public virtual Task<APIV1DELETEMultisigResponse> DeleteMultisigAsync(DeleteMultisigRequest delete_Multisig_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DeleteMultisigRequest	delete_Multisig_Request
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><APIV1DELETEMultisigResponse>	Response to POST /v1/multisig/delete

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

DeleteMultisigAsync(DeleteMultisigRequest)

Delete a multisig

Declaration

public virtual Task<APIV1DELETEMultisigResponse> DeleteMultisigAsync(DeleteMultisigRequest delete_Multisig_Request)

Parameters

Type	Name	Description
DeleteMultisigRequest	delete_Multisig_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1DELETEMultisigResponse>	Response to POST /v1/multisig/delete

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportKeyAsync(ExportKeyRequest, CancellationToken)

Export a key

Declaration

public virtual Task<APIV1POSTKeyExportResponse> ExportKeyAsync(ExportKeyRequest export_Key_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ExportKeyRequest	export_Key_Request
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><APIV1POSTKeyExportResponse>	Response to `POST /v1/key/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportKeyAsync(ExportKeyRequest)

Export a key

Declaration

public virtual Task<APIV1POSTKeyExportResponse> ExportKeyAsync(ExportKeyRequest export_Key_Request)

Parameters

Type	Name	Description
ExportKeyRequest	export_Key_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTKeyExportResponse>	Response to `POST /v1/key/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportMasterKeyAsync(ExportMasterKeyRequest, CancellationToken)

Export the master derivation key from a wallet

Declaration

public virtual Task<APIV1POSTMasterKeyExportResponse> ExportMasterKeyAsync(ExportMasterKeyRequest export_Master_Key_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ExportMasterKeyRequest	export_Master_Key_Request
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><APIV1POSTMasterKeyExportResponse>	Response to `POST /v1/master-key/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportMasterKeyAsync(ExportMasterKeyRequest)

Export the master derivation key from a wallet

Declaration

public virtual Task<APIV1POSTMasterKeyExportResponse> ExportMasterKeyAsync(ExportMasterKeyRequest export_Master_Key_Request)

Parameters

Type	Name	Description
ExportMasterKeyRequest	export_Master_Key_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMasterKeyExportResponse>	Response to `POST /v1/master-key/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportMultisigAsync(ExportMultisigRequest, CancellationToken)

Export multisig address metadata

Declaration

public virtual Task<APIV1POSTMultisigExportResponse> ExportMultisigAsync(ExportMultisigRequest export_Multisig_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ExportMultisigRequest	export_Multisig_Request
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><APIV1POSTMultisigExportResponse>	Response to `POST /v1/multisig/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ExportMultisigAsync(ExportMultisigRequest)

Export multisig address metadata

Declaration

public virtual Task<APIV1POSTMultisigExportResponse> ExportMultisigAsync(ExportMultisigRequest export_Multisig_Request)

Parameters

Type	Name	Description
ExportMultisigRequest	export_Multisig_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMultisigExportResponse>	Response to `POST /v1/multisig/export`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GenerateKeyAsync(GenerateKeyRequest, CancellationToken)

Generate a key

Declaration

public virtual Task<APIV1POSTKeyResponse> GenerateKeyAsync(GenerateKeyRequest generate_Key_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GenerateKeyRequest	generate_Key_Request
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><APIV1POSTKeyResponse>	Response to `POST /v1/key`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GenerateKeyAsync(GenerateKeyRequest)

Generate a key

Declaration

public virtual Task<APIV1POSTKeyResponse> GenerateKeyAsync(GenerateKeyRequest generate_Key_Request)

Parameters

Type	Name	Description
GenerateKeyRequest	generate_Key_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTKeyResponse>	Response to `POST /v1/key`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVersionAsync(object, CancellationToken)

Retrieves the current version

Declaration

public virtual Task<VersionsResponse> GetVersionAsync(object versions_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
object	versions_Request
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><VersionsResponse>	Response to `GET /versions`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVersionAsync(object)

Retrieves the current version

Declaration

public virtual Task<VersionsResponse> GetVersionAsync(object versions_Request)

Parameters

Type	Name	Description
object	versions_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><VersionsResponse>	Response to `GET /versions`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetWalletInfoAsync(WalletInfoRequest, CancellationToken)

Get wallet info

Declaration

public virtual Task<APIV1POSTWalletInfoResponse> GetWalletInfoAsync(WalletInfoRequest get_Wallet_Info_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
WalletInfoRequest	get_Wallet_Info_Request
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><APIV1POSTWalletInfoResponse>	Response to `POST /v1/wallet/info`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetWalletInfoAsync(WalletInfoRequest)

Get wallet info

Declaration

public virtual Task<APIV1POSTWalletInfoResponse> GetWalletInfoAsync(WalletInfoRequest get_Wallet_Info_Request)

Parameters

Type	Name	Description
WalletInfoRequest	get_Wallet_Info_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletInfoResponse>	Response to `POST /v1/wallet/info`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ImportKeyAsync(ImportKeyRequest, CancellationToken)

Import a key

Declaration

public virtual Task<APIV1POSTKeyImportResponse> ImportKeyAsync(ImportKeyRequest import_Key_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ImportKeyRequest	import_Key_Request
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><APIV1POSTKeyImportResponse>	Response to `POST /v1/key/import`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ImportKeyAsync(ImportKeyRequest)

Import a key

Declaration

public virtual Task<APIV1POSTKeyImportResponse> ImportKeyAsync(ImportKeyRequest import_Key_Request)

Parameters

Type	Name	Description
ImportKeyRequest	import_Key_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTKeyImportResponse>	Response to `POST /v1/key/import`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ImportMultisigAsync(ImportMultisigRequest, CancellationToken)

Import a multisig account

Declaration

public virtual Task<APIV1POSTMultisigImportResponse> ImportMultisigAsync(ImportMultisigRequest import_Multisig_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ImportMultisigRequest	import_Multisig_Request
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><APIV1POSTMultisigImportResponse>	Response to `POST /v1/multisig/import`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ImportMultisigAsync(ImportMultisigRequest)

Import a multisig account

Declaration

public virtual Task<APIV1POSTMultisigImportResponse> ImportMultisigAsync(ImportMultisigRequest import_Multisig_Request)

Parameters

Type	Name	Description
ImportMultisigRequest	import_Multisig_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMultisigImportResponse>	Response to `POST /v1/multisig/import`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

InitWalletHandleTokenAsync(InitWalletHandleTokenRequest, CancellationToken)

Initialize a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletInitResponse> InitWalletHandleTokenAsync(InitWalletHandleTokenRequest initialize_Wallet_Handle_Token_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InitWalletHandleTokenRequest	initialize_Wallet_Handle_Token_Request
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><APIV1POSTWalletInitResponse>	Response to `POST /v1/wallet/init`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

InitWalletHandleTokenAsync(InitWalletHandleTokenRequest)

Initialize a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletInitResponse> InitWalletHandleTokenAsync(InitWalletHandleTokenRequest initialize_Wallet_Handle_Token_Request)

Parameters

Type	Name	Description
InitWalletHandleTokenRequest	initialize_Wallet_Handle_Token_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletInitResponse>	Response to `POST /v1/wallet/init`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListKeysInWalletAsync(ListKeysRequest, CancellationToken)

List keys in wallet

Declaration

public virtual Task<APIV1POSTKeyListResponse> ListKeysInWalletAsync(ListKeysRequest list_Keys_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ListKeysRequest	list_Keys_Request
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><APIV1POSTKeyListResponse>	Response to `POST /v1/key/list`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListKeysInWalletAsync(ListKeysRequest)

List keys in wallet

Declaration

public virtual Task<APIV1POSTKeyListResponse> ListKeysInWalletAsync(ListKeysRequest list_Keys_Request)

Parameters

Type	Name	Description
ListKeysRequest	list_Keys_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTKeyListResponse>	Response to `POST /v1/key/list`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListMultisgAsync(ListMultisigRequest, CancellationToken)

List multisig accounts

Declaration

public virtual Task<APIV1POSTMultisigListResponse> ListMultisgAsync(ListMultisigRequest list_Multisig_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ListMultisigRequest	list_Multisig_Request
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><APIV1POSTMultisigListResponse>	Response to `POST /v1/multisig/list`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListMultisgAsync(ListMultisigRequest)

List multisig accounts

Declaration

public virtual Task<APIV1POSTMultisigListResponse> ListMultisgAsync(ListMultisigRequest list_Multisig_Request)

Parameters

Type	Name	Description
ListMultisigRequest	list_Multisig_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMultisigListResponse>	Response to `POST /v1/multisig/list`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListWalletsAsync(object, CancellationToken)

List wallets

Declaration

public virtual Task<APIV1GETWalletsResponse> ListWalletsAsync(object list_Wallet_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
object	list_Wallet_Request
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><APIV1GETWalletsResponse>	Response to `GET /v1/wallets`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ListWalletsAsync(object)

List wallets

Declaration

public virtual Task<APIV1GETWalletsResponse> ListWalletsAsync(object list_Wallet_Request)

Parameters

Type	Name	Description
object	list_Wallet_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1GETWalletsResponse>	Response to `GET /v1/wallets`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

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

Declaration

protected virtual Task<Api.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><Api.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

| Improve this Doc View Source

ReleaseWalletHandleTokenAsync(ReleaseWalletHandleTokenRequest, CancellationToken)

Release a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletReleaseResponse> ReleaseWalletHandleTokenAsync(ReleaseWalletHandleTokenRequest release_Wallet_Handle_Token_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ReleaseWalletHandleTokenRequest	release_Wallet_Handle_Token_Request
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><APIV1POSTWalletReleaseResponse>	Response to `POST /v1/wallet/release`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ReleaseWalletHandleTokenAsync(ReleaseWalletHandleTokenRequest)

Release a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletReleaseResponse> ReleaseWalletHandleTokenAsync(ReleaseWalletHandleTokenRequest release_Wallet_Handle_Token_Request)

Parameters

Type	Name	Description
ReleaseWalletHandleTokenRequest	release_Wallet_Handle_Token_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletReleaseResponse>	Response to `POST /v1/wallet/release`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

RenameWalletAsync(RenameWalletRequest, CancellationToken)

Rename a wallet

Declaration

public virtual Task<APIV1POSTWalletRenameResponse> RenameWalletAsync(RenameWalletRequest rename_Wallet_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RenameWalletRequest	rename_Wallet_Request
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><APIV1POSTWalletRenameResponse>	Response to `POST /v1/wallet/rename`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

RenameWalletAsync(RenameWalletRequest)

Rename a wallet

Declaration

public virtual Task<APIV1POSTWalletRenameResponse> RenameWalletAsync(RenameWalletRequest rename_Wallet_Request)

Parameters

Type	Name	Description
RenameWalletRequest	rename_Wallet_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletRenameResponse>	Response to `POST /v1/wallet/rename`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

RenewWalletHandleTokenAsync(RenewWalletHandleTokenRequest, CancellationToken)

Renew a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletRenewResponse> RenewWalletHandleTokenAsync(RenewWalletHandleTokenRequest renew_Wallet_Handle_Token_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RenewWalletHandleTokenRequest	renew_Wallet_Handle_Token_Request
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><APIV1POSTWalletRenewResponse>	Response `POST /v1/wallet/renew`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

RenewWalletHandleTokenAsync(RenewWalletHandleTokenRequest)

Renew a wallet handle token

Declaration

public virtual Task<APIV1POSTWalletRenewResponse> RenewWalletHandleTokenAsync(RenewWalletHandleTokenRequest renew_Wallet_Handle_Token_Request)

Parameters

Type	Name	Description
RenewWalletHandleTokenRequest	renew_Wallet_Handle_Token_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTWalletRenewResponse>	Response `POST /v1/wallet/renew`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignMultisigProgramAsync(SignProgramMultisigRequest, CancellationToken)

Sign a program for a multisig account

Declaration

public virtual Task<APIV1POSTMultisigProgramSignResponse> SignMultisigProgramAsync(SignProgramMultisigRequest sign_Multisig_Program_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SignProgramMultisigRequest	sign_Multisig_Program_Request
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><APIV1POSTMultisigProgramSignResponse>	Response to `POST /v1/multisig/signdata`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignMultisigProgramAsync(SignProgramMultisigRequest)

Sign a program for a multisig account

Declaration

public virtual Task<APIV1POSTMultisigProgramSignResponse> SignMultisigProgramAsync(SignProgramMultisigRequest sign_Multisig_Program_Request)

Parameters

Type	Name	Description
SignProgramMultisigRequest	sign_Multisig_Program_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMultisigProgramSignResponse>	Response to `POST /v1/multisig/signdata`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignMultisigTransactionAsync(SignMultisigRequest, CancellationToken)

Sign a multisig transaction

Declaration

public virtual Task<APIV1POSTMultisigTransactionSignResponse> SignMultisigTransactionAsync(SignMultisigRequest sign_Multisig_Transaction_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SignMultisigRequest	sign_Multisig_Transaction_Request
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><APIV1POSTMultisigTransactionSignResponse>	Response to `POST /v1/multisig/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignMultisigTransactionAsync(SignMultisigRequest)

Sign a multisig transaction

Declaration

public virtual Task<APIV1POSTMultisigTransactionSignResponse> SignMultisigTransactionAsync(SignMultisigRequest sign_Multisig_Transaction_Request)

Parameters

Type	Name	Description
SignMultisigRequest	sign_Multisig_Transaction_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTMultisigTransactionSignResponse>	Response to `POST /v1/multisig/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignProgramAsync(SignProgramRequest, CancellationToken)

Sign program

Declaration

public virtual Task<APIV1POSTProgramSignResponse> SignProgramAsync(SignProgramRequest sign_Program_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SignProgramRequest	sign_Program_Request
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><APIV1POSTProgramSignResponse>	Response to `POST /v1/data/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignProgramAsync(SignProgramRequest)

Sign program

Declaration

public virtual Task<APIV1POSTProgramSignResponse> SignProgramAsync(SignProgramRequest sign_Program_Request)

Parameters

Type	Name	Description
SignProgramRequest	sign_Program_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTProgramSignResponse>	Response to `POST /v1/data/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignTransactionAsync(SignTransactionRequest, CancellationToken)

Sign a transaction

Declaration

public virtual Task<APIV1POSTTransactionSignResponse> SignTransactionAsync(SignTransactionRequest sign_Transaction_Request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SignTransactionRequest	sign_Transaction_Request
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><APIV1POSTTransactionSignResponse>	Response to `POST /v1/transaction/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SignTransactionAsync(SignTransactionRequest)

Sign a transaction

Declaration

public virtual Task<APIV1POSTTransactionSignResponse> SignTransactionAsync(SignTransactionRequest sign_Transaction_Request)

Parameters

Type	Name	Description
SignTransactionRequest	sign_Transaction_Request

Returns

Type	Description
System.Threading.Tasks.Task<TResult><APIV1POSTTransactionSignResponse>	Response to `POST /v1/transaction/sign`

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SwaggerHandlerAsync()

Gets the current swagger spec.

Declaration

public virtual Task<string> SwaggerHandlerAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><string>	The current swagger spec

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

SwaggerHandlerAsync(CancellationToken)

Gets the current swagger spec.

Declaration

public virtual Task<string> SwaggerHandlerAsync(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>	The current swagger spec

Exceptions

Type	Condition
ApiException	A server side error occurred.

Implements

IApi