DefaultApi class
Constructors
DefaultApi (Dio _dio , Serializers _serializers
const
Properties
hashCode → int
The hash code for this object.
no setter inherited
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
Methods
createWallet ({required CreateWalletRequest createWalletRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletResponse >
Create a wallet
Create a new wallet (collection of keys) with the given parameters.
deleteKey ({required DeleteKeyRequest deleteKeyRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1DELETEKeyResponse >
Delete a key
Deletes the key with the passed public key from the wallet.
deleteMultisig ({required DeleteMultisigRequest deleteMultisigRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1DELETEMultisigResponse >
Delete a multisig
Deletes multisig preimage information for the passed address from the wallet.
exportKey ({required ExportKeyRequest exportKeyRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTKeyExportResponse >
Export a key
Export the secret key associated with the passed public key.
exportMasterKey ({required ExportMasterKeyRequest exportMasterKeyRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMasterKeyExportResponse >
Export the master derivation key from a wallet
Export the master derivation key from the wallet. This key is a master "backup" key for the underlying wallet. With it, you can regenerate all of the wallets that have been generated with this wallet's `POST /v1/key` endpoint. This key will not allow you to recover keys imported from other wallets, however.
exportMultisig ({required ExportMultisigRequest exportMultisigRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMultisigExportResponse >
Export multisig address metadata
Given a multisig address whose preimage this wallet stores, returns the information used to generate the address, including public keys, threshold, and multisig version.
generateKey ({required GenerateKeyRequest generateKeyRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTKeyResponse >
Generate a key
Generates the next key in the deterministic key sequence (as determined by the master derivation key) and adds it to the wallet, returning the public key.
getVersion ({JsonObject? versionsRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<VersionsResponse >
Retrieves the current version
getWalletInfo ({required WalletInfoRequest getWalletInfoRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletInfoResponse >
Get wallet info
Returns information about the wallet associated with the passed wallet handle token. Additionally returns expiration information about the token itself.
importKey ({required ImportKeyRequest importKeyRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTKeyImportResponse >
Import a key
Import an externally generated key into the wallet. Note that if you wish to back up the imported key, you must do so by backing up the entire wallet database, because imported keys were not derived from the wallet's master derivation key.
importMultisig ({required ImportMultisigRequest importMultisigRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMultisigImportResponse >
Import a multisig account
Generates a multisig account from the passed public keys array and multisig metadata, and stores all of this in the wallet.
initWalletHandleToken ({required InitWalletHandleTokenRequest initializeWalletHandleTokenRequest , CancelToken? cancelToken , Map <String dynamic > ?headers , Map <String dynamic > ?extra , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletInitResponse >
Initialize a wallet handle token
Unlock the wallet and return a wallet handle token that can be used for subsequent operations. These tokens expire periodically and must be renewed. You can `POST` the token to `/v1/wallet/info` to see how much time remains until expiration, and renew it with `/v1/wallet/renew`. When you're done, you can invalidate the token with `/v1/wallet/release`.
listKeysInWallet ({required ListKeysRequest listKeysRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTKeyListResponse >
List keys in wallet
Lists all of the public keys in this wallet. All of them have a stored private key.
listMultisg ({required ListMultisigRequest listMultisigRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMultisigListResponse >
List multisig accounts
Lists all of the multisig accounts whose preimages this wallet stores
listWallets ({JsonObject? listWalletRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1GETWalletsResponse >
List wallets
Lists all of the wallets that kmd is aware of.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
releaseWalletHandleToken ({required ReleaseWalletHandleTokenRequest releaseWalletHandleTokenRequest , CancelToken? cancelToken , Map <String dynamic > ?headers , Map <String dynamic > ?extra , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletReleaseResponse >
Release a wallet handle token
Invalidate the passed wallet handle token, making it invalid for use in subsequent requests.
renameWallet ({required RenameWalletRequest renameWalletRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletRenameResponse >
Rename a wallet
Rename the underlying wallet to something else
renewWalletHandleToken ({required RenewWalletHandleTokenRequest renewWalletHandleTokenRequest , CancelToken? cancelToken , Map <String dynamic > ?headers , Map <String dynamic > ?extra , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTWalletRenewResponse >
Renew a wallet handle token
Renew a wallet handle token, increasing its expiration duration to its initial value
signMultisigProgram ({required SignProgramMultisigRequest signMultisigProgramRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMultisigProgramSignResponse >
Sign a program for a multisig account
Start a multisig signature, or add a signature to a partially completed multisig signature object.
signMultisigTransaction ({required SignMultisigRequest signMultisigTransactionRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTMultisigTransactionSignResponse >
Sign a multisig transaction
Start a multisig signature, or add a signature to a partially completed multisig signature object.
signProgram ({required SignProgramRequest signProgramRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTProgramSignResponse >
Sign program
Signs the passed program with a key from the wallet, determined by the account named in the request.
signTransaction ({required SignTransactionRequest signTransactionRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<APIV1POSTTransactionSignResponse >
Sign a transaction
Signs the passed transaction with a key from the wallet, determined by the sender encoded in the transaction.
swaggerHandler ({CancelToken? cancelToken , Map <String dynamic > ?headers , Map <String dynamic > ?extra , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<String >
Gets the current swagger spec.
Returns the entire swagger spec in json.
toString ()
→ String
A string representation of this object.
inherited
