@shapeshiftoss/swapper 20.2.0 → 20.4.0

package/dist/cjs/utils/tron/getTronNetworkFeeCryptoBaseUnit.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTronContractCallNetworkFeeCryptoBaseUnit = exports.getTronContractCallFallbackFeeCryptoBaseUnit = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const unchained_client_1 = require("@shapeshiftoss/unchained-client");
+const utils_1 = require("@shapeshiftoss/utils");
+// A measured worst-case energy under the adapter's margin, at live prices
+const getTronContractCallFallbackFeeCryptoBaseUnit = async ({ adapter, energy, bandwidthBytes, contractAddress, fullEnergyOnShareLookupFailure = false, }) => {
+    const { httpProvider } = adapter;
+    const [{ energyPrice, bandwidthPrice }, share] = await Promise.all([
+        httpProvider.getChainPrices(),
+        contractAddress
+            ? httpProvider.getContractEnergyShare(chain_adapters_1.tron.toTronBase58(contractAddress)).catch(error => {
+                if (!fullEnergyOnShareLookupFailure)
+                    throw error;
+                return undefined;
+            })
+            : undefined,
+    ]);
+    const callerEnergy = share ? unchained_client_1.tron.getCallerEnergy(Number(energy), share) : energy;
+    return (0, utils_1.bn)(callerEnergy)
+        .times(chain_adapters_1.tron.TRON_ENERGY_SAFETY_MARGIN)
+        .times(energyPrice)
+        .plus((0, utils_1.bn)(bandwidthBytes).times(bandwidthPrice))
+        .toFixed(0);
+};
+exports.getTronContractCallFallbackFeeCryptoBaseUnit = getTronContractCallFallbackFeeCryptoBaseUnit;
+// Quote arm: a funded token sell that reverts for want of its allowance prices the measured worst case, anything else throws
+const getTronContractCallNetworkFeeCryptoBaseUnit = async ({ adapter, transactionData, from, sellAsset, sellAmountCryptoBaseUnit, spenderAddress, fallbackEnergy, }) => {
+    const { to, value, data } = transactionData;
+    try {
+        const { fast } = await adapter.getFeeData({
+            to,
+            value,
+            chainSpecific: { from, data, requireEnergyShare: true },
+        });
+        return fast.txFee;
+    }
+    catch (error) {
+        if (!(0, utils_1.isToken)(sellAsset.assetId))
+            throw error;
+        const contractAddress = (0, caip_1.fromAssetId)(sellAsset.assetId).assetReference;
+        const { httpProvider } = adapter;
+        const [allowance, balance] = await Promise.all([
+            httpProvider.getTrc20Allowance({
+                contractAddress,
+                owner: from,
+                spender: chain_adapters_1.tron.toTronBase58(spenderAddress),
+            }),
+            httpProvider.getTrc20Balance({ contractAddress, address: from }),
+        ]);
+        const sellAmount = BigInt(sellAmountCryptoBaseUnit);
+        if (BigInt(allowance) >= sellAmount || BigInt(balance) < sellAmount)
+            throw error;
+        return (0, exports.getTronContractCallFallbackFeeCryptoBaseUnit)({
+            adapter,
+            energy: fallbackEnergy,
+            bandwidthBytes: chain_adapters_1.tron.getTronContractCallBandwidthBytes(data),
+            contractAddress: to,
+        });
+    }
+};
+exports.getTronContractCallNetworkFeeCryptoBaseUnit = getTronContractCallNetworkFeeCryptoBaseUnit;

package/dist/cjs/utils/tron/getTronNetworkFeeCryptoBaseUnit.test.d.ts

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

package/dist/cjs/utils/tron/getTronNetworkFeeCryptoBaseUnit.test.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const caip_1 = require("@shapeshiftoss/caip");
+const vitest_1 = require("vitest");
+const assets_1 = require("../test-data/assets");
+const getTronNetworkFeeCryptoBaseUnit_1 = require("./getTronNetworkFeeCryptoBaseUnit");
+const USDT = 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t';
+const TRX = { ...assets_1.ETH, assetId: `${caip_1.tronChainId}/slip44:195`, chainId: caip_1.tronChainId };
+const USDT_TRON = { ...assets_1.ETH, assetId: `${caip_1.tronChainId}/trc20:${USDT}`, chainId: caip_1.tronChainId };
+const FROM = 'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9N';
+const SPENDER_HEX = '4107a39ae4c49dee86e892450b20881f32cd5d500d';
+const SPENDER = 'TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K';
+const transactionData = { to: SPENDER, data: '0x2213bc0b', value: '0' };
+const makeAdapter = ({ allowance = '0', balance = '100000000', simulation = 'ok', } = {}) => {
+    const getFeeData = simulation === 'ok'
+        ? vitest_1.vi.fn().mockResolvedValue({ fast: { txFee: '9000000' } })
+        : vitest_1.vi.fn().mockRejectedValue(new Error('REVERT opcode executed'));
+    const getTrc20Allowance = vitest_1.vi.fn().mockResolvedValue(allowance);
+    const getTrc20Balance = vitest_1.vi.fn().mockResolvedValue(balance);
+    const getContractEnergyShare = vitest_1.vi.fn().mockResolvedValue({
+        callerPercent: 100,
+        originEnergyLimit: 0,
+        originEnergyAvailable: 0,
+    });
+    const adapter = {
+        getFeeData,
+        httpProvider: {
+            getTrc20Allowance,
+            getTrc20Balance,
+            getContractEnergyShare,
+            getChainPrices: () => Promise.resolve({ energyPrice: 100, bandwidthPrice: 1000 }),
+        },
+    };
+    return {
+        adapter: adapter,
+        getFeeData,
+        getTrc20Allowance,
+        getTrc20Balance,
+        getContractEnergyShare,
+    };
+};
+const baseArgs = {
+    transactionData,
+    from: FROM,
+    sellAmountCryptoBaseUnit: '100000000',
+    spenderAddress: SPENDER_HEX,
+    fallbackEnergy: '400000',
+};
+// 400000 energy * 1.2 margin * 100 sun + (4 calldata + 279 envelope) bytes * 1000 sun
+const FALLBACK_FEE = '48283000';
+(0, vitest_1.describe)('getTronContractCallFallbackFeeCryptoBaseUnit', () => {
+    (0, vitest_1.it)('prices the energy under the adapter margin at live prices plus the bandwidth', async () => {
+        const { adapter, getContractEnergyShare } = makeAdapter();
+        (0, vitest_1.expect)(await (0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallFallbackFeeCryptoBaseUnit)({
+            adapter,
+            energy: '400000',
+            bandwidthBytes: 283,
+        })).toBe(FALLBACK_FEE);
+        (0, vitest_1.expect)(getContractEnergyShare).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('bills the caller only their share of a contract whose deployer covers the rest', async () => {
+        const { adapter, getContractEnergyShare } = makeAdapter();
+        getContractEnergyShare.mockResolvedValue({
+            callerPercent: 5,
+            originEnergyLimit: 10_000_000,
+            originEnergyAvailable: 5_000_000,
+        });
+        // 20000 caller energy * 1.2 margin * 100 sun + 283 bytes * 1000 sun
+        (0, vitest_1.expect)(await (0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallFallbackFeeCryptoBaseUnit)({
+            adapter,
+            energy: '400000',
+            bandwidthBytes: 283,
+            contractAddress: SPENDER,
+        })).toBe('2683000');
+        (0, vitest_1.expect)(getContractEnergyShare).toHaveBeenCalledWith(SPENDER);
+    });
+});
+(0, vitest_1.describe)('getTronContractCallFallbackFeeCryptoBaseUnit share lookup failure', () => {
+    (0, vitest_1.it)('rejects by default', async () => {
+        const { adapter, getContractEnergyShare } = makeAdapter();
+        getContractEnergyShare.mockRejectedValue(new Error('429'));
+        await (0, vitest_1.expect)((0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallFallbackFeeCryptoBaseUnit)({
+            adapter,
+            energy: '400000',
+            bandwidthBytes: 283,
+            contractAddress: SPENDER,
+        })).rejects.toThrow('429');
+    });
+    (0, vitest_1.it)('prices the caller in full when the caller opts in', async () => {
+        const { adapter, getContractEnergyShare } = makeAdapter();
+        getContractEnergyShare.mockRejectedValue(new Error('429'));
+        (0, vitest_1.expect)(await (0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallFallbackFeeCryptoBaseUnit)({
+            adapter,
+            energy: '400000',
+            bandwidthBytes: 283,
+            contractAddress: SPENDER,
+            fullEnergyOnShareLookupFailure: true,
+        })).toBe(FALLBACK_FEE);
+    });
+});
+(0, vitest_1.describe)('getTronContractCallNetworkFeeCryptoBaseUnit', () => {
+    (0, vitest_1.it)('prices a successful simulation without reading the allowance', async () => {
+        const { adapter, getFeeData, getTrc20Allowance } = makeAdapter();
+        const actual = await (0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({
+            ...baseArgs,
+            adapter,
+            sellAsset: USDT_TRON,
+        });
+        (0, vitest_1.expect)(actual).toBe('9000000');
+        (0, vitest_1.expect)(getFeeData).toHaveBeenCalledWith({
+            to: SPENDER,
+            value: '0',
+            chainSpecific: { from: FROM, data: '0x2213bc0b', requireEnergyShare: true },
+        });
+        (0, vitest_1.expect)(getTrc20Allowance).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('prices the measured worst case when a funded token sell reverts without its allowance', async () => {
+        const { adapter, getTrc20Allowance, getTrc20Balance, getContractEnergyShare } = makeAdapter({
+            simulation: 'revert',
+            allowance: '0',
+        });
+        const actual = await (0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({
+            ...baseArgs,
+            adapter,
+            sellAsset: USDT_TRON,
+        });
+        (0, vitest_1.expect)(actual).toBe(FALLBACK_FEE);
+        (0, vitest_1.expect)(getTrc20Allowance).toHaveBeenCalledWith({
+            contractAddress: USDT,
+            owner: FROM,
+            spender: SPENDER,
+        });
+        (0, vitest_1.expect)(getTrc20Balance).toHaveBeenCalledWith({ contractAddress: USDT, address: FROM });
+        (0, vitest_1.expect)(getContractEnergyShare).toHaveBeenCalledWith(SPENDER);
+    });
+    (0, vitest_1.it)('fails the quote rather than guessing when the share lookup fails', async () => {
+        const { adapter, getContractEnergyShare } = makeAdapter({
+            simulation: 'revert',
+            allowance: '0',
+        });
+        getContractEnergyShare.mockRejectedValue(new Error('429'));
+        await (0, vitest_1.expect)((0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({ ...baseArgs, adapter, sellAsset: USDT_TRON })).rejects.toThrow('429');
+    });
+    (0, vitest_1.it)('throws when a token sell reverts with a sufficient allowance', async () => {
+        const { adapter } = makeAdapter({ simulation: 'revert', allowance: '100000000' });
+        await (0, vitest_1.expect)((0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({ ...baseArgs, adapter, sellAsset: USDT_TRON })).rejects.toThrow('REVERT opcode executed');
+    });
+    (0, vitest_1.it)('throws when the token balance cannot cover the sell', async () => {
+        const { adapter } = makeAdapter({ simulation: 'revert', allowance: '0', balance: '1' });
+        await (0, vitest_1.expect)((0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({ ...baseArgs, adapter, sellAsset: USDT_TRON })).rejects.toThrow('REVERT opcode executed');
+    });
+    (0, vitest_1.it)('throws when a native sell reverts', async () => {
+        const { adapter, getTrc20Allowance } = makeAdapter({ simulation: 'revert' });
+        await (0, vitest_1.expect)((0, getTronNetworkFeeCryptoBaseUnit_1.getTronContractCallNetworkFeeCryptoBaseUnit)({ ...baseArgs, adapter, sellAsset: TRX })).rejects.toThrow('REVERT opcode executed');
+        (0, vitest_1.expect)(getTrc20Allowance).not.toHaveBeenCalled();
+    });
+});

package/dist/cjs/utils/tron/getUnsignedTronTransaction.d.ts

@@ -1,2 +1,3 @@
+import { tron } from '@shapeshiftoss/chain-adapters';
 import type { GetUnsignedTronTransactionArgs } from '../../types';
-export declare const getUnsignedTronTransaction: ({ stepIndex, tradeQuote, from, assertGetTronChainAdapter, }: GetUnsignedTronTransactionArgs) => Promise<import("packages/chain-adapters/src/tron").TronSignTx>;
+export declare const getUnsignedTronTransaction: ({ stepIndex, tradeQuote, from, assertGetTronChainAdapter, }: GetUnsignedTronTransactionArgs) => Promise<tron.TronSignTx>;

package/dist/cjs/utils/tron/getUnsignedTronTransaction.js

@@ -1,64 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUnsignedTronTransaction = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const utils_1 = require("@shapeshiftoss/utils");
-const tronweb_1 = require("tronweb");
 const utils_2 = require("../../utils");
 const getUnsignedTronTransaction = ({ stepIndex, tradeQuote, from, assertGetTronChainAdapter, }) => {
     if (!(0, utils_2.isExecutableTradeQuote)(tradeQuote))
-        throw new Error('Unable to execute a trade rate quote');
+        throw new Error('Unable to execute a trade rate');
     const step = (0, utils_2.getExecutableTradeStep)(tradeQuote, stepIndex);
-    const { accountNumber, sellAsset, relayTransactionMetadata, butterSwapTransactionMetadata } = step;
+    const { accountNumber, sellAsset, transactionData, feeData } = step;
+    if (transactionData?.type !== 'tron')
+        throw new Error('Missing tron transactionData');
     const adapter = assertGetTronChainAdapter(sellAsset.chainId);
-    if (butterSwapTransactionMetadata) {
-        const { to, data, method, args, value: butterValue } = butterSwapTransactionMetadata;
-        if (!to)
-            throw new Error('Missing Butter swap contract address');
-        if (!data)
-            throw new Error('Missing Butter swap transaction data');
-        // Use Butter's value field which includes swap fees for same-chain swaps
-        // For native TRX sells, also include the sell amount
-        const isNativeTron = sellAsset.assetId === caip_1.tronAssetId;
-        const value = isNativeTron ? step.sellAmountIncludingProtocolFeesCryptoBaseUnit : butterValue;
-        return adapter.buildCustomApiTx({
-            from,
-            to,
-            accountNumber,
-            data,
-            value,
-            method,
-            args,
-        });
-    }
-    if (relayTransactionMetadata?.data) {
-        if (!relayTransactionMetadata.to) {
-            throw new Error('Missing Relay transaction destination address');
-        }
-        const to = tronweb_1.TronWeb.address.fromHex(relayTransactionMetadata.to);
-        const isNativeTron = sellAsset.assetId === caip_1.tronAssetId;
-        const value = isNativeTron ? step.sellAmountIncludingProtocolFeesCryptoBaseUnit : '0';
-        return adapter.buildCustomApiTx({
-            from,
-            to,
-            accountNumber,
-            data: relayTransactionMetadata.data,
-            value,
-        });
-    }
-    const nearIntentsDepositAddress = step.swapperMetadata?.name === 'nearIntents' ? step.swapperMetadata.depositAddress : undefined;
-    const to = relayTransactionMetadata?.to ?? nearIntentsDepositAddress;
-    if (!to)
-        throw new Error('Missing transaction destination address');
-    const value = step.sellAmountIncludingProtocolFeesCryptoBaseUnit;
-    const contractAddress = (0, utils_1.contractAddressOrUndefined)(sellAsset.assetId);
+    const { to, value, data, memo } = transactionData;
+    const feeLimit = chain_adapters_1.tron.getTronFeeLimit(feeData.networkFeeCryptoBaseUnit);
+    if (data)
+        return adapter.buildCustomApiTx({ from, to, accountNumber, data, value, feeLimit });
     return adapter.buildSendApiTransaction({
-        to,
         from,
-        value,
+        to,
         accountNumber,
+        value,
         chainSpecific: {
-            contractAddress,
+            contractAddress: (0, utils_1.contractAddressOrUndefined)(sellAsset.assetId),
+            memo,
+            feeLimit,
         },
     });
 };

package/dist/cjs/utils/tron/getUnsignedTronTransaction.test.d.ts

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

package/dist/cjs/utils/tron/getUnsignedTronTransaction.test.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const caip_1 = require("@shapeshiftoss/caip");
+const vitest_1 = require("vitest");
+const assets_1 = require("../test-data/assets");
+const getUnsignedTronTransaction_1 = require("./getUnsignedTronTransaction");
+const USDT = 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t';
+const TRX = { ...assets_1.ETH, assetId: `${caip_1.tronChainId}/slip44:195`, chainId: caip_1.tronChainId };
+const USDT_TRON = { ...assets_1.ETH, assetId: `${caip_1.tronChainId}/trc20:${USDT}`, chainId: caip_1.tronChainId };
+const FROM = 'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9N';
+const TO = 'TCFNp179Lg46D16zKoumd4Poa2WFFdtqYj';
+const makeArgs = (sellAsset, transactionData, feeData = {
+    networkFeeCryptoBaseUnit: '9000000',
+}) => {
+    const adapter = {
+        buildCustomApiTx: vitest_1.vi.fn().mockResolvedValue('custom'),
+        buildSendApiTransaction: vitest_1.vi.fn().mockResolvedValue('send'),
+    };
+    const tradeQuote = {
+        quoteOrRate: 'quote',
+        steps: [{ accountNumber: 0, sellAsset, transactionData, feeData }],
+    };
+    return {
+        adapter,
+        args: {
+            tradeQuote,
+            stepIndex: 0,
+            from: FROM,
+            assertGetTronChainAdapter: () => adapter,
+        },
+    };
+};
+(0, vitest_1.describe)('getUnsignedTronTransaction', () => {
+    (0, vitest_1.it)('builds a contract call when data is present', async () => {
+        const { adapter, args } = makeArgs(TRX, {
+            type: 'tron',
+            to: TO,
+            data: '0xdeadbeef',
+            value: '1',
+        });
+        (0, vitest_1.expect)(await (0, getUnsignedTronTransaction_1.getUnsignedTronTransaction)(args)).toBe('custom');
+        (0, vitest_1.expect)(adapter.buildCustomApiTx).toHaveBeenCalledWith({
+            from: FROM,
+            to: TO,
+            accountNumber: 0,
+            data: '0xdeadbeef',
+            value: '1',
+            feeLimit: 27_000_000,
+        });
+    });
+    (0, vitest_1.it)('uses the standard fee limit when the step carries no estimate', async () => {
+        const { adapter, args } = makeArgs(TRX, { type: 'tron', to: TO, data: '0xdeadbeef', value: '1' }, { networkFeeCryptoBaseUnit: undefined });
+        await (0, getUnsignedTronTransaction_1.getUnsignedTronTransaction)(args);
+        (0, vitest_1.expect)(adapter.buildCustomApiTx).toHaveBeenCalledWith(vitest_1.expect.objectContaining({ feeLimit: 100_000_000 }));
+    });
+    (0, vitest_1.it)('builds a send of the sell asset when data is absent', async () => {
+        const { adapter, args } = makeArgs(USDT_TRON, {
+            type: 'tron',
+            to: TO,
+            value: '1',
+            memo: '=:ETH.ETH:0xabc',
+        });
+        (0, vitest_1.expect)(await (0, getUnsignedTronTransaction_1.getUnsignedTronTransaction)(args)).toBe('send');
+        (0, vitest_1.expect)(adapter.buildSendApiTransaction).toHaveBeenCalledWith({
+            from: FROM,
+            to: TO,
+            accountNumber: 0,
+            value: '1',
+            chainSpecific: { contractAddress: USDT, memo: '=:ETH.ETH:0xabc', feeLimit: 27_000_000 },
+        });
+    });
+    (0, vitest_1.it)('throws without tron transactionData', () => {
+        const { args } = makeArgs(TRX, undefined);
+        (0, vitest_1.expect)(() => (0, getUnsignedTronTransaction_1.getUnsignedTronTransaction)(args)).toThrow('Missing tron transactionData');
+    });
+});

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

@@ -1,2 +1,4 @@
+export * from './constants';
+export * from './getTronNetworkFeeCryptoBaseUnit';
 export * from './getTronTransactionFees';
 export * from './getUnsignedTronTransaction';

package/dist/cjs/utils/tron/index.js

@@ -14,5 +14,7 @@ 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("./constants"), exports);
+__exportStar(require("./getTronNetworkFeeCryptoBaseUnit"), exports);
 __exportStar(require("./getTronTransactionFees"), exports);
 __exportStar(require("./getUnsignedTronTransaction"), exports);