Interface WalletRepositoryApi<WalletMetadata, AccountMetadata>

Type Parameters

WalletMetadata extends {}
AccountMetadata extends {}

Hierarchy

WalletRepositoryApi

Implemented by

WalletRepository

Index

Properties

Methods

addAccount addWallet removeAccount removeWallet updateAccountMetadata updateWalletMetadata

Properties

wallets$

wallets$: Observable<AnyWallet<WalletMetadata, AccountMetadata>[]>

Methods

addAccount

addAccount(props: AddAccountProps<AccountMetadata>): Promise<AddAccountProps<AccountMetadata>>
Can be used to add a new account to an existing BIP32Wallet

Rejects with WalletConflictError when either
- wallet with provided walletId is not found
- account already exists for this wallet
Parameters
- props: AddAccountProps<AccountMetadata>
Returns Promise<AddAccountProps<AccountMetadata>>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:54

addWallet

addWallet(props: AddWalletProps<WalletMetadata, AccountMetadata>): Promise<string>
When adding a BIP32 wallet, it must have at least 1 account. 1st (accounts[0]) account is used to derive wallet id.

Rejects with WalletConflictError when wallet already exists.
Parameters
- props: AddWalletProps<WalletMetadata, AccountMetadata>
Returns Promise<string>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:45

removeAccount

removeAccount(props: RemoveAccountProps): Promise<RemoveAccountProps>
Rejects with WalletConflictError when account is not found.
Parameters
- props: RemoveAccountProps
Returns Promise<RemoveAccountProps>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:66

removeWallet

removeWallet(walletId: string): Promise<string>
Rejects with WalletConflictError when wallet is not found.
Parameters
- walletId: string
Returns Promise<string>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:69

updateAccountMetadata

updateAccountMetadata(props: UpdateAccountMetadataProps<AccountMetadata>): Promise<UpdateAccountMetadataProps<AccountMetadata>>
Parameters
- props: UpdateAccountMetadataProps<AccountMetadata>
Returns Promise<UpdateAccountMetadataProps<AccountMetadata>>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:61

updateWalletMetadata

updateWalletMetadata(props: UpdateWalletMetadataProps<WalletMetadata>): Promise<UpdateWalletMetadataProps<WalletMetadata>>
Rejects with WalletConflictError when wallet or account with specified index is not found
Parameters
- props: UpdateWalletMetadataProps<WalletMetadata>
Returns Promise<UpdateWalletMetadataProps<WalletMetadata>>
- Defined in packages/web-extension/src/walletManager/WalletRepository/types.ts:57

Generated using TypeDoc