@octaflowlabs/onchain-sdk 1.0.0-test10 → 1.0.0-test11

package/dist/blockchain/buildUnsignedTransferTx.d.ts

@@ -1,2 +1,3 @@
-import { BuildUnsignedTransferTxOptions, UnsignedTransferTxResponse } from '../types/common';
+import { BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, UnsignedTransferTxResponse } from '../types/common';
 export declare const buildUnsignedTransferTx: (options: BuildUnsignedTransferTxOptions) => Promise<UnsignedTransferTxResponse>;
+export declare const buildMaxNativeTransferTx: (options: BuildMaxNativeTransferTxOptions) => Promise<BuildMaxNativeTransferTxResponse>;

package/dist/blockchain/buildUnsignedTransferTx.js

@@ -1,5 +1,5 @@
 /** npm imports */
-import { Interface, parseUnits } from 'ethers';
+import { Interface, formatUnits, parseUnits } from 'ethers';
 /** local imports */
 import { getProvider } from './getProvider';
 import { estimateGasLimitFromProvider } from './estimateGasLimitFromProvider';
@@ -60,6 +60,11 @@ export const buildUnsignedTransferTx = async (options) => {
         };
         if (estimateGas.feeData.gasPrice)
             unsignedTxToReturn.gasPrice = estimateGas.feeData.gasPrice.toString();
+        const gasReserve = estimateGas.feeData.maxFeePerGas
+            ? estimateGas.gasLimit * estimateGas.feeData.maxFeePerGas
+            : estimateGas.feeData.gasPrice
+                ? estimateGas.gasLimit * estimateGas.feeData.gasPrice
+                : undefined;
         try {
             await provider.call({
                 from: options.fromAddress,
@@ -78,6 +83,7 @@ export const buildUnsignedTransferTx = async (options) => {
             nonce,
             gasEstimated: estimateGas.gasEstimated.toString(),
             gasLimit: estimateGas.gasLimit.toString(),
+            gasReserve: gasReserve?.toString(),
             bufferPercentage: estimateGas.bufferPercentage,
             feeData: {
                 maxFeePerGas: estimateGas.feeData.maxFeePerGas?.toString(),
@@ -93,3 +99,32 @@ export const buildUnsignedTransferTx = async (options) => {
         throw error;
     }
 };
+export const buildMaxNativeTransferTx = async (options) => {
+    const isNativeToken = !options.tokenAddress ||
+        options.tokenAddress?.toLowerCase() === '0x0000000000000000000000000000000000000000' ||
+        options.tokenAddress?.toLowerCase() === '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee';
+    if (!isNativeToken)
+        throw new Error('Max native transfer requires a native token address');
+    const provisionalTx = await buildUnsignedTransferTx({
+        ...options,
+        value: options.balance,
+        tokenAddress: options.tokenAddress,
+    });
+    if (!provisionalTx.gasReserve)
+        throw new Error('Could not determine gas reserve for max send');
+    const balanceWei = parseUnits(options.balance, 18);
+    const gasReserveWei = BigInt(provisionalTx.gasReserve);
+    const sendableWei = balanceWei - gasReserveWei;
+    if (sendableWei <= 0n)
+        throw new Error('Insufficient balance to cover gas reserve');
+    const sendableValue = formatUnits(sendableWei, 18);
+    const finalTx = await buildUnsignedTransferTx({
+        ...options,
+        value: sendableValue,
+        tokenAddress: options.tokenAddress,
+    });
+    return {
+        ...finalTx,
+        sendableValue,
+    };
+};

package/dist/cjs/blockchain/buildUnsignedTransferTx.d.ts

@@ -1,2 +1,3 @@
-import { BuildUnsignedTransferTxOptions, UnsignedTransferTxResponse } from '../types/common';
+import { BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, UnsignedTransferTxResponse } from '../types/common';
 export declare const buildUnsignedTransferTx: (options: BuildUnsignedTransferTxOptions) => Promise<UnsignedTransferTxResponse>;
+export declare const buildMaxNativeTransferTx: (options: BuildMaxNativeTransferTxOptions) => Promise<BuildMaxNativeTransferTxResponse>;

package/dist/cjs/blockchain/buildUnsignedTransferTx.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUnsignedTransferTx = void 0;
+exports.buildMaxNativeTransferTx = exports.buildUnsignedTransferTx = void 0;
 /** npm imports */
 const ethers_1 = require("ethers");
 /** local imports */
@@ -63,6 +63,11 @@ const buildUnsignedTransferTx = async (options) => {
         };
         if (estimateGas.feeData.gasPrice)
             unsignedTxToReturn.gasPrice = estimateGas.feeData.gasPrice.toString();
+        const gasReserve = estimateGas.feeData.maxFeePerGas
+            ? estimateGas.gasLimit * estimateGas.feeData.maxFeePerGas
+            : estimateGas.feeData.gasPrice
+                ? estimateGas.gasLimit * estimateGas.feeData.gasPrice
+                : undefined;
         try {
             await provider.call({
                 from: options.fromAddress,
@@ -81,6 +86,7 @@ const buildUnsignedTransferTx = async (options) => {
             nonce,
             gasEstimated: estimateGas.gasEstimated.toString(),
             gasLimit: estimateGas.gasLimit.toString(),
+            gasReserve: gasReserve?.toString(),
             bufferPercentage: estimateGas.bufferPercentage,
             feeData: {
                 maxFeePerGas: estimateGas.feeData.maxFeePerGas?.toString(),
@@ -97,3 +103,33 @@ const buildUnsignedTransferTx = async (options) => {
     }
 };
 exports.buildUnsignedTransferTx = buildUnsignedTransferTx;
+const buildMaxNativeTransferTx = async (options) => {
+    const isNativeToken = !options.tokenAddress ||
+        options.tokenAddress?.toLowerCase() === '0x0000000000000000000000000000000000000000' ||
+        options.tokenAddress?.toLowerCase() === '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee';
+    if (!isNativeToken)
+        throw new Error('Max native transfer requires a native token address');
+    const provisionalTx = await (0, exports.buildUnsignedTransferTx)({
+        ...options,
+        value: options.balance,
+        tokenAddress: options.tokenAddress,
+    });
+    if (!provisionalTx.gasReserve)
+        throw new Error('Could not determine gas reserve for max send');
+    const balanceWei = (0, ethers_1.parseUnits)(options.balance, 18);
+    const gasReserveWei = BigInt(provisionalTx.gasReserve);
+    const sendableWei = balanceWei - gasReserveWei;
+    if (sendableWei <= 0n)
+        throw new Error('Insufficient balance to cover gas reserve');
+    const sendableValue = (0, ethers_1.formatUnits)(sendableWei, 18);
+    const finalTx = await (0, exports.buildUnsignedTransferTx)({
+        ...options,
+        value: sendableValue,
+        tokenAddress: options.tokenAddress,
+    });
+    return {
+        ...finalTx,
+        sendableValue,
+    };
+};
+exports.buildMaxNativeTransferTx = buildMaxNativeTransferTx;

package/dist/cjs/index.d.ts

@@ -4,7 +4,7 @@ export { ERC20_TOKEN_CONTRACT_ABI };
 /** constants exports */
 export { GAS_LIMIT_PER_TX_TYPE } from './constants/constants';
 /** basic blockchain exports */
-export { buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
+export { buildMaxNativeTransferTx, buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
 export { broadcastTransaction } from './blockchain/broadcastTransaction';
 export { estimateGasLimitFromProvider } from './blockchain/estimateGasLimitFromProvider';
 export { getProvider } from './blockchain/getProvider';
@@ -15,4 +15,4 @@ export { transformBigInt } from './utils/transformBigInt';
 import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 /** types exports */
-export { BroadcastTransactionOptions, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, } from './types/common';
+export { BroadcastTransactionOptions, BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, FormatAmountOptions, } from './types/common';

package/dist/cjs/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NATIVE_TOKENS = exports.transformBigInt = exports.getShortenTransactionHash = exports.txStatus = exports.getProvider = exports.estimateGasLimitFromProvider = exports.broadcastTransaction = exports.buildUnsignedTransferTx = exports.GAS_LIMIT_PER_TX_TYPE = exports.ERC20_TOKEN_CONTRACT_ABI = void 0;
+exports.NATIVE_TOKENS = exports.transformBigInt = exports.getShortenTransactionHash = exports.txStatus = exports.getProvider = exports.estimateGasLimitFromProvider = exports.broadcastTransaction = exports.buildUnsignedTransferTx = exports.buildMaxNativeTransferTx = exports.GAS_LIMIT_PER_TX_TYPE = exports.ERC20_TOKEN_CONTRACT_ABI = void 0;
 /** ABIs exports */
 const ERC20_TOKEN_CONTRACT_ABI_1 = __importDefault(require("./ABIs/ERC20_TOKEN_CONTRACT_ABI"));
 exports.ERC20_TOKEN_CONTRACT_ABI = ERC20_TOKEN_CONTRACT_ABI_1.default;
@@ -12,6 +12,7 @@ var constants_1 = require("./constants/constants");
 Object.defineProperty(exports, "GAS_LIMIT_PER_TX_TYPE", { enumerable: true, get: function () { return constants_1.GAS_LIMIT_PER_TX_TYPE; } });
 /** basic blockchain exports */
 var buildUnsignedTransferTx_1 = require("./blockchain/buildUnsignedTransferTx");
+Object.defineProperty(exports, "buildMaxNativeTransferTx", { enumerable: true, get: function () { return buildUnsignedTransferTx_1.buildMaxNativeTransferTx; } });
 Object.defineProperty(exports, "buildUnsignedTransferTx", { enumerable: true, get: function () { return buildUnsignedTransferTx_1.buildUnsignedTransferTx; } });
 var broadcastTransaction_1 = require("./blockchain/broadcastTransaction");
 Object.defineProperty(exports, "broadcastTransaction", { enumerable: true, get: function () { return broadcastTransaction_1.broadcastTransaction; } });

package/dist/cjs/types/common.d.ts

@@ -33,6 +33,7 @@ export interface UnsignedTransferTxResponse {
     nonce: number;
     gasEstimated: string;
     gasLimit: string;
+    gasReserve?: string;
     bufferPercentage: number;
     feeData: {
         maxFeePerGas?: string;
@@ -40,6 +41,13 @@ export interface UnsignedTransferTxResponse {
         gasPrice?: string;
     };
 }
+export interface BuildMaxNativeTransferTxOptions extends Omit<BuildUnsignedTransferTxOptions, 'value' | 'tokenAddress' | 'tokenDecimals'> {
+    balance: string;
+    tokenAddress?: string;
+}
+export interface BuildMaxNativeTransferTxResponse extends UnsignedTransferTxResponse {
+    sendableValue: string;
+}
 export interface BroadcastTransactionOptions {
     signedTx: string;
     rpcUrl: string;
@@ -55,3 +63,11 @@ export interface TxStatusResponse {
     success: boolean;
     receipt: TransactionReceipt | null;
 }
+export interface FormatAmountOptions {
+    decimalsToShow?: number;
+    useGroupSeparator?: boolean;
+    locale?: string;
+    minimumFractionDigits?: number;
+    minDisplayDecimals?: number;
+    maxDisplayDigits?: number;
+}

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

@@ -0,0 +1,6 @@
+/** npm imports */
+import { BigNumberish } from 'ethers';
+/** local imports */
+import { FormatAmountOptions } from '../types/common';
+export declare const formattedAmountForDisplay: (amount: BigNumberish, decimals: number, options?: FormatAmountOptions) => string;
+export declare const parsedAmount: (amount: string, decimals: number) => bigint;

package/dist/cjs/utils/formatAmount.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsedAmount = exports.formattedAmountForDisplay = void 0;
+/** npm imports */
+const ethers_1 = require("ethers");
+const formattedAmountForDisplay = (amount, decimals, options = {}) => {
+    const { decimalsToShow = 0, useGroupSeparator = true, locale = 'en-US', minimumFractionDigits, minDisplayDecimals = 9, maxDisplayDigits = 16, } = options;
+    const formattedAmount = (0, ethers_1.formatUnits)(amount, decimals);
+    if (formattedAmount.startsWith('-')) {
+        throw new Error('Negative balances are not supported');
+    }
+    const [wholePart = '0', fractionPart = ''] = formattedAmount.split('.');
+    if (wholePart.length >= maxDisplayDigits) {
+        const mantissaWhole = wholePart[0] ?? '0';
+        const mantissaFraction = (wholePart.slice(1) + fractionPart).slice(0, decimalsToShow);
+        const exponent = wholePart.length - 1;
+        const rawMantissa = mantissaFraction ? `${mantissaWhole}.${mantissaFraction}` : mantissaWhole;
+        const trimmedMantissa = rawMantissa.replace(/\.0+$|(?<=\.[0-9]*?)0+$/g, '').replace(/\.$/, '');
+        return `${trimmedMantissa}e${exponent}`;
+    }
+    const firstNonZeroIndex = fractionPart.split('').findIndex((digit) => digit !== '0');
+    const hasNonZeroFraction = firstNonZeroIndex !== -1;
+    if (hasNonZeroFraction && wholePart === '0' && firstNonZeroIndex >= minDisplayDecimals) {
+        const sample = new Intl.NumberFormat(locale).format(1000.1);
+        const decimalSeparator = sample.replace(/\d/g, '').slice(-1) ?? '.';
+        const minValue = `0${decimalSeparator}${'0'.repeat(Math.max(0, minDisplayDecimals - 1))}1`;
+        return `< ${minValue}`;
+    }
+    if (!hasNonZeroFraction) {
+        const sample = new Intl.NumberFormat(locale).format(1000.1);
+        const groupSeparator = sample.replace(/\d/g, '')[0] ?? ',';
+        const groupedWhole = useGroupSeparator
+            ? (wholePart || '0').replace(/\B(?=(\d{3})+(?!\d))/g, groupSeparator)
+            : wholePart;
+        return groupedWhole;
+    }
+    const maxDecimals = decimalsToShow ?? fractionPart.length;
+    let trimmedFraction = fractionPart.slice(0, Math.max(0, maxDecimals));
+    const minDecimals = minimumFractionDigits ?? 0;
+    if (trimmedFraction.length < minDecimals) {
+        trimmedFraction = trimmedFraction.padEnd(minDecimals, '0');
+    }
+    const sample = new Intl.NumberFormat(locale).format(1000.1);
+    const groupSeparator = sample.replace(/\d/g, '')[0] ?? ',';
+    const decimalSeparator = sample.replace(/\d/g, '').slice(-1) ?? '.';
+    const groupedWhole = useGroupSeparator
+        ? (wholePart || '0').replace(/\B(?=(\d{3})+(?!\d))/g, groupSeparator)
+        : wholePart;
+    if (!trimmedFraction)
+        return groupedWhole;
+    return `${groupedWhole}${decimalSeparator}${trimmedFraction}`;
+};
+exports.formattedAmountForDisplay = formattedAmountForDisplay;
+const parsedAmount = (amount, decimals) => (0, ethers_1.parseUnits)(amount, decimals);
+exports.parsedAmount = parsedAmount;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { ERC20_TOKEN_CONTRACT_ABI };
 /** constants exports */
 export { GAS_LIMIT_PER_TX_TYPE } from './constants/constants';
 /** basic blockchain exports */
-export { buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
+export { buildMaxNativeTransferTx, buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
 export { broadcastTransaction } from './blockchain/broadcastTransaction';
 export { estimateGasLimitFromProvider } from './blockchain/estimateGasLimitFromProvider';
 export { getProvider } from './blockchain/getProvider';
@@ -15,4 +15,4 @@ export { transformBigInt } from './utils/transformBigInt';
 import NATIVE_TOKENS from './utils/tokens';
 export { NATIVE_TOKENS };
 /** types exports */
-export { BroadcastTransactionOptions, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, } from './types/common';
+export { BroadcastTransactionOptions, BuildMaxNativeTransferTxOptions, BuildMaxNativeTransferTxResponse, BuildUnsignedTransferTxOptions, EstimateGasLimitFromProviderProps, GasEstimateResult, TxStatusOptions, TxStatusResponse, UnsignedTransferTxResponse, FormatAmountOptions, } from './types/common';

package/dist/index.js

@@ -4,7 +4,7 @@ export { ERC20_TOKEN_CONTRACT_ABI };
 /** constants exports */
 export { GAS_LIMIT_PER_TX_TYPE } from './constants/constants';
 /** basic blockchain exports */
-export { buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
+export { buildMaxNativeTransferTx, buildUnsignedTransferTx } from './blockchain/buildUnsignedTransferTx';
 export { broadcastTransaction } from './blockchain/broadcastTransaction';
 export { estimateGasLimitFromProvider } from './blockchain/estimateGasLimitFromProvider';
 export { getProvider } from './blockchain/getProvider';

package/dist/types/common.d.ts

@@ -33,6 +33,7 @@ export interface UnsignedTransferTxResponse {
     nonce: number;
     gasEstimated: string;
     gasLimit: string;
+    gasReserve?: string;
     bufferPercentage: number;
     feeData: {
         maxFeePerGas?: string;
@@ -40,6 +41,13 @@ export interface UnsignedTransferTxResponse {
         gasPrice?: string;
     };
 }
+export interface BuildMaxNativeTransferTxOptions extends Omit<BuildUnsignedTransferTxOptions, 'value' | 'tokenAddress' | 'tokenDecimals'> {
+    balance: string;
+    tokenAddress?: string;
+}
+export interface BuildMaxNativeTransferTxResponse extends UnsignedTransferTxResponse {
+    sendableValue: string;
+}
 export interface BroadcastTransactionOptions {
     signedTx: string;
     rpcUrl: string;
@@ -55,3 +63,11 @@ export interface TxStatusResponse {
     success: boolean;
     receipt: TransactionReceipt | null;
 }
+export interface FormatAmountOptions {
+    decimalsToShow?: number;
+    useGroupSeparator?: boolean;
+    locale?: string;
+    minimumFractionDigits?: number;
+    minDisplayDecimals?: number;
+    maxDisplayDigits?: number;
+}

package/dist/utils/formatAmount.d.ts

@@ -0,0 +1,6 @@
+/** npm imports */
+import { BigNumberish } from 'ethers';
+/** local imports */
+import { FormatAmountOptions } from '../types/common';
+export declare const formattedAmountForDisplay: (amount: BigNumberish, decimals: number, options?: FormatAmountOptions) => string;
+export declare const parsedAmount: (amount: string, decimals: number) => bigint;

package/dist/utils/formatAmount.js

@@ -0,0 +1,50 @@
+/** npm imports */
+import { formatUnits, parseUnits } from 'ethers';
+export const formattedAmountForDisplay = (amount, decimals, options = {}) => {
+    const { decimalsToShow = 0, useGroupSeparator = true, locale = 'en-US', minimumFractionDigits, minDisplayDecimals = 9, maxDisplayDigits = 16, } = options;
+    const formattedAmount = formatUnits(amount, decimals);
+    if (formattedAmount.startsWith('-')) {
+        throw new Error('Negative balances are not supported');
+    }
+    const [wholePart = '0', fractionPart = ''] = formattedAmount.split('.');
+    if (wholePart.length >= maxDisplayDigits) {
+        const mantissaWhole = wholePart[0] ?? '0';
+        const mantissaFraction = (wholePart.slice(1) + fractionPart).slice(0, decimalsToShow);
+        const exponent = wholePart.length - 1;
+        const rawMantissa = mantissaFraction ? `${mantissaWhole}.${mantissaFraction}` : mantissaWhole;
+        const trimmedMantissa = rawMantissa.replace(/\.0+$|(?<=\.[0-9]*?)0+$/g, '').replace(/\.$/, '');
+        return `${trimmedMantissa}e${exponent}`;
+    }
+    const firstNonZeroIndex = fractionPart.split('').findIndex((digit) => digit !== '0');
+    const hasNonZeroFraction = firstNonZeroIndex !== -1;
+    if (hasNonZeroFraction && wholePart === '0' && firstNonZeroIndex >= minDisplayDecimals) {
+        const sample = new Intl.NumberFormat(locale).format(1000.1);
+        const decimalSeparator = sample.replace(/\d/g, '').slice(-1) ?? '.';
+        const minValue = `0${decimalSeparator}${'0'.repeat(Math.max(0, minDisplayDecimals - 1))}1`;
+        return `< ${minValue}`;
+    }
+    if (!hasNonZeroFraction) {
+        const sample = new Intl.NumberFormat(locale).format(1000.1);
+        const groupSeparator = sample.replace(/\d/g, '')[0] ?? ',';
+        const groupedWhole = useGroupSeparator
+            ? (wholePart || '0').replace(/\B(?=(\d{3})+(?!\d))/g, groupSeparator)
+            : wholePart;
+        return groupedWhole;
+    }
+    const maxDecimals = decimalsToShow ?? fractionPart.length;
+    let trimmedFraction = fractionPart.slice(0, Math.max(0, maxDecimals));
+    const minDecimals = minimumFractionDigits ?? 0;
+    if (trimmedFraction.length < minDecimals) {
+        trimmedFraction = trimmedFraction.padEnd(minDecimals, '0');
+    }
+    const sample = new Intl.NumberFormat(locale).format(1000.1);
+    const groupSeparator = sample.replace(/\d/g, '')[0] ?? ',';
+    const decimalSeparator = sample.replace(/\d/g, '').slice(-1) ?? '.';
+    const groupedWhole = useGroupSeparator
+        ? (wholePart || '0').replace(/\B(?=(\d{3})+(?!\d))/g, groupSeparator)
+        : wholePart;
+    if (!trimmedFraction)
+        return groupedWhole;
+    return `${groupedWhole}${decimalSeparator}${trimmedFraction}`;
+};
+export const parsedAmount = (amount, decimals) => parseUnits(amount, decimals);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaflowlabs/onchain-sdk",
-  "version": "1.0.0-test10",
+  "version": "1.0.0-test11",
   "description": "onchain methods for web3",
   "repository": "https://github.com/crisramb665/onchain-sdk.git",
   "license": "MIT",