@metamask/keyring-api
Version:
MetaMask Keyring API
83 lines • 2.99 kB
text/typescript
import { type Infer } from "@metamask/superstruct";
/**
* Struct for {@link CreateAccountBip44DerivePathOptions}.
*/
export declare const CreateAccountBip44DerivePathOptionsStruct: import("@metamask/superstruct").Struct<{
type: "bip44:derive-path";
derivationPath: `m/${string}`;
entropySource: string;
}, {
/**
* Type of the options.
*/
type: import("@metamask/superstruct").Struct<"bip44:derive-path", "bip44:derive-path">;
/**
* ID of the entropy source to be used to derive the account.
*/
entropySource: import("@metamask/superstruct").Struct<string, null>;
/**
* BIP-44 derivation path to be used to derive the account.
*/
derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
}>;
/**
* Options for creating an account using the given BIP-44 derivation path.
*/
export type CreateAccountBip44DerivePathOptions = Infer<typeof CreateAccountBip44DerivePathOptionsStruct>;
/**
* Struct for {@link CreateAccountBip44DeriveIndexOptions}.
*/
export declare const CreateAccountBip44DeriveIndexOptionsStruct: import("@metamask/superstruct").Struct<{
type: "bip44:derive-index";
groupIndex: number;
entropySource: string;
}, {
/**
* The type of the options.
*/
type: import("@metamask/superstruct").Struct<"bip44:derive-index", "bip44:derive-index">;
/**
* ID of the entropy source to be used to derive the account.
*/
entropySource: import("@metamask/superstruct").Struct<string, null>;
/**
* The index of the account group to be derived.
*/
groupIndex: import("@metamask/superstruct").Struct<number, null>;
}>;
/**
* Options for creating an account using the given BIP-44 account group index.
*
* Note that the keyring can support non-standard BIP-44 paths for
* compatibility with other wallets.
*/
export type CreateAccountBip44DeriveIndexOptions = Infer<typeof CreateAccountBip44DeriveIndexOptionsStruct>;
/**
* Struct for {@link CreateAccountBip44DiscoverOptions}.
*/
export declare const CreateAccountBip44DiscoverOptionsStruct: import("@metamask/superstruct").Struct<{
type: "bip44:discover";
groupIndex: number;
entropySource: string;
}, {
/**
* The type of the options.
*/
type: import("@metamask/superstruct").Struct<"bip44:discover", "bip44:discover">;
/**
* ID of the entropy source to be used to derive the account.
*/
entropySource: import("@metamask/superstruct").Struct<string, null>;
/**
* The index of the account group to be derived.
*/
groupIndex: import("@metamask/superstruct").Struct<number, null>;
}>;
/**
* Options for creating accounts by performing a BIP-44 account discovery.
*
* Note that the keyring can support non-standard BIP-44 paths for
* compatibility with other wallets.
*/
export type CreateAccountBip44DiscoverOptions = Infer<typeof CreateAccountBip44DiscoverOptionsStruct>;
//# sourceMappingURL=bip44.d.cts.map