@shapeshiftoss/swapper 17.6.6 → 17.6.8

package/dist/cjs/swappers/ArbitrumBridgeSwapper/getTradeQuote/getTradeQuote.test.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = require("@arbitrum/sdk");
+const caip_1 = require("@shapeshiftoss/caip");
+const vitest_1 = require("vitest");
+const types_1 = require("../../../types");
+const assets_1 = require("../../utils/test-data/assets");
+const getTradeQuote_1 = require("./getTradeQuote");
+vitest_1.vi.mock('@arbitrum/sdk', () => ({
+    Erc20Bridger: vitest_1.vi.fn(),
+    EthBridger: vitest_1.vi.fn(),
+    getArbitrumNetwork: vitest_1.vi.fn().mockResolvedValue({ chainID: 42161 }),
+}));
+vitest_1.vi.mock('@shapeshiftoss/chain-adapters', async () => {
+    const actual = await vitest_1.vi.importActual('@shapeshiftoss/chain-adapters');
+    return {
+        ...actual,
+        evm: {
+            getFees: vitest_1.vi.fn().mockResolvedValue({ networkFeeCryptoBaseUnit: '42' }),
+        },
+    };
+});
+(0, vitest_1.describe)('getTradeQuote', () => {
+    const mockAdapter = {
+        getGasFeeData: vitest_1.vi.fn().mockResolvedValue({
+            average: { gasPrice: '42', maxFeePerGas: '42' },
+        }),
+    };
+    const mockAdapterEth = Object.assign({}, mockAdapter, {
+        getFeeAssetId: () => caip_1.ethAssetId,
+    });
+    const assertGetEvmChainAdapter = () => mockAdapterEth;
+    const commonInput = {
+        allowMultiHop: false,
+        chainId: caip_1.ethChainId,
+        sellAsset: assets_1.ETH,
+        buyAsset: assets_1.ETH_ARBITRUM,
+        accountNumber: 0,
+        affiliateBps: '0',
+        supportsEIP1559: true,
+        receiveAddress: '0xfauxmes',
+        sellAmountIncludingProtocolFeesCryptoBaseUnit: '1000000000000000000',
+        sendAddress: '0xfauxmes',
+    };
+    (0, vitest_1.it)('returns a correct ETH deposit quote', async () => {
+        const ethBridgerMock = {
+            getDepositToRequest: vitest_1.vi.fn().mockResolvedValue({
+                txRequest: {
+                    data: '0x',
+                    to: '0x',
+                    value: '0',
+                    from: '0x',
+                },
+            }),
+        };
+        vitest_1.vi.mocked(sdk_1.EthBridger).mockReturnValue(ethBridgerMock);
+        const maybeQuote = await (0, getTradeQuote_1.getTradeQuote)(commonInput, {
+            assertGetEvmChainAdapter,
+            getEthersV5Provider: vitest_1.vi.fn(),
+        });
+        (0, vitest_1.expect)(maybeQuote.isOk()).toBe(true);
+        const quote = maybeQuote.unwrap();
+        (0, vitest_1.expect)(quote.receiveAddress).toBe(commonInput.receiveAddress);
+        (0, vitest_1.expect)(quote.rate).toBe('1');
+        (0, vitest_1.expect)(quote.steps[0].allowanceContract).toBe('0x0');
+        (0, vitest_1.expect)(quote.steps[0].source).toBe(types_1.SwapperName.ArbitrumBridge);
+    });
+    (0, vitest_1.it)('returns a correct ETH withdraw quote', async () => {
+        const ethBridgerMock = {
+            getWithdrawalRequest: vitest_1.vi.fn().mockResolvedValue({
+                txRequest: {
+                    data: '0x',
+                    to: '0x',
+                    value: '0',
+                    from: '0x',
+                },
+            }),
+        };
+        vitest_1.vi.mocked(sdk_1.EthBridger).mockReturnValue(ethBridgerMock);
+        const withdrawInput = {
+            ...commonInput,
+            sellAsset: assets_1.ETH_ARBITRUM,
+            buyAsset: assets_1.ETH,
+        };
+        const maybeQuote = await (0, getTradeQuote_1.getTradeQuote)(withdrawInput, {
+            assertGetEvmChainAdapter,
+            getEthersV5Provider: vitest_1.vi.fn(),
+        });
+        (0, vitest_1.expect)(maybeQuote.isOk()).toBe(true);
+        const quote = maybeQuote.unwrap();
+        (0, vitest_1.expect)(quote.receiveAddress).toBe(withdrawInput.receiveAddress);
+        (0, vitest_1.expect)(quote.rate).toBe('1');
+        (0, vitest_1.expect)(quote.steps[0].allowanceContract).toBe('0x0');
+        (0, vitest_1.expect)(quote.steps[0].source).toBe(types_1.SwapperName.ArbitrumBridge);
+    });
+    (0, vitest_1.it)('returns a correct ERC20 deposit quote', async () => {
+        const Erc20BridgerMock = {
+            getDepositRequest: vitest_1.vi.fn().mockResolvedValue({
+                txRequest: {
+                    data: '0x',
+                    to: '0x',
+                    value: '0',
+                    from: '0x',
+                },
+            }),
+            getChildErc20Address: vitest_1.vi.fn().mockResolvedValue('0xf929de51d91c77e42f5090069e0ad7a09e513c73'),
+            getParentErc20Address: vitest_1.vi
+                .fn()
+                .mockResolvedValue('0xc770eefad204b5180df6a14ee197d99d808ee52d'),
+            getParentGatewayAddress: vitest_1.vi
+                .fn()
+                .mockResolvedValue('0x0c66f315542fdec1d312c415b14eef614b0910ef'),
+        };
+        vitest_1.vi.mocked(sdk_1.Erc20Bridger).mockReturnValue(Erc20BridgerMock);
+        const erc20DepositInput = {
+            ...commonInput,
+            sellAsset: assets_1.FOX_MAINNET,
+            buyAsset: assets_1.FOX_ARBITRUM,
+        };
+        const maybeQuote = await (0, getTradeQuote_1.getTradeQuote)(erc20DepositInput, {
+            assertGetEvmChainAdapter,
+            getEthersV5Provider: vitest_1.vi.fn(),
+        });
+        (0, vitest_1.expect)(maybeQuote.isOk()).toBe(true);
+        const quote = maybeQuote.unwrap();
+        (0, vitest_1.expect)(quote.receiveAddress).toBe(erc20DepositInput.receiveAddress);
+        (0, vitest_1.expect)(quote.rate).toBe('1');
+        (0, vitest_1.expect)(quote.steps[0].allowanceContract).toBe('0x0c66f315542fdec1d312c415b14eef614b0910ef');
+        (0, vitest_1.expect)(quote.steps[0].source).toBe(types_1.SwapperName.ArbitrumBridge);
+    });
+    (0, vitest_1.it)('returns a correct ERC20 withdraw quote', async () => {
+        const Erc20BridgerMock = {
+            getWithdrawalRequest: vitest_1.vi.fn().mockResolvedValue({
+                txRequest: {
+                    data: '0x',
+                    to: '0x',
+                    value: '0',
+                    from: '0x',
+                },
+            }),
+            getChildErc20Address: vitest_1.vi.fn().mockResolvedValue('0xf929de51d91c77e42f5090069e0ad7a09e513c73'),
+            getParentErc20Address: vitest_1.vi
+                .fn()
+                .mockResolvedValue('0xc770eefad204b5180df6a14ee197d99d808ee52d'),
+            getParentGatewayAddress: vitest_1.vi
+                .fn()
+                .mockResolvedValue('0x0c66f315542fdec1d312c415b14eef614b0910ef'),
+        };
+        vitest_1.vi.mocked(sdk_1.Erc20Bridger).mockReturnValue(Erc20BridgerMock);
+        const erc20WithdrawInput = {
+            ...commonInput,
+            sellAsset: assets_1.FOX_ARBITRUM,
+            buyAsset: assets_1.FOX_MAINNET,
+        };
+        const maybeQuote = await (0, getTradeQuote_1.getTradeQuote)(erc20WithdrawInput, {
+            assertGetEvmChainAdapter,
+            getEthersV5Provider: vitest_1.vi.fn(),
+        });
+        (0, vitest_1.expect)(maybeQuote.isOk()).toBe(true);
+        const quote = maybeQuote.unwrap();
+        (0, vitest_1.expect)(quote.receiveAddress).toBe(erc20WithdrawInput.receiveAddress);
+        (0, vitest_1.expect)(quote.rate).toBe('1');
+        (0, vitest_1.expect)(quote.steps[0].allowanceContract).toBe('0x0');
+        (0, vitest_1.expect)(quote.steps[0].source).toBe(types_1.SwapperName.ArbitrumBridge);
+    });
+    (0, vitest_1.it)('returns an error monad if non-EVM chain IDs are used', async () => {
+        const result = await (0, getTradeQuote_1.getTradeQuote)({ ...commonInput, sellAsset: assets_1.BTC }, {
+            assertGetEvmChainAdapter,
+            getEthersV5Provider: vitest_1.vi.fn(),
+        });
+        (0, vitest_1.expect)(result.isErr()).toBe(true);
+        (0, vitest_1.expect)(result.unwrapErr().message).toBe('[ArbitrumBridge: assertValidTrade] - unsupported chainId');
+    });
+});

package/dist/cjs/swappers/ArbitrumBridgeSwapper/getTradeRate/getTradeRate.d.ts

@@ -0,0 +1,4 @@
+import type { Result } from '@sniptt/monads';
+import type { GetEvmTradeRateInput, SwapErrorRight, SwapperDeps } from '../../../types';
+import type { ArbitrumBridgeTradeRate } from '../types';
+export declare function getTradeRate(input: GetEvmTradeRateInput, { assertGetEvmChainAdapter }: SwapperDeps): Promise<Result<ArbitrumBridgeTradeRate, SwapErrorRight>>;

package/dist/cjs/swappers/ArbitrumBridgeSwapper/getTradeRate/getTradeRate.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTradeRate = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const monads_1 = require("@sniptt/monads");
+const uuid_1 = require("uuid");
+const constants_1 = require("../../../constants");
+const types_1 = require("../../../types");
+const utils_1 = require("../../../utils");
+const fetchArbitrumBridgeSwap_1 = require("../utils/fetchArbitrumBridgeSwap");
+const helpers_1 = require("../utils/helpers");
+async function getTradeRate(input, { assertGetEvmChainAdapter }) {
+    const { chainId, sellAsset, buyAsset, supportsEIP1559, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, sendAddress, accountNumber, } = input;
+    const assertion = await (0, helpers_1.assertValidTrade)({ buyAsset, sellAsset });
+    if (assertion.isErr())
+        return (0, monads_1.Err)(assertion.unwrapErr());
+    const isDeposit = sellAsset.chainId === caip_1.ethChainId;
+    // 15 minutes for deposits, 7 days for withdrawals
+    const estimatedExecutionTimeMs = isDeposit ? 15 * 60 * 1000 : 7 * 24 * 60 * 60 * 1000;
+    // 1/1 when bridging on Arbitrum bridge
+    const rate = '1';
+    try {
+        const args = {
+            supportsEIP1559,
+            chainId,
+            buyAsset,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            sellAsset,
+            sendAddress,
+            receiveAddress,
+            assertGetEvmChainAdapter,
+            quoteOrRate: 'rate',
+        };
+        const swap = await (0, fetchArbitrumBridgeSwap_1.fetchArbitrumBridgePrice)(args);
+        const buyAmountBeforeFeesCryptoBaseUnit = sellAmountIncludingProtocolFeesCryptoBaseUnit;
+        const buyAmountAfterFeesCryptoBaseUnit = sellAmountIncludingProtocolFeesCryptoBaseUnit;
+        return (0, monads_1.Ok)({
+            id: (0, uuid_1.v4)(),
+            quoteOrRate: 'rate',
+            accountNumber: undefined,
+            receiveAddress,
+            affiliateBps: '0',
+            rate,
+            slippageTolerancePercentageDecimal: (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_1.SwapperName.ArbitrumBridge),
+            swapperName: types_1.SwapperName.ArbitrumBridge,
+            steps: [
+                {
+                    estimatedExecutionTimeMs,
+                    allowanceContract: swap.allowanceContract,
+                    rate,
+                    buyAsset,
+                    sellAsset,
+                    accountNumber,
+                    buyAmountBeforeFeesCryptoBaseUnit,
+                    buyAmountAfterFeesCryptoBaseUnit,
+                    sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                    feeData: {
+                        protocolFees: {},
+                        networkFeeCryptoBaseUnit: swap.networkFeeCryptoBaseUnit,
+                    },
+                    source: types_1.SwapperName.ArbitrumBridge,
+                },
+            ],
+            direction: isDeposit ? 'deposit' : 'withdrawal',
+        });
+    }
+    catch (err) {
+        return (0, monads_1.Err)((0, utils_1.makeSwapErrorRight)({
+            message: '[ArbitrumBridge: tradeQuote] - failed to get fee data',
+            cause: err,
+            code: types_1.TradeQuoteError.NetworkFeeEstimationFailed,
+        }));
+    }
+}
+exports.getTradeRate = getTradeRate;

package/dist/cjs/swappers/ArbitrumBridgeSwapper/index.d.ts

@@ -0,0 +1,2 @@
+export * from './endpoints';
+export * from './getTradeQuote/getTradeQuote';

package/dist/cjs/swappers/ArbitrumBridgeSwapper/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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("./endpoints"), exports);
+__exportStar(require("./getTradeQuote/getTradeQuote"), exports);

package/dist/cjs/swappers/ArbitrumBridgeSwapper/types.d.ts

@@ -0,0 +1,13 @@
+import type { TradeQuote, TradeRate } from '../../types';
+export declare enum BRIDGE_TYPE {
+    ETH_DEPOSIT = "ETH Deposit",
+    ERC20_DEPOSIT = "ERC20 Deposit",
+    ETH_WITHDRAWAL = "ETH Withdrawal",
+    ERC20_WITHDRAWAL = "ERC20 Withdrawal"
+}
+type ArbitrumBridgeSpecificMetadata = {
+    direction: 'deposit' | 'withdrawal';
+};
+export type ArbitrumBridgeTradeQuote = TradeQuote & ArbitrumBridgeSpecificMetadata;
+export type ArbitrumBridgeTradeRate = TradeRate & ArbitrumBridgeSpecificMetadata;
+export {};

package/dist/cjs/swappers/ArbitrumBridgeSwapper/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BRIDGE_TYPE = void 0;
+var BRIDGE_TYPE;
+(function (BRIDGE_TYPE) {
+    BRIDGE_TYPE["ETH_DEPOSIT"] = "ETH Deposit";
+    BRIDGE_TYPE["ERC20_DEPOSIT"] = "ERC20 Deposit";
+    BRIDGE_TYPE["ETH_WITHDRAWAL"] = "ETH Withdrawal";
+    BRIDGE_TYPE["ERC20_WITHDRAWAL"] = "ERC20 Withdrawal";
+})(BRIDGE_TYPE || (exports.BRIDGE_TYPE = BRIDGE_TYPE = {}));

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const BRIDGE_TYPE_TO_FALLBACK_GAS_LIMIT: {
+    "ETH Deposit": BigNumber;
+    "ERC20 Deposit": BigNumber;
+    "ETH Withdrawal": BigNumber;
+    "ERC20 Withdrawal": BigNumber;
+};

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/constants.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BRIDGE_TYPE_TO_FALLBACK_GAS_LIMIT = void 0;
+const utils_1 = require("@shapeshiftoss/utils");
+const types_1 = require("../types");
+// Broad estimate calculated by looking at a couple of different ERC-20 deposits
+// https://github.com/OffchainLabs/arbitrum-token-bridge/blob/d17c88ef3eef3f4ffc61a04d34d50406039f045d/packages/arb-token-bridge-ui/src/util/TokenDepositUtils.ts#L45-L51
+const fallbackErc20DepositGasLimit = (0, utils_1.bn)(240_000);
+// Broad estimate calculated by looking at a couple of different ERC-20 withdraws
+// https://arbiscan.io/tx/0xf27939d382abcb0cce5c202489db457a6cc0d0dd8062468543400c3bf321148f
+// https://arbiscan.io/tx/0xa4639374806ecc1e9de7beafbab2567c078483b84b708e862bfbd84fbc2fc1da
+// https://arbiscan.io/tx/0xb6c3bce7999b2ae4bbe51a64bc7ab370d21ce9bf6807b805239acbf4c244a6db
+// https://arbiscan.io/tx/0x878aa224a65d831c931192550b3d8fe114fa81660c1af8369c0e2ebea682dd5b
+// https://arbiscan.io/tx/0xf293bd64f9dabddaffc4c8b97f2a602d4e9f77565f5d24018a0f70a95c1ecd38
+const fallbackErc20WithdrawGasLimit = (0, utils_1.bn)(350_000);
+// Actually extremely accurate estimate calculated by looking at a couple of different ETH deposits - gas limit is around 100-100.05k
+// https://etherscan.io/tx/0x31f7860fdb79c76d0301b9197f4e00ed2432170f1be38288f87838ce1184643a
+// https://etherscan.io/tx/0x933c1b625824abeae6f15b4667e22caa3dc14be4929ae62310e2fbf1d39c7d8b
+// https://etherscan.io/tx/0x695090931bb09e60fd378210a0c204ebb01cc137ff00e576074c79a41cc4fa80
+// https://etherscan.io/tx/0xaaef3d2391e4b07f6f0a7524dadde735d4a9822efc2a611e5e8dd5e2708438cc
+const fallbackEthDepositGasLimit = (0, utils_1.bn)(100_000);
+// Broad estimate calculated by looking at a couple of different ETH withdraws
+const fallbackEthWithdrawGasLimit = (0, utils_1.bn)(115_000);
+// https://arbiscan.io/tx/0x641f1c0bacced5896e35aa505abe03076323e769e959aa0f7b9c9cd63d1741dd
+// https://arbiscan.io/tx/0x060f503fa97b137d4298a6adb87cdae83030e1a43ee265b7d52e3b92493acd62
+// https://arbiscan.io/tx/0x162efc48dffb5f7d8c6b454c6df42b4739edb70d2427a311538a0927c5ccdddc
+// https://arbiscan.io/tx/0x51e76bc14ffa7a14d13732459ecd1c8fd3211bfb717ac2eb3de4d40fda8a9c4b
+exports.BRIDGE_TYPE_TO_FALLBACK_GAS_LIMIT = {
+    [types_1.BRIDGE_TYPE.ETH_DEPOSIT]: fallbackEthDepositGasLimit,
+    [types_1.BRIDGE_TYPE.ERC20_DEPOSIT]: fallbackErc20DepositGasLimit,
+    [types_1.BRIDGE_TYPE.ETH_WITHDRAWAL]: fallbackEthWithdrawGasLimit,
+    [types_1.BRIDGE_TYPE.ERC20_WITHDRAWAL]: fallbackErc20WithdrawGasLimit,
+};

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/fetchArbitrumBridgeSwap.d.ts

@@ -0,0 +1,35 @@
+import type { ChildToParentTransactionRequest, ParentToChildTransactionRequest } from '@arbitrum/sdk/dist/lib/dataEntities/transactionRequest';
+import type { ChainId } from '@shapeshiftoss/caip';
+import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
+import type { Asset } from '@shapeshiftoss/types';
+type FetchArbitrumBridgePriceInput = {
+    supportsEIP1559: false;
+    chainId: ChainId;
+    buyAsset: Asset;
+    receiveAddress: string | undefined;
+    sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
+    sellAsset: Asset;
+    sendAddress: undefined;
+    assertGetEvmChainAdapter: (chainId: ChainId) => EvmChainAdapter;
+};
+export type FetchArbitrumBridgeQuoteInput = {
+    supportsEIP1559: boolean;
+    chainId: ChainId;
+    buyAsset: Asset;
+    receiveAddress: string;
+    sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
+    sellAsset: Asset;
+    sendAddress: string;
+    assertGetEvmChainAdapter: (chainId: ChainId) => EvmChainAdapter;
+};
+export declare const fetchArbitrumBridgePrice: (args: FetchArbitrumBridgePriceInput) => Promise<{
+    request: Omit<ParentToChildTransactionRequest | ChildToParentTransactionRequest, 'retryableData'> | undefined;
+    allowanceContract: string;
+    networkFeeCryptoBaseUnit: string;
+}>;
+export declare const fetchArbitrumBridgeQuote: (args: FetchArbitrumBridgeQuoteInput) => Promise<{
+    request: Omit<ParentToChildTransactionRequest | ChildToParentTransactionRequest, 'retryableData'> | undefined;
+    allowanceContract: string;
+    networkFeeCryptoBaseUnit: string;
+}>;
+export {};

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/fetchArbitrumBridgeSwap.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchArbitrumBridgeQuote = exports.fetchArbitrumBridgePrice = void 0;
+const sdk_1 = require("@arbitrum/sdk");
+const caip_1 = require("@shapeshiftoss/caip");
+const contracts_1 = require("@shapeshiftoss/contracts");
+const types_1 = require("@shapeshiftoss/types");
+const utils_1 = require("@shapeshiftoss/utils");
+const ethers5_1 = require("ethers5");
+const chains_1 = require("viem/chains");
+const types_2 = require("../types");
+const helpers_1 = require("./helpers");
+const fetchArbitrumBridgeSwap = async ({ chainId, buyAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, sellAsset, sendAddress, receiveAddress, supportsEIP1559, assertGetEvmChainAdapter, quoteOrRate, }) => {
+    if (quoteOrRate === 'quote' && !receiveAddress)
+        throw new Error('receiveAddress is required for Arbitrum Bridge quotes');
+    if (quoteOrRate === 'quote' && !sendAddress)
+        throw new Error('sendAddress is required for Arbitrum Bridge quotes');
+    const adapter = assertGetEvmChainAdapter(chainId);
+    const l2Network = await (0, sdk_1.getArbitrumNetwork)(chains_1.arbitrum.id);
+    const isDeposit = sellAsset.chainId === caip_1.ethChainId;
+    const isEthBridge = isDeposit ? sellAsset.assetId === caip_1.ethAssetId : buyAsset.assetId === caip_1.ethAssetId;
+    const bridgeType = (() => {
+        if (isDeposit) {
+            return isEthBridge ? types_2.BRIDGE_TYPE.ETH_DEPOSIT : types_2.BRIDGE_TYPE.ERC20_DEPOSIT;
+        }
+        return isEthBridge ? types_2.BRIDGE_TYPE.ETH_WITHDRAWAL : types_2.BRIDGE_TYPE.ERC20_WITHDRAWAL;
+    })();
+    const parentProvider = (0, contracts_1.getEthersV5Provider)(types_1.KnownChainIds.EthereumMainnet);
+    const childProvider = (0, contracts_1.getEthersV5Provider)(types_1.KnownChainIds.ArbitrumMainnet);
+    switch (bridgeType) {
+        case types_2.BRIDGE_TYPE.ETH_DEPOSIT: {
+            const bridger = new sdk_1.EthBridger(l2Network);
+            const maybeRequest = quoteOrRate === 'quote'
+                ? await bridger
+                    .getDepositToRequest({
+                    parentProvider,
+                    childProvider,
+                    amount: ethers5_1.BigNumber.from(sellAmountIncludingProtocolFeesCryptoBaseUnit),
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !sendAddress)` above
+                    from: sendAddress ?? '',
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !receiveAddress)` above
+                    destinationAddress: receiveAddress ?? '',
+                })
+                    .catch(e => {
+                    console.error('Error getting ETH deposit request', e);
+                    return undefined;
+                })
+                : undefined;
+            const networkFeeCryptoBaseUnit = await (0, helpers_1.getNetworkFeeOrFallbackCryptoBaseUnit)({
+                maybeRequest,
+                bridgeType,
+                supportsEIP1559,
+                adapter,
+            });
+            return { request: maybeRequest, networkFeeCryptoBaseUnit, allowanceContract: '0x0' };
+        }
+        case types_2.BRIDGE_TYPE.ETH_WITHDRAWAL: {
+            const bridger = new sdk_1.EthBridger(l2Network);
+            const maybeRequest = quoteOrRate === 'quote'
+                ? await bridger
+                    .getWithdrawalRequest({
+                    amount: ethers5_1.BigNumber.from(sellAmountIncludingProtocolFeesCryptoBaseUnit),
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !sendAddress)` above
+                    from: sendAddress ?? '',
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !receiveAddress)` above
+                    destinationAddress: receiveAddress ?? '',
+                })
+                    .catch(e => {
+                    console.error('Error getting ETH withdraw request', e);
+                    return undefined;
+                })
+                : undefined;
+            const networkFeeCryptoBaseUnit = await (0, helpers_1.getNetworkFeeOrFallbackCryptoBaseUnit)({
+                maybeRequest,
+                bridgeType,
+                supportsEIP1559,
+                adapter,
+            });
+            return { request: maybeRequest, networkFeeCryptoBaseUnit, allowanceContract: '0x0' };
+        }
+        case types_2.BRIDGE_TYPE.ERC20_DEPOSIT: {
+            const bridger = new sdk_1.Erc20Bridger(l2Network);
+            const erc20ParentAddress = (0, caip_1.fromAssetId)(sellAsset.assetId).assetReference;
+            const allowanceContract = await bridger.getParentGatewayAddress(erc20ParentAddress, parentProvider);
+            const maybeRequest = quoteOrRate === 'quote'
+                ? await bridger
+                    .getDepositRequest({
+                    amount: ethers5_1.BigNumber.from(sellAmountIncludingProtocolFeesCryptoBaseUnit),
+                    parentProvider,
+                    childProvider,
+                    erc20ParentAddress,
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !sendAddress)` above
+                    from: sendAddress ?? '',
+                    destinationAddress: receiveAddress,
+                    retryableGasOverrides: {
+                        // https://github.com/OffchainLabs/arbitrum-token-bridge/blob/d17c88ef3eef3f4ffc61a04d34d50406039f045d/packages/arb-token-bridge-ui/src/util/TokenDepositUtils.ts#L159
+                        // the gas limit may vary by about 20k due to SSTORE (zero vs nonzero)
+                        // the 30% gas limit increase should cover the difference
+                        gasLimit: { percentIncrease: ethers5_1.BigNumber.from(30) },
+                    },
+                })
+                    .catch(e => {
+                    console.error('Error getting ERC20 deposit request', e);
+                    return undefined;
+                })
+                : undefined;
+            const networkFeeCryptoBaseUnit = await (0, helpers_1.getNetworkFeeOrFallbackCryptoBaseUnit)({
+                maybeRequest,
+                bridgeType,
+                supportsEIP1559,
+                adapter,
+            });
+            return { request: maybeRequest, networkFeeCryptoBaseUnit, allowanceContract };
+        }
+        case types_2.BRIDGE_TYPE.ERC20_WITHDRAWAL: {
+            const bridger = new sdk_1.Erc20Bridger(l2Network);
+            const erc20ParentAddress = (0, caip_1.fromAssetId)(buyAsset.assetId).assetReference;
+            const maybeRequest = quoteOrRate === 'quote'
+                ? await bridger
+                    .getWithdrawalRequest({
+                    amount: ethers5_1.BigNumber.from(sellAmountIncludingProtocolFeesCryptoBaseUnit),
+                    erc20ParentAddress,
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !sendAddress)` above
+                    from: sendAddress ?? '',
+                    // This is actually guarded against in if `(quoteOrRate === 'quote' && !receiveAddress)` above
+                    destinationAddress: receiveAddress ?? '',
+                })
+                    .catch(e => {
+                    console.error('Error getting ERC20 withdraw request', e);
+                    return undefined;
+                })
+                : undefined;
+            const networkFeeCryptoBaseUnit = await (0, helpers_1.getNetworkFeeOrFallbackCryptoBaseUnit)({
+                maybeRequest,
+                bridgeType,
+                supportsEIP1559,
+                adapter,
+            });
+            return { request: maybeRequest, networkFeeCryptoBaseUnit, allowanceContract: '0x0' };
+        }
+        default:
+            return (0, utils_1.assertUnreachable)(bridgeType);
+    }
+};
+const fetchArbitrumBridgePrice = (args) => fetchArbitrumBridgeSwap({ ...args, quoteOrRate: 'rate' });
+exports.fetchArbitrumBridgePrice = fetchArbitrumBridgePrice;
+const fetchArbitrumBridgeQuote = (args) => fetchArbitrumBridgeSwap({ ...args, quoteOrRate: 'quote' });
+exports.fetchArbitrumBridgeQuote = fetchArbitrumBridgeQuote;

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/helpers.d.ts

@@ -0,0 +1,16 @@
+import type { ChildToParentTransactionRequest, ParentToChildTransactionRequest } from '@arbitrum/sdk';
+import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
+import type { Asset } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads/build';
+import type { SwapErrorRight } from '../../../types';
+import type { BRIDGE_TYPE } from '../types';
+export declare const assertValidTrade: ({ buyAsset, sellAsset, }: {
+    buyAsset: Asset;
+    sellAsset: Asset;
+}) => Promise<Result<boolean, SwapErrorRight>>;
+export declare const getNetworkFeeOrFallbackCryptoBaseUnit: ({ maybeRequest, bridgeType, supportsEIP1559, adapter, }: {
+    maybeRequest: ParentToChildTransactionRequest | ChildToParentTransactionRequest | undefined;
+    bridgeType: BRIDGE_TYPE;
+    supportsEIP1559: boolean;
+    adapter: EvmChainAdapter;
+}) => Promise<string>;

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/helpers.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetworkFeeOrFallbackCryptoBaseUnit = exports.assertValidTrade = void 0;
+const sdk_1 = require("@arbitrum/sdk");
+const caip_1 = require("@shapeshiftoss/caip");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const contracts_1 = require("@shapeshiftoss/contracts");
+const types_1 = require("@shapeshiftoss/types");
+const build_1 = require("@sniptt/monads/build");
+const viem_1 = require("viem");
+const chains_1 = require("viem/chains");
+const types_2 = require("../../../types");
+const utils_1 = require("../../../utils");
+const constants_1 = require("./constants");
+const types_3 = require("./types");
+const assertValidTrade = async ({ buyAsset, sellAsset, }) => {
+    if (!types_3.arbitrumBridgeSupportedChainIds.includes(sellAsset.chainId) ||
+        !types_3.arbitrumBridgeSupportedChainIds.includes(buyAsset.chainId)) {
+        return (0, build_1.Err)((0, utils_1.makeSwapErrorRight)({
+            message: `[ArbitrumBridge: assertValidTrade] - unsupported chainId`,
+            code: types_2.TradeQuoteError.UnsupportedChain,
+            details: { buyAsset, sellAsset },
+        }));
+    }
+    if (buyAsset.chainId === sellAsset.chainId) {
+        return (0, build_1.Err)((0, utils_1.makeSwapErrorRight)({
+            message: `[ArbitrumBridge: assertValidTrade] - both assets must be on different chainIds`,
+            code: types_2.TradeQuoteError.UnsupportedTradePair,
+            details: { buyAsset, sellAsset },
+        }));
+    }
+    const isDeposit = sellAsset.chainId === caip_1.ethChainId;
+    const isEthBridge = isDeposit
+        ? sellAsset.assetId === caip_1.ethAssetId
+        : sellAsset.assetId === caip_1.arbitrumAssetId;
+    const isTokenBridge = !isEthBridge;
+    if (isEthBridge) {
+        const isInvalidPair = isDeposit
+            ? buyAsset.assetId !== caip_1.arbitrumAssetId
+            : buyAsset.assetId !== caip_1.ethAssetId;
+        if (isInvalidPair) {
+            return (0, build_1.Err)((0, utils_1.makeSwapErrorRight)({
+                message: `[ArbitrumBridge: tradeQuote] - Invalid ETH bridge pair`,
+                code: types_2.TradeQuoteError.UnsupportedTradePair,
+                details: { buyAsset, sellAsset },
+            }));
+        }
+    }
+    if (isTokenBridge) {
+        const childNetwork = await (0, sdk_1.getArbitrumNetwork)(chains_1.arbitrum.id);
+        const bridger = new sdk_1.Erc20Bridger(childNetwork);
+        const erc20ParentAddress = (0, caip_1.fromAssetId)((isDeposit ? sellAsset : buyAsset).assetId).assetReference;
+        const erc20ChildAddress = (0, caip_1.fromAssetId)((isDeposit ? buyAsset : sellAsset).assetId).assetReference;
+        const parentProvider = (0, contracts_1.getEthersV5Provider)(types_1.KnownChainIds.EthereumMainnet);
+        const childProvider = (0, contracts_1.getEthersV5Provider)(types_1.KnownChainIds.ArbitrumMainnet);
+        // Since our related assets list isn't exhaustive and won't cut it to determine the Parent <-> Child mapping, we double check that the bridge is valid
+        // by checking against Arbitrum bridge's own mappings, which uses different sources (Coingecko, Gemini, Uni and its own lists at the time of writing)
+        const arbitrumBridgeErc20ChildAddress = await bridger.getChildErc20Address(erc20ParentAddress, parentProvider);
+        const arbitrumBridgeErc20ParentAddress = await bridger.getParentErc20Address(erc20ChildAddress, childProvider);
+        if (!(0, viem_1.isAddressEqual)((0, viem_1.getAddress)(arbitrumBridgeErc20ParentAddress), (0, viem_1.getAddress)(erc20ParentAddress))) {
+            return (0, build_1.Err)((0, utils_1.makeSwapErrorRight)({
+                message: `[ArbitrumBridge: tradeQuote] - Invalid Parent ERC20 address: ${erc20ParentAddress}`,
+                code: types_2.TradeQuoteError.UnsupportedTradePair,
+            }));
+        }
+        if (!(0, viem_1.isAddressEqual)((0, viem_1.getAddress)(arbitrumBridgeErc20ChildAddress), (0, viem_1.getAddress)(erc20ChildAddress))) {
+            return (0, build_1.Err)((0, utils_1.makeSwapErrorRight)({
+                message: `[ArbitrumBridge: tradeQuote] - Invalid Child ERC20 address: ${erc20ChildAddress}`,
+                code: types_2.TradeQuoteError.UnsupportedTradePair,
+            }));
+        }
+    }
+    return (0, build_1.Ok)(true);
+};
+exports.assertValidTrade = assertValidTrade;
+const getNetworkFeeOrFallbackCryptoBaseUnit = async ({ maybeRequest, bridgeType, supportsEIP1559, adapter, }) => {
+    // Fallback fees
+    if (!maybeRequest) {
+        const { average } = await adapter.getGasFeeData();
+        const { gasPrice, maxFeePerGas } = average;
+        const fallbackGasLimit = constants_1.BRIDGE_TYPE_TO_FALLBACK_GAS_LIMIT[bridgeType];
+        // eip1559 fees
+        if (supportsEIP1559 && maxFeePerGas) {
+            return fallbackGasLimit.times(maxFeePerGas).toFixed();
+        }
+        // legacy fees
+        return fallbackGasLimit.times(gasPrice).toFixed();
+    }
+    // Actual fees
+    const feeData = await chain_adapters_1.evm.getFees({
+        adapter,
+        data: maybeRequest.txRequest.data.toString(),
+        to: maybeRequest.txRequest.to,
+        value: maybeRequest.txRequest.value.toString(),
+        from: maybeRequest.txRequest.from,
+        supportsEIP1559,
+    });
+    return feeData.networkFeeCryptoBaseUnit;
+};
+exports.getNetworkFeeOrFallbackCryptoBaseUnit = getNetworkFeeOrFallbackCryptoBaseUnit;

package/dist/cjs/swappers/ArbitrumBridgeSwapper/utils/types.d.ts

@@ -0,0 +1,3 @@
+import { KnownChainIds } from '@shapeshiftoss/types';
+export declare const arbitrumBridgeSupportedChainIds: readonly [KnownChainIds.EthereumMainnet, KnownChainIds.ArbitrumMainnet];
+export type ArbitrumBridgeSupportedChainId = (typeof arbitrumBridgeSupportedChainIds)[number];