From 629d8ce51f9b627c186ecd5b8e8d44520ae098d0 Mon Sep 17 00:00:00 2001 From: Jaco Date: Sun, 5 Sep 2021 14:35:04 +0300 Subject: [PATCH] Extract metamask-compat layer (optional) (#810) * Extract metamask-compat layer (optional) * README --- jest.config.cjs | 2 +- packages/extension-compat-metamask/LICENSE | 201 ++++++++++++++++++ packages/extension-compat-metamask/README.md | 3 + .../extension-compat-metamask/package.json | 22 ++ .../src/index.ts} | 2 +- .../src/packageInfo.ts | 6 + packages/extension-dapp/package.json | 4 +- packages/extension-dapp/src/compat/index.ts | 13 -- packages/extension-dapp/src/index.ts | 9 +- tsconfig.json | 1 + yarn.lock | 18 +- 11 files changed, 258 insertions(+), 23 deletions(-) create mode 100644 packages/extension-compat-metamask/LICENSE create mode 100644 packages/extension-compat-metamask/README.md create mode 100644 packages/extension-compat-metamask/package.json rename packages/{extension-dapp/src/compat/metamask.ts => extension-compat-metamask/src/index.ts} (97%) create mode 100644 packages/extension-compat-metamask/src/packageInfo.ts delete mode 100644 packages/extension-dapp/src/compat/index.ts diff --git a/jest.config.cjs b/jest.config.cjs index 0a37ef5585..1ee0c2c059 100644 --- a/jest.config.cjs +++ b/jest.config.cjs @@ -6,7 +6,7 @@ const config = require('@polkadot/dev/config/jest.cjs'); module.exports = { ...config, moduleNameMapper: { - '@polkadot/extension-(base|chains|dapp|inject|ui)(.*)$': '/packages/extension-$1/src/$2', + '@polkadot/extension-(base|chains|compat-metamask|dapp|inject|ui)(.*)$': '/packages/extension-$1/src/$2', // eslint-disable-next-line sort-keys '@polkadot/extension(.*)$': '/packages/extension/src/$1', '\\.(css|less)$': 'empty/object', diff --git a/packages/extension-compat-metamask/LICENSE b/packages/extension-compat-metamask/LICENSE new file mode 100644 index 0000000000..0d381b2e97 --- /dev/null +++ b/packages/extension-compat-metamask/LICENSE @@ -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 [yyyy] [name of copyright owner] + +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/extension-compat-metamask/README.md b/packages/extension-compat-metamask/README.md new file mode 100644 index 0000000000..f5f91f27b4 --- /dev/null +++ b/packages/extension-compat-metamask/README.md @@ -0,0 +1,3 @@ +# @polkadot/extension-metamask-compat + +An optional metamask-compatible layer diff --git a/packages/extension-compat-metamask/package.json b/packages/extension-compat-metamask/package.json new file mode 100644 index 0000000000..e13a571b31 --- /dev/null +++ b/packages/extension-compat-metamask/package.json @@ -0,0 +1,22 @@ +{ + "name": "@polkadot/extension-compat-metamask", + "description": "Metamask compatibility layer", + "version": "0.39.4-8", + "type": "module", + "author": "Jaco Greeff ", + "license": "Apache-2", + "main": "index.js", + "sideEffects": false, + "dependencies": { + "@babel/runtime": "^7.15.3", + "@metamask/detect-provider": "^1.2.0", + "@polkadot/extension-inject": "^0.39.4-8", + "@polkadot/util": "^7.3.1", + "@polkadot/util-crypto": "^7.3.1", + "web3": "^1.5.2" + }, + "peerDependencies": { + "@polkadot/util": "*", + "@polkadot/util-crypto": "*" + } +} diff --git a/packages/extension-dapp/src/compat/metamask.ts b/packages/extension-compat-metamask/src/index.ts similarity index 97% rename from packages/extension-dapp/src/compat/metamask.ts rename to packages/extension-compat-metamask/src/index.ts index 0af40d4032..c1a2eb98a1 100644 --- a/packages/extension-dapp/src/compat/metamask.ts +++ b/packages/extension-compat-metamask/src/index.ts @@ -85,7 +85,7 @@ function injectMetaMaskWeb3 (win: Web3Window): void { }; } -export default function initMetaMaskSource (): Promise { +export default function initMetaMask (): Promise { return new Promise((resolve): void => { const win = window as Window & Web3Window; diff --git a/packages/extension-compat-metamask/src/packageInfo.ts b/packages/extension-compat-metamask/src/packageInfo.ts new file mode 100644 index 0000000000..6b83c7be82 --- /dev/null +++ b/packages/extension-compat-metamask/src/packageInfo.ts @@ -0,0 +1,6 @@ +// Copyright 2017-2021 @polkadot/extension-compat-metamask authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +// Auto-generated by @polkadot/dev, do not edit + +export const packageInfo = { name: '@polkadot/extension-compat-metamask', version: '0.39.4-8' }; diff --git a/packages/extension-dapp/package.json b/packages/extension-dapp/package.json index 36efd43ff0..e2fd65b189 100644 --- a/packages/extension-dapp/package.json +++ b/packages/extension-dapp/package.json @@ -9,11 +9,9 @@ "sideEffects": false, "dependencies": { "@babel/runtime": "^7.15.3", - "@metamask/detect-provider": "^1.2.0", "@polkadot/extension-inject": "^0.39.4-8", "@polkadot/util": "^7.3.1", - "@polkadot/util-crypto": "^7.3.1", - "web3": "^1.5.2" + "@polkadot/util-crypto": "^7.3.1" }, "peerDependencies": { "@polkadot/api": "*", diff --git a/packages/extension-dapp/src/compat/index.ts b/packages/extension-dapp/src/compat/index.ts deleted file mode 100644 index c8c26fda80..0000000000 --- a/packages/extension-dapp/src/compat/index.ts +++ /dev/null @@ -1,13 +0,0 @@ -// Copyright 2019-2021 @polkadot/extension-dapp authors & contributors -// SPDX-License-Identifier: Apache-2.0 - -import initMetaMask from './metamask'; - -// initialize all the compatibility engines -export default function initCompat (): Promise { - return Promise.all([ - initMetaMask() - ]).then((): boolean => { - return true; - }); -} diff --git a/packages/extension-dapp/src/index.ts b/packages/extension-dapp/src/index.ts index 5beccf7c22..01e57931df 100644 --- a/packages/extension-dapp/src/index.ts +++ b/packages/extension-dapp/src/index.ts @@ -6,7 +6,6 @@ import type { Injected, InjectedAccount, InjectedAccountWithMeta, InjectedExtens import { u8aEq } from '@polkadot/util'; import { decodeAddress, encodeAddress } from '@polkadot/util-crypto'; -import initCompat from './compat'; import { documentReadyPromise } from './util'; // expose utility functions @@ -64,14 +63,18 @@ function getWindowExtensions (originName: string): Promise<[InjectedExtensionInf } // enables all the providers found on the injected window interface -export function web3Enable (originName: string): Promise { +export function web3Enable (originName: string, compatInits: (() => Promise)[] = []): Promise { if (!originName) { throw new Error('You must pass a name for your app to the web3Enable function'); } + const initCompat = compatInits.length + ? Promise.all(compatInits.map((c) => c())) + : Promise.resolve([true]); + web3EnablePromise = documentReadyPromise( (): Promise => - initCompat().then(() => + initCompat.then(() => getWindowExtensions(originName) .then((values): InjectedExtension[] => values diff --git a/tsconfig.json b/tsconfig.json index 4ec9b54e99..7a203b4892 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -14,6 +14,7 @@ "@polkadot/extension-base/*": ["packages/extension-base/src/*"], "@polkadot/extension-chains": ["packages/extension-chains/src"], "@polkadot/extension-chains/*": ["packages/extension-chains/src/*"], + "@polkadot/extension-compat-metamask": ["packages/extension-compat-metamask/src"], "@polkadot/extension-dapp": ["packages/extension-dapp/src"], "@polkadot/extension-dapp/*": ["packages/extension-dapp/src/*"], "@polkadot/extension-inject": ["packages/extension-inject/src"], diff --git a/yarn.lock b/yarn.lock index 21d3d88cc5..c714a75351 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2448,9 +2448,9 @@ __metadata: languageName: unknown linkType: soft -"@polkadot/extension-dapp@^0.39.4-8, @polkadot/extension-dapp@workspace:packages/extension-dapp": +"@polkadot/extension-compat-metamask@workspace:packages/extension-compat-metamask": version: 0.0.0-use.local - resolution: "@polkadot/extension-dapp@workspace:packages/extension-dapp" + resolution: "@polkadot/extension-compat-metamask@workspace:packages/extension-compat-metamask" dependencies: "@babel/runtime": ^7.15.3 "@metamask/detect-provider": ^1.2.0 @@ -2458,6 +2458,20 @@ __metadata: "@polkadot/util": ^7.3.1 "@polkadot/util-crypto": ^7.3.1 web3: ^1.5.2 + peerDependencies: + "@polkadot/util": "*" + "@polkadot/util-crypto": "*" + languageName: unknown + linkType: soft + +"@polkadot/extension-dapp@^0.39.4-8, @polkadot/extension-dapp@workspace:packages/extension-dapp": + version: 0.0.0-use.local + resolution: "@polkadot/extension-dapp@workspace:packages/extension-dapp" + dependencies: + "@babel/runtime": ^7.15.3 + "@polkadot/extension-inject": ^0.39.4-8 + "@polkadot/util": ^7.3.1 + "@polkadot/util-crypto": ^7.3.1 peerDependencies: "@polkadot/api": "*" "@polkadot/util": "*"