From a6097a6fb5c604dcc94f21be5f5a457d941d53d4 Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 14:51:05 +0100 Subject: [PATCH 1/6] feat: Add protocol Snap example --- .../packages/protocol/.depcheckrc.json | 18 ++ .../examples/packages/protocol/.eslintrc.js | 7 + .../examples/packages/protocol/CHANGELOG.md | 38 ++++ .../packages/protocol/LICENSE.APACHE2 | 201 ++++++++++++++++++ .../examples/packages/protocol/LICENSE.MIT0 | 16 ++ packages/examples/packages/protocol/README.md | 20 ++ .../examples/packages/protocol/jest.config.js | 36 ++++ .../examples/packages/protocol/package.json | 88 ++++++++ .../examples/packages/protocol/snap.config.ts | 17 ++ .../packages/protocol/snap.manifest.json | 31 +++ .../examples/packages/protocol/src/index.ts | 60 ++++++ .../examples/packages/protocol/tsconfig.json | 8 + packages/snaps-cli/src/main.ts | 0 yarn.lock | 39 ++++ 14 files changed, 579 insertions(+) create mode 100644 packages/examples/packages/protocol/.depcheckrc.json create mode 100644 packages/examples/packages/protocol/.eslintrc.js create mode 100644 packages/examples/packages/protocol/CHANGELOG.md create mode 100644 packages/examples/packages/protocol/LICENSE.APACHE2 create mode 100644 packages/examples/packages/protocol/LICENSE.MIT0 create mode 100644 packages/examples/packages/protocol/README.md create mode 100644 packages/examples/packages/protocol/jest.config.js create mode 100644 packages/examples/packages/protocol/package.json create mode 100644 packages/examples/packages/protocol/snap.config.ts create mode 100644 packages/examples/packages/protocol/snap.manifest.json create mode 100644 packages/examples/packages/protocol/src/index.ts create mode 100644 packages/examples/packages/protocol/tsconfig.json mode change 100755 => 100644 packages/snaps-cli/src/main.ts diff --git a/packages/examples/packages/protocol/.depcheckrc.json b/packages/examples/packages/protocol/.depcheckrc.json new file mode 100644 index 0000000000..c437c59cd2 --- /dev/null +++ b/packages/examples/packages/protocol/.depcheckrc.json @@ -0,0 +1,18 @@ +{ + "ignore-patterns": ["dist", "coverage"], + "ignores": [ + "@lavamoat/allow-scripts", + "@lavamoat/preinstall-always-fail", + "@metamask/auto-changelog", + "@metamask/eslint-*", + "@types/*", + "@typescript-eslint/*", + "eslint-config-*", + "eslint-plugin-*", + "jest-silent-reporter", + "prettier-plugin-packagejson", + "ts-node", + "typedoc", + "typescript" + ] +} diff --git a/packages/examples/packages/protocol/.eslintrc.js b/packages/examples/packages/protocol/.eslintrc.js new file mode 100644 index 0000000000..a47fd0b65d --- /dev/null +++ b/packages/examples/packages/protocol/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + extends: ['../../.eslintrc.js'], + + parserOptions: { + tsconfigRootDir: __dirname, + }, +}; diff --git a/packages/examples/packages/protocol/CHANGELOG.md b/packages/examples/packages/protocol/CHANGELOG.md new file mode 100644 index 0000000000..b8667fca88 --- /dev/null +++ b/packages/examples/packages/protocol/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.3] + +### Fixed + +- Bump MetaMask dependencies + +## [1.0.2] + +### Changed + +- Use error wrappers ([#2178](https://github.com/MetaMask/snaps/pull/2178)) + +## [1.0.1] + +### Changed + +- Remove snap icon ([#2189](https://github.com/MetaMask/snaps/pull/2189)) + +## [1.0.0] + +### Added + +- Add `snap_getClientStatus` example snap ([#2159](https://github.com/MetaMask/snaps/pull/2159)) + +[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.3...HEAD +[1.0.3]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.2...@metamask/client-status-example-snap@1.0.3 +[1.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.1...@metamask/client-status-example-snap@1.0.2 +[1.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.0...@metamask/client-status-example-snap@1.0.1 +[1.0.0]: https://github.com/MetaMask/snaps/releases/tag/@metamask/client-status-example-snap@1.0.0 diff --git a/packages/examples/packages/protocol/LICENSE.APACHE2 b/packages/examples/packages/protocol/LICENSE.APACHE2 new file mode 100644 index 0000000000..2ef0684d05 --- /dev/null +++ b/packages/examples/packages/protocol/LICENSE.APACHE2 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 ConsenSys Software Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/examples/packages/protocol/LICENSE.MIT0 b/packages/examples/packages/protocol/LICENSE.MIT0 new file mode 100644 index 0000000000..0660e58cc1 --- /dev/null +++ b/packages/examples/packages/protocol/LICENSE.MIT0 @@ -0,0 +1,16 @@ +MIT No Attribution + +Copyright 2025 ConsenSys Software Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this +software and associated documentation files (the "Software"), to deal in the Software +without restriction, including without limitation the rights to use, copy, modify, +merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/examples/packages/protocol/README.md b/packages/examples/packages/protocol/README.md new file mode 100644 index 0000000000..1e01eb468f --- /dev/null +++ b/packages/examples/packages/protocol/README.md @@ -0,0 +1,20 @@ +# `@metamask/protocol-example-snap` + +This snap demonstrates how to use `endowment:protocol` to expose protocol +data via the mulitchain API. + +This Snap specifically provides this information for the Solana devnet. + +## Snap usage + +This snap exposes an `onProtocolRequest` handler, which supports the following +JSON-RPC methods: + +- `getBlockHeight` - Return the block height of the chain. +- `getGenesisHash` - Return the genesis hash of the chain. + +``` + +For more information, you can refer to +[the end-to-end tests](./src/index.test.ts). +``` diff --git a/packages/examples/packages/protocol/jest.config.js b/packages/examples/packages/protocol/jest.config.js new file mode 100644 index 0000000000..f473a91b83 --- /dev/null +++ b/packages/examples/packages/protocol/jest.config.js @@ -0,0 +1,36 @@ +const deepmerge = require('deepmerge'); + +const baseConfig = require('../../../../jest.config.base'); + +module.exports = deepmerge(baseConfig, { + preset: '@metamask/snaps-jest', + + // Since `@metamask/snaps-jest` runs in the browser, we can't collect + // coverage information. + collectCoverage: false, + + // This is required for the tests to run inside the `MetaMask/snaps` + // repository. You don't need this in your own project. + moduleNameMapper: { + '^@metamask/(.+)/production/jsx-runtime': [ + '/../../../$1/src/jsx/production/jsx-runtime', + '/../../../../node_modules/@metamask/$1/jsx/production/jsx-runtime', + '/node_modules/@metamask/$1/jsx/production/jsx-runtime', + ], + '^@metamask/(.+)/jsx': [ + '/../../../$1/src/jsx', + '/../../../../node_modules/@metamask/$1/jsx', + '/node_modules/@metamask/$1/jsx', + ], + '^@metamask/(.+)/node$': [ + '/../../../$1/src/node', + '/../../../../node_modules/@metamask/$1/node', + '/node_modules/@metamask/$1/node', + ], + '^@metamask/(.+)$': [ + '/../../../$1/src', + '/../../../../node_modules/@metamask/$1', + '/node_modules/@metamask/$1', + ], + }, +}); diff --git a/packages/examples/packages/protocol/package.json b/packages/examples/packages/protocol/package.json new file mode 100644 index 0000000000..ae33c54804 --- /dev/null +++ b/packages/examples/packages/protocol/package.json @@ -0,0 +1,88 @@ +{ + "name": "@metamask/protocol-example-snap", + "version": "0.0.0", + "description": "MetaMask example snap demonstrating the use of `endowment:protocol`", + "keywords": [ + "MetaMask", + "Snaps", + "Ethereum" + ], + "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/client-status#readme", + "bugs": { + "url": "https://github.com/MetaMask/snaps/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/MetaMask/snaps.git" + }, + "license": "(MIT-0 OR Apache-2.0)", + "sideEffects": false, + "main": "./dist/bundle.js", + "files": [ + "dist", + "snap.manifest.json" + ], + "scripts": { + "build": "mm-snap build", + "build:clean": "yarn clean && yarn build", + "changelog:update": "../../../../scripts/update-changelog.sh @metamask/client-status-example-snap", + "changelog:validate": "../../../../scripts/validate-changelog.sh @metamask/client-status-example-snap", + "clean": "rimraf \"dist\"", + "lint": "yarn lint:eslint && yarn lint:misc --check && yarn changelog:validate && yarn lint:dependencies", + "lint:ci": "yarn lint", + "lint:dependencies": "depcheck", + "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx", + "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write", + "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!snap.manifest.json\" --ignore-path ../../../../.gitignore", + "publish:preview": "yarn npm publish --tag preview", + "since-latest-release": "../../../../scripts/since-latest-release.sh", + "start": "mm-snap watch", + "test": "jest --reporters=jest-silent-reporter", + "test:clean": "jest --clearCache", + "test:verbose": "jest --verbose", + "test:watch": "jest --watch" + }, + "dependencies": { + "@metamask/snaps-sdk": "workspace:^", + "@metamask/utils": "^11.1.0" + }, + "devDependencies": { + "@jest/globals": "^29.5.0", + "@lavamoat/allow-scripts": "^3.0.4", + "@metamask/auto-changelog": "^3.4.4", + "@metamask/eslint-config": "^12.1.0", + "@metamask/eslint-config-jest": "^12.1.0", + "@metamask/eslint-config-nodejs": "^12.1.0", + "@metamask/eslint-config-typescript": "^12.1.0", + "@metamask/snaps-cli": "workspace:^", + "@metamask/snaps-jest": "workspace:^", + "@swc/core": "1.3.78", + "@swc/jest": "^0.2.26", + "@typescript-eslint/eslint-plugin": "^5.42.1", + "@typescript-eslint/parser": "^6.21.0", + "deepmerge": "^4.2.2", + "depcheck": "^1.4.7", + "eslint": "^8.27.0", + "eslint-config-prettier": "^8.5.0", + "eslint-plugin-import": "^2.26.0", + "eslint-plugin-jest": "^27.1.5", + "eslint-plugin-jsdoc": "^41.1.2", + "eslint-plugin-n": "^15.7.0", + "eslint-plugin-prettier": "^4.2.1", + "eslint-plugin-promise": "^6.1.1", + "jest": "^29.0.2", + "jest-silent-reporter": "^0.6.0", + "prettier": "^2.8.8", + "prettier-plugin-packagejson": "^2.5.2", + "rimraf": "^4.1.2", + "ts-node": "^10.9.1", + "typescript": "~5.3.3" + }, + "engines": { + "node": "^18.16 || >=20" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org/" + } +} diff --git a/packages/examples/packages/protocol/snap.config.ts b/packages/examples/packages/protocol/snap.config.ts new file mode 100644 index 0000000000..5157d979c8 --- /dev/null +++ b/packages/examples/packages/protocol/snap.config.ts @@ -0,0 +1,17 @@ +import type { SnapConfig } from '@metamask/snaps-cli'; +import { resolve } from 'path'; + +const config: SnapConfig = { + input: resolve(__dirname, 'src/index.ts'), + server: { + port: 8032, + }, + typescript: { + enabled: true, + }, + stats: { + buffer: false, + }, +}; + +export default config; diff --git a/packages/examples/packages/protocol/snap.manifest.json b/packages/examples/packages/protocol/snap.manifest.json new file mode 100644 index 0000000000..5be0309610 --- /dev/null +++ b/packages/examples/packages/protocol/snap.manifest.json @@ -0,0 +1,31 @@ +{ + "version": "0.0.0", + "description": "MetaMask example snap demonstrating the use of `endowment:protocol`", + "proposedName": "Protocol Example Snap", + "repository": { + "type": "git", + "url": "https://github.com/MetaMask/snaps.git" + }, + "source": { + "shasum": "ZYKyp6xZmkWqxewj4kDbdtzxEvgNxroW7Z3flQAp75I=", + "location": { + "npm": { + "filePath": "dist/bundle.js", + "packageName": "@metamask/protocol-example-snap", + "registry": "https://registry.npmjs.org/" + } + } + }, + "initialPermissions": { + "endowment:protocol": { + "scopes": { + "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1": { + "methods": ["getBlockHeight", "getGenesisHash"] + } + } + }, + "endowment:network-access": {} + }, + "platformVersion": "6.17.1", + "manifestVersion": "0.1" +} diff --git a/packages/examples/packages/protocol/src/index.ts b/packages/examples/packages/protocol/src/index.ts new file mode 100644 index 0000000000..1c85039f74 --- /dev/null +++ b/packages/examples/packages/protocol/src/index.ts @@ -0,0 +1,60 @@ +import { + MethodNotFoundError, + type OnProtocolRequestHandler, +} from '@metamask/snaps-sdk'; +import { assert } from '@metamask/utils'; + +const API_URL = 'https://api.devnet.solana.com'; + +/** + * Make an RPC request to the Solana devnet RPC API. + * + * @param method - The RPC method to invoke. + * @returns The JSON-RPC result. + */ +async function rpcRequest(method: string) { + const response = await fetch(API_URL, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + jsonrpc: '2.0', + id: 1, + method, + }), + }); + const json = await response.json(); + return json.result; +} + +/** + * Handle incoming JSON-RPC requests from the multichain API. + * This handler handles two methods: + * + * - `getBlockHeight`: Returns the block height of the Solana devnet. + * - `getBlockHeight`: Returns the genesis hash of the Solana devnet. + * + * @param params - The request parameters. + * @param params.scope - The CAIP-2 scope of the request. + * @param params.request - The JSON-RPC request object. + * @returns The JSON-RPC response. + */ +export const onProtocolRequest: OnProtocolRequestHandler = async ({ + scope, + request, +}) => { + assert(scope === 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1'); + switch (request.method) { + case 'getBlockHeight': { + return rpcRequest('getBlockHeight'); + } + case 'getGenesisHash': { + return rpcRequest('getGenesisHash'); + } + + default: + // eslint-disable-next-line @typescript-eslint/no-throw-literal + throw new MethodNotFoundError({ method: request.method }); + } +}; diff --git a/packages/examples/packages/protocol/tsconfig.json b/packages/examples/packages/protocol/tsconfig.json new file mode 100644 index 0000000000..17a40a6a74 --- /dev/null +++ b/packages/examples/packages/protocol/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "composite": false, + "baseUrl": "./" + }, + "include": ["src", "snap.config.ts"] +} diff --git a/packages/snaps-cli/src/main.ts b/packages/snaps-cli/src/main.ts old mode 100755 new mode 100644 diff --git a/yarn.lock b/yarn.lock index 6c52edf60d..2a11432445 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5401,6 +5401,45 @@ __metadata: languageName: unknown linkType: soft +"@metamask/protocol-example-snap@workspace:packages/examples/packages/protocol": + version: 0.0.0-use.local + resolution: "@metamask/protocol-example-snap@workspace:packages/examples/packages/protocol" + dependencies: + "@jest/globals": "npm:^29.5.0" + "@lavamoat/allow-scripts": "npm:^3.0.4" + "@metamask/auto-changelog": "npm:^3.4.4" + "@metamask/eslint-config": "npm:^12.1.0" + "@metamask/eslint-config-jest": "npm:^12.1.0" + "@metamask/eslint-config-nodejs": "npm:^12.1.0" + "@metamask/eslint-config-typescript": "npm:^12.1.0" + "@metamask/snaps-cli": "workspace:^" + "@metamask/snaps-jest": "workspace:^" + "@metamask/snaps-sdk": "workspace:^" + "@metamask/utils": "npm:^11.1.0" + "@swc/core": "npm:1.3.78" + "@swc/jest": "npm:^0.2.26" + "@typescript-eslint/eslint-plugin": "npm:^5.42.1" + "@typescript-eslint/parser": "npm:^6.21.0" + deepmerge: "npm:^4.2.2" + depcheck: "npm:^1.4.7" + eslint: "npm:^8.27.0" + eslint-config-prettier: "npm:^8.5.0" + eslint-plugin-import: "npm:^2.26.0" + eslint-plugin-jest: "npm:^27.1.5" + eslint-plugin-jsdoc: "npm:^41.1.2" + eslint-plugin-n: "npm:^15.7.0" + eslint-plugin-prettier: "npm:^4.2.1" + eslint-plugin-promise: "npm:^6.1.1" + jest: "npm:^29.0.2" + jest-silent-reporter: "npm:^0.6.0" + prettier: "npm:^2.8.8" + prettier-plugin-packagejson: "npm:^2.5.2" + rimraf: "npm:^4.1.2" + ts-node: "npm:^10.9.1" + typescript: "npm:~5.3.3" + languageName: unknown + linkType: soft + "@metamask/providers@npm:^20.0.0": version: 20.0.0 resolution: "@metamask/providers@npm:20.0.0" From afeaa02da4657ac4f4d464f9426f093334f66a6f Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 14:55:44 +0100 Subject: [PATCH 2/6] Add to test-snaps --- packages/test-snaps/package.json | 1 + .../test-snaps/src/features/snaps/index.ts | 1 + .../src/features/snaps/protocol/Protocol.tsx | 20 +++++++++++++++++++ .../src/features/snaps/protocol/constants.ts | 5 +++++ .../src/features/snaps/protocol/index.ts | 1 + yarn.lock | 3 ++- 6 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 packages/test-snaps/src/features/snaps/protocol/Protocol.tsx create mode 100644 packages/test-snaps/src/features/snaps/protocol/constants.ts create mode 100644 packages/test-snaps/src/features/snaps/protocol/index.ts diff --git a/packages/test-snaps/package.json b/packages/test-snaps/package.json index b06aaf2284..24f2312899 100644 --- a/packages/test-snaps/package.json +++ b/packages/test-snaps/package.json @@ -65,6 +65,7 @@ "@metamask/network-example-snap": "workspace:^", "@metamask/notification-example-snap": "workspace:^", "@metamask/preinstalled-example-snap": "workspace:^", + "@metamask/protocol-example-snap": "workspace:^", "@metamask/send-flow-example-snap": "workspace:^", "@metamask/signature-insights-example-snap": "workspace:^", "@metamask/snaps-utils": "workspace:^", diff --git a/packages/test-snaps/src/features/snaps/index.ts b/packages/test-snaps/src/features/snaps/index.ts index 7eadf6599e..87d3fcd1a9 100644 --- a/packages/test-snaps/src/features/snaps/index.ts +++ b/packages/test-snaps/src/features/snaps/index.ts @@ -22,6 +22,7 @@ export * from './name-lookup'; export * from './network-access'; export * from './notifications'; export * from './preinstalled'; +export * from './protocol'; export * from './transaction-insights'; export * from './signature-insights'; export * from './updates'; diff --git a/packages/test-snaps/src/features/snaps/protocol/Protocol.tsx b/packages/test-snaps/src/features/snaps/protocol/Protocol.tsx new file mode 100644 index 0000000000..45477ecc5c --- /dev/null +++ b/packages/test-snaps/src/features/snaps/protocol/Protocol.tsx @@ -0,0 +1,20 @@ +import type { FunctionComponent } from 'react'; + +import { Snap } from '../../../components'; +import { + PROTOCOL_SNAP_ID, + PROTOCOL_SNAP_PORT, + PROTOCOL_VERSION, +} from './constants'; + +export const Protocol: FunctionComponent = () => { + return ( + + ); +}; diff --git a/packages/test-snaps/src/features/snaps/protocol/constants.ts b/packages/test-snaps/src/features/snaps/protocol/constants.ts new file mode 100644 index 0000000000..48f45fb7bd --- /dev/null +++ b/packages/test-snaps/src/features/snaps/protocol/constants.ts @@ -0,0 +1,5 @@ +import packageJson from '@metamask/protocol-example-snap/package.json'; + +export const PROTOCOL_SNAP_ID = 'npm:@metamask/protocol-example-snap'; +export const PROTOCOL_SNAP_PORT = 8032; +export const PROTOCOL_VERSION = packageJson.version; diff --git a/packages/test-snaps/src/features/snaps/protocol/index.ts b/packages/test-snaps/src/features/snaps/protocol/index.ts new file mode 100644 index 0000000000..ec0d9a3a3f --- /dev/null +++ b/packages/test-snaps/src/features/snaps/protocol/index.ts @@ -0,0 +1 @@ +export * from './Protocol'; diff --git a/yarn.lock b/yarn.lock index 2a11432445..4283dd0329 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5401,7 +5401,7 @@ __metadata: languageName: unknown linkType: soft -"@metamask/protocol-example-snap@workspace:packages/examples/packages/protocol": +"@metamask/protocol-example-snap@workspace:^, @metamask/protocol-example-snap@workspace:packages/examples/packages/protocol": version: 0.0.0-use.local resolution: "@metamask/protocol-example-snap@workspace:packages/examples/packages/protocol" dependencies: @@ -6465,6 +6465,7 @@ __metadata: "@metamask/network-example-snap": "workspace:^" "@metamask/notification-example-snap": "workspace:^" "@metamask/preinstalled-example-snap": "workspace:^" + "@metamask/protocol-example-snap": "workspace:^" "@metamask/providers": "npm:^20.0.0" "@metamask/send-flow-example-snap": "workspace:^" "@metamask/signature-insights-example-snap": "workspace:^" From 6802cb771fe98ca66550a808bcde9b4c31bdb3bc Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 15:05:32 +0100 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Maarten Zuidhoorn --- packages/examples/packages/protocol/README.md | 4 ++-- packages/examples/packages/protocol/package.json | 6 +++--- packages/examples/packages/protocol/snap.manifest.json | 2 +- packages/examples/packages/protocol/src/index.ts | 1 + 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/examples/packages/protocol/README.md b/packages/examples/packages/protocol/README.md index 1e01eb468f..4e1a597068 100644 --- a/packages/examples/packages/protocol/README.md +++ b/packages/examples/packages/protocol/README.md @@ -1,13 +1,13 @@ # `@metamask/protocol-example-snap` -This snap demonstrates how to use `endowment:protocol` to expose protocol +This Snap demonstrates how to use `endowment:protocol` to expose protocol data via the mulitchain API. This Snap specifically provides this information for the Solana devnet. ## Snap usage -This snap exposes an `onProtocolRequest` handler, which supports the following +This Snap exposes an `onProtocolRequest` handler, which supports the following JSON-RPC methods: - `getBlockHeight` - Return the block height of the chain. diff --git a/packages/examples/packages/protocol/package.json b/packages/examples/packages/protocol/package.json index ae33c54804..fc70333484 100644 --- a/packages/examples/packages/protocol/package.json +++ b/packages/examples/packages/protocol/package.json @@ -7,7 +7,7 @@ "Snaps", "Ethereum" ], - "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/client-status#readme", + "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/protocol#readme", "bugs": { "url": "https://github.com/MetaMask/snaps/issues" }, @@ -25,8 +25,8 @@ "scripts": { "build": "mm-snap build", "build:clean": "yarn clean && yarn build", - "changelog:update": "../../../../scripts/update-changelog.sh @metamask/client-status-example-snap", - "changelog:validate": "../../../../scripts/validate-changelog.sh @metamask/client-status-example-snap", + "changelog:update": "../../../../scripts/update-changelog.sh @metamask/protocol-example-snap", + "changelog:validate": "../../../../scripts/validate-changelog.sh @metamask/protocol-example-snap", "clean": "rimraf \"dist\"", "lint": "yarn lint:eslint && yarn lint:misc --check && yarn changelog:validate && yarn lint:dependencies", "lint:ci": "yarn lint", diff --git a/packages/examples/packages/protocol/snap.manifest.json b/packages/examples/packages/protocol/snap.manifest.json index 5be0309610..1c1336808b 100644 --- a/packages/examples/packages/protocol/snap.manifest.json +++ b/packages/examples/packages/protocol/snap.manifest.json @@ -1,6 +1,6 @@ { "version": "0.0.0", - "description": "MetaMask example snap demonstrating the use of `endowment:protocol`", + "description": "MetaMask example Snap demonstrating the use of `endowment:protocol`", "proposedName": "Protocol Example Snap", "repository": { "type": "git", diff --git a/packages/examples/packages/protocol/src/index.ts b/packages/examples/packages/protocol/src/index.ts index 1c85039f74..2caf04ed1d 100644 --- a/packages/examples/packages/protocol/src/index.ts +++ b/packages/examples/packages/protocol/src/index.ts @@ -49,6 +49,7 @@ export const onProtocolRequest: OnProtocolRequestHandler = async ({ case 'getBlockHeight': { return rpcRequest('getBlockHeight'); } + case 'getGenesisHash': { return rpcRequest('getGenesisHash'); } From 2d78f8bb0555fe54c0965d93e512d6a08e64f1fe Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 15:10:15 +0100 Subject: [PATCH 4/6] Address PR comments --- .../examples/packages/protocol/CHANGELOG.md | 30 +------------------ packages/examples/packages/protocol/README.md | 6 ---- .../examples/packages/protocol/package.json | 2 +- .../packages/protocol/snap.manifest.json | 2 +- .../examples/packages/protocol/src/index.ts | 2 ++ 5 files changed, 5 insertions(+), 37 deletions(-) diff --git a/packages/examples/packages/protocol/CHANGELOG.md b/packages/examples/packages/protocol/CHANGELOG.md index b8667fca88..720e00537e 100644 --- a/packages/examples/packages/protocol/CHANGELOG.md +++ b/packages/examples/packages/protocol/CHANGELOG.md @@ -7,32 +7,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [1.0.3] - -### Fixed - -- Bump MetaMask dependencies - -## [1.0.2] - -### Changed - -- Use error wrappers ([#2178](https://github.com/MetaMask/snaps/pull/2178)) - -## [1.0.1] - -### Changed - -- Remove snap icon ([#2189](https://github.com/MetaMask/snaps/pull/2189)) - -## [1.0.0] - -### Added - -- Add `snap_getClientStatus` example snap ([#2159](https://github.com/MetaMask/snaps/pull/2159)) - -[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.3...HEAD -[1.0.3]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.2...@metamask/client-status-example-snap@1.0.3 -[1.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.1...@metamask/client-status-example-snap@1.0.2 -[1.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/client-status-example-snap@1.0.0...@metamask/client-status-example-snap@1.0.1 -[1.0.0]: https://github.com/MetaMask/snaps/releases/tag/@metamask/client-status-example-snap@1.0.0 +[Unreleased]: https://github.com/MetaMask/snaps/ diff --git a/packages/examples/packages/protocol/README.md b/packages/examples/packages/protocol/README.md index 4e1a597068..cd32163b2a 100644 --- a/packages/examples/packages/protocol/README.md +++ b/packages/examples/packages/protocol/README.md @@ -12,9 +12,3 @@ JSON-RPC methods: - `getBlockHeight` - Return the block height of the chain. - `getGenesisHash` - Return the genesis hash of the chain. - -``` - -For more information, you can refer to -[the end-to-end tests](./src/index.test.ts). -``` diff --git a/packages/examples/packages/protocol/package.json b/packages/examples/packages/protocol/package.json index fc70333484..fc8e7fe11c 100644 --- a/packages/examples/packages/protocol/package.json +++ b/packages/examples/packages/protocol/package.json @@ -1,7 +1,7 @@ { "name": "@metamask/protocol-example-snap", "version": "0.0.0", - "description": "MetaMask example snap demonstrating the use of `endowment:protocol`", + "description": "MetaMask example Snap demonstrating the use of `endowment:protocol`", "keywords": [ "MetaMask", "Snaps", diff --git a/packages/examples/packages/protocol/snap.manifest.json b/packages/examples/packages/protocol/snap.manifest.json index 1c1336808b..f9e53ce341 100644 --- a/packages/examples/packages/protocol/snap.manifest.json +++ b/packages/examples/packages/protocol/snap.manifest.json @@ -7,7 +7,7 @@ "url": "https://github.com/MetaMask/snaps.git" }, "source": { - "shasum": "ZYKyp6xZmkWqxewj4kDbdtzxEvgNxroW7Z3flQAp75I=", + "shasum": "XCSzJbcyYNaEve/S9QSQiUzs5IPqWPoF3sEKJpg5KTQ=", "location": { "npm": { "filePath": "dist/bundle.js", diff --git a/packages/examples/packages/protocol/src/index.ts b/packages/examples/packages/protocol/src/index.ts index 2caf04ed1d..a47d0f7e47 100644 --- a/packages/examples/packages/protocol/src/index.ts +++ b/packages/examples/packages/protocol/src/index.ts @@ -44,7 +44,9 @@ export const onProtocolRequest: OnProtocolRequestHandler = async ({ scope, request, }) => { + // This Snap strictly supports the Solana devnet for now. assert(scope === 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1'); + switch (request.method) { case 'getBlockHeight': { return rpcRequest('getBlockHeight'); From a74c2a77d25ee84bc978e39c3cb3a3480753812a Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 15:11:27 +0100 Subject: [PATCH 5/6] Revert accidental change to CLI file --- packages/snaps-cli/src/main.ts | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 packages/snaps-cli/src/main.ts diff --git a/packages/snaps-cli/src/main.ts b/packages/snaps-cli/src/main.ts old mode 100644 new mode 100755 From fbe7f7500e28ecad83863c60caf2f24a43df3c15 Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Wed, 12 Feb 2025 15:27:30 +0100 Subject: [PATCH 6/6] Fix lint and test --- packages/examples/packages/protocol/package.json | 3 +-- yarn.config.cjs | 2 +- yarn.lock | 1 - 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/examples/packages/protocol/package.json b/packages/examples/packages/protocol/package.json index fc8e7fe11c..e897da1925 100644 --- a/packages/examples/packages/protocol/package.json +++ b/packages/examples/packages/protocol/package.json @@ -37,7 +37,7 @@ "publish:preview": "yarn npm publish --tag preview", "since-latest-release": "../../../../scripts/since-latest-release.sh", "start": "mm-snap watch", - "test": "jest --reporters=jest-silent-reporter", + "test": "jest --reporters=jest-silent-reporter --passWithNoTests", "test:clean": "jest --clearCache", "test:verbose": "jest --verbose", "test:watch": "jest --watch" @@ -47,7 +47,6 @@ "@metamask/utils": "^11.1.0" }, "devDependencies": { - "@jest/globals": "^29.5.0", "@lavamoat/allow-scripts": "^3.0.4", "@metamask/auto-changelog": "^3.4.4", "@metamask/eslint-config": "^12.1.0", diff --git a/yarn.config.cjs b/yarn.config.cjs index b664ba13f6..6c5b8f11b1 100644 --- a/yarn.config.cjs +++ b/yarn.config.cjs @@ -173,7 +173,7 @@ module.exports = defineConfig({ 'scripts.test', 'jest --reporters=jest-silent-reporter && yarn test:browser', ); - } else { + } else if (workspace.cwd !== 'packages/examples/packages/protocol') { expectWorkspaceField( workspace, 'scripts.test', diff --git a/yarn.lock b/yarn.lock index 4283dd0329..138661f93b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5405,7 +5405,6 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/protocol-example-snap@workspace:packages/examples/packages/protocol" dependencies: - "@jest/globals": "npm:^29.5.0" "@lavamoat/allow-scripts": "npm:^3.0.4" "@metamask/auto-changelog": "npm:^3.4.4" "@metamask/eslint-config": "npm:^12.1.0"