@shapeshiftoss/swapper 17.7.3 → 18.1.0

package/dist/cjs/utils/cosmossdk/getCosmosSdkExecutionContext.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCosmosSdkExecutionContext = void 0;
+const utils_1 = require("../../utils");
+const getCosmosSdkExecutionContext = async ({ stepIndex, tradeQuote, assertGetCosmosSdkChainAdapter, }) => {
+    if (!(0, utils_1.isExecutableTradeQuote)(tradeQuote))
+        throw new Error('unable to execute a trade rate');
+    const step = (0, utils_1.getExecutableTradeStep)(tradeQuote, stepIndex);
+    const { transactionData, sellAsset } = step;
+    if (transactionData?.type !== 'cosmossdk_msg_send' &&
+        transactionData?.type !== 'cosmossdk_msg_deposit') {
+        throw new Error('invalid cosmossdk transaction');
+    }
+    const adapter = assertGetCosmosSdkChainAdapter(sellAsset.chainId);
+    const { fast } = await adapter.getFeeData({});
+    return { step, adapter, transactionData, feeData: fast };
+};
+exports.getCosmosSdkExecutionContext = getCosmosSdkExecutionContext;

package/dist/cjs/utils/cosmossdk/getCosmosSdkTransactionFees.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCosmosSdkTransactionFees = void 0;
+const getCosmosSdkExecutionContext_1 = require("./getCosmosSdkExecutionContext");
+const getCosmosSdkTransactionFees = async (args) => {
+    const { feeData } = await (0, getCosmosSdkExecutionContext_1.getCosmosSdkExecutionContext)(args);
+    return feeData.txFee;
+};
+exports.getCosmosSdkTransactionFees = getCosmosSdkTransactionFees;

package/dist/cjs/utils/cosmossdk/getUnsignedCosmosSdkTransaction.d.ts

@@ -0,0 +1,4 @@
+import type { SignTx } from '@shapeshiftoss/chain-adapters';
+import type { CosmosSdkChainId } from '@shapeshiftoss/types';
+import type { GetUnsignedCosmosSdkTransactionArgs } from '../../types';
+export declare const getUnsignedCosmosSdkTransaction: (args: GetUnsignedCosmosSdkTransactionArgs) => Promise<SignTx<CosmosSdkChainId>>;

package/dist/cjs/utils/cosmossdk/getUnsignedCosmosSdkTransaction.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnsignedCosmosSdkTransaction = void 0;
+const getCosmosSdkExecutionContext_1 = require("./getCosmosSdkExecutionContext");
+const getUnsignedCosmosSdkTransaction = async (args) => {
+    const { from } = args;
+    const { step, adapter, transactionData, feeData } = await (0, getCosmosSdkExecutionContext_1.getCosmosSdkExecutionContext)(args);
+    const { accountNumber } = step;
+    const chainSpecific = { gas: feeData.chainSpecific.gasLimit, fee: feeData.txFee };
+    if (transactionData.type === 'cosmossdk_msg_deposit') {
+        const { value, memo, coin } = transactionData;
+        if (!('buildDepositTransaction' in adapter)) {
+            throw new Error('adapter does not support deposit transactions');
+        }
+        const depositAdapter = adapter;
+        const { txToSign } = await depositAdapter.buildDepositTransaction({
+            accountNumber,
+            from,
+            value,
+            memo,
+            chainSpecific: { ...chainSpecific, coin },
+        });
+        return txToSign;
+    }
+    const { to, value, memo } = transactionData;
+    const { txToSign } = await adapter.buildSendApiTransaction({
+        accountNumber,
+        from,
+        to,
+        value,
+        memo,
+        chainSpecific,
+    });
+    return txToSign;
+};
+exports.getUnsignedCosmosSdkTransaction = getUnsignedCosmosSdkTransaction;

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

@@ -0,0 +1,3 @@
+export * from './getCosmosSdkExecutionContext';
+export * from './getCosmosSdkTransactionFees';
+export * from './getUnsignedCosmosSdkTransaction';

package/dist/cjs/{thorchain-utils/solana → utils/cosmossdk}/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./getThorTxData"), exports);
-__exportStar(require("./getUnsignedSolanaTransaction"), exports);
-__exportStar(require("./getSolanaTransactionFees"), exports);
+__exportStar(require("./getCosmosSdkExecutionContext"), exports);
+__exportStar(require("./getCosmosSdkTransactionFees"), exports);
+__exportStar(require("./getUnsignedCosmosSdkTransaction"), exports);

package/dist/cjs/{cowswap-utils → utils/cowswap}/index.d.ts

@@ -6,7 +6,7 @@ import type { AccountMetadata, UnsignedOrderCreation } from '@shapeshiftoss/type
 import { CowNetwork } from '@shapeshiftoss/types';
 import type { TypedData } from 'eip-712';
 import type { Address } from 'viem';
-import type { AffiliateAppDataFragment } from '../swappers/CowSwapper';
+import type { AffiliateAppDataFragment } from '../../swappers/CowSwapper';
 export * from './constants';
 export declare const getCowNetwork: (chainId: ChainId) => CowNetwork | undefined;
 export declare const assertGetCowNetwork: (chainId: ChainId) => CowNetwork;

package/dist/cjs/{cowswap-utils → utils/cowswap}/index.js

@@ -22,7 +22,7 @@ const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
 const ethers_1 = require("ethers");
 const viem_1 = require("viem");
-const helpers_1 = require("../swappers/utils/helpers/helpers");
+const helpers_1 = require("../helpers");
 const constants_1 = require("./constants");
 __exportStar(require("./constants"), exports);
 const getCowNetwork = (chainId) => {

package/dist/cjs/utils/cowswap/index.test.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const _1 = require(".");
+(0, vitest_1.describe)('getFullAppData', () => {
+    (0, vitest_1.it)('should return correct AppData for given inputs for no affiliate fee', async () => {
+        const slippageTolerancePercentage = '0.005'; // 0.5%
+        const affiliateAppDataFragment = {}; // no affiliate fee
+        const result = await (0, _1.getFullAppData)(slippageTolerancePercentage, affiliateAppDataFragment, 'market');
+        (0, vitest_1.expect)(result).toEqual({
+            appDataHash: '0x41fffc0127f56060cc551652721d84c336f87649a20c51fcff5b8841dfeabe5b',
+            appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+        });
+    });
+    (0, vitest_1.it)('should return correct AppData for given inputs for affiliate fee', async () => {
+        const slippageTolerancePercentage = '0.005'; // 0.5%
+        const affiliateAppDataFragment = {
+            partnerFee: {
+                bps: 48,
+                recipient: '0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3',
+            },
+        };
+        const result = await (0, _1.getFullAppData)(slippageTolerancePercentage, affiliateAppDataFragment, 'market');
+        (0, vitest_1.expect)(result).toEqual({
+            appDataHash: '0x6a731164dc2bb01874c1537079a3f543894da3b5803dcfed23aaf8396c919be2',
+            appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"partnerFee":{"bps":48,"recipient":"0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+        });
+    });
+});

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

@@ -0,0 +1 @@
+export declare const EVM_PLACEHOLDER_ADDRESS = "0x000000000000000000000000000000000000dEaD";

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVM_PLACEHOLDER_ADDRESS = void 0;
+// Placeholder sender for rate estimation without a connected wallet - the balance override funds
+// it as needed, and it never collides with a provider deposit address, keeping the estimated
+// transfer two-slot shaped (a self-transfer touches one balance slot and estimates low)
+exports.EVM_PLACEHOLDER_ADDRESS = '0x000000000000000000000000000000000000dEaD';

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

@@ -0,0 +1,27 @@
+import { evm } from '@shapeshiftoss/chain-adapters';
+import type { GetUnsignedEvmTransactionArgs } from '../../types';
+export declare const getEvmExecutionContext: ({ stepIndex, tradeQuote, supportsEIP1559, assertGetEvmChainAdapter, }: GetUnsignedEvmTransactionArgs) => Promise<{
+    step: import("../../types").TradeQuoteStep;
+    adapter: import("@shapeshiftoss/chain-adapters").EvmChainAdapter;
+    transactionData: {
+        type: "evm";
+        chainId: number;
+        to: string;
+        data: string;
+        value: string;
+        gasLimit?: string | undefined;
+        signatureRequired?: {
+            type: "permit2";
+            eip712: {
+                domain: Record<string, unknown>;
+                types: Record<string, {
+                    name: string;
+                    type: string;
+                }[]>;
+                primaryType: string;
+                message: Record<string, unknown>;
+            };
+        } | undefined;
+    };
+    feeData: evm.Fees;
+}>;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEvmExecutionContext = void 0;
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const utils_1 = require("../../utils");
+const getEvmExecutionContext = async ({ stepIndex, tradeQuote, supportsEIP1559, assertGetEvmChainAdapter, }) => {
+    if (!(0, utils_1.isExecutableTradeQuote)(tradeQuote))
+        throw new Error('unable to execute a trade rate');
+    const step = (0, utils_1.getExecutableTradeStep)(tradeQuote, stepIndex);
+    const { transactionData, sellAsset } = step;
+    if (transactionData?.type !== 'evm')
+        throw new Error('invalid evm transaction');
+    if (!transactionData.gasLimit)
+        throw new Error('missing gas limit in evm transaction');
+    const { gasLimit } = transactionData;
+    const adapter = assertGetEvmChainAdapter(sellAsset.chainId);
+    const { average } = await adapter.getGasFeeData();
+    const networkFeeCryptoBaseUnit = chain_adapters_1.evm.calcNetworkFeeCryptoBaseUnit({
+        ...average,
+        supportsEIP1559,
+        gasLimit,
+    });
+    const { gasPrice, maxFeePerGas, maxPriorityFeePerGas } = average;
+    const feeData = supportsEIP1559 && maxFeePerGas && maxPriorityFeePerGas
+        ? { networkFeeCryptoBaseUnit, gasLimit, maxFeePerGas, maxPriorityFeePerGas }
+        : { networkFeeCryptoBaseUnit, gasLimit, gasPrice };
+    return { step, adapter, transactionData, feeData };
+};
+exports.getEvmExecutionContext = getEvmExecutionContext;

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

@@ -0,0 +1,22 @@
+import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
+import type { Asset } from '@shapeshiftoss/types';
+import type { TxBuildData } from '../../types';
+type GetEvmNetworkFeeCryptoBaseUnitArgs = {
+    adapter: EvmChainAdapter;
+    supportsEIP1559: boolean;
+} & ({
+    gasLimit: string;
+} | {
+    transactionData: Extract<TxBuildData, {
+        type: 'evm';
+    }>;
+    from: string;
+    gasLimitBuffer?: number;
+    stateOverride?: {
+        sellAsset: Asset;
+        sellAmountCryptoBaseUnit: string;
+        spenderAddress?: string;
+    };
+});
+export declare const getEvmNetworkFeeCryptoBaseUnit: (args: GetEvmNetworkFeeCryptoBaseUnitArgs) => Promise<string>;
+export {};

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEvmNetworkFeeCryptoBaseUnit = void 0;
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const utils_1 = require("@shapeshiftoss/utils");
+const stateOverride_1 = require("./stateOverride");
+const getEvmNetworkFeeCryptoBaseUnit = async (args) => {
+    const { adapter, supportsEIP1559 } = args;
+    // Price a provider gas limit with fresh gas prices - no on chain estimation
+    const priceProviderGasLimit = async (gasLimit) => {
+        const { average: gasPrices } = await adapter.getGasFeeData();
+        return chain_adapters_1.evm.calcNetworkFeeCryptoBaseUnit({ ...gasPrices, supportsEIP1559, gasLimit });
+    };
+    // Rate network fee: the caller passed a provider gas limit directly
+    if (!('transactionData' in args))
+        return priceProviderGasLimit(args.gasLimit);
+    const { transactionData, from, gasLimitBuffer = 1.2 } = args;
+    // Executable quote: the provider supplied a gas limit on the tx data, price it as-is
+    const providerGasLimit = transactionData.gasLimit;
+    if (providerGasLimit && (0, utils_1.bnOrZero)(providerGasLimit).gt(0)) {
+        return priceProviderGasLimit(providerGasLimit);
+    }
+    const { to, data, value } = transactionData;
+    if (args.stateOverride) {
+        const { sellAsset, sellAmountCryptoBaseUnit, spenderAddress } = args.stateOverride;
+        // Best effort - a timeout, undiscoverable slot, or an rpc without stateOverride support falls
+        // through to plain estimation, which succeeds whenever the seller's state was sufficient anyway
+        const overriddenGasLimit = await (0, stateOverride_1.withTimeout)((async () => {
+            const overrideArgs = {
+                sellAsset,
+                sellAmountCryptoBaseUnit,
+                from,
+                spenderAddress,
+                value,
+            };
+            const stateOverride = await (0, stateOverride_1.getMinimalStateOverride)(overrideArgs);
+            if (!stateOverride)
+                return undefined;
+            return (0, stateOverride_1.estimateGasWithStateOverride)({ ...overrideArgs, to, data, stateOverride });
+        })()).catch(() => undefined);
+        if (overriddenGasLimit) {
+            transactionData.gasLimit = (0, utils_1.bnOrZero)(overriddenGasLimit).times(gasLimitBuffer).toFixed(0);
+            return priceProviderGasLimit(overriddenGasLimit);
+        }
+    }
+    // Estimate on chain, then set the buffered limit on the tx data in place so the executable tx
+    // always carries a gas limit
+    const estimatedFees = await chain_adapters_1.evm.getFees({ adapter, data, to, value, from, supportsEIP1559 });
+    transactionData.gasLimit = (0, utils_1.bnOrZero)(estimatedFees.gasLimit).times(gasLimitBuffer).toFixed(0);
+    return estimatedFees.networkFeeCryptoBaseUnit;
+};
+exports.getEvmNetworkFeeCryptoBaseUnit = getEvmNetworkFeeCryptoBaseUnit;

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

@@ -0,0 +1,2 @@
+import type { GetUnsignedEvmTransactionArgs } from '../../types';
+export declare const getEvmTransactionFees: (args: GetUnsignedEvmTransactionArgs) => Promise<string>;

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEvmTransactionFees = void 0;
+const getEvmExecutionContext_1 = require("./getEvmExecutionContext");
+const getEvmTransactionFees = async (args) => {
+    const { feeData } = await (0, getEvmExecutionContext_1.getEvmExecutionContext)(args);
+    return feeData.networkFeeCryptoBaseUnit;
+};
+exports.getEvmTransactionFees = getEvmTransactionFees;

package/dist/cjs/{thorchain-utils → utils}/evm/getUnsignedEvmTransaction.d.ts

@@ -1,4 +1,4 @@
 import type { SignTx } from '@shapeshiftoss/chain-adapters';
 import type { EvmChainId } from '@shapeshiftoss/types';
-import type { GetUnsignedEvmTransactionArgs, SwapperName } from '../../types';
-export declare const getUnsignedEvmTransaction: (args: GetUnsignedEvmTransactionArgs, swapperName: SwapperName) => Promise<SignTx<EvmChainId>>;
+import type { GetUnsignedEvmTransactionArgs } from '../../types';
+export declare const getUnsignedEvmTransaction: (args: GetUnsignedEvmTransactionArgs) => Promise<SignTx<EvmChainId>>;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnsignedEvmTransaction = void 0;
+const viem_1 = require("viem");
+const getEvmExecutionContext_1 = require("./getEvmExecutionContext");
+const getUnsignedEvmTransaction = async (args) => {
+    const { from, permit2Signature } = args;
+    const { step, adapter, transactionData, feeData } = await (0, getEvmExecutionContext_1.getEvmExecutionContext)(args);
+    const { accountNumber } = step;
+    const { to, value } = transactionData;
+    const data = (() => {
+        if (!permit2Signature)
+            return transactionData.data;
+        // Append the permit2 signature to the calldata
+        // https://0x.org/docs/0x-swap-api/guides/swap-tokens-with-0x-swap-api#5-append-signature-length-and-signature-data-to-transactiondata
+        const signatureLengthInHex = (0, viem_1.numberToHex)((0, viem_1.size)(permit2Signature), {
+            signed: false,
+            size: 32,
+        });
+        return (0, viem_1.concat)([transactionData.data, signatureLengthInHex, permit2Signature]);
+    })();
+    return adapter.buildCustomApiTx({ accountNumber, data, from, to, value, ...feeData });
+};
+exports.getUnsignedEvmTransaction = getUnsignedEvmTransaction;

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

@@ -0,0 +1,7 @@
+export * from './constants';
+export * from './getEvmExecutionContext';
+export * from './getEvmNetworkFeeCryptoBaseUnit';
+export * from './getEvmTransactionFees';
+export * from './getUnsignedEvmTransaction';
+export * from './stateOverride';
+export * from './storageSlots';

package/dist/cjs/{thorchain-utils → utils}/evm/index.js

@@ -14,6 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./getThorTxData"), exports);
-__exportStar(require("./getUnsignedEvmTransaction"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./getEvmExecutionContext"), exports);
+__exportStar(require("./getEvmNetworkFeeCryptoBaseUnit"), exports);
 __exportStar(require("./getEvmTransactionFees"), exports);
+__exportStar(require("./getUnsignedEvmTransaction"), exports);
+__exportStar(require("./stateOverride"), exports);
+__exportStar(require("./storageSlots"), exports);

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

@@ -0,0 +1,17 @@
+import type { Asset } from '@shapeshiftoss/types';
+import type { StateOverride } from 'viem';
+export declare const withTimeout: <T>(promise: Promise<T>) => Promise<T>;
+export type GetMinimalStateOverrideArgs = {
+    sellAsset: Asset;
+    sellAmountCryptoBaseUnit: string;
+    from: string;
+    spenderAddress?: string;
+    value: string;
+};
+export declare const getMinimalStateOverride: ({ sellAsset, sellAmountCryptoBaseUnit, from: _from, spenderAddress, value, }: GetMinimalStateOverrideArgs) => Promise<StateOverride | undefined>;
+export type EstimateGasWithStateOverrideArgs = GetMinimalStateOverrideArgs & {
+    to: string;
+    data: string;
+    stateOverride?: StateOverride;
+};
+export declare const estimateGasWithStateOverride: ({ to, data, stateOverride: prebuiltStateOverride, ...overrideArgs }: EstimateGasWithStateOverrideArgs) => Promise<string>;