@metamask/keyring-api
Version:
MetaMask Keyring API
65 lines • 2.14 kB
text/typescript
import type { Infer } from "@metamask/superstruct";
/**
* Account type tag.
*
* The main use of this enum is to tag the {@link DiscoveredAccount} type for
* future use.
*/
export declare enum DiscoveredAccountType {
Bip44 = "bip44"
}
/**
* This struct represents a discovered BIP-44 compatible account.
*
* It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at
* least 1 segment.
*/
export declare const DiscoveredBip44AccountStruct: import("@metamask/superstruct").Struct<{
type: "bip44";
derivationPath: `m/${string}`;
scopes: `${string}:${string}`[];
}, {
/**
* Account type.
*/
type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
/**
* Account supported scopes (CAIP-2 chain IDs).
*/
scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
/**
* The derivation path for this account. It MUST HAVE at least 1 segment.
*/
derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
}>;
/**
* Discovered BIP-44 account object.
*
* See {@link TransactionStruct}.
*/
export type DiscoveredBip44Account = Infer<typeof DiscoveredBip44AccountStruct>;
export declare const DiscoveredAccountStruct: import("@metamask/superstruct").Struct<{
type: "bip44";
derivationPath: `m/${string}`;
scopes: `${string}:${string}`[];
}, {
/**
* Account type.
*/
type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
/**
* Account supported scopes (CAIP-2 chain IDs).
*/
scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
/**
* The derivation path for this account. It MUST HAVE at least 1 segment.
*/
derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
}>;
/**
* Discovered account object.
*
* See {@link DiscoveredAccountStruct}.
*/
export type DiscoveredAccount = Infer<typeof DiscoveredAccountStruct>;
//# sourceMappingURL=discovery.d.mts.map