@dynamic-labs/starknet 1.4.13 → 1.4.15

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 
+### [1.4.15](https://github.com/dynamic-labs/DynamicAuth/compare/v1.4.14...v1.4.15) (2024-07-17)
+
+
+### Bug Fixes
+
+* re-establish connection to metamask starknet snap on page reload ([#6362](https://github.com/dynamic-labs/DynamicAuth/issues/6362)) ([176bd0e](https://github.com/dynamic-labs/DynamicAuth/commit/176bd0e096a523731e815b1e32961509db1e05d2))
+
+### [1.4.14](https://github.com/dynamic-labs/DynamicAuth/compare/v1.4.13...v1.4.14) (2024-07-11)
+
 ### [1.4.13](https://github.com/dynamic-labs/DynamicAuth/compare/v1.4.12...v1.4.13) (2024-06-05)
 
+### Features
+
+* add the Starknet MetaMask snap to the available wallets
 
 ### Bug Fixes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/starknet",
-  "version": "1.4.13",
+  "version": "1.4.15",
   "repository": {
     "type": "git",
     "url": "https://github.com/dynamic-labs/DynamicAuth.git",
@@ -31,11 +31,12 @@
     "text-encoding": "0.7.0",
     "starknetkit": "1.1.3",
     "@dynamic-labs/sdk-api": "0.0.387",
-    "@dynamic-labs/rpc-providers": "1.4.13",
-    "@dynamic-labs/types": "1.4.13",
-    "@dynamic-labs/utils": "1.4.13",
-    "@dynamic-labs/wallet-book": "1.4.13",
-    "@dynamic-labs/wallet-connector-core": "1.4.13"
+    "@module-federation/runtime": "0.1.19",
+    "@dynamic-labs/rpc-providers": "1.4.15",
+    "@dynamic-labs/types": "1.4.15",
+    "@dynamic-labs/utils": "1.4.15",
+    "@dynamic-labs/wallet-book": "1.4.15",
+    "@dynamic-labs/wallet-connector-core": "1.4.15"
   },
   "peerDependencies": {}
 }

package/src/index.cjs

@@ -8,6 +8,7 @@ var argentxMobile = require('./wallets/argentxMobile.cjs');
 var argentxWeb = require('./wallets/argentxWeb.cjs');
 var bitget = require('./wallets/bitget.cjs');
 var okx = require('./wallets/okx.cjs');
+var metamask = require('./wallets/metamask.cjs');
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const StarknetWalletConnectors = (props) => [
@@ -17,6 +18,7 @@ const StarknetWalletConnectors = (props) => [
     argentxWeb.ArgentXWeb,
     okx.Okx,
     bitget.Bitget,
+    metamask.MetaMask,
 ];
 
 exports.StarknetWalletConnectors = StarknetWalletConnectors;

package/src/index.js

@@ -4,6 +4,7 @@ import { ArgentXMobile } from './wallets/argentxMobile.js';
 import { ArgentXWeb } from './wallets/argentxWeb.js';
 import { Bitget } from './wallets/bitget.js';
 import { Okx } from './wallets/okx.js';
+import { MetaMask } from './wallets/metamask.js';
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const StarknetWalletConnectors = (props) => [
@@ -13,6 +14,7 @@ const StarknetWalletConnectors = (props) => [
     ArgentXWeb,
     Okx,
     Bitget,
+    MetaMask,
 ];
 
 export { StarknetWalletConnectors };

package/src/starknetWalletConnector.cjs

@@ -22,6 +22,8 @@ class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
         this.connectedChain = 'STARK';
         this.supportedChains = ['STARK'];
         this.switchNetworkOnlyFromWallet = true;
+        // required for metamask snap integration as MM snaps don't have event listeners
+        this.canSetEventListeners = true;
         this.name = name;
         this.windowKey = windowKey;
         this.starknetNetworks = opts.starknetNetworks;
@@ -201,6 +203,24 @@ class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
             if (!wallet) {
                 return [];
             }
+            try {
+                yield this.reconnectIfNeeded(wallet);
+            }
+            catch (e) {
+                return [];
+            }
+            const getSelectedAddress = () => wallet.selectedAddress
+                ? Promise.resolve([wallet.selectedAddress])
+                : Promise.reject();
+            return utils.retryableFn(getSelectedAddress, {
+                fallbackValue: [],
+                retryIntervalMs: 100,
+                retryStrategy: 'timeout-and-rejection',
+            });
+        });
+    }
+    reconnectIfNeeded(wallet) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
             const needsReconnection = !this.isProviderConnected() && (yield wallet.isPreauthorized());
             if (needsReconnection) {
                 /**
@@ -218,24 +238,18 @@ class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
                     }
                     catch (_a) {
                         localStorage.removeItem('dynamic_should_have_wallet');
-                        return [];
+                        throw new Error('Could not reconnect');
                     }
                 }
                 else {
                     yield this.connect();
                 }
             }
-            const getSelectedAddress = () => wallet.selectedAddress
-                ? Promise.resolve([wallet.selectedAddress])
-                : Promise.reject();
-            return utils.retryableFn(getSelectedAddress, {
-                fallbackValue: [],
-                retryIntervalMs: 100,
-                retryStrategy: 'timeout-and-rejection',
-            });
         });
     }
     setupEventListeners() {
+        if (!this.canSetEventListeners)
+            return;
         const wallet = this.getWallet();
         if (!wallet) {
             return walletConnectorCore.logger.error('Wallet has not been found');
@@ -264,6 +278,8 @@ class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
     }
     teardownEventListeners() {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!this.canSetEventListeners)
+                return;
             const wallet = this.getWallet();
             if (this.handleAccountChange) {
                 wallet === null || wallet === void 0 ? void 0 : wallet.off(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);

package/src/starknetWalletConnector.d.ts

@@ -24,6 +24,7 @@ declare abstract class StarknetWalletConnector extends WalletConnectorBase {
     handleNetworkChange: NetworkChangeEventHandler | undefined;
     switchNetworkOnlyFromWallet: boolean;
     starknetNetworks: NetworkConfiguration[];
+    canSetEventListeners: boolean;
     constructor(name: string, windowKey: StarknetWalletKey, opts: {
         chainRpcProviders: typeof ChainRpcProviders;
         starknetNetworks: NetworkConfiguration[];
@@ -100,6 +101,7 @@ declare abstract class StarknetWalletConnector extends WalletConnectorBase {
     getWallet(): StarknetWindowObject | undefined;
     isInstalledOnBrowser(): boolean;
     getConnectedAccounts(): Promise<string[]>;
+    reconnectIfNeeded(wallet: StarknetWindowObject): Promise<Promise<Promise<void>>>;
     setupEventListeners(): void;
     teardownEventListeners(): Promise<void>;
     mapNetworkNameToChainId(networkNameOrChainId: string): constants.StarknetChainId | undefined;

package/src/starknetWalletConnector.js

@@ -18,6 +18,8 @@ class StarknetWalletConnector extends WalletConnectorBase {
         this.connectedChain = 'STARK';
         this.supportedChains = ['STARK'];
         this.switchNetworkOnlyFromWallet = true;
+        // required for metamask snap integration as MM snaps don't have event listeners
+        this.canSetEventListeners = true;
         this.name = name;
         this.windowKey = windowKey;
         this.starknetNetworks = opts.starknetNetworks;
@@ -197,6 +199,24 @@ class StarknetWalletConnector extends WalletConnectorBase {
             if (!wallet) {
                 return [];
             }
+            try {
+                yield this.reconnectIfNeeded(wallet);
+            }
+            catch (e) {
+                return [];
+            }
+            const getSelectedAddress = () => wallet.selectedAddress
+                ? Promise.resolve([wallet.selectedAddress])
+                : Promise.reject();
+            return retryableFn(getSelectedAddress, {
+                fallbackValue: [],
+                retryIntervalMs: 100,
+                retryStrategy: 'timeout-and-rejection',
+            });
+        });
+    }
+    reconnectIfNeeded(wallet) {
+        return __awaiter(this, void 0, void 0, function* () {
             const needsReconnection = !this.isProviderConnected() && (yield wallet.isPreauthorized());
             if (needsReconnection) {
                 /**
@@ -214,24 +234,18 @@ class StarknetWalletConnector extends WalletConnectorBase {
                     }
                     catch (_a) {
                         localStorage.removeItem('dynamic_should_have_wallet');
-                        return [];
+                        throw new Error('Could not reconnect');
                     }
                 }
                 else {
                     yield this.connect();
                 }
             }
-            const getSelectedAddress = () => wallet.selectedAddress
-                ? Promise.resolve([wallet.selectedAddress])
-                : Promise.reject();
-            return retryableFn(getSelectedAddress, {
-                fallbackValue: [],
-                retryIntervalMs: 100,
-                retryStrategy: 'timeout-and-rejection',
-            });
         });
     }
     setupEventListeners() {
+        if (!this.canSetEventListeners)
+            return;
         const wallet = this.getWallet();
         if (!wallet) {
             return logger.error('Wallet has not been found');
@@ -260,6 +274,8 @@ class StarknetWalletConnector extends WalletConnectorBase {
     }
     teardownEventListeners() {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!this.canSetEventListeners)
+                return;
             const wallet = this.getWallet();
             if (this.handleAccountChange) {
                 wallet === null || wallet === void 0 ? void 0 : wallet.off(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);

package/src/types.d.ts

@@ -1,5 +1,5 @@
 import type { StarknetWindowObject } from 'get-starknet-core';
-export type StarknetWalletKey = 'braavos' | 'argentX' | 'argentXMobile' | 'argentWebWallet' | 'okxwallet' | 'bitkeep';
+export type StarknetWalletKey = 'braavos' | 'argentX' | 'argentXMobile' | 'argentWebWallet' | 'okxwallet' | 'bitkeep' | 'metamask_snap';
 export type StarknetWindowKey = `starknet_${StarknetWalletKey}` | 'starknet';
 type StarknetWindow = {
     [key in StarknetWindowKey]: StarknetWindowObject;

package/src/utils/starknetSnap.cjs

@@ -0,0 +1,111 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../_virtual/_tslib.cjs');
+var moduleFederation = require('@module-federation/runtime/dist/index.cjs.js');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var moduleFederation__namespace = /*#__PURE__*/_interopNamespace(moduleFederation);
+
+/**
+ *
+ * @param {IEthereum} provider the metamask window provider object
+ * @returns {StarknetWindowObject} the metamask provider wrapper formed into starknet window object
+ */
+const createMetaMaskProviderWrapper = (provider) => {
+    let metaMaskSnapWallet;
+    // using @module-federation to load the get-starknet remoteEntry, as recommended
+    // by the starknet team. this file is a small wrapper around the metamask snap api
+    // to communicate with starknet, which we then wrap into a starknet window object
+    // and use in our starknet connector, just like braavos and argent
+    const initMetaMaskSnapWallet = () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+        if (!metaMaskSnapWallet) {
+            moduleFederation__namespace.init({
+                name: 'MetaMaskStarknetSnapWallet',
+                remotes: [
+                    {
+                        alias: 'MetaMaskStarknetSnapWallet',
+                        entry: 'https://snaps.consensys.io/starknet/get-starknet/v1/remoteEntry.js',
+                        name: 'MetaMaskStarknetSnapWallet',
+                    },
+                ],
+            });
+            const result = yield moduleFederation__namespace.loadRemote('MetaMaskStarknetSnapWallet/index');
+            const { MetaMaskSnapWallet } = result;
+            metaMaskSnapWallet = new MetaMaskSnapWallet(provider, '*');
+        }
+    });
+    const metaMaskProviderWrapper = {
+        get account() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.account;
+        },
+        get chainId() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.chainId;
+        },
+        enable: () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+            yield initMetaMaskSnapWallet();
+            if (!metaMaskSnapWallet) {
+                return [];
+            }
+            return metaMaskSnapWallet.enable();
+        }),
+        icon: '',
+        id: 'MetaMaskStarknetSnapWallet',
+        get isConnected() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.isConnected;
+        },
+        isPreauthorized: () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            yield initMetaMaskSnapWallet();
+            return (_a = (yield (metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.isPreauthorized()))) !== null && _a !== void 0 ? _a : false;
+        }),
+        name: 'MetaMaskStarknetSnapWallet',
+        off: (
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        event, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        handleEvent) => undefined,
+        on: (
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        event, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        handleEvent) => undefined,
+        get provider() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.provider;
+        },
+        request: (call) => {
+            if (!metaMaskSnapWallet) {
+                throw new Error('Wallet not enabled');
+            }
+            return metaMaskSnapWallet.request(call);
+        },
+        get selectedAddress() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.selectedAddress;
+        },
+        get version() {
+            var _a;
+            return (_a = metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.version) !== null && _a !== void 0 ? _a : '0.0.0';
+        },
+    };
+    return metaMaskProviderWrapper;
+};
+
+exports.createMetaMaskProviderWrapper = createMetaMaskProviderWrapper;

package/src/utils/starknetSnap.d.ts

@@ -0,0 +1,8 @@
+import { StarknetWindowObject } from 'get-starknet-core';
+import { IEthereum } from '@dynamic-labs/utils';
+/**
+ *
+ * @param {IEthereum} provider the metamask window provider object
+ * @returns {StarknetWindowObject} the metamask provider wrapper formed into starknet window object
+ */
+export declare const createMetaMaskProviderWrapper: (provider: IEthereum) => StarknetWindowObject;

package/src/utils/starknetSnap.js

@@ -0,0 +1,87 @@
+import { __awaiter } from '../../_virtual/_tslib.js';
+import * as moduleFederation from '@module-federation/runtime/dist/index.cjs.js';
+
+/**
+ *
+ * @param {IEthereum} provider the metamask window provider object
+ * @returns {StarknetWindowObject} the metamask provider wrapper formed into starknet window object
+ */
+const createMetaMaskProviderWrapper = (provider) => {
+    let metaMaskSnapWallet;
+    // using @module-federation to load the get-starknet remoteEntry, as recommended
+    // by the starknet team. this file is a small wrapper around the metamask snap api
+    // to communicate with starknet, which we then wrap into a starknet window object
+    // and use in our starknet connector, just like braavos and argent
+    const initMetaMaskSnapWallet = () => __awaiter(void 0, void 0, void 0, function* () {
+        if (!metaMaskSnapWallet) {
+            moduleFederation.init({
+                name: 'MetaMaskStarknetSnapWallet',
+                remotes: [
+                    {
+                        alias: 'MetaMaskStarknetSnapWallet',
+                        entry: 'https://snaps.consensys.io/starknet/get-starknet/v1/remoteEntry.js',
+                        name: 'MetaMaskStarknetSnapWallet',
+                    },
+                ],
+            });
+            const result = yield moduleFederation.loadRemote('MetaMaskStarknetSnapWallet/index');
+            const { MetaMaskSnapWallet } = result;
+            metaMaskSnapWallet = new MetaMaskSnapWallet(provider, '*');
+        }
+    });
+    const metaMaskProviderWrapper = {
+        get account() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.account;
+        },
+        get chainId() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.chainId;
+        },
+        enable: () => __awaiter(void 0, void 0, void 0, function* () {
+            yield initMetaMaskSnapWallet();
+            if (!metaMaskSnapWallet) {
+                return [];
+            }
+            return metaMaskSnapWallet.enable();
+        }),
+        icon: '',
+        id: 'MetaMaskStarknetSnapWallet',
+        get isConnected() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.isConnected;
+        },
+        isPreauthorized: () => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            yield initMetaMaskSnapWallet();
+            return (_a = (yield (metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.isPreauthorized()))) !== null && _a !== void 0 ? _a : false;
+        }),
+        name: 'MetaMaskStarknetSnapWallet',
+        off: (
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        event, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        handleEvent) => undefined,
+        on: (
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        event, 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        handleEvent) => undefined,
+        get provider() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.provider;
+        },
+        request: (call) => {
+            if (!metaMaskSnapWallet) {
+                throw new Error('Wallet not enabled');
+            }
+            return metaMaskSnapWallet.request(call);
+        },
+        get selectedAddress() {
+            return metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.selectedAddress;
+        },
+        get version() {
+            var _a;
+            return (_a = metaMaskSnapWallet === null || metaMaskSnapWallet === void 0 ? void 0 : metaMaskSnapWallet.version) !== null && _a !== void 0 ? _a : '0.0.0';
+        },
+    };
+    return metaMaskProviderWrapper;
+};
+
+export { createMetaMaskProviderWrapper };

package/src/wallets/metamask.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../_virtual/_tslib.cjs');
+var utils = require('@dynamic-labs/utils');
+var starknetWalletConnector = require('../starknetWalletConnector.cjs');
+var starknetSnap = require('../utils/starknetSnap.cjs');
+
+class MetaMask extends starknetWalletConnector["default"] {
+    constructor(opts) {
+        super('MetaMask Starknet', 'metamask_snap', opts);
+        this.overrideKey = 'metamaskstarknet';
+        this.canSetEventListeners = false;
+        if (!window.starknet_metamask_snap) {
+            const { providers } = utils.Eip6963ProviderSingleton.get();
+            const metamaskProvider = providers.find((p) => ['io.metamask', 'io.metamask.flask'].includes(p.info.rdns));
+            if (metamaskProvider) {
+                window.starknet_metamask_snap = starknetSnap.createMetaMaskProviderWrapper(metamaskProvider.provider);
+            }
+        }
+    }
+    getConnectedAccounts() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = this.getWallet();
+            if (!wallet) {
+                return [];
+            }
+            const isProviderConnected = this.isProviderConnected();
+            const isPreauthorized = yield wallet.isPreauthorized();
+            const shouldReconnect = !isProviderConnected && isPreauthorized;
+            if (shouldReconnect) {
+                yield this.connect();
+            }
+            return wallet.selectedAddress ? [wallet.selectedAddress] : [];
+        });
+    }
+}
+
+exports.MetaMask = MetaMask;

package/src/wallets/metamask.d.ts

@@ -0,0 +1,8 @@
+import { type WalletConnector } from '@dynamic-labs/wallet-connector-core';
+import StarknetProvider from '../starknetWalletConnector';
+export declare class MetaMask extends StarknetProvider implements WalletConnector {
+    overrideKey: string;
+    canSetEventListeners: boolean;
+    constructor(opts: any);
+    getConnectedAccounts(): Promise<string[]>;
+}

package/src/wallets/metamask.js

@@ -0,0 +1,36 @@
+import { __awaiter } from '../../_virtual/_tslib.js';
+import { Eip6963ProviderSingleton } from '@dynamic-labs/utils';
+import StarknetWalletConnector from '../starknetWalletConnector.js';
+import { createMetaMaskProviderWrapper } from '../utils/starknetSnap.js';
+
+class MetaMask extends StarknetWalletConnector {
+    constructor(opts) {
+        super('MetaMask Starknet', 'metamask_snap', opts);
+        this.overrideKey = 'metamaskstarknet';
+        this.canSetEventListeners = false;
+        if (!window.starknet_metamask_snap) {
+            const { providers } = Eip6963ProviderSingleton.get();
+            const metamaskProvider = providers.find((p) => ['io.metamask', 'io.metamask.flask'].includes(p.info.rdns));
+            if (metamaskProvider) {
+                window.starknet_metamask_snap = createMetaMaskProviderWrapper(metamaskProvider.provider);
+            }
+        }
+    }
+    getConnectedAccounts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const wallet = this.getWallet();
+            if (!wallet) {
+                return [];
+            }
+            const isProviderConnected = this.isProviderConnected();
+            const isPreauthorized = yield wallet.isPreauthorized();
+            const shouldReconnect = !isProviderConnected && isPreauthorized;
+            if (shouldReconnect) {
+                yield this.connect();
+            }
+            return wallet.selectedAddress ? [wallet.selectedAddress] : [];
+        });
+    }
+}
+
+export { MetaMask };