@metamask/account-api
Version:
MetaMask Account API
55 lines • 1.9 kB
text/typescript
import type { EntropySourceId, KeyringAccount } from "@metamask/keyring-api";
import type { Bip44Account } from "./bip44.mjs";
/**
* An account provider is reponsible of providing accounts to an account group.
*/
export type AccountProvider<Account extends KeyringAccount> = {
/**
* Gets an account for a given ID.
*
* @returns An account, or undefined if not found.
*/
getAccount: (id: Account['id']) => Account | undefined;
/**
* Gets all accounts for this provider.
*
* @returns A list of all account for this provider.
*/
getAccounts: () => Account[];
/**
* Creates accounts for a given entropy source and a given group
* index.
*
* @param options - Options.
* @param options.entropySource - Entropy source to use.
* @param options.groupIndex - Group index to use.
* @returns The list of created accounts.
*/
createAccounts: (options: {
entropySource: EntropySourceId;
groupIndex: number;
}) => Promise<Account[]>;
/**
* Discover accounts for a given entropy source and a given group
* index.
*
* NOTE: This method needs to also create the discovered accounts.
*
* @param options - Options.
* @param options.entropySource - Entropy source to use.
* @param options.groupIndex - Group index to use.
* @returns The list of discovered and created accounts.
*/
discoverAccounts: (options: {
entropySource: EntropySourceId;
groupIndex: number;
}) => Promise<Account[]>;
};
/**
* A BIP-44 provider is a provider that can provide BIP-44 compatible accounts.
*
* Note: This is an alias for the `AccountProvider` type, but with a more specific
* type for the account.
*/
export type Bip44AccountProvider = AccountProvider<Bip44Account<KeyringAccount>>;
//# sourceMappingURL=provider.d.mts.map