@metamask/keyring-api/dist/api/v2/keyring-capabilities.mjs.map

MetaMask Keyring API

{"version":3,"file":"keyring-capabilities.mjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,EACR,MAAM,EAEP,8BAA8B;AAE/B,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC7B,0BAAsB;AACvB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC1C;;OAEG;IACH,KAAK,EAAE,aAAa,CAClB,MAAM,CAAC;QACL;;WAEG;QACH,UAAU,EAAE,OAAO,EAAE;QACrB;;WAEG;QACH,WAAW,EAAE,OAAO,EAAE;QACtB;;WAEG;QACH,QAAQ,EAAE,OAAO,EAAE;KACpB,CAAC,CACH;IACD;;OAEG;IACH,UAAU,EAAE,aAAa,CACvB,MAAM,CAAC;QACL;;WAEG;QACH,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACjE;;WAEG;QACH,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAClE,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import {\n  array,\n  boolean,\n  exactOptional,\n  nonempty,\n  object,\n  type Infer,\n} from '@metamask/superstruct';\n\nimport {\n  ExportPrivateKeyFormatStruct,\n  ImportPrivateKeyFormatStruct,\n} from './private-key';\nimport { CaipChainIdStruct } from '../caip';\n\n/**\n * Struct for {@link KeyringCapabilities}.\n */\nexport const KeyringCapabilitiesStruct = object({\n  /**\n   * List of CAIP-2 chain IDs that this keyring supports.\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n  /**\n   * BIP-44 capabilities supported by this keyring.\n   */\n  bip44: exactOptional(\n    object({\n      /**\n       * Whether the keyring supports deriving accounts from a specific BIP-44 path.\n       */\n      derivePath: boolean(),\n      /**\n       * Whether the keyring supports deriving accounts from a BIP-44 account index.\n       */\n      deriveIndex: boolean(),\n      /**\n       * Whether the keyring supports BIP-44 account discovery.\n       */\n      discover: boolean(),\n    }),\n  ),\n  /**\n   * Private key capabilities supported by this keyring.\n   */\n  privateKey: exactOptional(\n    object({\n      /**\n       * List of supported formats for importing private keys.\n       */\n      importFormats: exactOptional(array(ImportPrivateKeyFormatStruct)),\n      /**\n       * List of supported formats for exporting private keys.\n       */\n      exportFormats: exactOptional(array(ExportPrivateKeyFormatStruct)),\n    }),\n  ),\n});\n\n/**\n * Type representing the capabilities supported by a keyring.\n *\n * @example\n * ```ts\n * const capabilities: KeyringCapabilities = {\n *   scopes: ['bip122:_'],\n *   bip44: {\n *     derivePath: true,\n *     deriveIndex: true,\n *     discover: true,\n *   },\n *   privateKey: {\n *     importFormats: [\n *       { encoding: 'base58', type: 'bip122:p2sh' },\n *       { encoding: 'base58', type: 'bip122:p2tr' },\n *       { encoding: 'base58', type: 'bip122:p2pkh' },\n *       { encoding: 'base58', type: 'bip122:p2wpkh' },\n *     ],\n *     exportFormats: [\n *       { encoding: 'base58' },\n *       { encoding: 'base58' },\n *     ],\n *   },\n * };\n * ```\n */\nexport type KeyringCapabilities = Infer<typeof KeyringCapabilitiesStruct>;\n"]}