diff --git a/packages/examples/packages/dynamic-permissions/.depcheckrc.json b/packages/examples/packages/dynamic-permissions/.depcheckrc.json new file mode 100644 index 0000000000..15d64e734b --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/.depcheckrc.json @@ -0,0 +1,17 @@ +{ + "ignore-patterns": ["dist", "coverage"], + "ignores": [ + "@lavamoat/allow-scripts", + "@lavamoat/preinstall-always-fail", + "@metamask/auto-changelog", + "@metamask/eslint-*", + "@types/*", + "@typescript-eslint/*", + "eslint-config-*", + "eslint-plugin-*", + "prettier-plugin-packagejson", + "ts-node", + "typedoc", + "typescript" + ] +} diff --git a/packages/examples/packages/dynamic-permissions/.eslintrc.js b/packages/examples/packages/dynamic-permissions/.eslintrc.js new file mode 100644 index 0000000000..a47fd0b65d --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + extends: ['../../.eslintrc.js'], + + parserOptions: { + tsconfigRootDir: __dirname, + }, +}; diff --git a/packages/examples/packages/dynamic-permissions/CHANGELOG.md b/packages/examples/packages/dynamic-permissions/CHANGELOG.md new file mode 100644 index 0000000000..d94e3d6c6b --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/CHANGELOG.md @@ -0,0 +1,7 @@ +# 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] diff --git a/packages/examples/packages/dynamic-permissions/LICENSE.APACHE2 b/packages/examples/packages/dynamic-permissions/LICENSE.APACHE2 new file mode 100644 index 0000000000..bf37d0e612 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/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 2023 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/dynamic-permissions/LICENSE.MIT0 b/packages/examples/packages/dynamic-permissions/LICENSE.MIT0 new file mode 100644 index 0000000000..913c577462 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/LICENSE.MIT0 @@ -0,0 +1,16 @@ +MIT No Attribution + +Copyright 2023 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/dynamic-permissions/README.md b/packages/examples/packages/dynamic-permissions/README.md new file mode 100644 index 0000000000..2d672d1d0c --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/README.md @@ -0,0 +1,37 @@ +# `@metamask/dynamic-permissions-example-snap` + +This Snap demonstrates the use of RPC methods for managing dynamic permissions. + +## Snap manifest + +> **Note**: Using dynamic permissions requires `dynamicPermissions` property specified in the manifest. +> Refer to [the documentation](https://docs.metamask.io/snaps/reference/rpc-api/#dynamic-permissions) +> for more information. + +The manifest of this Snap includes the `dynamicPermissions`property which specifies which permissions can be requested or revoked at the runtime: + +```json +{ + "dynamicPermissions": { + "endowment:network-access": {}, + "endowment:webassembly": {}, + "endowment:ethereum-provider": {}, + "snap_getBip44Entropy": [ + { + "coinType": 3 + }, + { + "coinType": 1 + } + ] + } +} +``` + +## Snap usage + +This Snap is using following RPC methods for managing dynamic permissions: + +- `snap_requestPermissions`: Request dynamic permissions specified in the manifest. +- `snap_getPermissions`: Retrieve all granted permissions. +- `snap_revokePermissions`: Revoke dynamic permissions previously granted. diff --git a/packages/examples/packages/dynamic-permissions/jest.config.js b/packages/examples/packages/dynamic-permissions/jest.config.js new file mode 100644 index 0000000000..270869ba84 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/jest.config.js @@ -0,0 +1,21 @@ +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/(.+)$': [ + '/../../../$1/src', + '/../../../../node_modules/@metamask/$1', + '/node_modules/@metamask/$1', + ], + }, +}); diff --git a/packages/examples/packages/dynamic-permissions/package.json b/packages/examples/packages/dynamic-permissions/package.json new file mode 100644 index 0000000000..cdbc70b496 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/package.json @@ -0,0 +1,74 @@ +{ + "name": "@metamask/dynamic-permissions-example-snap", + "version": "1.0.0", + "description": "MetaMask example snap demonstrating the use of RPC methods for managing dynamic permissions.", + "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", + "clean": "rimraf \"dist\"", + "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies", + "lint:changelog": "../../../../scripts/validate-changelog.sh @metamask/dynamic-permissions-example-snap", + "lint:ci": "yarn lint", + "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", + "start": "mm-snap watch", + "test": "yarn test:e2e", + "test:e2e": "jest", + "publish:preview": "yarn npm publish --tag preview", + "lint:dependencies": "depcheck" + }, + "dependencies": { + "@metamask/rpc-errors": "^6.1.0", + "@metamask/snaps-sdk": "workspace:^" + }, + "devDependencies": { + "@jest/globals": "^29.5.0", + "@lavamoat/allow-scripts": "^3.0.2", + "@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:^", + "@metamask/utils": "^8.3.0", + "@swc/core": "1.3.78", + "@swc/jest": "^0.2.26", + "@typescript-eslint/eslint-plugin": "^5.42.1", + "@typescript-eslint/parser": "^5.42.1", + "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": "^39.6.2", + "eslint-plugin-n": "^15.7.0", + "eslint-plugin-prettier": "^4.2.1", + "eslint-plugin-promise": "^6.1.1", + "jest": "^29.0.2", + "prettier": "^2.7.1", + "prettier-plugin-packagejson": "^2.2.11", + "ts-node": "^10.9.1", + "typescript": "~4.8.4" + }, + "engines": { + "node": "^18.16 || >=20" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org/" + } +} diff --git a/packages/examples/packages/dynamic-permissions/snap.config.ts b/packages/examples/packages/dynamic-permissions/snap.config.ts new file mode 100644 index 0000000000..7bbeb6d794 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/snap.config.ts @@ -0,0 +1,15 @@ +import type { SnapConfig } from '@metamask/snaps-cli'; +import { resolve } from 'path'; + +const config: SnapConfig = { + bundler: 'webpack', + input: resolve(__dirname, 'src/index.ts'), + server: { + port: 8005, + }, + stats: { + buffer: false, + }, +}; + +export default config; diff --git a/packages/examples/packages/dynamic-permissions/snap.manifest.json b/packages/examples/packages/dynamic-permissions/snap.manifest.json new file mode 100644 index 0000000000..e158075327 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/snap.manifest.json @@ -0,0 +1,40 @@ +{ + "version": "1.0.0", + "description": "MetaMask example snap demonstrating the use of RPC methods for managing dynamic permissions.", + "proposedName": "Dynamic Permissions Example Snap", + "repository": { + "type": "git", + "url": "https://github.com/MetaMask/snaps.git" + }, + "source": { + "shasum": "wX4pqJ2RkmZdllC1iVnHP4uE4sWiqTb6GWXNyEUDnCA=", + "location": { + "npm": { + "filePath": "dist/bundle.js", + "packageName": "@metamask/dynamic-permissions-example-snap", + "registry": "https://registry.npmjs.org/" + } + } + }, + "initialPermissions": { + "snap_dialog": {}, + "endowment:rpc": { + "dapps": true, + "snaps": false + } + }, + "dynamicPermissions": { + "endowment:network-access": {}, + "endowment:webassembly": {}, + "endowment:ethereum-provider": {}, + "snap_getBip44Entropy": [ + { + "coinType": 3 + }, + { + "coinType": 1 + } + ] + }, + "manifestVersion": "0.1" +} diff --git a/packages/examples/packages/dynamic-permissions/src/index.test.ts b/packages/examples/packages/dynamic-permissions/src/index.test.ts new file mode 100644 index 0000000000..af4fa36dec --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/src/index.test.ts @@ -0,0 +1,48 @@ +import { expect } from '@jest/globals'; +import { installSnap } from '@metamask/snaps-jest'; + +describe('onRpcRequest', () => { + it('throws an error if the requested method does not exist', async () => { + const { request } = await installSnap(); + + const response = await request({ + method: 'foo', + }); + + expect(response).toRespondWithError({ + code: -32601, + message: 'The method does not exist / is not available.', + stack: expect.any(String), + data: { + method: 'foo', + cause: null, + }, + }); + }); + + describe('getPermissions', () => { + it('returns permissions granted to a snap', async () => { + const { request } = await installSnap(); + + const response = await request({ + method: 'getPermissions', + params: {}, + }); + + expect(response).toRespondWith({}); + }); + }); + + describe('revokePermissions', () => { + it('revokes dynamic permissions and returns null', async () => { + const { request } = await installSnap(); + + const response = await request({ + method: 'revokePermissions', + params: {}, + }); + + expect(response).toRespondWith({}); + }); + }); +}); diff --git a/packages/examples/packages/dynamic-permissions/src/index.ts b/packages/examples/packages/dynamic-permissions/src/index.ts new file mode 100644 index 0000000000..e7fcfc9ed8 --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/src/index.ts @@ -0,0 +1,69 @@ +import { rpcErrors } from '@metamask/rpc-errors'; +import type { OnRpcRequestHandler } from '@metamask/snaps-sdk'; + +/** + * Handle incoming JSON-RPC requests from the dapp, sent through the + * `wallet_invokeSnap` method. This handler handles three methods, one for each + * type of dynamic permissions functionality: + * + * - `requestPermissions`: Request all dynamic permission specified in the manifest. + * - `getPermissions`: Retrieve all granted permissions. + * - `revokePermissions`: Revoke all dynamic permissions. + * + * @param params - The request parameters. + * @param params.request - The JSON-RPC request object. + * @returns The JSON-RPC response. + */ +export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => { + switch (request.method) { + case 'requestPermissions': + return snap.request({ + method: 'snap_requestPermissions', + params: { + 'endowment:network-access': {}, + 'endowment:webassembly': {}, + 'endowment:ethereum-provider': {}, + // eslint-disable-next-line @typescript-eslint/naming-convention + snap_getBip44Entropy: [ + { + coinType: 3, + }, + { + coinType: 1, + }, + ], + }, + }); + + case 'getPermissions': + return snap.request({ + method: 'snap_getPermissions', + }); + + case 'revokePermissions': + return snap.request({ + method: 'snap_revokePermissions', + params: { + 'endowment:network-access': {}, + 'endowment:webassembly': {}, + 'endowment:ethereum-provider': {}, + // eslint-disable-next-line @typescript-eslint/naming-convention + snap_getBip44Entropy: [ + { + coinType: 3, + }, + { + coinType: 1, + }, + ], + }, + }); + + default: + throw rpcErrors.methodNotFound({ + data: { + method: request.method, + }, + }); + } +}; diff --git a/packages/examples/packages/dynamic-permissions/tsconfig.json b/packages/examples/packages/dynamic-permissions/tsconfig.json new file mode 100644 index 0000000000..1cb4c3315f --- /dev/null +++ b/packages/examples/packages/dynamic-permissions/tsconfig.json @@ -0,0 +1,21 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "baseUrl": "./", + "paths": { + "@metamask/*": ["../../../*/src"] + } + }, + "include": ["src", "snap.config.ts"], + "references": [ + { + "path": "../../../snaps-sdk" + }, + { + "path": "../../../snaps-jest" + }, + { + "path": "../../../snaps-cli" + } + ] +}