@exodus/web3-ethereum 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# @exodus/web3-ethereum
+
+Apps connectivity library for Ethereum and EVM-compatible chains.
+
+## Usage
+
+```js
+const EventEmitter = require('events')
+
+// Separate entry points are supported
+const { EthereumProvider } = require('@exodus/web3-ethereum/provider')
+const { registerRPCHandlers } = require('@exodus/web3-ethereum/rpc')
+
+// Create transport.
+const transport = new EventEmitter()
+transport.write = (data) => {
+  setTimeout(() => {
+    transport.emit('data', data)
+  })
+}
+
+// Create Exodus global API.
+const accountsObservable = new Observable()
+const storage = new Storage()
+const supportedChainIDs = ['0x1']
+const exodus = {
+  ethereum: new EthereumProvider({
+    accountsObservable,
+    storage,
+    supportedChainIDs,
+    transport,
+  }),
+}
+
+// Inject the Exodus object into the app.
+window.exodus = exodus
+
+// Register RPC handlers for requests the Provider can call.
+registerRPCHandlers({
+  transport,
+  deps: {}, // required deps
+})
+```

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/simulation/constant.d.ts

@@ -0,0 +1,5 @@
+import type { EVMConstants } from './types.js';
+export declare const CHAIN_IDS: {
+    [key: string]: number;
+};
+export declare const ENABLED_EVMS: EVMConstants[];

package/lib/simulation/constant.js

@@ -0,0 +1,32 @@
+export const CHAIN_IDS = {
+    avalanchec: 43114,
+    bsc: 56,
+    ethereum: 1,
+    ethereumclassic: 61,
+    ethereumgoerli: 5,
+    fantommainnet: 250,
+    harmonymainnet: 1666600000,
+    matic: 137,
+};
+export const ENABLED_EVMS = [
+    {
+        assetName: 'ethereum',
+        shouldSimulate: true,
+    },
+    {
+        assetName: 'matic',
+        shouldSimulate: false,
+    },
+    {
+        assetName: 'bsc',
+        shouldSimulate: false,
+    },
+    {
+        assetName: 'avalanchec',
+        shouldSimulate: false,
+    },
+    {
+        assetName: 'fantommainnet',
+        shouldSimulate: false,
+    },
+];

package/lib/simulation/index.d.ts

@@ -0,0 +1,16 @@
+import type { EthTransaction } from '@exodus/web3-ethereum-utils';
+import type { Asset, EthBalanceChanges } from './types.js';
+export declare const simulateTransaction: (assets: Record<string, Asset>, transaction: EthTransaction, network: string) => Promise<{
+    assetName: string;
+    advancedDetails: never[];
+    balanceChanges: EthBalanceChanges;
+    displayInfo: {
+        title: string;
+    };
+    txFee: unknown;
+    txFeeDetails: {
+        gasLimit: number;
+        maxFeePerGas: number | undefined;
+        gasPrice: number;
+    };
+}>;

package/lib/simulation/index.js

@@ -0,0 +1,70 @@
+import { retrieveSideEffects } from '@exodus/ethereum-api';
+import { createCurrency, formatAccounts, getEthereumDisplayInfo, supportedNetworkEvms, hexToBN, isEthTransferTx, } from './utils.js';
+const computeBalanceChanges = async (asset, shouldSimulate, transaction) => {
+    const assetName = asset.name;
+    let balanceChanges = {
+        willReceive: [],
+        willSend: [],
+        willApprove: [],
+    };
+    if (isEthTransferTx(transaction)) {
+        const txValue = hexToBN(transaction.value).toString();
+        balanceChanges.willSend.push({
+            balance: createCurrency({
+                amount: txValue,
+                denominator: asset.currency.defaultUnit.power,
+                symbol: asset.displayTicker,
+            }),
+        });
+    }
+    else {
+        try {
+            const sideEffect = await retrieveSideEffects({
+                assetName,
+                shouldSimulate,
+                transaction,
+            });
+            if (sideEffect) {
+                balanceChanges = formatAccounts(sideEffect);
+            }
+        }
+        catch (error) {
+            console.error('Ethereum transaction simulation failed.', error);
+        }
+    }
+    return balanceChanges;
+};
+const getTxFeeDetails = (asset, transaction) => {
+    const maxFeePerGasBn = transaction.maxFeePerGas
+        ? hexToBN(transaction.maxFeePerGas)
+        : undefined;
+    const gasPriceBn = hexToBN(transaction.gasPrice);
+    const gasBn = hexToBN(transaction.gas);
+    return {
+        txFee: asset.currency.baseUnit(gasBn.mul(maxFeePerGasBn || gasPriceBn).toString()),
+        txFeeDetails: {
+            gasLimit: gasBn.toNumber(),
+            maxFeePerGas: maxFeePerGasBn?.toNumber(),
+            gasPrice: gasPriceBn.toNumber(),
+        },
+    };
+};
+export const simulateTransaction = async (assets, transaction, network) => {
+    const evm = supportedNetworkEvms.get(network);
+    if (!evm) {
+        throw new Error(`unsupported network, ${network}`);
+    }
+    const { assetName, shouldSimulate } = evm;
+    const asset = assets[assetName];
+    const balanceChanges = await computeBalanceChanges(asset, shouldSimulate, transaction);
+    const { txFee, txFeeDetails } = getTxFeeDetails(asset, transaction);
+    const displayInfo = getEthereumDisplayInfo(balanceChanges);
+    return {
+        assetName,
+        advancedDetails: [],
+        balanceChanges,
+        displayInfo,
+        txFee,
+        txFeeDetails,
+    };
+};

package/lib/simulation/types.d.ts

@@ -0,0 +1,36 @@
+export interface EVMConstants {
+    assetName: string;
+    shouldSimulate: boolean;
+}
+export interface CurrencyParams {
+    amount: string;
+    symbol: string;
+    denominator: number;
+}
+export interface Asset {
+    name: string;
+    displayTicker: string;
+    currency: {
+        defaultUnit: {
+            power: number;
+        };
+        baseUnit: (args: unknown) => unknown;
+    };
+}
+export interface EthBalanceChanges {
+    willReceive: Array<EthBalanceChange>;
+    willSend: Array<EthBalanceChange>;
+    willApprove: Array<EthBalanceChange>;
+}
+export interface EthBalanceChange {
+    unitName?: string;
+    balance: EthNumberUnit;
+}
+export interface EthNumberUnit {
+    unitName: string;
+}
+export interface EthAccount {
+    balance: number;
+    symbol: string;
+    decimal: number;
+}

package/lib/simulation/types.js

@@ -0,0 +1 @@
+export {};

package/lib/simulation/utils.d.ts

@@ -0,0 +1,24 @@
+import BN from 'bn.js';
+import type { CurrencyParams, EthBalanceChange, EthBalanceChanges } from './types.js';
+import type { EthTransaction } from '@exodus/web3-ethereum-utils';
+export declare const hexToBN: (hexValue?: string) => BN;
+export declare const supportedNetworkEvms: Map<string, {
+    chainId: string;
+    network: string;
+    assetName: string;
+    shouldSimulate: boolean;
+}>;
+export declare const isEthTransferTx: (transaction: EthTransaction) => boolean;
+export declare function getEthereumDisplayInfo(balanceChanges: EthBalanceChanges): {
+    title: string;
+};
+export declare const createCurrency: ({ amount, symbol, denominator, }: CurrencyParams) => any;
+export declare const formatAccounts: ({ willSend, willReceive, willApprove, }: {
+    willSend?: never[] | undefined;
+    willReceive?: never[] | undefined;
+    willApprove?: never[] | undefined;
+}) => {
+    willSend: EthBalanceChange[];
+    willReceive: EthBalanceChange[];
+    willApprove: never[];
+};

package/lib/simulation/utils.js

@@ -0,0 +1,44 @@
+import { UnitType } from '@exodus/currency';
+import BN from 'bn.js';
+import { CHAIN_IDS, ENABLED_EVMS } from './constant.js';
+export const hexToBN = (hexValue) => new BN((hexValue || '').slice(2), 'hex');
+const getEvmNetwork = (chainId) => `evm:${chainId}`;
+export const supportedNetworkEvms = new Map(ENABLED_EVMS.map((constant) => {
+    const chainId = '0x' + CHAIN_IDS[constant.assetName].toString(16);
+    const network = getEvmNetwork(chainId);
+    return [network, { ...constant, chainId, network }];
+}));
+export const isEthTransferTx = (transaction) => {
+    return (['0x', null, undefined].includes(transaction.data) &&
+        [undefined, '0x5208'].includes(transaction.gas));
+};
+export function getEthereumDisplayInfo(balanceChanges) {
+    let title = 'Approve Transaction?';
+    const isApproveTransaction = balanceChanges.willApprove.length;
+    if (isApproveTransaction) {
+        const tokenName = balanceChanges.willApprove[0].unitName;
+        title = `Approve ${tokenName} Transactions?`;
+    }
+    return { title };
+}
+export const createCurrency = ({ amount, symbol, denominator, }) => UnitType.create({
+    base: 0,
+    [symbol]: denominator,
+}).base(amount);
+const convertToNumberUnit = (account) => ({
+    ...account,
+    balance: createCurrency({
+        amount: new BN(account.balance).abs().toString(),
+        symbol: account.symbol,
+        denominator: account.decimal,
+    }),
+});
+export const formatAccounts = ({ willSend = [], willReceive = [], willApprove = [], }) => {
+    const newWillSend = willSend.map(convertToNumberUnit);
+    const newWillReceive = willReceive.map(convertToNumberUnit);
+    return {
+        willSend: newWillSend,
+        willReceive: newWillReceive,
+        willApprove,
+    };
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@exodus/web3-ethereum",
+  "description": "Apps connectivity library for EVM-compatible chains.",
+  "version": "0.1.0",
+  "type": "module",
+  "sideEffects": false,
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js",
+    "./package.json": "./package.json",
+    "./provider": "./lib/provider/index.js",
+    "./rpc": "./lib/rpc-handlers/index.js",
+    "./utils": "./lib/rpc-handlers/index.js"
+  },
+  "react-native": "./lib/index.js",
+  "files": [
+    "lib/**/*.d.ts",
+    "lib/**/*.mjs",
+    "lib/**/*.js"
+  ],
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "repository": "https://github.com/ExodusMovement/exodus-web3/tree/master/packages/ethereum",
+  "license": "UNLICENSED",
+  "scripts": {
+    "clean": "rimraf lib",
+    "build": "yarn clean && tsc"
+  },
+  "dependencies": {
+    "@exodus/currency": "^2.1.2",
+    "@exodus/ethereum-api": "3.2.4",
+    "@exodus/web3-ethereum-utils": "1.7.0"
+  },
+  "devDependencies": {
+    "@exodus/assets": "^8.0.72",
+    "@exodus/schemasafe": "^1.0.0-rc.7",
+    "@exodus/web3-types": "^1.6.0"
+  },
+  "peerDependencies": {
+    "@exodus/assets": "^8.0.72"
+  },
+  "gitHead": "9c988db57f3b4a18feb2038480e3466b93f2d06e"
+}