@exodus/web3-ethereum-utils 3.34.0 → 3.35.0

package/lib/createSimulateMessage.js

@@ -1,5 +1,6 @@
 import { getMessageType } from './simulation/getMessageType.js';
 import { simulateMessage } from './simulation/simulateMessage.js';
+import { tryParsingSIWE } from './simulation/tryParsingSIWE.js';
 export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exodus.io/simulateMessage', headers = {
     'X-Api-Version': '2023-06-05',
 }, } = {}) => async ({ message, origin, asset, address, }) => {
@@ -11,6 +12,12 @@ export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exod
     if (messageType === 2 /* MessageTypeEnum.Unknown */) {
         return simulationResult;
     }
+    tryParsingSIWE({
+        message,
+        messageType,
+        origin,
+        simulationResult,
+    });
     await simulateMessage({
         address,
         message: {

package/lib/simulation/common.d.ts

@@ -1,4 +1,12 @@
 import BN from 'bn.js';
+import type { Asset } from '@exodus/web3-types';
+import type { CreateCurrencyParams } from '@exodus/web3-utils';
+export declare const getCreateCurrencyParams: (asset: Asset, amount: CreateCurrencyParams['amount']) => {
+    amount: string | number | BN;
+    base: string;
+    symbol: string;
+    denominator: number;
+};
 interface BlowfishEvmChain {
     [key: string]: {
         network: string;

package/lib/simulation/common.js

@@ -1,4 +1,10 @@
 import BN from 'bn.js';
+export const getCreateCurrencyParams = (asset, amount) => ({
+    amount,
+    base: 'wei',
+    symbol: asset.displayTicker,
+    denominator: asset.units[asset.ticker],
+});
 export const BLOWFISH_EVM_CHAINS = {
     ethereum: {
         network: 'ethereum',

package/lib/simulation/estimateFee.js

@@ -8,14 +8,15 @@
  However, a final fee for non-simple transfers is always calculated on-chain once the EVM executes a transaction
  and has the number of gas consumed.
  */
-import { hexToBN } from '@exodus/web3-utils';
+import { createCurrency, hexToBN } from '@exodus/web3-utils';
+import { getCreateCurrencyParams } from './common.js';
 export const estimateFee = ({ asset, transaction, }) => {
     const gas = hexToBN(transaction.gas);
     if (transaction.maxFeePerGas) {
         const maxFeePerGas = hexToBN(transaction.maxFeePerGas);
         const maximumFee = gas.mul(maxFeePerGas);
-        return asset.currency.baseUnit(maximumFee.toString());
+        return createCurrency(getCreateCurrencyParams(asset, maximumFee.toString()));
     }
     const gasPrice = hexToBN(transaction.gasPrice);
-    return asset.currency.baseUnit(gas.mul(gasPrice).toString());
+    return createCurrency(getCreateCurrencyParams(asset, gas.mul(gasPrice).toString()));
 };

package/lib/simulation/estimateSimpleTransfer.d.ts

@@ -1,6 +1,5 @@
 import type { EthTransaction } from '../types.js';
-import type { NumberUnit } from '@exodus/web3-types';
-import type { Asset } from '@exodus/web3-types';
+import type { Asset, NumberUnit } from '@exodus/web3-types';
 export declare class NotSimpleTransferError extends Error {
     constructor(msg: string);
 }

package/lib/simulation/estimateSimpleTransfer.js

@@ -6,7 +6,8 @@
  Even empty `data` field transactions ("0x") can cause unexpected state changes if sent to a smart contract
  with a gas limit exceeding 21000 units.
  */
-import { hexToBN } from '@exodus/web3-utils';
+import { createCurrency, hexToBN } from '@exodus/web3-utils';
+import { getCreateCurrencyParams } from './common.js';
 export class NotSimpleTransferError extends Error {
     constructor(msg) {
         super(msg);
@@ -18,5 +19,5 @@ export const estimateSimpleTransfer = ({ asset, transaction, }) => {
         throw new NotSimpleTransferError('The transaction input should be empty ("0x").');
     }
     const txValue = hexToBN(transaction.value || '0x0').toString();
-    return asset.currency.baseUnit(txValue);
+    return createCurrency(getCreateCurrencyParams(asset, txValue));
 };

package/lib/simulation/tryEstimatingChangesLocally.js

@@ -1,3 +1,5 @@
+import { createCurrency } from '@exodus/web3-utils';
+import { getCreateCurrencyParams } from './common.js';
 import { estimateSimpleTransfer, NotSimpleTransferError, } from './estimateSimpleTransfer.js';
 /*
  Mutates the provided 'simulationResult' adding a 'willSend' entry if the transaction is a simple transfer.
@@ -6,7 +8,7 @@ export const tryEstimatingChangesLocally = ({ asset, simulationResult, transacti
     try {
         const estimatedValue = estimateSimpleTransfer({ asset, transaction });
         const actualTransferValue = transaction.from.toLowerCase() === transaction.to.toLowerCase()
-            ? asset.currency.ZERO
+            ? createCurrency(getCreateCurrencyParams(asset, 0)) // A self-send does not transfer any funds.
             : estimatedValue;
         simulationResult.balanceChanges.willSend.push({
             balance: actualTransferValue,

package/lib/simulation/tryParsingSIWE.d.ts

@@ -0,0 +1,8 @@
+import { MessageTypeEnum } from './getMessageType.js';
+import type { MessageSimulationResult } from '@exodus/web3-types';
+export declare const tryParsingSIWE: ({ message, messageType, origin, simulationResult, }: {
+    message: string;
+    messageType: MessageTypeEnum;
+    origin: string;
+    simulationResult: MessageSimulationResult;
+}) => void;

package/lib/simulation/tryParsingSIWE.js

@@ -0,0 +1,20 @@
+export const tryParsingSIWE = ({ message, messageType, origin, simulationResult, }) => {
+    if (messageType === 1 /* MessageTypeEnum.TypedData */) {
+        return;
+    }
+    /*
+      Some dApps don't comply with EIP-4361 and use their custom Sign-In messages. This code block detects such known custom SIWE messages.
+     */
+    if (origin.includes('rarible.com') &&
+        message.includes('I want to login on Rarible')) {
+        simulationResult.kind = {
+            kind: 'SIWE',
+            info: {
+                date: new Date(),
+                statement: 'I accept the Rarible Terms of Service https://static.rarible.com/terms.pdf and I am at least 13 years old.',
+            },
+        };
+    }
+    // TODO: add proper EIP-4361 parsing.
+    return;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "3.34.0",
+  "version": "3.35.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -27,14 +27,14 @@
     "build": "yarn clean &&  run -T tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "0.0.0"
+    "@exodus/web3-types": "1.49.0"
   },
   "dependencies": {
     "@exodus/basic-utils": "^2.5.1",
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.47.0",
+    "@exodus/web3-utils": "^1.47.1",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "fbff6236b1adf18931a2b7ef888907ec67fa62e4"
+  "gitHead": "97a9adffba6edc4a782f45ebbf2fc5f6c188dc4b"
 }