@dynamic-labs/starknet 0.19.0-alpha.1 → 0.19.0-alpha.10

package/src/starknetWalletConnector.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var _tslib = require('../_virtual/_tslib.cjs');
 var getStarknetCore = require('get-starknet-core');
 var starknet = require('starknet');
@@ -9,203 +11,213 @@ var constants = require('./constants.cjs');
 var ethereumContractAbi = require('./ethereumContractAbi.cjs');
 var convertors = require('./utils/convertors.cjs');
 
-const ACCOUNT_CHANGED_EVENT_LISTENER = 'accountsChanged';
-const NETWORK_CHANGED_EVENT_LISTENER = 'networkChanged';
-class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
-    constructor(name, windowKey, starknetNetworks) {
-        super();
-        this.connectedChain = 'STARK';
-        this.supportedChains = ['STARK'];
-        this.switchNetworkOnlyFromWallet = true;
-        this.name = name;
-        this.windowKey = windowKey;
-        this.starknetNetworks = starknetNetworks;
-    }
-    getRpcProvider() {
-        var _a, _b;
-        const nodeUrl = (_b = (_a = this.starknetNetworks) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.rpcUrls[0];
-        if (!nodeUrl) {
-            throw new utils.DynamicError('RPC URL has not been found.');
-        }
-        return Promise.resolve(new starknet.RpcProvider({ nodeUrl }));
-    }
-    /**
-     * returns stakrnet wallet network id
-     */
-    getNetwork() {
-        var _a;
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            if (!wallet) {
-                return Promise.resolve(undefined);
-            }
-            if (!wallet.isConnected) {
-                yield wallet.enable();
-            }
-            return Promise.resolve((_a = wallet.provider) === null || _a === void 0 ? void 0 : _a.chainId);
-        });
-    }
-    connect() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            try {
-                if (wallet && !wallet.isConnected) {
-                    yield wallet.enable();
-                }
-            }
-            catch (err) {
-                walletConnectorCore.logger.error(err);
-            }
-        });
-    }
-    fetchPublicAddress() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            /**
-             * Fetches public address. Uses `isPreauthorized` as a temporary solution to ensure
-             * the wallets store's data is read. Without it, an empty string may be returned due
-             * to a possible reliance on its side-effects for data refreshing.
-             */
-            yield (wallet === null || wallet === void 0 ? void 0 : wallet.isPreauthorized());
-            yield this.connect();
-            return Promise.resolve(wallet === null || wallet === void 0 ? void 0 : wallet.selectedAddress);
-        });
-    }
-    getSigner() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            return wallet === null || wallet === void 0 ? void 0 : wallet.account;
-        });
-    }
-    getWallet() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            if (!this.wallet) {
-                const providers = yield getStarknetCore.getStarknet().getAvailableWallets();
-                this.wallet = providers.find((provider) => provider.name === this.name);
-            }
-            return this.wallet;
-        });
-    }
-    getWeb3Provider() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            return wallet === null || wallet === void 0 ? void 0 : wallet.provider;
-        });
-    }
-    signMessage(messageToSign) {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            const walletAddress = yield this.fetchPublicAddress();
-            if (!walletAddress || !wallet) {
-                walletConnectorCore.logger.error('Could not fetch wallet address for signing message');
-                return undefined;
-            }
-            const { provider: { chainId }, } = wallet;
-            const encodedMessage = convertors.formatTypedDataMessage(messageToSign, chainId);
-            const signature = yield wallet.account.signMessage(encodedMessage);
-            return signature === null || signature === void 0 ? void 0 : signature.join(',');
-        });
-    }
-    getBalance() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const walletAddress = yield this.fetchPublicAddress();
-            const provider = yield this.getWeb3Provider();
-            if (!walletAddress || !provider) {
-                walletConnectorCore.logger.error('Could not fetch wallet address for getting balance');
-                return undefined;
-            }
-            const contract = new starknet.Contract(ethereumContractAbi, constants.ETH_STARKNET_ADDRESS, provider);
-            try {
-                const { balance } = yield contract.balanceOf(walletAddress);
-                const gweiBalance = parseInt(starknet.uint256.uint256ToBN(balance).toString(10));
-                /**
-                 * Dividing by 1e18 as the returned balance is a Gwei number.
-                 * Read more here: https://www.investopedia.com/terms/g/gwei-ethereum.asp#toc-what-is-gwei
-                 */
-                return (gweiBalance / 1e18).toFixed(6);
-            }
-            catch (error) {
-                throw new utils.DynamicError('Something went wrong');
-            }
-        });
-    }
-    endSession() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            getStarknetCore.getStarknet().disconnect({ clearLastWallet: true });
-        });
-    }
-    getStarknetWindowObject() {
-        const starknetWindowInstance = window[`starknet_${this.windowKey}`] || window['starknet'];
-        if ((starknetWindowInstance === null || starknetWindowInstance === void 0 ? void 0 : starknetWindowInstance.name) === this.name) {
-            return starknetWindowInstance;
-        }
-        else {
-            return undefined;
-        }
-    }
-    isInstalledOnBrowser() {
-        var _a;
-        const starknetWindowInstance = (_a = window[`starknet_${this.windowKey}`]) !== null && _a !== void 0 ? _a : window['starknet'];
-        return (starknetWindowInstance === null || starknetWindowInstance === void 0 ? void 0 : starknetWindowInstance.name) === this.name;
-    }
-    getConnectedAccounts() {
-        var _a;
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            return ((_a = wallet === null || wallet === void 0 ? void 0 : wallet.account) === null || _a === void 0 ? void 0 : _a.address) ? [wallet.account.address] : [];
-        });
-    }
-    setupEventListeners(listeners) {
-        const wallet = this.getStarknetWindowObject();
-        if (!wallet) {
-            return walletConnectorCore.logger.error('Wallet has not been found');
-        }
-        this.handleAccountChange = (address) => _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            if (!address) {
-                yield ((_a = listeners.onDisconnect) === null || _a === void 0 ? void 0 : _a.call(listeners));
-                return;
-            }
-            if (address.toString()) {
-                yield ((_b = listeners.onAccountChange) === null || _b === void 0 ? void 0 : _b.call(listeners, [address.toString()]));
-            }
-        });
-        this.handleNetworkChange = (network) => _tslib.__awaiter(this, void 0, void 0, function* () {
-            var _c, _d;
-            if (!network) {
-                yield ((_c = listeners.onDisconnect) === null || _c === void 0 ? void 0 : _c.call(listeners));
-                return;
-            }
-            const chainId = this.mapChainUrlToChainId(network.toString());
-            if (chainId) {
-                yield ((_d = listeners.onChainChange) === null || _d === void 0 ? void 0 : _d.call(listeners, chainId));
-            }
-        });
-        wallet === null || wallet === void 0 ? void 0 : wallet.on(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);
-        wallet === null || wallet === void 0 ? void 0 : wallet.on(NETWORK_CHANGED_EVENT_LISTENER, this.handleNetworkChange);
-    }
-    teardownEventListeners() {
-        return _tslib.__awaiter(this, void 0, void 0, function* () {
-            const wallet = yield this.getWallet();
-            if (this.handleAccountChange) {
-                wallet === null || wallet === void 0 ? void 0 : wallet.off(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);
-                this.handleAccountChange = undefined;
-            }
-            if (this.handleNetworkChange) {
-                wallet === null || wallet === void 0 ? void 0 : wallet.off(NETWORK_CHANGED_EVENT_LISTENER, this.handleNetworkChange);
-                this.handleNetworkChange = undefined;
-            }
-        });
-    }
-    mapChainUrlToChainId(baseUrl) {
-        if (baseUrl.includes('mainnet')) {
-            return starknet.constants.StarknetChainId.SN_MAIN;
-        }
-        else if (baseUrl.includes('goerli')) {
-            return starknet.constants.StarknetChainId.SN_GOERLI;
-        }
-        return undefined;
-    }
+const ACCOUNT_CHANGED_EVENT_LISTENER = 'accountsChanged';
+const NETWORK_CHANGED_EVENT_LISTENER = 'networkChanged';
+const STARKNET_VERSION = 'v5';
+class StarknetWalletConnector extends walletConnectorCore.WalletConnectorBase {
+    constructor(name, windowKey, opts) {
+        super(opts);
+        this.connectedChain = 'STARK';
+        this.supportedChains = ['STARK'];
+        this.switchNetworkOnlyFromWallet = true;
+        this.name = name;
+        this.windowKey = windowKey;
+        this.starknetNetworks = opts.starknetNetworks;
+    }
+    getRpcProvider() {
+        var _a, _b;
+        const nodeUrl = (_b = (_a = this.starknetNetworks) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.rpcUrls[0];
+        if (!nodeUrl) {
+            throw new utils.DynamicError('RPC URL has not been found.');
+        }
+        return Promise.resolve(new starknet.RpcProvider({ nodeUrl }));
+    }
+    /**
+     * returns stakrnet wallet network id
+     */
+    getNetwork() {
+        var _a;
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            if (!wallet) {
+                return Promise.resolve(undefined);
+            }
+            if (!wallet.isConnected) {
+                yield wallet.enable({ starknetVersion: STARKNET_VERSION });
+            }
+            return Promise.resolve((_a = wallet.provider) === null || _a === void 0 ? void 0 : _a.getChainId());
+        });
+    }
+    connect() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            try {
+                if (wallet && !wallet.isConnected) {
+                    yield wallet.enable({ starknetVersion: STARKNET_VERSION });
+                }
+            }
+            catch (err) {
+                walletConnectorCore.logger.error(err);
+            }
+        });
+    }
+    fetchPublicAddress() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            /**
+             * Fetches public address. Uses `isPreauthorized` as a temporary solution to ensure
+             * the wallets store's data is read. Without it, an empty string may be returned due
+             * to a possible reliance on its side-effects for data refreshing.
+             */
+            yield (wallet === null || wallet === void 0 ? void 0 : wallet.isPreauthorized());
+            yield this.connect();
+            return Promise.resolve(wallet === null || wallet === void 0 ? void 0 : wallet.selectedAddress);
+        });
+    }
+    getSigner() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            return wallet === null || wallet === void 0 ? void 0 : wallet.account;
+        });
+    }
+    getWallet() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!this.wallet) {
+                const providers = yield getStarknetCore.getStarknet().getAvailableWallets();
+                this.wallet = providers.find((provider) => provider.name === this.name);
+            }
+            return this.wallet;
+        });
+    }
+    getWeb3Provider() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            return wallet === null || wallet === void 0 ? void 0 : wallet.provider;
+        });
+    }
+    signMessage(messageToSign) {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            const walletAddress = yield this.fetchPublicAddress();
+            if (!walletAddress || !wallet) {
+                walletConnectorCore.logger.error('Could not fetch wallet address for signing message');
+                return undefined;
+            }
+            const encodedMessage = convertors.formatTypedDataMessage(messageToSign, (yield wallet.provider.getChainId()));
+            const signature = yield wallet.account.signMessage(encodedMessage);
+            return signature === null || signature === void 0 ? void 0 : signature.join(',');
+        });
+    }
+    getBalance() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const walletAddress = yield this.fetchPublicAddress();
+            const provider = yield this.getWeb3Provider();
+            if (!walletAddress || !provider) {
+                walletConnectorCore.logger.error('Could not fetch wallet address for getting balance');
+                return undefined;
+            }
+            const contract = new starknet.Contract(ethereumContractAbi, constants.ETH_STARKNET_ADDRESS, provider);
+            try {
+                const { balance } = yield contract.balanceOf(walletAddress);
+                /**
+                 * Dividing by 1e18 as the returned balance is a Gwei number.
+                 * Read more here: https://www.investopedia.com/terms/g/gwei-ethereum.asp#toc-what-is-gwei
+                 */
+                return (Number(starknet.cairo.uint256(balance.low).low) / 1e18).toFixed(6);
+            }
+            catch (error) {
+                throw new utils.DynamicError('Something went wrong');
+            }
+        });
+    }
+    endSession() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            getStarknetCore.getStarknet().disconnect({ clearLastWallet: true });
+        });
+    }
+    getStarknetWindowObject() {
+        const starknetWindowInstance = window[`starknet_${this.windowKey}`] || window['starknet'];
+        if ((starknetWindowInstance === null || starknetWindowInstance === void 0 ? void 0 : starknetWindowInstance.name) === this.name) {
+            return starknetWindowInstance;
+        }
+        else {
+            return undefined;
+        }
+    }
+    isInstalledOnBrowser() {
+        var _a;
+        const starknetWindowInstance = (_a = window[`starknet_${this.windowKey}`]) !== null && _a !== void 0 ? _a : window['starknet'];
+        return (starknetWindowInstance === null || starknetWindowInstance === void 0 ? void 0 : starknetWindowInstance.name) === this.name;
+    }
+    getConnectedAccounts() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            if (!wallet) {
+                return [];
+            }
+            const needsReconnection = !wallet.isConnected && (yield wallet.isPreauthorized());
+            if (needsReconnection) {
+                yield this.connect();
+            }
+            return wallet.selectedAddress ? [wallet.selectedAddress] : [];
+        });
+    }
+    setupEventListeners() {
+        const wallet = this.getStarknetWindowObject();
+        if (!wallet) {
+            return walletConnectorCore.logger.error('Wallet has not been found');
+        }
+        this.handleAccountChange = (address) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!(yield wallet.isPreauthorized()) && !address) {
+                this.emit('disconnect');
+                return;
+            }
+            // this is the case where the wallet emits an empty account change event
+            // when the user is simply switching network
+            if (!address) {
+                return;
+            }
+            if (address.toString()) {
+                this.emit('accountChange', { accounts: [address.toString()] });
+            }
+        });
+        this.handleNetworkChange = (network) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!network) {
+                this.emit('disconnect');
+                return;
+            }
+            const chain = this.mapChainUrlToChainId(network.toString());
+            if (chain) {
+                this.emit('chainChange', { chain });
+            }
+        });
+        wallet === null || wallet === void 0 ? void 0 : wallet.on(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);
+        wallet === null || wallet === void 0 ? void 0 : wallet.on(NETWORK_CHANGED_EVENT_LISTENER, this.handleNetworkChange);
+    }
+    teardownEventListeners() {
+        return _tslib.__awaiter(this, void 0, void 0, function* () {
+            const wallet = yield this.getWallet();
+            if (this.handleAccountChange) {
+                wallet === null || wallet === void 0 ? void 0 : wallet.off(ACCOUNT_CHANGED_EVENT_LISTENER, this.handleAccountChange);
+                this.handleAccountChange = undefined;
+            }
+            if (this.handleNetworkChange) {
+                wallet === null || wallet === void 0 ? void 0 : wallet.off(NETWORK_CHANGED_EVENT_LISTENER, this.handleNetworkChange);
+                this.handleNetworkChange = undefined;
+            }
+        });
+    }
+    mapChainUrlToChainId(baseUrl) {
+        if (baseUrl.includes('mainnet')) {
+            return starknet.constants.StarknetChainId.SN_MAIN;
+        }
+        else if (baseUrl.includes('goerli')) {
+            return starknet.constants.StarknetChainId.SN_GOERLI;
+        }
+        return undefined;
+    }
 }
 
-module.exports = StarknetWalletConnector;
+exports.ACCOUNT_CHANGED_EVENT_LISTENER = ACCOUNT_CHANGED_EVENT_LISTENER;
+exports.NETWORK_CHANGED_EVENT_LISTENER = NETWORK_CHANGED_EVENT_LISTENER;
+exports["default"] = StarknetWalletConnector;

package/src/starknetWalletConnector.d.ts

@@ -1,44 +1,50 @@
-import { StarknetWindowObject } from 'get-starknet-core';
-import { ProviderInterface, constants, AccountInterface, RpcProvider } from 'starknet';
-import { Chain, WalletConnectorBase, WalletEventListeners } from '@dynamic-labs/wallet-connector-core';
-import { NetworkConfiguration } from '@dynamic-labs/sdk-api';
-import { StarknetWalletKey } from './types';
-type AccountChangeEventHandler = (address: {
-    toString(): string;
-}) => Promise<void>;
-type NetworkChangeEventHandler = (network: {
-    toString(): string;
-}) => Promise<void>;
-declare abstract class StarknetWalletConnector extends WalletConnectorBase {
-    name: string;
-    windowKey: StarknetWalletKey;
-    connectedChain: Chain;
-    supportedChains: Chain[];
-    wallet: StarknetWindowObject | undefined;
-    handleAccountChange: AccountChangeEventHandler | undefined;
-    handleNetworkChange: NetworkChangeEventHandler | undefined;
-    switchNetworkOnlyFromWallet: boolean;
-    starknetNetworks: NetworkConfiguration[];
-    constructor(name: string, windowKey: StarknetWalletKey, starknetNetworks: NetworkConfiguration[]);
-    getRpcProvider(): Promise<RpcProvider>;
-    /**
-     * returns stakrnet wallet network id
-     */
-    getNetwork(): Promise<any>;
-    connect(): Promise<void>;
-    fetchPublicAddress(): Promise<string | undefined>;
-    getSigner(): Promise<AccountInterface | undefined>;
-    getWallet(): Promise<StarknetWindowObject | undefined>;
-    getWeb3Provider(): Promise<ProviderInterface | undefined>;
-    signMessage(messageToSign: string): Promise<string | undefined>;
-    getBalance(): Promise<string | undefined>;
-    endSession(): Promise<void>;
-    getStarknetWindowObject(): StarknetWindowObject | undefined;
-    isInstalledOnBrowser(): boolean;
-    getConnectedAccounts(): Promise<string[]>;
-    setupEventListeners(listeners: WalletEventListeners): void;
-    teardownEventListeners(): Promise<void>;
-    mapChainUrlToChainId(baseUrl: string): constants.StarknetChainId | undefined;
-}
-export type StarknetWalletConnectorType = StarknetWalletConnector;
-export default StarknetWalletConnector;
+import { StarknetWindowObject } from 'get-starknet-core';
+import { ProviderInterface, constants, AccountInterface, RpcProvider } from 'starknet';
+import { Chain, WalletConnectorBase } from '@dynamic-labs/wallet-connector-core';
+import { NetworkConfiguration } from '@dynamic-labs/sdk-api';
+import { WalletBookSchema } from '@dynamic-labs/wallet-book';
+import { StarknetWalletKey } from './types';
+type AccountChangeEventHandler = (address: {
+    toString(): string;
+}) => Promise<void>;
+type NetworkChangeEventHandler = (network: {
+    toString(): string;
+}) => Promise<void>;
+export declare const ACCOUNT_CHANGED_EVENT_LISTENER = "accountsChanged";
+export declare const NETWORK_CHANGED_EVENT_LISTENER = "networkChanged";
+declare abstract class StarknetWalletConnector extends WalletConnectorBase {
+    name: string;
+    windowKey: StarknetWalletKey;
+    connectedChain: Chain;
+    supportedChains: Chain[];
+    wallet: StarknetWindowObject | undefined;
+    handleAccountChange: AccountChangeEventHandler | undefined;
+    handleNetworkChange: NetworkChangeEventHandler | undefined;
+    switchNetworkOnlyFromWallet: boolean;
+    starknetNetworks: NetworkConfiguration[];
+    constructor(name: string, windowKey: StarknetWalletKey, opts: {
+        starknetNetworks: NetworkConfiguration[];
+        walletBook: WalletBookSchema;
+    });
+    getRpcProvider(): Promise<RpcProvider>;
+    /**
+     * returns stakrnet wallet network id
+     */
+    getNetwork(): Promise<any>;
+    connect(): Promise<void>;
+    fetchPublicAddress(): Promise<string | undefined>;
+    getSigner(): Promise<AccountInterface | undefined>;
+    getWallet(): Promise<StarknetWindowObject | undefined>;
+    getWeb3Provider(): Promise<ProviderInterface | undefined>;
+    signMessage(messageToSign: string): Promise<string | undefined>;
+    getBalance(): Promise<string | undefined>;
+    endSession(): Promise<void>;
+    getStarknetWindowObject(): StarknetWindowObject | undefined;
+    isInstalledOnBrowser(): boolean;
+    getConnectedAccounts(): Promise<string[]>;
+    setupEventListeners(): void;
+    teardownEventListeners(): Promise<void>;
+    mapChainUrlToChainId(baseUrl: string): constants.StarknetChainId | undefined;
+}
+export type StarknetWalletConnectorType = StarknetWalletConnector;
+export default StarknetWalletConnector;