• Api Documentation
Show / Hide Table of Contents
  • AVM.ClientGenerator
    • ClientGeneratorAnalyzer
    • ProxyBase
    • ProxyException
    • SignatureBase
  • AVM.ClientGenerator.ABI.ARC32
    • AbiMethodDefaultArgument
    • AppDescription
    • AppDescriptionConverter
    • ArgumentDefaultSource
    • CallConfig
    • CallConfigSpec
    • ConstantDefaultArgument
    • DefaultArgumentConverter
    • DefaultArgumentSpec
    • HintSpec
    • StateDefaultArgument
    • StateDescription
    • StorageElement
    • StorageSection
  • AVM.ClientGenerator.ABI.ARC4
    • ArgumentDescription
    • ContractDescription
    • MethodDescription
    • NetworkAppId
    • ReturnTypeDescription
  • AVM.ClientGenerator.ABI.ARC4.Types
    • Address
    • Application
    • Asset
    • Bool
    • Byte
    • FixedArray<T>
    • String
    • StructArray<T>
    • Tuple
    • UFixed
    • UInt
    • UInt128
    • UInt16
    • UInt24
    • UInt256
    • UInt32
    • UInt48
    • UInt512
    • UInt64
    • VariableArray<T>
    • WireType
  • AVM.ClientGenerator.ABI.ARC56
    • AppDescriptionArc56
    • BareActions
    • CompilerInfo
    • CompilerVersion
    • ContractState
    • DefaultValue
    • Event
    • EventArgument
    • Method
    • MethodActions
    • MethodArgument
    • MethodReturn
    • NetworkInfo
    • ProgramSource
    • ProgramSourceInfo
    • RecommendationBox
    • Recommendations
    • Schema
    • SchemaValues
    • ScratchVariable
    • SourceInfo
    • SourceInfoArgument
    • StorageKey
    • StorageMap
    • StructField
    • TemplateVariable
  • AVM.ClientGenerator.Clients
    • ContractUtilities
    • ProxyException
    • ProxyGenerator
    • SmartSignatureUtilities
  • AVM.ClientGenerator.Compiler
    • TealTypeUtils
    • Utilities
  • AVM.ClientGenerator.Core
    • AccountReference
    • AppCall
    • AppCallTransactionReference
    • AssetAccept
    • AssetClawback
    • AssetClawbackTransactionReference
    • AssetConfiguration
    • AssetConfigurationTransactionReference
    • AssetFreeze
    • AssetFreezeTransactionReference
    • AssetReference
    • AssetTransfer
    • AssetTransferTransactionReference
    • BigIntegerExtensions
    • ByteArrayExtensions
    • Constants
    • IAlgorandCommonPredefineds
    • ICompiledContract
    • ICompiledSignature
    • ISmartContractPredefineds
    • ISmartSignaturePredefineds
    • InnerTransaction
    • IntegerExtensions
    • IntentionallyNotImplementedException
    • KeyRegistration
    • KeyRegistrationTransactionReference
    • OnCompleteType
    • Payment
    • PaymentTransactionReference
    • SmartContract
    • SmartContractLibrary
    • SmartContractReference
    • SmartSignature
    • StorageType
    • StringExtensions
    • TransactionReference
    • VariableType
  • AVM.ClientGenerator.Core.Attributes
    • ABIFixedSizeAttribute
    • ABIStructAttribute
    • ABITypeDecoratorAttribute
    • InnerTransactionCallAttribute
    • SmartContractMethodAttribute
    • SmartSignatureMethodAttribute
    • StorageAttribute
  • AVM.ClientGenerator.Optimisers
    • CompiledLine
    • ICompilerMemento
    • IOptimiser
  • Algorand
    • Address
    • ApiException
    • ApiException<TResult>
    • Digest
    • HttpClientConfigurator
    • LogicsigSignature
    • MultisigAddress
    • MultisigSignature
    • MultisigSubsig
    • ParticipationPublicKey
    • Signature
    • TEALProgram
    • TxGroup
    • VRFPublicKey
  • Algorand.AVM.ClientGenerator.ABI.ARC32
    • SourceDescription
  • Algorand.AVM.ClientGenerator.ABI.ARC56
    • AVMObjectType
    • ClientGeneratorARC56
  • Algorand.AVM.ClientGenerator.Extensions
    • StringExtensions
  • Algorand.Algod
    • AlgodClient
    • AlgodConfiguration
    • DefaultApi
    • DefaultApi.ObjectResponseResult<T>
    • FundAccount
    • IAlgodClient
    • IDefaultApi
  • Algorand.Algod.Model
    • Account
    • AccountApplicationResource
    • AccountApplicationResponse
    • AccountApplicationsInformationResponse
    • AccountAssetHolding
    • AccountAssetResponse
    • AccountAssetsInformationResponse
    • AccountBalanceRecord
    • AccountDeltas
    • AccountParticipation
    • AccountSigType
    • AccountStateDelta
    • AccountTotals
    • AppCallLogs
    • AppResourceRecord
    • Application
    • ApplicationInitialStates
    • ApplicationKVStorage
    • ApplicationLocalReference
    • ApplicationLocalState
    • ApplicationParams
    • ApplicationStateOperation
    • ApplicationStateSchema
    • Asset
    • AssetHolding
    • AssetHoldingReference
    • AssetParams
    • AssetResourceRecord
    • AvmKeyValue
    • AvmValue
    • Block
    • BlockCert
    • BlockCertProp
    • BlockCertVote
    • BlockCertVoteCred
    • BlockCertVoteSig
    • BlockHashConverter
    • BlockHashResponse
    • BlockHeaderResponse
    • BlockLogsResponse
    • BlockTxidsResponse
    • Box
    • BoxDescriptor
    • BoxRef
    • BoxReference
    • BoxesResponse
    • BuildVersion
    • CertifiedBlock
    • CompileResponse
    • DisassembleResponse
    • DryrunRequest
    • DryrunResponse
    • DryrunSource
    • DryrunState
    • DryrunTxnResult
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • FileParameter
    • Format
    • Genesis
    • GenesisAllocation
    • GetBlockTimeStampOffsetResponse
    • GetSyncRoundResponse
    • HeartBeat
    • KvDelta
    • LedgerStateDelta
    • LedgerStateDeltaForTransactionGroup
    • LightBlockHeaderProof
    • ModifiedApp
    • ModifiedAsset
    • NodeStatusResponse
    • ParticipationKey
    • PendingTransactions
    • PostTransactionsResponse
    • ProofResponse
    • ReturnedTransaction
    • ScratchChange
    • SimulateInitialStates
    • SimulateRequest
    • SimulateRequestTransactionGroup
    • SimulateResponse
    • SimulateTraceConfig
    • SimulateTransactionGroupResult
    • SimulateTransactionResult
    • SimulateUnnamedResourcesAccessed
    • SimulationEvalOverrides
    • SimulationOpcodeTraceUnit
    • SimulationTransactionExecTrace
    • StateDelta
    • StateProof
    • StateProofMessage
    • StateProofTrackingData
    • SupplyResponse
    • TealKeyValue
    • TealValue
    • TransactionGroupLedgerStateDeltasForRoundResponse
    • TransactionParametersResponse
    • TransactionProofResponse
    • TxLease
    • Version
  • Algorand.Algod.Model.Agreement
    • ProposalValue
    • RawVote
    • Vote
  • Algorand.Algod.Model.Converters.Json
    • BlockCertVoteSigConverterJson
    • ParticipationPublicKeyConverterJson
    • UlongDictionaryConverterJson<T>
    • VRFPublicKeyConverterJson
    • ValueDeltaBytesConverterJson
  • Algorand.Algod.Model.Converters.MsgPack
    • AddressFormatterMsgPack
    • Deserializer
    • DigestFormatterMsgPack
    • NoDefaultsFormatter<T>
    • NullableStringFormatterMsgPack
    • ParticipationPublicKeyFormatterMsgPack
    • TEALProgramFormatterMsgPack
    • VRFPublicKeyFormatterMsgPack
    • ValueDeltaFormatterMsgPack
  • Algorand.Algod.Model.Exceptions
    • UnnamedResourceException
  • Algorand.Algod.Model.Transactions
    • ApplicationCallTransaction
    • ApplicationClearStateTransaction
    • ApplicationCloseOutTransaction
    • ApplicationCreateTransaction
    • ApplicationDeleteTransaction
    • ApplicationNoopTransaction
    • ApplicationOptInTransaction
    • ApplicationUpdateTransaction
    • AssetAcceptTransaction
    • AssetChangeTransaction
    • AssetClawbackTransaction
    • AssetCloseTransaction
    • AssetConfigurationTransaction
    • AssetCreateTransaction
    • AssetDestroyTransaction
    • AssetFreezeTransaction
    • AssetMovementsTransaction
    • AssetTransferTransaction
    • AssetUpdateTransaction
    • HeartBeatTransaction
    • IReturnableTransaction
    • KeyRegisterOfflineTransaction
    • KeyRegisterOnlineTransaction
    • KeyRegistrationTransaction
    • OnCompletion
    • PaymentTransaction
    • SignedTransaction
    • SignedTransactionDetail
    • StateProofTransaction
    • StateSchema
    • Transaction
    • TransactionsExtensions
    • ValueDelta
  • Algorand.Algod.Test
    • TestHttpMessageHandler
  • Algorand.Crypto
    • KeyPair
  • Algorand.Gossip
    • DnsSrvRecord
    • DnsSrvResolver
    • GossipHttpClient
    • GossipHttpConfiguration
    • GossipNetwork
    • GossipNodePurpose
    • GossipWebsocketClient
    • GossipWebsocketClient.AgreementVoteReceivedEventHandler
    • GossipWebsocketClient.MsgDigestSkipReceivedEventHandler
    • GossipWebsocketClient.MsgOfInterestReceivedEventHandler
    • GossipWebsocketClient.NetPrioResponseReceivedEventHandler
    • GossipWebsocketClient.PingReceivedEventHandler
    • GossipWebsocketClient.PingReplyReceivedEventHandler
    • GossipWebsocketClient.ProposalPayloadReceivedEventHandler
    • GossipWebsocketClient.StateProofSigReceivedEventHandler
    • GossipWebsocketClient.TopicMsgRespReceivedEventHandler
    • GossipWebsocketClient.TransactionReceivedEventHandler
    • GossipWebsocketClient.UniEnsBlockReqReceivedEventHandler
    • GossipWebsocketClient.VoteBundleReceivedEventHandler
    • GossipWebsocketClientConfiguration
  • Algorand.Gossip.Model
    • Tag
    • Topic
    • Topics
  • Algorand.Indexer
    • CommonApi
    • CommonApi.ObjectResponseResult<T>
    • ICommonApi
    • ILookupApi
    • ISearchApi
    • LookupApi
    • LookupApi.ObjectResponseResult<T>
    • SearchApi
    • SearchApi.ObjectResponseResult<T>
  • Algorand.Indexer.Model
    • Account
    • AccountParticipation
    • AccountResponse
    • AccountStateDelta
    • AccountsResponse
    • Application
    • ApplicationLocalState
    • ApplicationLocalStatesResponse
    • ApplicationLogData
    • ApplicationLogsResponse
    • ApplicationParams
    • ApplicationResponse
    • ApplicationStateSchema
    • ApplicationsResponse
    • 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
    • APIV1DELETEKeyResponse
    • APIV1DELETEMultisigResponse
    • APIV1GETWalletsResponse
    • APIV1POSTKeyExportResponse
    • APIV1POSTKeyImportResponse
    • APIV1POSTKeyListResponse
    • APIV1POSTKeyResponse
    • APIV1POSTMasterKeyExportResponse
    • APIV1POSTMultisigExportResponse
    • APIV1POSTMultisigImportResponse
    • APIV1POSTMultisigListResponse
    • APIV1POSTMultisigProgramSignResponse
    • APIV1POSTMultisigTransactionSignResponse
    • APIV1POSTProgramSignResponse
    • APIV1POSTTransactionSignResponse
    • APIV1POSTWalletInfoResponse
    • APIV1POSTWalletInitResponse
    • APIV1POSTWalletReleaseResponse
    • APIV1POSTWalletRenameResponse
    • APIV1POSTWalletRenewResponse
    • APIV1POSTWalletResponse
    • APIV1Wallet
    • APIV1WalletHandle
    • Api
    • Api.ObjectResponseResult<T>
    • ApiException
    • ApiException<TResult>
    • 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
    • SourceMap
    • SourceMap.VLQDecoder
    • Utils
    • VarintResult
    • Wordlist
  • Algorand.Utils.Crypto
    • FixedSecureRandom

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

| Edit this page View Source

Api(HttpClient)

Declaration
public Api(HttpClient httpClient)
Parameters
Type Name Description
HttpClient httpClient

Properties

| Edit this page View Source

BaseUrl

Declaration
public string BaseUrl { get; set; }
Property Value
Type Description
string
| Edit this page View Source

JsonSerializerSettings

Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Type Description
JsonSerializerSettings
| Edit this page View Source

ReadResponseAsString

Declaration
public bool ReadResponseAsString { get; set; }
Property Value
Type Description
bool

Methods

| Edit this page 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
Task<APIV1POSTWalletResponse>

Response to POST /v1/wallet

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletResponse>

Response to POST /v1/wallet

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1DELETEKeyResponse>

Response to DELETE /v1/key

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1DELETEKeyResponse>

Response to DELETE /v1/key

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1DELETEMultisigResponse>

Response to POST /v1/multisig/delete

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1DELETEMultisigResponse>

Response to POST /v1/multisig/delete

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTKeyExportResponse>

Response to POST /v1/key/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTKeyExportResponse>

Response to POST /v1/key/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMasterKeyExportResponse>

Response to POST /v1/master-key/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMasterKeyExportResponse>

Response to POST /v1/master-key/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMultisigExportResponse>

Response to POST /v1/multisig/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMultisigExportResponse>

Response to POST /v1/multisig/export

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTKeyResponse>

Response to POST /v1/key

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTKeyResponse>

Response to POST /v1/key

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<VersionsResponse>

Response to GET /versions

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<VersionsResponse>

Response to GET /versions

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTWalletInfoResponse>

Response to POST /v1/wallet/info

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletInfoResponse>

Response to POST /v1/wallet/info

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTKeyImportResponse>

Response to POST /v1/key/import

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTKeyImportResponse>

Response to POST /v1/key/import

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMultisigImportResponse>

Response to POST /v1/multisig/import

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMultisigImportResponse>

Response to POST /v1/multisig/import

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTWalletInitResponse>

Response to POST /v1/wallet/init

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletInitResponse>

Response to POST /v1/wallet/init

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTKeyListResponse>

Response to POST /v1/key/list

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTKeyListResponse>

Response to POST /v1/key/list

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMultisigListResponse>

Response to POST /v1/multisig/list

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMultisigListResponse>

Response to POST /v1/multisig/list

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1GETWalletsResponse>

Response to GET /v1/wallets

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1GETWalletsResponse>

Response to GET /v1/wallets

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
HttpResponseMessage response
IReadOnlyDictionary<string, IEnumerable<string>> headers
CancellationToken cancellationToken
Returns
Type Description
Task<Api.ObjectResponseResult<T>>
Type Parameters
Name Description
T
| Edit this page 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
Task<APIV1POSTWalletReleaseResponse>

Response to POST /v1/wallet/release

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletReleaseResponse>

Response to POST /v1/wallet/release

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTWalletRenameResponse>

Response to POST /v1/wallet/rename

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletRenameResponse>

Response to POST /v1/wallet/rename

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTWalletRenewResponse>

Response POST /v1/wallet/renew

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTWalletRenewResponse>

Response POST /v1/wallet/renew

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMultisigProgramSignResponse>

Response to POST /v1/multisig/signdata

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMultisigProgramSignResponse>

Response to POST /v1/multisig/signdata

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTMultisigTransactionSignResponse>

Response to POST /v1/multisig/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTMultisigTransactionSignResponse>

Response to POST /v1/multisig/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTProgramSignResponse>

Response to POST /v1/data/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTProgramSignResponse>

Response to POST /v1/data/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
Task<APIV1POSTTransactionSignResponse>

Response to POST /v1/transaction/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page 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
CancellationToken cancellationToken

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

Returns
Type Description
Task<APIV1POSTTransactionSignResponse>

Response to POST /v1/transaction/sign

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page View Source

SwaggerHandlerAsync()

Gets the current swagger spec.

Declaration
public virtual Task<string> SwaggerHandlerAsync()
Returns
Type Description
Task<string>

The current swagger spec

Exceptions
Type Condition
ApiException

A server side error occurred.

| Edit this page View Source

SwaggerHandlerAsync(CancellationToken)

Gets the current swagger spec.

Declaration
public virtual Task<string> SwaggerHandlerAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

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

Returns
Type Description
Task<string>

The current swagger spec

Exceptions
Type Condition
ApiException

A server side error occurred.

Implements

IApi
  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾