Struct algo_rust_sdk::kmd::KmdClient

pub struct KmdClient { /* fields omitted */ }

Client for interacting with the key management daemon

Implementations

impl KmdClient

pub fn new(address: &str, token: &str) -> KmdClient

pub fn versions(&self) -> Result<VersionsResponse, Error>

Retrieves the current version

pub fn list_wallets(&self) -> Result<ListWalletsResponse, Error>

List all of the wallets that kmd is aware of

pub fn create_wallet(
    &self,
    wallet_name: &str,
    wallet_password: &str,
    wallet_driver_name: &str,
    master_derivation_key: MasterDerivationKey
) -> Result<CreateWalletResponse, Error>

Creates a wallet

pub fn init_wallet_handle(
    &self,
    wallet_id: &str,
    wallet_password: &str
) -> Result<InitWalletHandleResponse, Error>

Unlock the wallet and return a wallet token that can be used for subsequent operations

These tokens expire periodically and must be renewed. You can see how much time remains until expiration with get_wallet and renew it with renew_wallet_handle. When you're done, you can invalidate the token with release_wallet_handle

pub fn release_wallet_handle(
    &self,
    wallet_handle: &str
) -> Result<ReleaseWalletHandleResponse, Error>

Release a wallet handle token

pub fn renew_wallet_handle(
    &self,
    wallet_handle: &str
) -> Result<RenewWalletHandleResponse, Error>

Renew a wallet handle token

pub fn rename_wallet(
    &self,
    wallet_id: &str,
    wallet_password: &str,
    new_name: &str
) -> Result<RenameWalletResponse, Error>

Rename a wallet

pub fn get_wallet(
    &self,
    wallet_handle: &str
) -> Result<GetWalletResponse, Error>

Get wallet info

pub fn export_master_derivation_key(
    &self,
    wallet_handle: &str,
    wallet_password: &str
) -> Result<ExportMasterDerivationKeyResponse, Error>

Export the master derivation key from a wallet

pub fn import_key(
    &self,
    wallet_handle: &str,
    private_key: [u8; 32]
) -> Result<ImportKeyResponse, Error>

Import an externally generated key into the wallet

pub fn export_key(
    &self,
    wallet_handle: &str,
    wallet_password: &str,
    address: &str
) -> Result<ExportKeyResponse, Error>

Export the Ed25519 seed associated with the passed address

Note the first 32 bytes of the returned value is the seed, the second 32 bytes is the public key

pub fn generate_key(
    &self,
    wallet_handle: &str
) -> Result<GenerateKeyResponse, Error>

Generates a key and adds it to the wallet, returning the public key

pub fn delete_key(
    &self,
    wallet_handle: &str,
    wallet_password: &str,
    address: &str
) -> Result<DeleteKeyResponse, Error>

Deletes the key from the wallet

pub fn list_keys(&self, wallet_handle: &str) -> Result<ListKeysResponse, Error>

List all of the public keys in the wallet

pub fn sign_transaction(
    &self,
    wallet_handle: &str,
    wallet_password: &str,
    transaction: &Transaction
) -> Result<SignTransactionResponse, Error>

Sign a transaction

pub fn list_multisig(
    &self,
    wallet_handle: &str
) -> Result<ListMultisigResponse, Error>

Lists all of the multisig accounts whose preimages this wallet stores

pub fn import_multisig(
    &self,
    wallet_handle: &str,
    version: u8,
    threshold: u8,
    pks: &[Ed25519PublicKey]
) -> Result<ImportMultisigResponse, Error>

Import a multisig account

pub fn export_multisig(
    &self,
    wallet_handle: &str,
    address: &str
) -> Result<ExportMultisigResponse, Error>

Export multisig address metadata

pub fn delete_multisig(
    &self,
    wallet_handle: &str,
    wallet_password: &str,
    address: &str
) -> Result<DeleteMultisigResponse, Error>

Delete a multisig from the wallet

pub fn sign_multisig_transaction(
    &self,
    wallet_handle: &str,
    wallet_password: &str,
    transaction: &Transaction,
    public_key: Ed25519PublicKey,
    partial_multisig: Option<MultisigSignature>
) -> Result<SignMultisigTransactionResponse, Error>

Start a multisig signature or add a signature to a partially completed multisig signature