algorand_kmd (EXPERIMENTAL)
API for KMD (Key Management Daemon)
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.1
- Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen
Requirements
- Dart 2.12.0 or later OR Flutter 1.26.0 or later
- Dio 4.0.0+
Installation & Usage
pub.dev
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
algorand_kmd: 1.0.0
Github
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
algorand_kmd:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
Local development
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
algorand_kmd:
path: /path/to/algorand_kmd
Getting Started
Please follow the installation procedure and then run the following:
import 'package:algorand_kmd/algorand_kmd.dart';
final api = AlgorandKmd().getDefaultApi();
final CreateWalletRequest createWalletRequest = ; // CreateWalletRequest |
try {
final response = await api.createWallet(createWalletRequest);
print(response);
} catch on DioError (e) {
print("Exception when calling DefaultApi->createWallet: $e\n");
}
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | createWallet | POST /v1/wallet | Create a wallet |
DefaultApi | deleteKey | DELETE /v1/key | Delete a key |
DefaultApi | deleteMultisig | DELETE /v1/multisig | Delete a multisig |
DefaultApi | exportKey | POST /v1/key/export | Export a key |
DefaultApi | exportMasterKey | POST /v1/master-key/export | Export the master derivation key from a wallet |
DefaultApi | exportMultisig | POST /v1/multisig/export | Export multisig address metadata |
DefaultApi | generateKey | POST /v1/key | Generate a key |
DefaultApi | getVersion | GET /versions | Retrieves the current version |
DefaultApi | getWalletInfo | POST /v1/wallet/info | Get wallet info |
DefaultApi | importKey | POST /v1/key/import | Import a key |
DefaultApi | importMultisig | POST /v1/multisig/import | Import a multisig account |
DefaultApi | initWalletHandleToken | POST /v1/wallet/init | Initialize a wallet handle token |
DefaultApi | listKeysInWallet | POST /v1/key/list | List keys in wallet |
DefaultApi | listMultisg | POST /v1/multisig/list | List multisig accounts |
DefaultApi | listWallets | GET /v1/wallets | List wallets |
DefaultApi | releaseWalletHandleToken | POST /v1/wallet/release | Release a wallet handle token |
DefaultApi | renameWallet | POST /v1/wallet/rename | Rename a wallet |
DefaultApi | renewWalletHandleToken | POST /v1/wallet/renew | Renew a wallet handle token |
DefaultApi | signMultisigProgram | POST /v1/multisig/signprogram | Sign a program for a multisig account |
DefaultApi | signMultisigTransaction | POST /v1/multisig/sign | Sign a multisig transaction |
DefaultApi | signProgram | POST /v1/program/sign | Sign program |
DefaultApi | signTransaction | POST /v1/transaction/sign | Sign a transaction |
DefaultApi | swaggerHandler | GET /swagger.json | Gets the current swagger spec. |
Documentation For Models
- APIV1DELETEKeyResponse
- APIV1DELETEMultisigResponse
- APIV1GETWalletsResponse
- APIV1POSTKeyExportResponse
- APIV1POSTKeyImportResponse
- APIV1POSTKeyListResponse
- APIV1POSTKeyResponse
- APIV1POSTMasterKeyExportResponse
- APIV1POSTMultisigExportResponse
- APIV1POSTMultisigImportResponse
- APIV1POSTMultisigListResponse
- APIV1POSTMultisigProgramSignResponse
- APIV1POSTMultisigTransactionSignResponse
- APIV1POSTProgramSignResponse
- APIV1POSTTransactionSignResponse
- APIV1POSTWalletInfoResponse
- APIV1POSTWalletInitResponse
- APIV1POSTWalletReleaseResponse
- APIV1POSTWalletRenameResponse
- APIV1POSTWalletRenewResponse
- APIV1POSTWalletResponse
- APIV1Wallet
- APIV1WalletHandle
- CreateWalletRequest
- DeleteKeyRequest
- DeleteMultisigRequest
- ExportKeyRequest
- ExportMasterKeyRequest
- ExportMultisigRequest
- GenerateKeyRequest
- ImportKeyRequest
- ImportMultisigRequest
- InitWalletHandleTokenRequest
- ListKeysRequest
- ListMultisigRequest
- MultisigSig
- MultisigSubsig
- ReleaseWalletHandleTokenRequest
- RenameWalletRequest
- RenewWalletHandleTokenRequest
- SignMultisigRequest
- SignProgramMultisigRequest
- SignProgramRequest
- SignTransactionRequest
- VersionsResponse
- WalletInfoRequest
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: X-KMD-API-Token
- Location: HTTP header