@ton/appkit 0.0.5-alpha.2 → 1.0.0-alpha.0

package/dist/cjs/utils/amount/truncate-decimals.test.js

@@ -0,0 +1,83 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const truncate_decimals_1 = require("./truncate-decimals");
+(0, vitest_1.describe)('truncateDecimals', () => {
+    (0, vitest_1.it)('should return integers unchanged', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('123', 2)).toBe('123');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('0', 5)).toBe('0');
+    });
+    (0, vitest_1.it)('should truncate decimals exceeding maxDecimals', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.23456', 2)).toBe('1.23');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.23456', 4)).toBe('1.2345');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('0.123456789', 9)).toBe('0.123456789');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('0.1234567890', 9)).toBe('0.123456789');
+    });
+    (0, vitest_1.it)('should return value unchanged when decimals are within limit', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.23', 5)).toBe('1.23');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.2', 2)).toBe('1.2');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('5.0', 1)).toBe('5.0');
+    });
+    (0, vitest_1.it)('should handle maxDecimals of 0', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.999', 0)).toBe('1');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('42.1', 0)).toBe('42');
+    });
+    (0, vitest_1.it)('should strip trailing dot', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.', 3)).toBe('1');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.', 0)).toBe('1');
+    });
+    (0, vitest_1.it)('should handle empty string', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('', 2)).toBe('');
+    });
+    (0, vitest_1.it)('should handle number input', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(1.23456, 2)).toBe('1.23');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(42, 3)).toBe('42');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(0.1, 5)).toBe('0.1');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(3.14159, 0)).toBe('3');
+    });
+    (0, vitest_1.it)('should handle scientific notation strings', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.095492908209088e-9', 9)).toBe('0.000000001');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('5e-7', 9)).toBe('0.0000005');
+    });
+    (0, vitest_1.it)('should handle numbers that produce scientific notation', () => {
+        const tiny = 0.000000001 * 1.095492908209088; // 1.095492908209088e-9
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(tiny, 9)).toBe('0.000000001');
+    });
+    (0, vitest_1.it)('should handle negative numbers and negative scientific notation', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('-1.23456', 2)).toBe('-1.23');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('-5e-7', 9)).toBe('-0.0000005');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(-0.0000005, 9)).toBe('-0.0000005');
+    });
+    (0, vitest_1.it)('should handle scientific notation with positive exponents', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.2345e2', 2)).toBe('123.45');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1.2345e+2', 0)).toBe('123');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('5.2e9', 0)).toBe('5200000000');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('-1.23e+9', 0)).toBe('-1230000000');
+    });
+    (0, vitest_1.it)('should handle extreme scientific exponents', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1e-100', 100)).toBe('0.' + '0'.repeat(99) + '1');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('1e21', 0)).toBe('1000000000000000000000');
+    });
+    (0, vitest_1.it)('should handle NaN and Infinity', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(NaN, 2)).toBe('NaN');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(Infinity, 2)).toBe('Infinity');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(-Infinity, 2)).toBe('-Infinity');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('NaN', 2)).toBe('NaN');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)('Infinity', 2)).toBe('Infinity');
+    });
+    (0, vitest_1.it)('should handle native numbers with e (scientific notation)', () => {
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(1e-10, 10)).toBe('0.0000000001');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(1.23e-8, 10)).toBe('0.0000000123');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(-5.43e-7, 9)).toBe('-0.000000543');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(5.2e9, 0)).toBe('5200000000');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(-1.23e9, 0)).toBe('-1230000000');
+        (0, vitest_1.expect)((0, truncate_decimals_1.truncateDecimals)(1e21, 0)).toBe('1000000000000000000000');
+    });
+});

package/dist/cjs/utils/balance/calc-max-spendable.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+/**
+ * Default TON reserve subtracted from balance when computing the max spendable amount
+ * for a native TON operation — leaves room for network fees. 0.1 TON.
+ */
+export declare const DEFAULT_TON_FEE_RESERVE_NANOS = 100000000n;
+export interface CalcMaxSpendableParams {
+    /** User's balance of `token`, as a decimal string. */
+    balance: string;
+    /** The token the user is going to spend. */
+    token: {
+        address: string;
+        decimals: number;
+    };
+    /**
+     * TON reserve (in nanos) subtracted from balance when the token is native TON.
+     * Ignored for jettons. Defaults to {@link DEFAULT_TON_FEE_RESERVE_NANOS}.
+     */
+    feeReserveNanos?: bigint;
+}
+/**
+ * Compute the max spendable amount a user can place into an input when they click MAX.
+ * For native TON — subtracts a fixed reserve so the user still has room for network fees.
+ * For jettons — returns the full balance (gas is paid from TON separately).
+ */
+export declare const calcMaxSpendable: ({ balance, token, feeReserveNanos, }: CalcMaxSpendableParams) => string;
+//# sourceMappingURL=calc-max-spendable.d.ts.map

package/dist/cjs/utils/balance/calc-max-spendable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calc-max-spendable.d.ts","sourceRoot":"","sources":["../../../../src/utils/balance/calc-max-spendable.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;;GAGG;AACH,eAAO,MAAM,6BAA6B,aAAe,CAAC;AAE1D,MAAM,WAAW,sBAAsB;IACnC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,sCAI9B,sBAAsB,KAAG,MAM3B,CAAC"}

package/dist/cjs/utils/balance/calc-max-spendable.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcMaxSpendable = exports.DEFAULT_TON_FEE_RESERVE_NANOS = void 0;
+const walletkit_1 = require("@ton/walletkit");
+/**
+ * Default TON reserve subtracted from balance when computing the max spendable amount
+ * for a native TON operation — leaves room for network fees. 0.1 TON.
+ */
+exports.DEFAULT_TON_FEE_RESERVE_NANOS = 100000000n;
+/**
+ * Compute the max spendable amount a user can place into an input when they click MAX.
+ * For native TON — subtracts a fixed reserve so the user still has room for network fees.
+ * For jettons — returns the full balance (gas is paid from TON separately).
+ */
+const calcMaxSpendable = ({ balance, token, feeReserveNanos = exports.DEFAULT_TON_FEE_RESERVE_NANOS, }) => {
+    if (token.address !== 'ton')
+        return balance;
+    const balanceNanos = (0, walletkit_1.parseUnits)(balance, token.decimals);
+    const reducedNanos = balanceNanos > feeReserveNanos ? balanceNanos - feeReserveNanos : 0n;
+    return (0, walletkit_1.formatUnits)(reducedNanos, token.decimals);
+};
+exports.calcMaxSpendable = calcMaxSpendable;

package/dist/cjs/utils/balance/calc-max-spendable.test.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+export {};
+//# sourceMappingURL=calc-max-spendable.test.d.ts.map

package/dist/cjs/utils/balance/calc-max-spendable.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calc-max-spendable.test.d.ts","sourceRoot":"","sources":["../../../../src/utils/balance/calc-max-spendable.test.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/cjs/utils/balance/calc-max-spendable.test.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const calc_max_spendable_1 = require("./calc-max-spendable");
+const TON = { address: 'ton', decimals: 9 };
+const JETTON = { address: 'EQA_jetton', decimals: 6 };
+(0, vitest_1.describe)('calcMaxSpendable', () => {
+    (0, vitest_1.it)('returns balance minus the TON fee reserve for native TON', () => {
+        // 1 TON balance, default reserve 0.1 TON → 0.9 TON spendable.
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '1', token: TON })).toBe('0.9');
+    });
+    (0, vitest_1.it)('returns the full balance for a jetton (no reserve)', () => {
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '100', token: JETTON })).toBe('100');
+    });
+    (0, vitest_1.it)('clamps to zero when balance is below the reserve', () => {
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '0.05', token: TON })).toBe('0');
+    });
+    (0, vitest_1.it)('clamps to zero when balance equals the reserve', () => {
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '0.1', token: TON })).toBe('0');
+    });
+    (0, vitest_1.it)('respects a custom feeReserveNanos', () => {
+        // 1 TON balance, 0.5 TON reserve → 0.5 TON spendable.
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '1', token: TON, feeReserveNanos: 500000000n })).toBe('0.5');
+    });
+    (0, vitest_1.it)('ignores feeReserveNanos for jettons', () => {
+        (0, vitest_1.expect)((0, calc_max_spendable_1.calcMaxSpendable)({ balance: '100', token: JETTON, feeReserveNanos: 999999999999n })).toBe('100');
+    });
+    (0, vitest_1.it)('exports a sane default reserve', () => {
+        (0, vitest_1.expect)(calc_max_spendable_1.DEFAULT_TON_FEE_RESERVE_NANOS).toBe(100000000n);
+    });
+});

package/dist/cjs/utils/balance/get-ton-shortfall.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+/** Default extra TON buffer added on top of built transaction outflow when checking balance before sending. */
+export declare const DEFAULT_GAS_BUFFER_NANOS = 100000000n;
+/**
+ * Default extra headroom baked into the suggested reduced amount, on top of the gas buffer.
+ * Covers quote/gas drift between the current built tx and the one that will actually be sent
+ * after the amount changes. 0.02 TON.
+ */
+export declare const DEFAULT_SAFETY_MARGIN_NANOS = 20000000n;
+export type TonShortfall = {
+    mode: 'reduce';
+    requiredNanos: bigint;
+    suggestedFromAmount: string;
+} | {
+    mode: 'topup';
+    requiredNanos: bigint;
+    suggestedFromAmount: '';
+};
+export interface GetTonShortfallParams {
+    /** Messages of the built transaction. Each `amount` is the TON value in nanos attached to the message. */
+    messages: Array<{
+        amount: string;
+    }>;
+    /** User's current TON balance as a decimal string (same format `formatUnits(balance, 9)` returns). */
+    tonBalance: string | undefined;
+    /** The outgoing token — `{ address: 'ton' }` when the user spends TON, otherwise a jetton. */
+    fromToken: {
+        address: string;
+    };
+    /** Amount the user intends to spend in `fromToken` units, as a decimal string. */
+    fromAmount: string;
+    /**
+     * Extra TON headroom on top of built-tx outflow when checking balance before sending.
+     * Defaults to {@link DEFAULT_GAS_BUFFER_NANOS}.
+     */
+    gasBufferNanos?: bigint;
+    /**
+     * Extra headroom baked into the suggested reduced amount, on top of the gas buffer.
+     * Defaults to {@link DEFAULT_SAFETY_MARGIN_NANOS}.
+     */
+    safetyMarginNanos?: bigint;
+}
+/**
+ * Check whether the user's TON balance covers the built transaction.
+ * - Returns `null` if the balance is sufficient.
+ * - Returns `{ mode: 'reduce', ... }` with a smaller suggested `fromAmount` when `fromToken` is TON
+ *   and the balance is enough to cover at least gas (user can fix it by reducing the amount).
+ * - Returns `{ mode: 'topup', ... }` when `fromToken` is a jetton (reducing jetton amount won't free up TON gas),
+ *   or when `fromToken` is TON but the balance can't even cover gas (reducing won't help — user must top up).
+ */
+export declare const getTonShortfall: ({ messages, tonBalance, fromToken, fromAmount, gasBufferNanos, safetyMarginNanos, }: GetTonShortfallParams) => TonShortfall | undefined;
+//# sourceMappingURL=get-ton-shortfall.d.ts.map

package/dist/cjs/utils/balance/get-ton-shortfall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ton-shortfall.d.ts","sourceRoot":"","sources":["../../../../src/utils/balance/get-ton-shortfall.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,+GAA+G;AAC/G,eAAO,MAAM,wBAAwB,aAAe,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,YAAc,CAAC;AAEvD,MAAM,MAAM,YAAY,GAClB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,EAAE,CAAA;CAAE,CAAC;AAExE,MAAM,WAAW,qBAAqB;IAClC,0GAA0G;IAC1G,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpC,sGAAsG;IACtG,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,8FAA8F;IAC9F,SAAS,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAAI,qFAO7B,qBAAqB,KAAG,YAAY,GAAG,SAqBzC,CAAC"}

package/dist/cjs/utils/balance/get-ton-shortfall.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTonShortfall = exports.DEFAULT_SAFETY_MARGIN_NANOS = exports.DEFAULT_GAS_BUFFER_NANOS = void 0;
+const walletkit_1 = require("@ton/walletkit");
+/** Default extra TON buffer added on top of built transaction outflow when checking balance before sending. */
+exports.DEFAULT_GAS_BUFFER_NANOS = 100000000n;
+/**
+ * Default extra headroom baked into the suggested reduced amount, on top of the gas buffer.
+ * Covers quote/gas drift between the current built tx and the one that will actually be sent
+ * after the amount changes. 0.02 TON.
+ */
+exports.DEFAULT_SAFETY_MARGIN_NANOS = 20000000n;
+/**
+ * Check whether the user's TON balance covers the built transaction.
+ * - Returns `null` if the balance is sufficient.
+ * - Returns `{ mode: 'reduce', ... }` with a smaller suggested `fromAmount` when `fromToken` is TON
+ *   and the balance is enough to cover at least gas (user can fix it by reducing the amount).
+ * - Returns `{ mode: 'topup', ... }` when `fromToken` is a jetton (reducing jetton amount won't free up TON gas),
+ *   or when `fromToken` is TON but the balance can't even cover gas (reducing won't help — user must top up).
+ */
+const getTonShortfall = ({ messages, tonBalance, fromToken, fromAmount, gasBufferNanos = exports.DEFAULT_GAS_BUFFER_NANOS, safetyMarginNanos = exports.DEFAULT_SAFETY_MARGIN_NANOS, }) => {
+    const totalOutNanos = messages.reduce((acc, m) => acc + BigInt(m.amount), 0n);
+    const requiredNanos = totalOutNanos + gasBufferNanos;
+    const tonBalanceNanos = tonBalance ? (0, walletkit_1.parseUnits)(tonBalance, 9) : 0n;
+    if (tonBalanceNanos >= requiredNanos)
+        return;
+    if (fromToken.address === 'ton') {
+        const gasOnlyNanos = totalOutNanos - (0, walletkit_1.parseUnits)(fromAmount, 9);
+        const nonSwapReservedNanos = gasOnlyNanos + gasBufferNanos + safetyMarginNanos;
+        // Balance can't cover even gas for a minimal outgoing tx — reducing the amount won't help.
+        if (tonBalanceNanos <= nonSwapReservedNanos) {
+            return { mode: 'topup', requiredNanos, suggestedFromAmount: '' };
+        }
+        const suggestedFromAmount = (0, walletkit_1.formatUnits)(tonBalanceNanos - nonSwapReservedNanos, 9);
+        return { mode: 'reduce', requiredNanos, suggestedFromAmount };
+    }
+    return { mode: 'topup', requiredNanos, suggestedFromAmount: '' };
+};
+exports.getTonShortfall = getTonShortfall;

package/dist/cjs/utils/balance/get-ton-shortfall.test.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+export {};
+//# sourceMappingURL=get-ton-shortfall.test.d.ts.map

package/dist/cjs/utils/balance/get-ton-shortfall.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ton-shortfall.test.d.ts","sourceRoot":"","sources":["../../../../src/utils/balance/get-ton-shortfall.test.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/cjs/utils/balance/get-ton-shortfall.test.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const get_ton_shortfall_1 = require("./get-ton-shortfall");
+const TON = { address: 'ton' };
+const JETTON = { address: 'EQA_jetton_address' };
+// Helper — convert a decimal string of TON to nanos as a string (for message amounts).
+const toNanos = (ton) => BigInt(Math.round(Number(ton) * 1e9)).toString();
+(0, vitest_1.describe)('getTonShortfall', () => {
+    (0, vitest_1.it)('returns undefined when TON balance covers the built transaction', () => {
+        // Swap 1 TON, total tx outflow 1.3 TON (1 TON swap + 0.3 TON attached gas), balance 2 TON.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '2',
+            fromToken: TON,
+            fromAmount: '1',
+        });
+        (0, vitest_1.expect)(result).toBeUndefined();
+    });
+    (0, vitest_1.it)('returns topup when fromToken is a jetton and TON balance is below outflow + buffer', () => {
+        // Jetton swap, tx needs 0.05 TON for gas, user has 0 TON.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('0.05') }],
+            tonBalance: '0',
+            fromToken: JETTON,
+            fromAmount: '100',
+        });
+        (0, vitest_1.expect)(result).toEqual({
+            mode: 'topup',
+            requiredNanos: 50000000n + get_ton_shortfall_1.DEFAULT_GAS_BUFFER_NANOS,
+            suggestedFromAmount: '',
+        });
+    });
+    (0, vitest_1.it)('returns reduce for TON-from when balance covers gas but not full amount', () => {
+        // User wants 1 TON swap, total outflow 1.3 TON, has 1 TON. Gas only = 0.3 TON.
+        // Balance (1) > nonSwapReserved (0.3 gas + 0.1 buffer + 0.02 safety = 0.42) → reduce mode.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '1',
+            fromToken: TON,
+            fromAmount: '1',
+        });
+        (0, vitest_1.expect)(result?.mode).toBe('reduce');
+        if (result?.mode !== 'reduce')
+            return;
+        // Suggested = 1 - 0.42 = 0.58
+        (0, vitest_1.expect)(result.suggestedFromAmount).toBe('0.58');
+        (0, vitest_1.expect)(result.requiredNanos).toBe(1300000000n + get_ton_shortfall_1.DEFAULT_GAS_BUFFER_NANOS);
+    });
+    (0, vitest_1.it)('returns topup for TON-from when balance cannot cover even gas (reducing would not help)', () => {
+        // User wants 1 TON swap, total outflow 1.3 TON → gas = 0.3 TON. Balance 0.2 TON.
+        // nonSwapReserved = 0.3 + 0.1 buffer + 0.02 safety = 0.42 TON → balance (0.2) <= 0.42 → topup.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '0.2',
+            fromToken: TON,
+            fromAmount: '1',
+        });
+        (0, vitest_1.expect)(result).toEqual({
+            mode: 'topup',
+            requiredNanos: 1300000000n + get_ton_shortfall_1.DEFAULT_GAS_BUFFER_NANOS,
+            suggestedFromAmount: '',
+        });
+    });
+    (0, vitest_1.it)('treats an undefined tonBalance as zero', () => {
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('0.05') }],
+            tonBalance: undefined,
+            fromToken: JETTON,
+            fromAmount: '100',
+        });
+        (0, vitest_1.expect)(result?.mode).toBe('topup');
+    });
+    (0, vitest_1.it)('sums amounts across multiple messages', () => {
+        // Two messages attaching 0.6 TON each → totalOut = 1.2 TON. Balance 1 TON → shortfall.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('0.6') }, { amount: toNanos('0.6') }],
+            tonBalance: '1',
+            fromToken: JETTON,
+            fromAmount: '100',
+        });
+        (0, vitest_1.expect)(result?.mode).toBe('topup');
+        (0, vitest_1.expect)(result?.requiredNanos).toBe(1200000000n + get_ton_shortfall_1.DEFAULT_GAS_BUFFER_NANOS);
+    });
+    (0, vitest_1.it)('respects a custom gasBufferNanos', () => {
+        const baseParams = {
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '1.3',
+            fromToken: TON,
+            fromAmount: '1',
+        };
+        // With the default buffer (0.1 TON), balance 1.3 is insufficient (needs 1.4).
+        (0, vitest_1.expect)((0, get_ton_shortfall_1.getTonShortfall)(baseParams)?.mode).toBe('reduce');
+        // With a zero buffer, 1.3 TON balance covers the 1.3 TON outflow exactly.
+        (0, vitest_1.expect)((0, get_ton_shortfall_1.getTonShortfall)({ ...baseParams, gasBufferNanos: 0n })).toBeUndefined();
+    });
+    (0, vitest_1.it)('respects a custom safetyMarginNanos in the reduce branch', () => {
+        // Default margin: suggested = balance - gas - buffer - 0.02 = 1 - 0.3 - 0.1 - 0.02 = 0.58
+        // Zero margin:    suggested = balance - gas - buffer       = 1 - 0.3 - 0.1       = 0.6
+        const baseParams = {
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '1',
+            fromToken: TON,
+            fromAmount: '1',
+        };
+        const withDefault = (0, get_ton_shortfall_1.getTonShortfall)(baseParams);
+        (0, vitest_1.expect)(withDefault?.mode === 'reduce' ? withDefault.suggestedFromAmount : null).toBe('0.58');
+        const withZero = (0, get_ton_shortfall_1.getTonShortfall)({ ...baseParams, safetyMarginNanos: 0n });
+        (0, vitest_1.expect)(withZero?.mode === 'reduce' ? withZero.suggestedFromAmount : null).toBe('0.6');
+    });
+    (0, vitest_1.it)('flips from reduce to topup when a large custom safetyMarginNanos eats the balance', () => {
+        // Balance 1 TON, gas 0.3 TON, buffer 0.1 TON. With a 1 TON safety margin, nonSwapReserved becomes 1.4 TON → topup.
+        const result = (0, get_ton_shortfall_1.getTonShortfall)({
+            messages: [{ amount: toNanos('1.3') }],
+            tonBalance: '1',
+            fromToken: TON,
+            fromAmount: '1',
+            safetyMarginNanos: 1000000000n,
+        });
+        (0, vitest_1.expect)(result?.mode).toBe('topup');
+    });
+    (0, vitest_1.it)('exports sane default constants', () => {
+        (0, vitest_1.expect)(get_ton_shortfall_1.DEFAULT_GAS_BUFFER_NANOS).toBe(100000000n);
+        (0, vitest_1.expect)(get_ton_shortfall_1.DEFAULT_SAFETY_MARGIN_NANOS).toBe(20000000n);
+    });
+});

package/dist/cjs/utils/functions/debounce.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+export interface DebounceOptions {
+    /**
+     * An optional AbortSignal to cancel the debounced function.
+     */
+    signal?: AbortSignal;
+    /**
+     * An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
+     * If `edges` include "leading", the function will be invoked at the start of the delay period.
+     * If `edges` include "trailing", the function will be invoked at the end of the delay period.
+     * If both "leading" and "trailing" are included, the function will be invoked at both the start and end of the delay period.
+     * @default ["trailing"]
+     */
+    edges?: Array<'leading' | 'trailing'>;
+}
+export interface DebouncedFunction<F extends (...args: unknown[]) => void> {
+    (...args: Parameters<F>): void;
+    /**
+     * Schedules the execution of the debounced function after the specified debounced delay.
+     * This method resets any existing timer, ensuring that the function is only invoked
+     * after the delay has elapsed since the last call to the debounced function.
+     * It is typically called internally whenever the debounced function is invoked.
+     *
+     * @returns {void}
+     */
+    schedule: () => void;
+    /**
+     * Cancels any pending execution of the debounced function.
+     * This method clears the active timer and resets any stored context or arguments.
+     */
+    cancel: () => void;
+    /**
+     * Immediately invokes the debounced function if there is a pending execution.
+     * This method executes the function right away if there is a pending execution.
+     */
+    flush: () => void;
+}
+/**
+ * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
+ * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
+ * method to cancel any pending execution.
+ *
+ * @template F - The type of function.
+ * @param {F} func - The function to debounce.
+ * @param {number} debounceMs - The number of milliseconds to delay.
+ * @param {DebounceOptions} options - The options object
+ * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
+ * @returns A new debounced function with a `cancel` method.
+ *
+ * @example
+ * const debouncedFunction = debounce(() => {
+ *   console.log('Function executed');
+ * }, 1000);
+ *
+ * // Will log 'Function executed' after 1 second if not called again in that time
+ * debouncedFunction();
+ *
+ * // Will not log anything as the previous call is canceled
+ * debouncedFunction.cancel();
+ *
+ * // With AbortSignal
+ * const controller = new AbortController();
+ * const signal = controller.signal;
+ * const debouncedWithSignal = debounce(() => {
+ *  console.log('Function executed');
+ * }, 1000, { signal });
+ *
+ * debouncedWithSignal();
+ *
+ * // Will cancel the debounced function call
+ * controller.abort();
+ */
+export declare const debounce: <F extends (...args: unknown[]) => void>(func: F, debounceMs: number, { signal, edges }?: DebounceOptions) => DebouncedFunction<F>;
+//# sourceMappingURL=debounce.d.ts.map

package/dist/cjs/utils/functions/debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../../../src/utils/functions/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI;IACrE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE/B;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,EAC3D,MAAM,CAAC,EACP,YAAY,MAAM,EAClB,oBAAmB,eAAoB,KACxC,iBAAiB,CAAC,CAAC,CA+ErB,CAAC"}

package/dist/cjs/utils/functions/debounce.js

@@ -0,0 +1,107 @@
+"use strict";
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = void 0;
+/**
+ * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
+ * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
+ * method to cancel any pending execution.
+ *
+ * @template F - The type of function.
+ * @param {F} func - The function to debounce.
+ * @param {number} debounceMs - The number of milliseconds to delay.
+ * @param {DebounceOptions} options - The options object
+ * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
+ * @returns A new debounced function with a `cancel` method.
+ *
+ * @example
+ * const debouncedFunction = debounce(() => {
+ *   console.log('Function executed');
+ * }, 1000);
+ *
+ * // Will log 'Function executed' after 1 second if not called again in that time
+ * debouncedFunction();
+ *
+ * // Will not log anything as the previous call is canceled
+ * debouncedFunction.cancel();
+ *
+ * // With AbortSignal
+ * const controller = new AbortController();
+ * const signal = controller.signal;
+ * const debouncedWithSignal = debounce(() => {
+ *  console.log('Function executed');
+ * }, 1000, { signal });
+ *
+ * debouncedWithSignal();
+ *
+ * // Will cancel the debounced function call
+ * controller.abort();
+ */
+const debounce = (func, debounceMs, { signal, edges } = {}) => {
+    let pendingThis = undefined;
+    let pendingArgs = null;
+    const leading = edges != null && edges.includes('leading');
+    const trailing = edges == null || edges.includes('trailing');
+    const invoke = () => {
+        if (pendingArgs !== null) {
+            func.apply(pendingThis, pendingArgs);
+            pendingThis = undefined;
+            pendingArgs = null;
+        }
+    };
+    const onTimerEnd = () => {
+        if (trailing) {
+            invoke();
+        }
+        cancel();
+    };
+    let timeoutId = null;
+    const schedule = () => {
+        if (timeoutId != null) {
+            clearTimeout(timeoutId);
+        }
+        timeoutId = setTimeout(() => {
+            timeoutId = null;
+            onTimerEnd();
+        }, debounceMs);
+    };
+    const cancelTimer = () => {
+        if (timeoutId !== null) {
+            clearTimeout(timeoutId);
+            timeoutId = null;
+        }
+    };
+    const cancel = () => {
+        cancelTimer();
+        pendingThis = undefined;
+        pendingArgs = null;
+    };
+    const flush = () => {
+        invoke();
+    };
+    const debounced = function (...args) {
+        if (signal?.aborted) {
+            return;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        pendingThis = this;
+        pendingArgs = args;
+        const isFirstCall = timeoutId == null;
+        schedule();
+        if (leading && isFirstCall) {
+            invoke();
+        }
+    };
+    debounced.schedule = schedule;
+    debounced.cancel = cancel;
+    debounced.flush = flush;
+    signal?.addEventListener('abort', cancel, { once: true });
+    return debounced;
+};
+exports.debounce = debounce;