@lunch-money/ethereum-to-lunch-money 1.2.0 → 1.3.0

package/dist/cjs/src/client.d.ts

@@ -1,17 +1,18 @@
 import * as ethscan from '@mycrypto/eth-scan';
 import * as ethers from 'ethers';
 export interface EthereumWalletClient {
+    getChainId(): Promise<bigint>;
     getWeiBalance(walletAddress: string): Promise<bigint>;
     getTokensBalance(walletAddress: string, tokenContractAddresses: string[]): Promise<ethscan.BalanceMap<bigint>>;
 }
-export declare const createEthereumWalletClient: (provider: ethers.providers.BaseProvider) => EthereumWalletClient;
+export declare const createEthereumWalletClient: (provider: ethers.AbstractProvider) => EthereumWalletClient;
 interface Token {
     address: string;
     chainId: number;
     name: string;
     symbol: string;
     decimals: number;
-    logoURI: string;
+    logoURI: string | null;
 }
 export declare const loadTokenList: () => Promise<Token[]>;
 export {};

package/dist/cjs/src/client.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -33,22 +37,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadTokenList = exports.createEthereumWalletClient = void 0;
 const ethscan = __importStar(require("@mycrypto/eth-scan"));
-const mem_1 = __importDefault(require("mem"));
 const _1inch_json_1 = __importDefault(require("../fixtures/1inch.json"));
-const createEthereumWalletClient = (provider) => ({
-    getWeiBalance(walletAddress) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield provider.getBalance(walletAddress)).toBigInt();
-        });
-    },
-    getTokensBalance(walletAddress, tokenContractAddresses) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return ethscan.getTokensBalance(provider, walletAddress, tokenContractAddresses);
-        });
-    },
-});
+const createEthereumWalletClient = (provider) => {
+    // A custom ethscan provider implementation is needed to map `call` to `send` for ethscan to use the ethers client correctly.
+    // This is a temporary solution until the ethscan library is updated to support ethers v6.
+    const customProvider = {
+        send(method, params) {
+            // Type pulled from: https://github.com/MyCryptoHQ/eth-scan/blob/master/src/providers/provider.ts#L32
+            const typedParams = params;
+            return provider.call({ to: typedParams[0].to, data: typedParams[0].data });
+        }
+    };
+    return {
+        getChainId() {
+            return __awaiter(this, void 0, void 0, function* () {
+                return (yield provider.getNetwork()).chainId;
+            });
+        },
+        getWeiBalance(walletAddress) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return (yield provider.getBalance(walletAddress));
+            });
+        },
+        getTokensBalance(walletAddress, tokenContractAddresses) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return ethscan.getTokensBalance(customProvider, walletAddress, tokenContractAddresses);
+            });
+        },
+    };
+};
 exports.createEthereumWalletClient = createEthereumWalletClient;
-exports.loadTokenList = mem_1.default(() => __awaiter(void 0, void 0, void 0, function* () {
+const loadTokenList = () => __awaiter(void 0, void 0, void 0, function* () {
     return _1inch_json_1.default.tokens;
-}));
+});
+exports.loadTokenList = loadTokenList;
 //# sourceMappingURL=client.js.map

package/dist/cjs/src/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4DAA8C;AAE9C,8CAAsB;AAEtB,yEAAoD;AAO7C,MAAM,0BAA0B,GAAG,CAAC,QAAuC,EAAwB,EAAE,CAAC,CAAC;IACtG,aAAa,CAAC,aAAa;;YAC/B,OAAO,CAAC,MAAM,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC/D,CAAC;KAAA;IACK,gBAAgB,CAAC,aAAa,EAAE,sBAAsB;;YAC1D,OAAO,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,aAAa,EAAE,sBAAsB,CAAC,CAAC;QACnF,CAAC;KAAA;CACF,CAAC,CAAC;AAPU,QAAA,0BAA0B,8BAOpC;AAWU,QAAA,aAAa,GAAG,aAAG,CAAC,GAA2B,EAAE;IAC5D,OAAO,qBAAc,CAAC,MAAM,CAAC;AAC/B,CAAC,CAAA,CAAC,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4DAA8C;AAG9C,yEAAoD;AAS7C,MAAM,0BAA0B,GAAG,CAAC,QAAiC,EAAwB,EAAE;IAEpG,6HAA6H;IAC7H,0FAA0F;IAC1F,MAAM,cAAc,GAAwB;QAC1C,IAAI,CAAS,MAAc,EAAE,MAA2B;YAEtD,qGAAqG;YACrG,MAAM,WAAW,GAAG,MAA8C,CAAC;YAEnE,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAC,CAAoB,CAAA;QAC7F,CAAC;KACF,CAAA;IAED,OAAO;QACC,UAAU;;gBACd,OAAO,CAAC,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC;YAC/C,CAAC;SAAA;QACK,aAAa,CAAC,aAAa;;gBAC/B,OAAO,CAAC,MAAM,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YACpD,CAAC;SAAA;QACK,gBAAgB,CAAC,aAAa,EAAE,sBAAsB;;gBAC1D,OAAO,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,aAAa,EAAE,sBAAsB,CAAC,CAAC;YACzF,CAAC;SAAA;KACF,CAAC;AACJ,CAAC,CAAC;AAzBW,QAAA,0BAA0B,8BAyBrC;AAWK,MAAM,aAAa,GAAG,GAA2B,EAAE;IACxD,OAAO,qBAAc,CAAC,MAAM,CAAC;AAC/B,CAAC,CAAA,CAAC;AAFW,QAAA,aAAa,iBAExB"}

package/dist/cjs/src/main.d.ts

@@ -1,7 +1,6 @@
-import { LunchMoneyCryptoConnection, LunchMoneyCryptoConnectionContext, LunchMoneyCryptoConnectionConfig } from './types.js';
+import type { LunchMoneyCryptoConnection, LunchMoneyCryptoConnectionContext, LunchMoneyCryptoConnectionConfig } from './types.js';
 import { EthereumWalletClient } from './client.js';
-export { LunchMoneyCryptoConnection } from './types.js';
-export { createEthereumWalletClient, EthereumWalletClient } from './client.js';
+export { createEthereumWalletClient } from './client.js';
 interface LunchMoneyEthereumWalletConnectionConfig extends LunchMoneyCryptoConnectionConfig {
     /** The unique ID of the user's wallet address on the blockchain. */
     walletAddress: string;

package/dist/cjs/src/main.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -45,19 +49,27 @@ exports.LunchMoneyEthereumWalletConnection = {
     getBalances({ walletAddress, negligibleBalanceThreshold = NEGLIGIBLE_BALANCE_THRESHOLD }, { client }) {
         return __awaiter(this, void 0, void 0, function* () {
             const weiBalance = yield client.getWeiBalance(walletAddress);
-            const tokenList = yield client_js_1.loadTokenList();
-            const map = yield client.getTokensBalance(walletAddress, tokenList.map((t) => t.address));
-            const balances = tokenList
-                .map((t) => {
-                var _a;
-                return ({
-                    asset: t.symbol,
-                    amount: (_a = map[t.address]) !== null && _a !== void 0 ? _a : 0,
-                });
+            // Filter out tokens that are not on mainnet
+            const chainId = yield client.getChainId();
+            const chainFilteredTokensList = (yield (0, client_js_1.loadTokenList)()).filter((t) => BigInt(t.chainId) === BigInt(chainId));
+            const map = yield client.getTokensBalance(walletAddress, chainFilteredTokensList.map((t) => t.address));
+            const balances = Object.entries(map)
+                .map(([address, balance]) => {
+                const token = chainFilteredTokensList.find((t) => t.address === address);
+                if (!token) {
+                    throw new Error(`Token ${address} not found in filtered token list for chainId ${chainId}`);
+                }
+                return {
+                    asset: token.symbol,
+                    undivisedAmount: balance,
+                    decimals: token.decimals,
+                };
             })
-                .concat({ asset: 'ETH', amount: weiBalance })
-                .filter((b) => b.amount > negligibleBalanceThreshold)
-                .map(({ asset, amount }) => ({ asset, amount: ethers.utils.formatEther(amount) }))
+                .concat({ asset: 'ETH', undivisedAmount: weiBalance, decimals: 18 })
+                .map(({ asset, undivisedAmount, decimals }) => ({ asset, amount: ethers.formatUnits(undivisedAmount, decimals) }))
+                // Normalize the amount to 18 decimal places (for the wei per eth standard) for filtering out negligible balances
+                .filter((b) => ethers.parseUnits(b.amount, 18) > negligibleBalanceThreshold)
+                .map((b) => ({ asset: b.asset, amount: String(b.amount) }))
                 .sort((a, b) => a.asset.localeCompare(b.asset));
             return {
                 providerName: 'wallet_ethereum',

package/dist/cjs/src/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,2CAAkE;AAClE,+CAAiC;AAGjC,yCAA+E;AAAtE,uHAAA,0BAA0B,OAAA;AAEnC;4CAC4C;AAC5C,MAAM,4BAA4B,GAAG,IAAI,CAAC;AAY7B,QAAA,kCAAkC,GAG3C;IACI,QAAQ,CAAC,MAAM,EAAE,OAAO;;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;KAAA;IACK,WAAW,CAAC,EAAE,aAAa,EAAE,0BAA0B,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE;;YACxG,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAE7D,MAAM,SAAS,GAAG,MAAM,yBAAa,EAAE,CAAC;YACxC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,gBAAgB,CACvC,aAAa,EACb,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAChC,CAAC;YAEF,MAAM,QAAQ,GAAG,SAAS;iBACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;;gBAAC,OAAA,CAAC;oBACX,KAAK,EAAE,CAAC,CAAC,MAAM;oBACf,MAAM,EAAE,MAAA,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,mCAAI,CAAC;iBAC5B,CAAC,CAAA;aAAA,CAAC;iBACF,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;iBAC5C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,0BAA0B,CAAC;iBACpD,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;iBACjF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAElD,OAAO;gBACL,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ;aACT,CAAC;QACJ,CAAC;KAAA;CACF,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,2CAAkE;AAClE,+CAAiC;AAEjC,yCAAyD;AAAhD,uHAAA,0BAA0B,OAAA;AAEnC;4CAC4C;AAC5C,MAAM,4BAA4B,GAAG,IAAI,CAAC;AAY7B,QAAA,kCAAkC,GAG3C;IACI,QAAQ,CAAC,MAAM,EAAE,OAAO;;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;KAAA;IACK,WAAW,CAAC,EAAE,aAAa,EAAE,0BAA0B,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE;;YACxG,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAE7D,4CAA4C;YAC5C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;YAC1C,MAAM,uBAAuB,GAAG,CAAC,MAAM,IAAA,yBAAa,GAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAE7G,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,gBAAgB,CACvC,aAAa,EACb,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAC9C,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;iBACjC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC1B,MAAM,KAAK,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;gBAEzE,IAAI,CAAC,KAAK,EAAE;oBACV,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,iDAAiD,OAAO,EAAE,CAAC,CAAC;iBAC7F;gBAED,OAAO;oBACL,KAAK,EAAE,KAAK,CAAC,MAAM;oBACnB,eAAe,EAAE,OAAO;oBACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;iBACzB,CAAC;YACJ,CAAC,CAAC;iBACD,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;iBACnE,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAClH,iHAAiH;iBAChH,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,0BAA0B,CAAC;iBAC3E,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;iBAC1D,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAElD,OAAO;gBACL,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ;aACT,CAAC;QACJ,CAAC;KAAA;CACF,CAAC"}

package/dist/cjs/src/types.d.ts

@@ -1,22 +1,22 @@
 /**
  * Serializable configuration for the connection
  */
-export declare type LunchMoneyCryptoConnectionConfig = {};
+export type LunchMoneyCryptoConnectionConfig = {};
 /**
  * Non-serializable injected dependencies for the connection
  */
-export declare type LunchMoneyCryptoConnectionContext = {};
+export type LunchMoneyCryptoConnectionContext = {};
 export interface CryptoBalance {
     asset: string;
     amount: string;
 }
 export declare const providerNames: readonly ["coinbase", "coinbase_pro", "kraken", "binance", "wallet_ethereum"];
-export declare type ProviderName = typeof providerNames[number];
+export type ProviderName = typeof providerNames[number];
 export interface LunchMoneyCryptoConnectionBalances {
     providerName: ProviderName;
     balances: CryptoBalance[];
 }
-export declare type LunchMoneyCryptoConnectionInitialization = LunchMoneyCryptoConnectionBalances;
+export type LunchMoneyCryptoConnectionInitialization = LunchMoneyCryptoConnectionBalances;
 export interface LunchMoneyCryptoConnection<TConfig extends LunchMoneyCryptoConnectionConfig, TContext extends LunchMoneyCryptoConnectionContext> {
     initiate(config: TConfig, context: TContext): Promise<LunchMoneyCryptoConnectionInitialization>;
     getBalances(config: TConfig, context: TContext): Promise<LunchMoneyCryptoConnectionBalances>;