@metamask/keyring-api 4.0.1 → 5.0.0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.0.0]
+
+### Changed
+
+- **BREAKING**: Add new `KeyringExecutionContext` to user operation methods ([#275](https://github.com/MetaMask/keyring-api/pull/275))
+- Fix bundler type (defined as `string` now) ([#277](https://github.com/MetaMask/keyring-api/pull/277))
+- Bump @metamask/providers from 15.0.0 to 16.0.0 ([#276](https://github.com/MetaMask/keyring-api/pull/276))
+- Bump @metamask/safe-event-emitter from 3.1.0 to 3.1.1 ([#274](https://github.com/MetaMask/keyring-api/pull/274))
+
+## [4.0.2]
+
+### Changed
+
+- Bump @metamask/snaps-sdk to ^3.1.1 ([#271](https://github.com/MetaMask/keyring-api/pull/271))
+- Bump @metamask/safe-event-emitter from 3.0.0 to 3.1.0 ([#270](https://github.com/MetaMask/keyring-api/pull/270))
+- Fix bundler URL validation ([#262](https://github.com/MetaMask/keyring-api/pull/262))
+
 ## [4.0.1]
 
 ### Changed
@@ -227,7 +244,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v4.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v5.0.0...HEAD
+[5.0.0]: https://github.com/MetaMask/keyring-api/compare/v4.0.2...v5.0.0
+[4.0.2]: https://github.com/MetaMask/keyring-api/compare/v4.0.1...v4.0.2
 [4.0.1]: https://github.com/MetaMask/keyring-api/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/MetaMask/keyring-api/compare/v3.0.0...v4.0.0
 [3.0.0]: https://github.com/MetaMask/keyring-api/compare/v2.0.0...v3.0.0

package/dist/contexts.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Context used by a Keyring implementation.
+ */
+export declare type KeyringExecutionContext = {
+    /** The chain ID. */
+    chainId: string;
+};

package/dist/contexts.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contexts.js.map

package/dist/contexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contexts.js","sourceRoot":"","sources":["../src/contexts.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Context used by a Keyring implementation.\n */\nexport type KeyringExecutionContext = {\n  /** The chain ID. */\n  chainId: string;\n};\n"]}

package/dist/eth/erc4337/types.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EthUserOperationPatchStruct = exports.EthBaseUserOperationStruct = exports.EthBaseTransactionStruct = exports.EthUserOperationStruct = void 0;
-const superstruct_1 = require("superstruct");
-const superstruct_2 = require("../../superstruct");
+const superstruct_1 = require("../../superstruct");
 const types_1 = require("../types");
 /**
  * Struct of a UserOperation as defined by ERC-4337.
  * @see https://eips.ethereum.org/EIPS/eip-4337#definitions
  */
-exports.EthUserOperationStruct = (0, superstruct_2.object)({
+exports.EthUserOperationStruct = (0, superstruct_1.object)({
     sender: types_1.EthAddressStruct,
     nonce: types_1.EthUint256Struct,
     initCode: types_1.EthBytesStruct,
@@ -25,7 +24,7 @@ exports.EthUserOperationStruct = (0, superstruct_2.object)({
  * Struct containing the most basic transaction information required to
  * construct a UserOperation.
  */
-exports.EthBaseTransactionStruct = (0, superstruct_2.object)({
+exports.EthBaseTransactionStruct = (0, superstruct_1.object)({
     /**
      * Address of the transaction recipient.
      */
@@ -39,23 +38,23 @@ exports.EthBaseTransactionStruct = (0, superstruct_2.object)({
      */
     data: types_1.EthBytesStruct,
 });
-exports.EthBaseUserOperationStruct = (0, superstruct_2.object)({
+exports.EthBaseUserOperationStruct = (0, superstruct_1.object)({
     nonce: types_1.EthUint256Struct,
     initCode: types_1.EthBytesStruct,
     callData: types_1.EthBytesStruct,
-    gasLimits: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
+    gasLimits: (0, superstruct_1.exactOptional)((0, superstruct_1.object)({
         callGasLimit: types_1.EthUint256Struct,
         verificationGasLimit: types_1.EthUint256Struct,
         preVerificationGas: types_1.EthUint256Struct,
     })),
     dummyPaymasterAndData: types_1.EthBytesStruct,
     dummySignature: types_1.EthBytesStruct,
-    bundlerUrl: (0, superstruct_1.string)(),
+    bundlerUrl: superstruct_1.UrlStruct,
 });
-exports.EthUserOperationPatchStruct = (0, superstruct_2.object)({
+exports.EthUserOperationPatchStruct = (0, superstruct_1.object)({
     paymasterAndData: types_1.EthBytesStruct,
-    callGasLimit: (0, superstruct_2.exactOptional)(types_1.EthUint256Struct),
-    verificationGasLimit: (0, superstruct_2.exactOptional)(types_1.EthUint256Struct),
-    preVerificationGas: (0, superstruct_2.exactOptional)(types_1.EthUint256Struct),
+    callGasLimit: (0, superstruct_1.exactOptional)(types_1.EthUint256Struct),
+    verificationGasLimit: (0, superstruct_1.exactOptional)(types_1.EthUint256Struct),
+    preVerificationGas: (0, superstruct_1.exactOptional)(types_1.EthUint256Struct),
 });
 //# sourceMappingURL=types.js.map

package/dist/eth/erc4337/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/eth/erc4337/types.ts"],"names":[],"mappings":";;;AAAA,6CAAiD;AAEjD,mDAA0D;AAC1D,oCAA8E;AAE9E;;;GAGG;AACU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAAC;IAC3C,MAAM,EAAE,wBAAgB;IACxB,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,kBAAkB,EAAE,wBAAgB;IACpC,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,gBAAgB,EAAE,sBAAc;IAChC,SAAS,EAAE,sBAAc;CAC1B,CAAC,CAAC;AAIH;;;GAGG;AACU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C;;OAEG;IACH,EAAE,EAAE,wBAAgB;IAEpB;;OAEG;IACH,KAAK,EAAE,wBAAgB;IAEvB;;OAEG;IACH,IAAI,EAAE,sBAAc;CACrB,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,SAAS,EAAE,IAAA,2BAAa,EACtB,IAAA,oBAAM,EAAC;QACL,YAAY,EAAE,wBAAgB;QAC9B,oBAAoB,EAAE,wBAAgB;QACtC,kBAAkB,EAAE,wBAAgB;KACrC,CAAC,CACH;IACD,qBAAqB,EAAE,sBAAc;IACrC,cAAc,EAAE,sBAAc;IAC9B,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC;AAIU,QAAA,2BAA2B,GAAG,IAAA,oBAAM,EAAC;IAChD,gBAAgB,EAAE,sBAAc;IAChC,YAAY,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;IAC7C,oBAAoB,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;IACrD,kBAAkB,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;CACpD,CAAC,CAAC","sourcesContent":["import { string, type Infer } from 'superstruct';\n\nimport { exactOptional, object } from '../../superstruct';\nimport { EthAddressStruct, EthBytesStruct, EthUint256Struct } from '../types';\n\n/**\n * Struct of a UserOperation as defined by ERC-4337.\n * @see https://eips.ethereum.org/EIPS/eip-4337#definitions\n */\nexport const EthUserOperationStruct = object({\n  sender: EthAddressStruct,\n  nonce: EthUint256Struct,\n  initCode: EthBytesStruct,\n  callData: EthBytesStruct,\n  callGasLimit: EthUint256Struct,\n  verificationGasLimit: EthUint256Struct,\n  preVerificationGas: EthUint256Struct,\n  maxFeePerGas: EthUint256Struct,\n  maxPriorityFeePerGas: EthUint256Struct,\n  paymasterAndData: EthBytesStruct,\n  signature: EthBytesStruct,\n});\n\nexport type EthUserOperation = Infer<typeof EthUserOperationStruct>;\n\n/**\n * Struct containing the most basic transaction information required to\n * construct a UserOperation.\n */\nexport const EthBaseTransactionStruct = object({\n  /**\n   * Address of the transaction recipient.\n   */\n  to: EthAddressStruct,\n\n  /**\n   * Amount of wei to transfer to the recipient.\n   */\n  value: EthUint256Struct,\n\n  /**\n   * Data to pass to the recipient.\n   */\n  data: EthBytesStruct,\n});\n\nexport type EthBaseTransaction = Infer<typeof EthBaseTransactionStruct>;\n\nexport const EthBaseUserOperationStruct = object({\n  nonce: EthUint256Struct,\n  initCode: EthBytesStruct,\n  callData: EthBytesStruct,\n  gasLimits: exactOptional(\n    object({\n      callGasLimit: EthUint256Struct,\n      verificationGasLimit: EthUint256Struct,\n      preVerificationGas: EthUint256Struct,\n    }),\n  ),\n  dummyPaymasterAndData: EthBytesStruct,\n  dummySignature: EthBytesStruct,\n  bundlerUrl: string(),\n});\n\nexport type EthBaseUserOperation = Infer<typeof EthBaseUserOperationStruct>;\n\nexport const EthUserOperationPatchStruct = object({\n  paymasterAndData: EthBytesStruct,\n  callGasLimit: exactOptional(EthUint256Struct),\n  verificationGasLimit: exactOptional(EthUint256Struct),\n  preVerificationGas: exactOptional(EthUint256Struct),\n});\n\nexport type EthUserOperationPatch = Infer<typeof EthUserOperationPatchStruct>;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/eth/erc4337/types.ts"],"names":[],"mappings":";;;AAEA,mDAAqE;AACrE,oCAA8E;AAE9E;;;GAGG;AACU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAAC;IAC3C,MAAM,EAAE,wBAAgB;IACxB,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,kBAAkB,EAAE,wBAAgB;IACpC,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,gBAAgB,EAAE,sBAAc;IAChC,SAAS,EAAE,sBAAc;CAC1B,CAAC,CAAC;AAIH;;;GAGG;AACU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C;;OAEG;IACH,EAAE,EAAE,wBAAgB;IAEpB;;OAEG;IACH,KAAK,EAAE,wBAAgB;IAEvB;;OAEG;IACH,IAAI,EAAE,sBAAc;CACrB,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,SAAS,EAAE,IAAA,2BAAa,EACtB,IAAA,oBAAM,EAAC;QACL,YAAY,EAAE,wBAAgB;QAC9B,oBAAoB,EAAE,wBAAgB;QACtC,kBAAkB,EAAE,wBAAgB;KACrC,CAAC,CACH;IACD,qBAAqB,EAAE,sBAAc;IACrC,cAAc,EAAE,sBAAc;IAC9B,UAAU,EAAE,uBAAS;CACtB,CAAC,CAAC;AAIU,QAAA,2BAA2B,GAAG,IAAA,oBAAM,EAAC;IAChD,gBAAgB,EAAE,sBAAc;IAChC,YAAY,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;IAC7C,oBAAoB,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;IACrD,kBAAkB,EAAE,IAAA,2BAAa,EAAC,wBAAgB,CAAC;CACpD,CAAC,CAAC","sourcesContent":["import { type Infer } from 'superstruct';\n\nimport { UrlStruct, exactOptional, object } from '../../superstruct';\nimport { EthAddressStruct, EthBytesStruct, EthUint256Struct } from '../types';\n\n/**\n * Struct of a UserOperation as defined by ERC-4337.\n * @see https://eips.ethereum.org/EIPS/eip-4337#definitions\n */\nexport const EthUserOperationStruct = object({\n  sender: EthAddressStruct,\n  nonce: EthUint256Struct,\n  initCode: EthBytesStruct,\n  callData: EthBytesStruct,\n  callGasLimit: EthUint256Struct,\n  verificationGasLimit: EthUint256Struct,\n  preVerificationGas: EthUint256Struct,\n  maxFeePerGas: EthUint256Struct,\n  maxPriorityFeePerGas: EthUint256Struct,\n  paymasterAndData: EthBytesStruct,\n  signature: EthBytesStruct,\n});\n\nexport type EthUserOperation = Infer<typeof EthUserOperationStruct>;\n\n/**\n * Struct containing the most basic transaction information required to\n * construct a UserOperation.\n */\nexport const EthBaseTransactionStruct = object({\n  /**\n   * Address of the transaction recipient.\n   */\n  to: EthAddressStruct,\n\n  /**\n   * Amount of wei to transfer to the recipient.\n   */\n  value: EthUint256Struct,\n\n  /**\n   * Data to pass to the recipient.\n   */\n  data: EthBytesStruct,\n});\n\nexport type EthBaseTransaction = Infer<typeof EthBaseTransactionStruct>;\n\nexport const EthBaseUserOperationStruct = object({\n  nonce: EthUint256Struct,\n  initCode: EthBytesStruct,\n  callData: EthBytesStruct,\n  gasLimits: exactOptional(\n    object({\n      callGasLimit: EthUint256Struct,\n      verificationGasLimit: EthUint256Struct,\n      preVerificationGas: EthUint256Struct,\n    }),\n  ),\n  dummyPaymasterAndData: EthBytesStruct,\n  dummySignature: EthBytesStruct,\n  bundlerUrl: UrlStruct,\n});\n\nexport type EthBaseUserOperation = Infer<typeof EthBaseUserOperationStruct>;\n\nexport const EthUserOperationPatchStruct = object({\n  paymasterAndData: EthBytesStruct,\n  callGasLimit: exactOptional(EthUint256Struct),\n  verificationGasLimit: exactOptional(EthUint256Struct),\n  preVerificationGas: exactOptional(EthUint256Struct),\n});\n\nexport type EthUserOperationPatch = Infer<typeof EthUserOperationPatchStruct>;\n"]}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './api';
+export * from './contexts';
 export * from './eth';
 export * from './events';
 export * from './internal';

package/dist/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api"), exports);
+__exportStar(require("./contexts"), exports);
 __exportStar(require("./eth"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./internal"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,wCAAsB;AACtB,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,yDAAuC;AACvC,gDAA8B;AAC9B,+CAA6B;AAC7B,gDAA8B","sourcesContent":["export * from './api';\nexport * from './eth';\nexport * from './events';\nexport * from './internal';\nexport * from './KeyringClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './superstruct';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,6CAA2B;AAC3B,wCAAsB;AACtB,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,yDAAuC;AACvC,gDAA8B;AAC9B,+CAA6B;AAC7B,gDAA8B","sourcesContent":["export * from './api';\nexport * from './contexts';\nexport * from './eth';\nexport * from './events';\nexport * from './internal';\nexport * from './KeyringClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './superstruct';\n"]}

package/dist/internal/eth/EthKeyring.d.ts

@@ -1,4 +1,5 @@
 import type { Json, Keyring } from '@metamask/utils';
+import type { KeyringExecutionContext } from '../../contexts';
 import type { EthBaseTransaction, EthBaseUserOperation, EthUserOperation, EthUserOperationPatch } from '../../eth';
 export declare type EthKeyring<State extends Json> = Keyring<State> & {
     /**
@@ -6,24 +7,27 @@ export declare type EthKeyring<State extends Json> = Keyring<State> & {
      *
      * @param address - Address of the sender.
      * @param transactions - Base transactions to include in the UserOperation.
+     * @param context - Keyring execution context.
      * @returns A pseudo-UserOperation that can be used to construct a real.
      */
-    prepareUserOperation?(address: string, transactions: EthBaseTransaction[]): Promise<EthBaseUserOperation>;
+    prepareUserOperation?(address: string, transactions: EthBaseTransaction[], context: KeyringExecutionContext): Promise<EthBaseUserOperation>;
     /**
      * Patches properties of a UserOperation. Currently, only the
      * `paymasterAndData` can be patched.
      *
      * @param address - Address of the sender.
      * @param userOp - UserOperation to patch.
+     * @param context - Keyring execution context.
      * @returns A patch to apply to the UserOperation.
      */
-    patchUserOperation?(address: string, userOp: EthUserOperation): Promise<EthUserOperationPatch>;
+    patchUserOperation?(address: string, userOp: EthUserOperation, context: KeyringExecutionContext): Promise<EthUserOperationPatch>;
     /**
      * Signs an UserOperation.
      *
      * @param address - Address of the sender.
      * @param userOp - UserOperation to sign.
+     * @param context - Keyring execution context.
      * @returns The signature of the UserOperation.
      */
-    signUserOperation?(address: string, userOp: EthUserOperation): Promise<string>;
+    signUserOperation?(address: string, userOp: EthUserOperation, context: KeyringExecutionContext): Promise<string>;
 };

package/dist/internal/eth/EthKeyring.js.map

@@ -1 +1 @@
-{"version":3,"file":"EthKeyring.js","sourceRoot":"","sources":["../../../src/internal/eth/EthKeyring.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json, Keyring } from '@metamask/utils';\n\nimport type {\n  EthBaseTransaction,\n  EthBaseUserOperation,\n  EthUserOperation,\n  EthUserOperationPatch,\n} from '../../eth';\n\nexport type EthKeyring<State extends Json> = Keyring<State> & {\n  /**\n   * Convert a base transaction to a base UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param transactions - Base transactions to include in the UserOperation.\n   * @returns A pseudo-UserOperation that can be used to construct a real.\n   */\n  prepareUserOperation?(\n    address: string,\n    transactions: EthBaseTransaction[],\n  ): Promise<EthBaseUserOperation>;\n\n  /**\n   * Patches properties of a UserOperation. Currently, only the\n   * `paymasterAndData` can be patched.\n   *\n   * @param address - Address of the sender.\n   * @param userOp - UserOperation to patch.\n   * @returns A patch to apply to the UserOperation.\n   */\n  patchUserOperation?(\n    address: string,\n    userOp: EthUserOperation,\n  ): Promise<EthUserOperationPatch>;\n\n  /**\n   * Signs an UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param userOp - UserOperation to sign.\n   * @returns The signature of the UserOperation.\n   */\n  signUserOperation?(\n    address: string,\n    userOp: EthUserOperation,\n  ): Promise<string>;\n};\n"]}
+{"version":3,"file":"EthKeyring.js","sourceRoot":"","sources":["../../../src/internal/eth/EthKeyring.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json, Keyring } from '@metamask/utils';\n\nimport type { KeyringExecutionContext } from '../../contexts';\nimport type {\n  EthBaseTransaction,\n  EthBaseUserOperation,\n  EthUserOperation,\n  EthUserOperationPatch,\n} from '../../eth';\n\nexport type EthKeyring<State extends Json> = Keyring<State> & {\n  /**\n   * Convert a base transaction to a base UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param transactions - Base transactions to include in the UserOperation.\n   * @param context - Keyring execution context.\n   * @returns A pseudo-UserOperation that can be used to construct a real.\n   */\n  prepareUserOperation?(\n    address: string,\n    transactions: EthBaseTransaction[],\n    context: KeyringExecutionContext,\n  ): Promise<EthBaseUserOperation>;\n\n  /**\n   * Patches properties of a UserOperation. Currently, only the\n   * `paymasterAndData` can be patched.\n   *\n   * @param address - Address of the sender.\n   * @param userOp - UserOperation to patch.\n   * @param context - Keyring execution context.\n   * @returns A patch to apply to the UserOperation.\n   */\n  patchUserOperation?(\n    address: string,\n    userOp: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<EthUserOperationPatch>;\n\n  /**\n   * Signs an UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param userOp - UserOperation to sign.\n   * @param context - Keyring execution context.\n   * @returns The signature of the UserOperation.\n   */\n  signUserOperation?(\n    address: string,\n    userOp: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<string>;\n};\n"]}

package/dist/superstruct.d.ts

@@ -69,4 +69,11 @@ export declare function exactOptional<Type, Schema>(struct: Struct<Type, Schema>
  * @returns A new string-struct that matches the given pattern.
  */
 export declare function definePattern(name: string, pattern: RegExp): Struct<string, null>;
+/**
+ * Validates if a given value is a valid URL.
+ *
+ * @param value - The value to be validated.
+ * @returns A boolean indicating if the value is a valid URL.
+ */
+export declare const UrlStruct: Struct<string, null>;
 export {};

package/dist/superstruct.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.definePattern = exports.exactOptional = exports.object = void 0;
+exports.UrlStruct = exports.definePattern = exports.exactOptional = exports.object = void 0;
 const superstruct_1 = require("superstruct");
 /**
  * Change the return type of a superstruct object struct to support exact
@@ -62,4 +62,20 @@ function definePattern(name, pattern) {
     return (0, superstruct_1.define)(name, (value) => typeof value === 'string' && pattern.test(value));
 }
 exports.definePattern = definePattern;
+/**
+ * Validates if a given value is a valid URL.
+ *
+ * @param value - The value to be validated.
+ * @returns A boolean indicating if the value is a valid URL.
+ */
+exports.UrlStruct = (0, superstruct_1.define)('Url', (value) => {
+    let url;
+    try {
+        url = new URL(value);
+    }
+    catch (_) {
+        return false;
+    }
+    return url.protocol === 'http:' || url.protocol === 'https:';
+});
 //# sourceMappingURL=superstruct.js.map

package/dist/superstruct.js.map

@@ -1 +1 @@
-{"version":3,"file":"superstruct.js","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":";;;AACA,6CAAiE;AAkDjE;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,MAAc;IAEd,OAAO,IAAA,oBAAQ,EAAC,MAAM,CAAQ,CAAC;AACjC,CAAC;AAJD,wBAIC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAY;IAC/B,MAAM,QAAQ,GAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAA4B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,MAA4B;IAE5B,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,MAAM;QAET,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACxB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAEnD,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACtB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAa,EAAE,GAAG,CAAC;KAC1D,CAAC,CAAC;AACL,CAAC;AAZD,sCAYC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,IAAY,EACZ,OAAe;IAEf,OAAO,IAAA,oBAAM,EACX,IAAI,EACJ,CAAC,KAAc,EAAW,EAAE,CAC1B,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CACnD,CAAC;AACJ,CAAC;AATD,sCASC","sourcesContent":["import type { Infer, Context } from 'superstruct';\nimport { Struct, define, object as stObject } from 'superstruct';\nimport type {\n  ObjectSchema,\n  OmitBy,\n  Optionalize,\n  PickBy,\n  Simplify,\n} from 'superstruct/dist/utils';\n\ndeclare const ExactOptionalSymbol: unique symbol;\n\nexport type ExactOptionalTag = {\n  type: typeof ExactOptionalSymbol;\n};\n\n/**\n * Exclude type `Type` from the properties of `Obj`.\n *\n * ```ts\n * type Foo = { a: string | null; b: number };\n * type Bar = ExcludeType<Foo, null>;\n * // Bar = { a: string, b: number }\n * ```\n */\nexport type ExcludeType<Obj, Type> = {\n  [K in keyof Obj]: Exclude<Obj[K], Type>;\n};\n\n/**\n * Make optional all properties that have the `ExactOptionalTag` type.\n *\n * ```ts\n * type Foo = { a: string | ExactOptionalTag; b: number};\n * type Bar = ExactOptionalize<Foo>;\n * // Bar = { a?: string; b: number}\n * ```\n */\nexport type ExactOptionalize<Schema extends object> = OmitBy<\n  Schema,\n  ExactOptionalTag\n> &\n  Partial<ExcludeType<PickBy<Schema, ExactOptionalTag>, ExactOptionalTag>>;\n\n/**\n * Infer a type from an superstruct object schema.\n */\nexport type ObjectType<Schema extends ObjectSchema> = Simplify<\n  ExactOptionalize<Optionalize<{ [K in keyof Schema]: Infer<Schema[K]> }>>\n>;\n\n/**\n * Change the return type of a superstruct object struct to support exact\n * optional properties.\n *\n * @param schema - The object schema.\n * @returns A struct representing an object with a known set of properties.\n */\nexport function object<Schema extends ObjectSchema>(\n  schema: Schema,\n): Struct<ObjectType<Schema>, Schema> {\n  return stObject(schema) as any;\n}\n\n/**\n * Check if the current property is present in its parent object.\n *\n * @param ctx - The context to check.\n * @returns `true` if the property is present, `false` otherwise.\n */\nfunction hasOptional(ctx: Context): boolean {\n  const property: string = ctx.path[ctx.path.length - 1];\n  const parent: Record<string, unknown> = ctx.branch[ctx.branch.length - 2];\n\n  return property in parent;\n}\n\n/**\n * Augment a struct to allow exact-optional values. Exact-optional values can\n * be omitted but cannot be `undefined`.\n *\n * ```ts\n * const foo = object({ bar: exactOptional(string()) });\n * type Foo = Infer<typeof foo>;\n * // Foo = { bar?: string }\n * ```\n *\n * @param struct - The struct to augment.\n * @returns The augmented struct.\n */\nexport function exactOptional<Type, Schema>(\n  struct: Struct<Type, Schema>,\n): Struct<Type | ExactOptionalTag, Schema> {\n  return new Struct({\n    ...struct,\n\n    validator: (value, ctx) =>\n      !hasOptional(ctx) || struct.validator(value, ctx),\n\n    refiner: (value, ctx) =>\n      !hasOptional(ctx) || struct.refiner(value as Type, ctx),\n  });\n}\n\n/**\n * Defines a new string-struct matching a regular expression.\n *\n * Example:\n *\n * ```ts\n * const EthAddressStruct = definePattern('EthAddress', /^0x[0-9a-f]{40}$/iu);\n * ```\n *\n * @param name - Type name.\n * @param pattern - Regular expression to match.\n * @returns A new string-struct that matches the given pattern.\n */\nexport function definePattern(\n  name: string,\n  pattern: RegExp,\n): Struct<string, null> {\n  return define<string>(\n    name,\n    (value: unknown): boolean =>\n      typeof value === 'string' && pattern.test(value),\n  );\n}\n"]}
+{"version":3,"file":"superstruct.js","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":";;;AACA,6CAAiE;AAkDjE;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,MAAc;IAEd,OAAO,IAAA,oBAAQ,EAAC,MAAM,CAAQ,CAAC;AACjC,CAAC;AAJD,wBAIC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAY;IAC/B,MAAM,QAAQ,GAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAA4B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,MAA4B;IAE5B,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,MAAM;QAET,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACxB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAEnD,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACtB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAa,EAAE,GAAG,CAAC;KAC1D,CAAC,CAAC;AACL,CAAC;AAZD,sCAYC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,IAAY,EACZ,OAAe;IAEf,OAAO,IAAA,oBAAM,EACX,IAAI,EACJ,CAAC,KAAc,EAAW,EAAE,CAC1B,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CACnD,CAAC;AACJ,CAAC;AATD,sCASC;AAED;;;;;GAKG;AACU,QAAA,SAAS,GAAG,IAAA,oBAAM,EAAS,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE;IAChE,IAAI,GAAG,CAAC;IAER,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,KAAe,CAAC,CAAC;KAChC;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;IAED,OAAO,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC;AAC/D,CAAC,CAAC,CAAC","sourcesContent":["import type { Infer, Context } from 'superstruct';\nimport { Struct, define, object as stObject } from 'superstruct';\nimport type {\n  ObjectSchema,\n  OmitBy,\n  Optionalize,\n  PickBy,\n  Simplify,\n} from 'superstruct/dist/utils';\n\ndeclare const ExactOptionalSymbol: unique symbol;\n\nexport type ExactOptionalTag = {\n  type: typeof ExactOptionalSymbol;\n};\n\n/**\n * Exclude type `Type` from the properties of `Obj`.\n *\n * ```ts\n * type Foo = { a: string | null; b: number };\n * type Bar = ExcludeType<Foo, null>;\n * // Bar = { a: string, b: number }\n * ```\n */\nexport type ExcludeType<Obj, Type> = {\n  [K in keyof Obj]: Exclude<Obj[K], Type>;\n};\n\n/**\n * Make optional all properties that have the `ExactOptionalTag` type.\n *\n * ```ts\n * type Foo = { a: string | ExactOptionalTag; b: number};\n * type Bar = ExactOptionalize<Foo>;\n * // Bar = { a?: string; b: number}\n * ```\n */\nexport type ExactOptionalize<Schema extends object> = OmitBy<\n  Schema,\n  ExactOptionalTag\n> &\n  Partial<ExcludeType<PickBy<Schema, ExactOptionalTag>, ExactOptionalTag>>;\n\n/**\n * Infer a type from an superstruct object schema.\n */\nexport type ObjectType<Schema extends ObjectSchema> = Simplify<\n  ExactOptionalize<Optionalize<{ [K in keyof Schema]: Infer<Schema[K]> }>>\n>;\n\n/**\n * Change the return type of a superstruct object struct to support exact\n * optional properties.\n *\n * @param schema - The object schema.\n * @returns A struct representing an object with a known set of properties.\n */\nexport function object<Schema extends ObjectSchema>(\n  schema: Schema,\n): Struct<ObjectType<Schema>, Schema> {\n  return stObject(schema) as any;\n}\n\n/**\n * Check if the current property is present in its parent object.\n *\n * @param ctx - The context to check.\n * @returns `true` if the property is present, `false` otherwise.\n */\nfunction hasOptional(ctx: Context): boolean {\n  const property: string = ctx.path[ctx.path.length - 1];\n  const parent: Record<string, unknown> = ctx.branch[ctx.branch.length - 2];\n\n  return property in parent;\n}\n\n/**\n * Augment a struct to allow exact-optional values. Exact-optional values can\n * be omitted but cannot be `undefined`.\n *\n * ```ts\n * const foo = object({ bar: exactOptional(string()) });\n * type Foo = Infer<typeof foo>;\n * // Foo = { bar?: string }\n * ```\n *\n * @param struct - The struct to augment.\n * @returns The augmented struct.\n */\nexport function exactOptional<Type, Schema>(\n  struct: Struct<Type, Schema>,\n): Struct<Type | ExactOptionalTag, Schema> {\n  return new Struct({\n    ...struct,\n\n    validator: (value, ctx) =>\n      !hasOptional(ctx) || struct.validator(value, ctx),\n\n    refiner: (value, ctx) =>\n      !hasOptional(ctx) || struct.refiner(value as Type, ctx),\n  });\n}\n\n/**\n * Defines a new string-struct matching a regular expression.\n *\n * Example:\n *\n * ```ts\n * const EthAddressStruct = definePattern('EthAddress', /^0x[0-9a-f]{40}$/iu);\n * ```\n *\n * @param name - Type name.\n * @param pattern - Regular expression to match.\n * @returns A new string-struct that matches the given pattern.\n */\nexport function definePattern(\n  name: string,\n  pattern: RegExp,\n): Struct<string, null> {\n  return define<string>(\n    name,\n    (value: unknown): boolean =>\n      typeof value === 'string' && pattern.test(value),\n  );\n}\n\n/**\n * Validates if a given value is a valid URL.\n *\n * @param value - The value to be validated.\n * @returns A boolean indicating if the value is a valid URL.\n */\nexport const UrlStruct = define<string>('Url', (value: unknown) => {\n  let url;\n\n  try {\n    url = new URL(value as string);\n  } catch (_) {\n    return false;\n  }\n\n  return url.protocol === 'http:' || url.protocol === 'https:';\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -38,8 +38,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/providers": "^15.0.0",
-    "@metamask/snaps-sdk": "^3.1.0",
+    "@metamask/providers": "^16.0.0",
+    "@metamask/snaps-sdk": "^3.1.1",
     "@metamask/utils": "^8.3.0",
     "@types/uuid": "^9.0.1",
     "superstruct": "^1.0.3",