@shapeshiftoss/swapper 20.4.0 → 20.5.0

package/dist/cjs/utils/evm/getEvmNetworkFeeCryptoBaseUnit.test.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const getEvmNetworkFeeCryptoBaseUnit_1 = require("./getEvmNetworkFeeCryptoBaseUnit");
+const stateOverride_1 = require("./stateOverride");
+vitest_1.vi.mock('./stateOverride', async (importActual) => ({
+    ...(await importActual()),
+    getMinimalStateOverride: vitest_1.vi.fn(),
+    estimateGasWithStateOverride: vitest_1.vi.fn(),
+}));
+const gasFees = { gasPrice: '10' };
+const makeTransactionData = () => ({ type: 'evm', to: '0x1', data: '0x', value: '0' });
+const makeArgs = (adapter) => ({
+    adapter: adapter,
+    supportsEIP1559: false,
+    transactionData: makeTransactionData(),
+    from: '0x0000000000000000000000000000000000000001',
+    stateOverride: { sellAsset: {}, sellAmountCryptoBaseUnit: '1' },
+});
+(0, vitest_1.describe)('getEvmNetworkFeeCryptoBaseUnit state override', () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockReset();
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockReset();
+    });
+    (0, vitest_1.it)('buffers the override gas limit onto the tx and prices the buffered limit', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockResolvedValue([]);
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockResolvedValue('200');
+        const args = makeArgs({ getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }) });
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmNetworkFeeCryptoBaseUnit)(args)).resolves.toBe('2400');
+        (0, vitest_1.expect)(args.transactionData.gasLimit).toBe('240');
+    });
+    (0, vitest_1.it)('falls back to plain estimation when the override simulation times out', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockResolvedValue([]);
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockRejectedValue(new stateOverride_1.EstimationTimeoutError());
+        const getFeeData = vitest_1.vi.fn().mockResolvedValue({
+            average: { chainSpecific: { gasLimit: '100', ...gasFees } },
+        });
+        const args = makeArgs({
+            getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }),
+            getFeeData,
+        });
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmNetworkFeeCryptoBaseUnit)(args)).resolves.toBe('1200');
+        (0, vitest_1.expect)(args.transactionData.gasLimit).toBe('120');
+    });
+    (0, vitest_1.it)('estimates over a provider gas limit already set on the tx', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockResolvedValue([]);
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockResolvedValue('200');
+        const args = makeArgs({ getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }) });
+        args.transactionData.gasLimit = '150';
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmNetworkFeeCryptoBaseUnit)(args)).resolves.toBe('2400');
+        (0, vitest_1.expect)(args.transactionData.gasLimit).toBe('240');
+    });
+    (0, vitest_1.it)('signs the buffered provider limit when the needed override cannot be built', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockRejectedValue(new Error('Unable to locate allowance slot'));
+        const args = {
+            ...makeArgs({ getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }) }),
+            providerGasLimit: '300',
+        };
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmNetworkFeeCryptoBaseUnit)(args)).resolves.toBe('3600');
+        (0, vitest_1.expect)(args.transactionData.gasLimit).toBe('360');
+        (0, vitest_1.expect)(stateOverride_1.estimateGasWithStateOverride).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('fails rather than trusting the provider limit when the overridden simulation reverts', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockResolvedValue([]);
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockRejectedValue(new Error('execution reverted'));
+        const getFeeData = vitest_1.vi.fn();
+        const args = {
+            ...makeArgs({ getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }), getFeeData }),
+            providerGasLimit: '300',
+        };
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmNetworkFeeCryptoBaseUnit)(args)).rejects.toThrow('execution reverted');
+        (0, vitest_1.expect)(getFeeData).not.toHaveBeenCalled();
+    });
+});
+(0, vitest_1.describe)('getEvmRateNetworkFeeCryptoBaseUnit', () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockReset();
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockReset();
+    });
+    (0, vitest_1.it)('prices the provider limit as given without simulating', async () => {
+        const { transactionData, from, stateOverride, ...feeArgs } = makeArgs({
+            getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }),
+        });
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmRateNetworkFeeCryptoBaseUnit)({
+            ...feeArgs,
+            providerGasLimit: '300',
+            simulation: { transactionData, from, stateOverride },
+        })).resolves.toBe('3000');
+        (0, vitest_1.expect)(stateOverride_1.getMinimalStateOverride).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('simulates when the provider has no gas limit', async () => {
+        vitest_1.vi.mocked(stateOverride_1.getMinimalStateOverride).mockResolvedValue([]);
+        vitest_1.vi.mocked(stateOverride_1.estimateGasWithStateOverride).mockResolvedValue('200');
+        const { transactionData, from, stateOverride, ...feeArgs } = makeArgs({
+            getGasFeeData: vitest_1.vi.fn().mockResolvedValue({ average: gasFees }),
+        });
+        await (0, vitest_1.expect)((0, getEvmNetworkFeeCryptoBaseUnit_1.getEvmRateNetworkFeeCryptoBaseUnit)({
+            ...feeArgs,
+            providerGasLimit: undefined,
+            simulation: { transactionData, from, stateOverride },
+        })).resolves.toBe('2400');
+    });
+});

package/dist/cjs/utils/evm/stateOverride.d.ts

@@ -1,5 +1,8 @@
 import type { Asset } from '@shapeshiftoss/types';
 import type { StateOverride } from 'viem';
+export declare class EstimationTimeoutError extends Error {
+    constructor();
+}
 export declare const withTimeout: <T>(promise: Promise<T>) => Promise<T>;
 export type GetMinimalStateOverrideArgs = {
     sellAsset: Asset;

package/dist/cjs/utils/evm/stateOverride.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.estimateGasWithStateOverride = exports.getMinimalStateOverride = exports.withTimeout = void 0;
+exports.estimateGasWithStateOverride = exports.getMinimalStateOverride = exports.withTimeout = exports.EstimationTimeoutError = void 0;
 const contracts_1 = require("@shapeshiftoss/contracts");
 const utils_1 = require("@shapeshiftoss/utils");
 const viem_1 = require("viem");
@@ -29,13 +29,19 @@ const discoveredSlots = new Map();
 const rawDiscoveredSlots = new Map();
 const failedSlotDiscoveries = new Map();
 const FAILED_DISCOVERY_TTL_MS = 60_000;
+class EstimationTimeoutError extends Error {
+    constructor() {
+        super('State override estimation timed out');
+    }
+}
+exports.EstimationTimeoutError = EstimationTimeoutError;
 const withTimeout = async (promise) => {
     let timer;
     try {
         return await Promise.race([
             promise,
             new Promise((_, reject) => {
-                timer = setTimeout(() => reject(new Error('State override estimation timed out')), ESTIMATION_TIMEOUT_MS);
+                timer = setTimeout(() => reject(new EstimationTimeoutError()), ESTIMATION_TIMEOUT_MS);
             }),
         ]);
     }
@@ -293,7 +299,7 @@ exports.getMinimalStateOverride = getMinimalStateOverride;
 // only the missing state. Estimation runs on our own RPCs - the node applies the same engine over
 // the patched pre-state, so the only systematic delta is the unrealized allowance-decrement refund
 // (a few k gas high, conservative).
-const estimateGasWithStateOverride = ({ to, data, stateOverride: prebuiltStateOverride, ...overrideArgs }) => (0, exports.withTimeout)((async () => {
+const estimateGasWithStateOverride = async ({ to, data, stateOverride: prebuiltStateOverride, ...overrideArgs }) => {
     const client = (0, contracts_1.assertGetViemClient)(overrideArgs.sellAsset.chainId);
     const stateOverride = prebuiltStateOverride ?? (await (0, exports.getMinimalStateOverride)(overrideArgs));
     const gasLimit = await client.estimateGas({
@@ -304,5 +310,5 @@ const estimateGasWithStateOverride = ({ to, data, stateOverride: prebuiltStateOv
         ...(stateOverride ? { stateOverride } : {}),
     });
     return gasLimit.toString();
-})());
+};
 exports.estimateGasWithStateOverride = estimateGasWithStateOverride;

package/dist/cjs/utils/helpers.js

@@ -44,6 +44,7 @@ const DAO_TREASURY_BY_CHAIN_ID = {
     [types_1.KnownChainIds.RobinhoodMainnet]: utils_1.DAO_TREASURY_ROBINHOOD,
     [types_1.KnownChainIds.PlasmaMainnet]: utils_1.DAO_TREASURY_PLASMA,
     [types_1.KnownChainIds.MegaEthMainnet]: utils_1.DAO_TREASURY_MEGAETH,
+    [types_1.KnownChainIds.UnichainMainnet]: utils_1.DAO_TREASURY_UNICHAIN,
 };
 const getTreasuryAddressFromChainId = (chainId) => {
     const maybeTreasuryChainId = (0, utils_1.isTreasuryChainId)(chainId) ? chainId : undefined;

package/dist/cjs/utils/helpers.test.js

@@ -25,6 +25,7 @@ const helpers_1 = require("./helpers");
         [types_1.KnownChainIds.RobinhoodMainnet]: '0xF5AA59151bE6515C4Ca68A0282CF68B3eA4846fC',
         [types_1.KnownChainIds.PlasmaMainnet]: '0xF5AA59151bE6515C4Ca68A0282CF68B3eA4846fC',
         [types_1.KnownChainIds.MegaEthMainnet]: '0xF5AA59151bE6515C4Ca68A0282CF68B3eA4846fC',
+        [types_1.KnownChainIds.UnichainMainnet]: '0xF5AA59151bE6515C4Ca68A0282CF68B3eA4846fC',
         [types_1.KnownChainIds.BitcoinMainnet]: 'bc1q9xrjfet2a05r3jvsxx66rru7pysevk5dvqasdw9eeea3rfqlk33qr4hghh',
         [types_1.KnownChainIds.SolanaMainnet]: 'FxXyPB5RH4uHLPPJR5H89zGwZp19juBetmRwrxfsLj2j',
         [types_1.KnownChainIds.StarknetMainnet]: '0x07ac2252f2da7cbf085e7a5ddc1318243aa818607cdd430dd2e17dd5d487606a',

package/dist/cjs/utils/index.d.ts

@@ -1,13 +1,13 @@
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { EvmChainAdapter, near, SignTx, solana, starknet, sui, ton } from '@shapeshiftoss/chain-adapters';
 import type { TronSignTx } from '@shapeshiftoss/chain-adapters/src/tron/types';
-import type { SolanaSignTx, StarknetSignTx, SuiSignTx } from '@shapeshiftoss/hdwallet-core';
+import type { AptosSignTx, SolanaSignTx, StarknetSignTx, SuiSignTx } from '@shapeshiftoss/hdwallet-core';
 import type { Asset, EvmChainId } from '@shapeshiftoss/types';
 import { TxStatus } from '@shapeshiftoss/unchained-client';
 import type { Result } from '@sniptt/monads';
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import type { TypedData } from 'eip-712';
-import type { CommonSwapMetadata, EvmTransactionExecutionProps, NearTransactionExecutionProps, SolanaTransactionExecutionProps, StarknetTransactionExecutionProps, SuiTransactionExecutionProps, SupportedTradeQuoteStepIndex, SwapErrorRight, SwapMetadata, SwapperMetadata, TonTransactionExecutionProps, TradeQuote, TradeQuoteStep, TradeRate, TradeRateStep, TradeStatus, TronTransactionExecutionProps } from '../types';
+import type { AptosTransactionExecutionProps, CommonSwapMetadata, EvmTransactionExecutionProps, NearTransactionExecutionProps, SolanaTransactionExecutionProps, StarknetTransactionExecutionProps, SuiTransactionExecutionProps, SupportedTradeQuoteStepIndex, SwapErrorRight, SwapMetadata, SwapperMetadata, TonTransactionExecutionProps, TradeQuote, TradeQuoteStep, TradeRate, TradeRateStep, TradeStatus, TronTransactionExecutionProps } from '../types';
 import { TradeQuoteError } from '../types';
 export declare const getPermit2Eip712: (step: TradeQuoteStep | TradeRateStep | undefined) => TypedData | undefined;
 export declare const makeSwapErrorRight: ({ details, cause, code, message, }: {
@@ -43,6 +43,7 @@ export declare const executeSuiTransaction: (txToSign: SuiSignTx, callbacks: Sui
 export declare const executeNearTransaction: (txToSign: near.NearSignTx, callbacks: NearTransactionExecutionProps) => Promise<string>;
 export declare const executeStarknetTransaction: (txToSign: StarknetSignTx, callbacks: StarknetTransactionExecutionProps) => Promise<string>;
 export declare const executeTonTransaction: (txToSign: ton.TonSignTx, callbacks: TonTransactionExecutionProps) => Promise<string>;
+export declare const executeAptosTransaction: (txToSign: AptosSignTx, callbacks: AptosTransactionExecutionProps) => Promise<string>;
 export declare const createDefaultStatusResponse: (buyTxHash?: string) => {
     status: TxStatus;
     buyTxHash: string | undefined;

package/dist/cjs/utils/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSwapMetadata = exports.buildSwapMetadata = exports.SolanaLogsError = exports.checkStarknetSwapStatus = exports.checkSuiSwapStatus = exports.checkSolanaSwapStatus = exports.getExecutableTradeStep = exports.isExecutableTradeQuote = exports.getInputOutputRate = exports.checkEvmSwapStatus = exports.checkSafeTransactionStatus = exports.createDefaultStatusResponse = exports.executeTonTransaction = exports.executeStarknetTransaction = exports.executeNearTransaction = exports.executeSuiTransaction = exports.executeTronTransaction = exports.executeSolanaTransaction = exports.executeEvmTransaction = exports.getHopByIndex = exports.makeSwapperAxiosServiceMonadic = exports.createCache = exports.makeTradeStepBuildFailedErr = exports.makeNetworkFeeEstimationFailedErr = exports.createTradeAmountTooSmallErr = exports.assertQuoteAddresses = exports.makeSwapErrorRight = exports.getPermit2Eip712 = void 0;
+exports.getSwapMetadata = exports.buildSwapMetadata = exports.SolanaLogsError = exports.checkStarknetSwapStatus = exports.checkSuiSwapStatus = exports.checkSolanaSwapStatus = exports.getExecutableTradeStep = exports.isExecutableTradeQuote = exports.getInputOutputRate = exports.checkEvmSwapStatus = exports.checkSafeTransactionStatus = exports.createDefaultStatusResponse = exports.executeAptosTransaction = exports.executeTonTransaction = exports.executeStarknetTransaction = exports.executeNearTransaction = exports.executeSuiTransaction = exports.executeTronTransaction = exports.executeSolanaTransaction = exports.executeEvmTransaction = exports.getHopByIndex = exports.makeSwapperAxiosServiceMonadic = exports.createCache = exports.makeTradeStepBuildFailedErr = exports.makeNetworkFeeEstimationFailedErr = exports.createTradeAmountTooSmallErr = exports.assertQuoteAddresses = exports.makeSwapErrorRight = exports.getPermit2Eip712 = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const unchained_client_1 = require("@shapeshiftoss/unchained-client");
@@ -151,6 +151,10 @@ const executeTonTransaction = (txToSign, callbacks) => {
     return callbacks.signAndBroadcastTransaction(txToSign);
 };
 exports.executeTonTransaction = executeTonTransaction;
+const executeAptosTransaction = (txToSign, callbacks) => {
+    return callbacks.signAndBroadcastTransaction(txToSign);
+};
+exports.executeAptosTransaction = executeAptosTransaction;
 const createDefaultStatusResponse = (buyTxHash) => ({
     status: unchained_client_1.TxStatus.Unknown,
     buyTxHash,
@@ -275,34 +279,14 @@ const checkSuiSwapStatus = async ({ txHash, address, assertGetSuiChainAdapter, }
             throw new Error('Missing address');
         const adapter = assertGetSuiChainAdapter(caip_1.suiChainId);
         const client = adapter.getSuiClient();
-        const txResponse = await client.getTransactionBlock({
+        const txResponse = await client.getTransaction({
             digest: txHash,
-            options: {
-                showEffects: true,
-                showBalanceChanges: true,
-            },
+            include: { balanceChanges: true },
         });
-        const status = txResponse.effects?.status?.status === 'success' ? unchained_client_1.TxStatus.Confirmed : unchained_client_1.TxStatus.Failed;
-        // Extract actual buy amount from balance changes
-        let actualBuyAmountCryptoBaseUnit;
-        if (txResponse.balanceChanges) {
-            // Balance changes show the net effect on the user's balances
-            // Positive amounts are received, negative are sent
-            const receivedChanges = txResponse.balanceChanges.filter(change => {
-                // The owner field is a discriminated union - check for AddressOwner variant
-                // Handle both object and string cases
-                const ownerAddress = change.owner && typeof change.owner === 'object' && 'AddressOwner' in change.owner
-                    ? change.owner.AddressOwner
-                    : change.owner && typeof change.owner === 'object' && 'ObjectOwner' in change.owner
-                        ? change.owner.ObjectOwner
-                        : null;
-                return ownerAddress === address && Number(change.amount) > 0;
-            });
-            if (receivedChanges.length > 0) {
-                // For swaps, we expect exactly one positive balance change (the buy asset)
-                actualBuyAmountCryptoBaseUnit = receivedChanges[0].amount;
-            }
-        }
+        const status = txResponse.Transaction ? unchained_client_1.TxStatus.Confirmed : unchained_client_1.TxStatus.Failed;
+        // For swaps, we expect exactly one positive balance change for the receiver (the buy asset)
+        const actualBuyAmountCryptoBaseUnit = (txResponse.Transaction ?? txResponse.FailedTransaction).balanceChanges.find(change => change.address === address && BigInt(change.amount) > 0n)
+            ?.amount;
         return {
             status,
             buyTxHash: txHash,