add web3modal extension

package.json

@@ -69,7 +69,7 @@
  "ts-node": "^10.2.0",
  "tsc-watch": "^4.2.9",
  "tslib": "^2.3.1",
- "typescript": "~4.4.2",
+ "typescript": "4.5.2",
  "wsrun": "^5.2.1",
  "zombi": "^3.3.0"
  },

packages/@magic-ext/web3modal-ethers5/.eslintignore

@@ -0,0 +1,5 @@
+/node_modules
+/coverage
+/dist
+/.eslintrc.js
+/jest.config.ts

packages/@magic-ext/web3modal-ethers5/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+ extends: ['../../../.eslintrc.js'],
+ parserOptions: {
+ project: ['./tsconfig.json', './test/tsconfig.json'],
+ tsconfigRootDir: __dirname,
+ },
+};

packages/@magic-ext/web3modal-ethers5/.lintstagedrc.yml

@@ -0,0 +1,2 @@
+'*.{ts,tsx}':
+ - eslint --fix

packages/@magic-ext/web3modal-ethers5/.prettierrc.js

@@ -0,0 +1 @@
+module.exports = require('../../../.prettierrc.js');

packages/@magic-ext/web3modal-ethers5/LICENSE

@@ -0,0 +1,177 @@
+ Apache License
+ Version 2.0, January 2004
+ http:https://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
+

packages/@magic-ext/web3modal-ethers5/babel.config.json

@@ -0,0 +1,7 @@
+{
+ "env": {
+ "test": {
+ "plugins": ["@babel/plugin-transform-modules-commonjs"]
+ }
+ }
+}

packages/@magic-ext/web3modal-ethers5/jest.config.ts

@@ -0,0 +1,13 @@
+import baseJestConfig from '../../../jest.config';
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+ ...baseJestConfig,
+ transform: {
+ '^.+\\.(js|jsx)$': 'babel-jest',
+ '\\.(ts|tsx)$': 'ts-jest',
+ },
+ coveragePathIgnorePatterns: ['index.cdn.ts', 'index.native.ts'],
+};
+
+export default config;

packages/@magic-ext/web3modal-ethers5/package.json

@@ -0,0 +1,37 @@
+{
+ "name": "@magic-ext/web3modal-ethers5",
+ "version": "0.1.0",
+ "description": "magic web3modal ethers 5 extension",
+ "author": "Magic <[email protected]> (https://magic.link/)",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/magiclabs/magic-js"
+ },
+ "files": [
+ "dist"
+ ],
+ "target": "neutral",
+ "cdnGlobalName": "MagicWeb3ModalExtension",
+ "main": "./dist/cjs/index.js",
+ "module": "./dist/es/index.js",
+ "types": "./dist/types/index.d.ts",
+ "jsdelivr": "./dist/extension.js",
+ "exports": {
+ "import": "./dist/es/index.mjs",
+ "types": "./dist/types/index.d.ts",
+ "require": "./dist/cjs/index.js"
+ },
+ "externals": {
+ "include": [
+ "@magic-sdk/commons"
+ ]
+ },
+ "devDependencies": {
+ "@magic-sdk/commons": "^24.0.2"
+ },
+ "dependencies": {
+ "@web3modal/ethers5": "^4.1.11",
+ "ethers": "5.7.2"
+ }
+}

packages/@magic-ext/web3modal-ethers5/src/index.cdn.ts

@@ -0,0 +1,3 @@
+import { Web3ModalExtension } from './index';
+
+export default Web3ModalExtension;

packages/@magic-ext/web3modal-ethers5/src/index.native.ts

@@ -0,0 +1 @@
+export * from './index';

packages/@magic-ext/web3modal-ethers5/src/index.ts

@@ -0,0 +1,101 @@
+import { Extension, ThirdPartyWalletEvents } from '@magic-sdk/commons';
+import { Web3Modal, createWeb3Modal, defaultConfig } from '@web3modal/ethers5';
+import { Web3ModalExtensionOptions } from './types';
+
+export class Web3ModalExtension extends Extension.Internal<'web3modal', any> {
+ name = 'web3modal' as const;
+ config: any = {};
+ modal: Web3Modal;
+
+ static eventsListenerAdded = false;
+
+ constructor({ configOptions, modalOptions }: Web3ModalExtensionOptions) {
+ super();
+
+ this.modal = createWeb3Modal({
+ ...modalOptions,
+ ...{ themeVariables: { ...(modalOptions.themeVariables || {}), '--w3m-z-index': 3000000000 } },
+ ethersConfig: defaultConfig({ metadata: configOptions }),
+ });
+
+ // Set delay for web3modal to register if user is connected
+ setTimeout(() => {
+ if (!this.modal.getIsConnected()) return;
+ this.setIsConnected();
+ this.setEip1193EventListenersIfConnected();
+ }, 50);
+ }
+
+ public setIsConnected() {
+ localStorage.setItem('3pw_provider', 'web3modal');
+ localStorage.setItem('3pw_address', this.modal.getAddress() as string);
+ localStorage.setItem('3pw_chainId', (this.modal.getChainId() as number).toString());
+ this.sdk.thirdPartyWallet.isConnected = true;
+ }
+
+ public initialize() {
+ this.sdk.thirdPartyWallet.enabledWallets.web3Modal = true;
+ this.sdk.thirdPartyWallet.eventListeners.push({
+ event: ThirdPartyWalletEvents.Web3ModalSelected,
+ callback: async (payloadId) => {
+ await this.connectToWeb3Modal(payloadId);
+ },
+ });
+ }
+
+ private setEip1193EventListenersIfConnected() {
+ if (Web3ModalExtension.eventsListenerAdded) return;
+ Web3ModalExtension.eventsListenerAdded = true;
+
+ this.modal.subscribeProvider(({ address, chainId }) => {
+ // If user disconnected all accounts from wallet
+ if (!address && localStorage.getItem('3pw_address')) {
+ this.sdk.thirdPartyWallet.resetState();
+ return this.sdk.rpcProvider.emit('accountsChanged', []);
+ }
+ if (address && address !== localStorage.getItem('3pw_address')) {
+ localStorage.setItem('3pw_address', address);
+ return this.sdk.rpcProvider.emit('accountsChanged', [address]);
+ }
+ if (chainId && chainId !== Number(localStorage.getItem('3pw_chainId'))) {
+ localStorage.setItem('3pw_chainId', chainId.toString());
+ return this.sdk.rpcProvider.emit('chainChanged', chainId);
+ }
+ return null;
+ });
+ }
+
+ private connectToWeb3Modal(payloadId: string) {
+ const { modal } = this;
+
+ const promiEvent = this.utils.createPromiEvent<string[]>(async () => {
+ // Listen for wallet connected
+ const unsubscribeFromProviderEvents = modal.subscribeProvider(({ address, error }) => {
+ // User rejected connection request
+ if (error) {
+ unsubscribeFromProviderEvents();
+ this.createIntermediaryEvent(ThirdPartyWalletEvents.WalletRejected, payloadId)();
+ }
+ // If user connected wallet, keep listeners active
+ if (address) {
+ this.setIsConnected();
+ this.createIntermediaryEvent(ThirdPartyWalletEvents.WalletConnected as any, payloadId as any)(address);
+ }
+ });
+
+ // Listen for modal close before user connects wallet
+ const unsubscribeFromModalEvents = modal.subscribeEvents((event) => {
+ if (event.data.event === 'MODAL_CLOSE') {
+ // Remove listeners
+ unsubscribeFromModalEvents();
+ unsubscribeFromProviderEvents();
+ this.createIntermediaryEvent(ThirdPartyWalletEvents.WalletRejected, payloadId)();
+ }
+ });
+
+ modal.open();
+ });
+
+ return promiEvent;
+ }
+}

packages/@magic-ext/web3modal-ethers5/src/types.ts

@@ -0,0 +1,7 @@
+// @ts-ignore
+import { ConfigOptions, Web3ModalOptions } from '@web3modal/ethers5';
+
+export interface Web3ModalExtensionOptions {
+ configOptions: ConfigOptions;
+ modalOptions: Web3ModalOptions;
+}

packages/@magic-ext/web3modal-ethers5/test/setup.ts

@@ -0,0 +1,4 @@
+// NOTE: This module is automatically included at the top of each test file.
+import browserEnv from '@ikscodes/browser-env';
+
+browserEnv();

packages/@magic-ext/web3modal-ethers5/test/tsconfig.json

@@ -0,0 +1,3 @@
+{
+ "extends": "../../../../tsconfig.settings.test.json",
+}

packages/@magic-ext/web3modal-ethers5/tsconfig.json

@@ -0,0 +1,4 @@
+{
+ "extends": "../../../tsconfig.settings.json",
+}
+