Class VaultClient

Client to mainly interact with Vault and associated entities.

Hierarchy

BaseClient
- VaultClient

Index

Methods

Methods

getVault

getVault(vaultPublicKey: PublicKeyOrPublicKeyInit): Promise<null | Vault>

- Defined in clients/VaultClient.ts:37
Fetches a fault by it's public key.

Parameters
- vaultPublicKey: PublicKeyOrPublicKeyInit
  
  The public key of the vault.
Returns Promise<null | Vault>

The found fault or null if not found.

getVaultSafetyDepositBoxes

getVaultSafetyDepositBoxes(vaultPublicKey: PublicKeyOrPublicKeyInit): Promise<SafetyDepositBox[]>

- Defined in clients/VaultClient.ts:55
Fetches all associated safety deposit boxes for a Vault.

Parameters
- vaultPublicKey: PublicKeyOrPublicKeyInit
  
  The public key of the vault.
Returns Promise<SafetyDepositBox[]>

A list of safety deposit boxes for a vault.

getVaults

getVaults(): Promise<Vault[]>

- Defined in clients/VaultClient.ts:14
Fetches all vaults.

Returns Promise<Vault[]>

A list of vaults.

Generated using TypeDoc