Merge branch 'main' into bump-braces

Author: mcmire

.github/CODEOWNERS

@@ -2,3 +2,5 @@
 # Each line is a file pattern followed by one or more owners.
 
 *                                   @MetaMask/wallet-framework-engineers
+src/methods                         @MetaMask/wallet-api-platform-engineers @MetaMask/confirmations
+src/wallet.*                        @MetaMask/wallet-api-platform-engineers @MetaMask/confirmations

.github/workflows/security-code-scanner.yml

@@ -1,10 +1,13 @@
-name: 'MetaMask Security Code Scanner'
+name: MetaMask Security Code Scanner
 
 on:
   push:
-    branches: ['main']
+    branches:
+      - main
   pull_request:
-    branches: ['main']
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
   run-security-scan:
@@ -15,7 +18,7 @@ jobs:
       security-events: write
     steps:
       - name: MetaMask Security Code Scanner
-        uses: MetaMask/Security-Code-Scanner@main
+        uses: MetaMask/action-security-code-scanner@v1
         with:
           repo: ${{ github.repository }}
           paths_ignored: |

CHANGELOG.md

@@ -6,6 +6,120 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.0.0]
+### Changed
+- **BREAKING:** Support version `2.0.0` of EIP-5792 ([#370](https://github.com/MetaMask/eth-json-rpc-middleware/pull/370))
+  - Add `atomicRequired` property to `SendCallsStruct`.
+  - Make `from` optional in `SendCallsStruct`.
+  - Add `atomic` property to `GetCallsStatusResult`.
+  - Validate `address` in `GetCapabilitiesParams` is added to wallet.
+  - Use `-32602` code for all EIP-5792 schema errors.
+
+## [16.0.1]
+### Fixed
+- Fix `fetch` middleware so that non-standard JSON-RPC error responses are no longer treated as successful responses ([#367](https://github.com/MetaMask/eth-json-rpc-middleware/pull/367))
+  - A "non-standard" error response is one with an `error` field but where there are more properties in the error object than expected
+
+## [16.0.0]
+### Added
+- Support updated EIP-5792 specification ([#363](https://github.com/MetaMask/eth-json-rpc-middleware/pull/363))
+  - Add optional `id` to `SendCallsParams`.
+  - Add optional `capabilities` to each call in `SendCallsParams`.
+  - Add `optional` property to both top-level and call-level capabilities.
+  - Add `SendCallsResult` type.
+  - Add `id`, `version`, and optional `capabilities` to `GetCallsStatusResult`.
+  - Add `GetCallsStatusCode` enum.
+  - Add `GetCallsStatusHook` type.
+  - Add optional `chainIds` argument to `GetCapabilitiesParams`.
+
+### Changed
+- **BREAKING:** Support updated EIP-5792 specification ([#363](https://github.com/MetaMask/eth-json-rpc-middleware/pull/363))
+  - Return `SendCallsResult` from `wallet_sendCalls` instead of `string`.
+  - Change `GetCallsStatusParams` to contain `Hex` instead of `string`. 
+  - Change `status` in `GetCallsStatusResult` to `number` instead of `string`.
+  - Replace `GetTransactionReceiptsByBatchIdHook` with `GetCallsStatusHook`.
+
+### Removed
+- **BREAKING:** Support updated EIP-5792 specification ([#363](https://github.com/MetaMask/eth-json-rpc-middleware/pull/363))
+  - Remove `GetCallsStatusReceipt` type.
+  - Remove `GetTransactionReceiptsByBatchIdHook` type.
+
+## [15.3.0]
+### Added
+- Support EIP-5792 ([#357](https://github.com/MetaMask/eth-json-rpc-middleware/pull/359))
+  - Add support for RPC methods:
+    - `wallet_sendCalls`
+    - `wallet_getCallsStatus`
+    - `wallet_getCapabilities`
+  - Add optional hooks to `WalletMiddlewareOptions`:
+    - `getCapabilities`
+    - `getTransactionReceiptsByBatchId`
+    - `processSendCalls`
+  - Add types:
+    - `GetCallsStatusParams`
+    - `GetCallsStatusReceipt`
+    - `GetCallsStatusResult`
+    - `GetCapabilitiesHook`
+    - `GetCapabilitiesParams`
+    - `GetCapabilitiesResult`
+    - `GetTransactionReceiptsByBatchIdHook`
+    - `ProcessSendCallsHook`
+    - `SendCalls`
+    - `SendCallsParams`
+
+## [15.2.0]
+### Added
+- Add a way to pass an RPC service to `createFetchMiddleware` ([#357](https://github.com/MetaMask/eth-json-rpc-middleware/pull/357))
+  - The new, recommended function signature is now `createFetchMiddleware({ rpcService: AbstractRpcService; options?: { originHttpHeaderKey?: string; } })`, where `AbstractRpcService` matches the same interface from `@metamask/network-controller`
+  - This allows us to support automatic failover to a secondary node when the network goes down
+
+### Changed
+- Bump `@metamask/utils` to `^11.1.0` ([#358](https://github.com/MetaMask/eth-json-rpc-middleware/pull/358))
+
+### Deprecated
+- Deprecate passing an RPC endpoint to `createFetchMiddleware` ([#357](https://github.com/MetaMask/eth-json-rpc-middleware/pull/357))
+  - See recommended function signature above
+  - The existing signature `createFetchMiddleware({ btoa: typeof btoa; fetch: typeof fetch; rpcUrl: string; originHttpHeaderKey?: string; })` will be removed in a future major version
+- Deprecate `PayloadWithOrigin` type ([#357](https://github.com/MetaMask/eth-json-rpc-middleware/pull/357))
+  - There is no replacement for this type; it will be removed in a future major version.
+
+## [15.1.2]
+### Changed
+- Fix validation of primary type for signTypedDataV3 and signTypedDataV4 ([#353](https://github.com/MetaMask/eth-json-rpc-middleware/pull/353))
+  - It was updated to handle `undefined` input
+
+## [15.1.1]
+### Changed
+- Bump `@metamask/eth-block-tracker` from `^11.0.3` to `^11.0.4` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+- Bump `@metamask/eth-json-rpc-provider` from `^4.1.5` to `^4.1.7` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+- Bump `@metamask/eth-sig-util` from `^7.0.3` to `^8.1.2` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+- Bump `@metamask/json-rpc-engine` from `^10.0.0` to `^10.0.2` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+- Bump `@metamask/rpc-errors` from `^7.0.0` to `^7.0.2` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+- Bump `@metamask/utils` from `^9.1.0` to `^11.0.1` ([#351](https://github.com/MetaMask/eth-json-rpc-middleware/pull/351))
+
+## [15.1.0]
+### Changed
+- Improved validation of primary type for signTypedDataV3 and signTypedDataV4 ([#350](https://github.com/MetaMask/eth-json-rpc-middleware/pull/350))
+
+## [15.0.1]
+### Changed
+- Bump `@metamask/eth-block-tracker` from `^11.0.1` to `^11.0.3` ([#347](https://github.com/MetaMask/eth-json-rpc-middleware/pull/347))
+
+## [15.0.0]
+### Changed
+- **BREAKING**: Update `@metamask/rpc-errors` from `^6.3.1` to `^7.0.0` ([#342](https://github.com/MetaMask/eth-json-rpc-middleware/pull/342))
+- **BREAKING**: Update `@metamask/json-rpc-engine` from `^9.0.2` to `^10.0.0` ([#342](https://github.com/MetaMask/eth-json-rpc-middleware/pull/342))
+- Bump `@metamask/eth-json-rpc-provider` from `^4.1.1` to `^4.1.5` ([#342](https://github.com/MetaMask/eth-json-rpc-middleware/pull/342))
+
+### Removed
+- **BREAKING**: Remove `eth_sign` support ([#320](https://github.com/MetaMask/eth-json-rpc-middleware/pull/320))
+  - The functions `ethSign` and `processEthSignMessage` have been removed
+
+## [14.0.2]
+### Fixed
+- Allow the string "cosmos" in the "verifyingContract" field of EIP-712 signatures ([#333](https://github.com/MetaMask/eth-json-rpc-middleware/pull/333))
+  - This change was made to support Ethermint's EIP-712 implementation, which was broken by validation added in v14.0.0
+
 ## [14.0.1]
 ### Fixed
 - Request validation should not throw if verifyingContract is not defined in typed signature ([#328](https://github.com/MetaMask/eth-json-rpc-middleware/pull/328))
@@ -206,7 +320,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `json-rpc-engine@5.3.0` ([#53](https://github.com/MetaMask/eth-json-rpc-middleware/pull/53))
 - `eth-rpc-errors@3.0.0` ([#55](https://github.com/MetaMask/eth-json-rpc-middleware/pull/55))
 
-[Unreleased]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v14.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v17.0.0...HEAD
+[17.0.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v16.0.1...v17.0.0
+[16.0.1]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v16.0.0...v16.0.1
+[16.0.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.3.0...v16.0.0
+[15.3.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.2.0...v15.3.0
+[15.2.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.1.2...v15.2.0
+[15.1.2]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.1.1...v15.1.2
+[15.1.1]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.1.0...v15.1.1
+[15.1.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.0.1...v15.1.0
+[15.0.1]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v15.0.0...v15.0.1
+[15.0.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v14.0.2...v15.0.0
+[14.0.2]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v14.0.1...v14.0.2
 [14.0.1]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v14.0.0...v14.0.1
 [14.0.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v13.0.0...v14.0.0
 [13.0.0]: https://github.com/MetaMask/eth-json-rpc-middleware/compare/v12.1.2...v13.0.0

jest.config.js

@@ -22,7 +22,7 @@ module.exports = {
   collectCoverage: true,
 
   // An array of glob patterns indicating a set of files for which coverage information should be collected
-  collectCoverageFrom: ['./src/**/*.ts'],
+  collectCoverageFrom: ['./src/**/*.ts', '!./src/**/*.test-d.ts'],
 
   // The directory where Jest should output its coverage files
   coverageDirectory: 'coverage',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-json-rpc-middleware",
-  "version": "14.0.1",
+  "version": "17.0.0",
   "description": "Ethereum-related json-rpc-engine middleware.",
   "repository": {
     "type": "git",
@@ -24,16 +24,18 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest",
+    "test": "jest && yarn build:clean && yarn test:types",
+    "test:types": "tsd --files 'src/**/*.test-d.ts'",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/eth-block-tracker": "^11.0.1",
-    "@metamask/eth-json-rpc-provider": "^4.1.1",
-    "@metamask/eth-sig-util": "^7.0.3",
-    "@metamask/json-rpc-engine": "^9.0.2",
-    "@metamask/rpc-errors": "^6.3.1",
-    "@metamask/utils": "^9.1.0",
+    "@metamask/eth-block-tracker": "^12.0.0",
+    "@metamask/eth-json-rpc-provider": "^4.1.7",
+    "@metamask/eth-sig-util": "^8.1.2",
+    "@metamask/json-rpc-engine": "^10.0.2",
+    "@metamask/rpc-errors": "^7.0.2",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^11.1.0",
     "@types/bn.js": "^5.1.5",
     "bn.js": "^5.2.1",
     "klona": "^2.0.6",
@@ -48,6 +50,7 @@
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
+    "@metamask/network-controller": "22.2.0",
     "@types/btoa": "^1.2.3",
     "@types/jest": "^27.4.1",
     "@types/node": "^18.16",
@@ -68,6 +71,7 @@
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
+    "tsd": "^0.31.2",
     "typescript": "~4.8.4"
   },
   "packageManager": "yarn@3.2.1",