@hyperlane-xyz/utils 0.0.0-beta-20251201221151

package/dist/addresses.test.js

@@ -0,0 +1,68 @@
+import { expect } from 'chai';
+import { addressToBytes, bytesToProtocolAddress, isZeroishAddress, padBytesToLength, } from './addresses.js';
+import { ProtocolType } from './types.js';
+const ETH_ZERO_ADDR = '0x0000000000000000000000000000000000000000';
+const ETH_NON_ZERO_ADDR = '0x0000000000000000000000000000000000000001';
+const COS_ZERO_ADDR = 'cosmos1000';
+const COS_NON_ZERO_ADDR = 'neutron1jyyjd3x0jhgswgm6nnctxvzla8ypx50tew3ayxxwkrjfxhvje6kqzvzudq';
+const COSMOS_PREFIX = 'neutron';
+const COSMOS_NATIVE_ZERO_ADDR = '0x0000000000000000000000000000000000000000000000000000000000000000';
+const COSMOS_NATIVE_NON_ZERO_ADDR = '0x726f757465725f61707000000000000000000000000000010000000000000000';
+const SOL_ZERO_ADDR = '111111';
+const SOL_NON_ZERO_ADDR = 'TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb';
+const STARKNET_ZERO_ADDR = '0x0000000000000000000000000000000000000000000000000000000000000000';
+const STARKNET_NON_ZERO_ADDR = '0x0000000000000000000000000000000000000000000000000000000000000001';
+// TODO increase address utility test coverage
+describe('Address utilities', () => {
+    describe('isZeroishAddress', () => {
+        it('Identifies 0-ish addresses', () => {
+            expect(isZeroishAddress('0x')).to.be.true;
+            expect(isZeroishAddress(ETH_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(COS_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(COSMOS_NATIVE_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(SOL_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(STARKNET_ZERO_ADDR)).to.be.true;
+        });
+        it('Identifies non-0-ish addresses', () => {
+            expect(isZeroishAddress(ETH_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(COS_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(COSMOS_NATIVE_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(SOL_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(STARKNET_NON_ZERO_ADDR)).to.be.false;
+        });
+    });
+    describe('addressToBytes', () => {
+        it('Converts addresses to bytes', () => {
+            expect(addressToBytes(ETH_NON_ZERO_ADDR).length).to.equal(32);
+            expect(addressToBytes(STARKNET_NON_ZERO_ADDR).length).to.equal(32);
+        });
+        it('Rejects zeroish addresses', () => {
+            expect(() => addressToBytes(ETH_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(COS_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(COSMOS_NATIVE_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(SOL_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(STARKNET_ZERO_ADDR)).to.throw(Error);
+        });
+    });
+    describe('padBytesToLength', () => {
+        it('Pads bytes to a given length', () => {
+            const bytes = Buffer.from([1, 2, 3]);
+            expect(padBytesToLength(bytes, 5).equals(Buffer.from([0, 0, 1, 2, 3])));
+        });
+        it('Rejects bytes that exceed the target length', () => {
+            const bytes = Buffer.from([1, 2, 3]);
+            expect(() => padBytesToLength(bytes, 2)).to.throw(Error);
+        });
+    });
+    describe('bytesToProtocolAddress', () => {
+        it('Converts bytes to address', () => {
+            expect(bytesToProtocolAddress(addressToBytes(ETH_NON_ZERO_ADDR), ProtocolType.Ethereum)).to.equal(ETH_NON_ZERO_ADDR);
+            expect(bytesToProtocolAddress(addressToBytes(COSMOS_NATIVE_NON_ZERO_ADDR), ProtocolType.CosmosNative, COSMOS_PREFIX)).to.equal(COSMOS_NATIVE_NON_ZERO_ADDR);
+            expect(bytesToProtocolAddress(addressToBytes(STARKNET_NON_ZERO_ADDR), ProtocolType.Starknet)).to.equal(STARKNET_NON_ZERO_ADDR);
+        });
+        it('Rejects zeroish addresses', () => {
+            expect(() => bytesToProtocolAddress(new Uint8Array([0, 0, 0]), ProtocolType.Ethereum)).to.throw(Error);
+        });
+    });
+});
+//# sourceMappingURL=addresses.test.js.map

package/dist/addresses.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.test.js","sourceRoot":"","sources":["../src/addresses.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,aAAa,GAAG,4CAA4C,CAAC;AACnE,MAAM,iBAAiB,GAAG,4CAA4C,CAAC;AACvE,MAAM,aAAa,GAAG,YAAY,CAAC;AACnC,MAAM,iBAAiB,GACrB,oEAAoE,CAAC;AACvE,MAAM,aAAa,GAAG,SAAS,CAAC;AAChC,MAAM,uBAAuB,GAC3B,oEAAoE,CAAC;AACvE,MAAM,2BAA2B,GAC/B,oEAAoE,CAAC;AACvE,MAAM,aAAa,GAAG,QAAQ,CAAC;AAC/B,MAAM,iBAAiB,GAAG,6CAA6C,CAAC;AACxE,MAAM,kBAAkB,GACtB,oEAAoE,CAAC;AACvE,MAAM,sBAAsB,GAC1B,oEAAoE,CAAC;AAEvE,8CAA8C;AAC9C,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC1C,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnD,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnD,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC7D,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnD,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC1D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxD,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxD,MAAM,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAClE,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxD,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC9D,MAAM,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtE,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CACJ,sBAAsB,CACpB,cAAc,CAAC,iBAAiB,CAAC,EACjC,YAAY,CAAC,QAAQ,CACtB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC9B,MAAM,CACJ,sBAAsB,CACpB,cAAc,CAAC,2BAA2B,CAAC,EAC3C,YAAY,CAAC,YAAY,EACzB,aAAa,CACd,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YACxC,MAAM,CACJ,sBAAsB,CACpB,cAAc,CAAC,sBAAsB,CAAC,EACtC,YAAY,CAAC,QAAQ,CACtB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,GAAG,EAAE,CACV,sBAAsB,CACpB,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EACzB,YAAY,CAAC,QAAQ,CACtB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/amount.d.ts

@@ -0,0 +1,70 @@
+import { BigNumber } from 'bignumber.js';
+import { ethers } from 'ethers';
+/**
+ * Convert the given Wei value to Ether value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export declare function fromWei(value: BigNumber.Value | null | undefined, decimals?: number): string;
+/**
+ * Convert the given Wei value to Ether value,
+ * round to set number of decimals with a minimum floor, configured per token
+ * @param value The value to convert.
+ * @param decimals
+ * @returns Converted value in string type.
+ */
+export declare function fromWeiRounded(value: BigNumber.Value | null | undefined, decimals?: number, displayDecimals?: number): string;
+/**
+ * Convert the given value to Wei value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export declare function toWei(value: BigNumber.Value | null | undefined, decimals?: number): string;
+/**
+ * Try to parse the given value into BigNumber.js BigNumber
+ * @param value The value to parse.
+ * @returns Parsed value in BigNumber.js BigNumber type.
+ */
+export declare function tryParseAmount(value: BigNumber.Value | null | undefined): BigNumber | null;
+/**
+ * Checks if an amount is equal of nearly equal to balance within a small margin of error
+ * Necessary because amounts in the UI are often rounded
+ * @param amount1 The amount to compare.
+ * @param amount2 The amount to compare.
+ * @returns true/false.
+ */
+export declare function eqAmountApproximate(amount1: BigNumber.Value, amount2: BigNumber.Value, maxDifference: BigNumber.Value): boolean;
+/**
+ * Converts a value with `fromDecimals` decimals to a value with `toDecimals` decimals.
+ * Incurs a loss of precision when `fromDecimals` > `toDecimals`.
+ * @param fromDecimals The number of decimals `value` has.
+ * @param toDecimals The number of decimals to convert `value` to.
+ * @param value The value to convert.
+ * @returns `value` represented with `toDecimals` decimals in string type.
+ */
+export declare function convertDecimalsToIntegerString(fromDecimals: number, toDecimals: number, value: BigNumber.Value): string;
+export declare function convertDecimals(fromDecimals: number, toDecimals: number, value: BigNumber.Value): BigNumber;
+/**
+ * Calculates the gas limit with a buffer added to the estimated gas.
+ * @param estimatedGas The estimated gas for the transaction.
+ * @param bufferPercent The percentage to add as a buffer (default: 10%).
+ * @returns The calculated gas limit with the buffer added.
+ */
+export declare function addBufferToGasLimit(estimatedGas: ethers.BigNumber, bufferPercent?: number): ethers.BigNumber;
+/**
+ * Calculates the amount from the origin chain scaled to the destination chain
+ * This calculation is in line with the FungibleTokenRouter contract _outboundAmount
+ * and _inboundAmount functions
+ * @param fromScale The origin scale number.
+ * @param toScale The destination scale number.
+ * @param amount The number to scale.
+ * @param precisionFactor  Number used to get accurate conversion for smaller numbers.
+ * Take into account the resulting amount will be have this precision factor multiplied into it.
+ */
+export declare function convertToScaledAmount({ amount, fromScale, toScale, precisionFactor, }: {
+    fromScale?: number;
+    toScale?: number;
+    amount: bigint;
+    precisionFactor: number;
+}): bigint;
+//# sourceMappingURL=amount.d.ts.map

package/dist/amount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAKhC;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,GAChC,MAAM,CAKR;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,EACjC,eAAe,CAAC,EAAE,MAAM,GACvB,MAAM,CAOR;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CACnB,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,GAChC,MAAM,CAmBR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,GACxC,SAAS,GAAG,IAAI,CASlB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,SAAS,CAAC,KAAK,EACxB,OAAO,EAAE,SAAS,CAAC,KAAK,EACxB,aAAa,EAAE,SAAS,CAAC,KAAK,GAC7B,OAAO,CAGT;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,CAAC,KAAK,GACrB,MAAM,CAGR;AAED,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,CAAC,KAAK,GACrB,SAAS,CAaX;AAKD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,CAAC,SAAS,EAC9B,aAAa,GAAE,MAAyC,GACvD,MAAM,CAAC,SAAS,CAGlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,MAAM,EACN,SAAS,EACT,OAAO,EACP,eAAe,GAChB,EAAE;IACD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACzB,UAOA"}

package/dist/amount.js

@@ -0,0 +1,143 @@
+import { formatUnits, parseUnits } from '@ethersproject/units';
+import { BigNumber } from 'bignumber.js';
+const DEFAULT_DISPLAY_DECIMALS = 4;
+const DEFAULT_TOKEN_DECIMALS = 18;
+/**
+ * Convert the given Wei value to Ether value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export function fromWei(value, decimals = DEFAULT_TOKEN_DECIMALS) {
+    if (!value)
+        return (0).toString();
+    const valueString = value.toString(10).trim();
+    const flooredValue = BigNumber(valueString).toFixed(0, BigNumber.ROUND_FLOOR);
+    return parseFloat(formatUnits(flooredValue, decimals)).toString();
+}
+/**
+ * Convert the given Wei value to Ether value,
+ * round to set number of decimals with a minimum floor, configured per token
+ * @param value The value to convert.
+ * @param decimals
+ * @returns Converted value in string type.
+ */
+export function fromWeiRounded(value, decimals = DEFAULT_TOKEN_DECIMALS, displayDecimals) {
+    if (!value)
+        return '0';
+    const flooredValue = BigNumber(value).toFixed(0, BigNumber.ROUND_FLOOR);
+    const amount = BigNumber(formatUnits(flooredValue, decimals));
+    if (amount.isZero())
+        return '0';
+    displayDecimals ??= amount.gte(10000) ? 2 : DEFAULT_DISPLAY_DECIMALS;
+    return amount.toFixed(displayDecimals, BigNumber.ROUND_FLOOR);
+}
+/**
+ * Convert the given value to Wei value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export function toWei(value, decimals = DEFAULT_TOKEN_DECIMALS) {
+    if (!value)
+        return BigNumber(0).toString();
+    // First convert to a BigNumber, and then call `toString` with the
+    // explicit radix 10 such that the result is formatted as a base-10 string
+    // and not in scientific notation.
+    const valueBN = BigNumber(value);
+    const valueString = valueBN.toString(10).trim();
+    const components = valueString.split('.');
+    if (components.length === 1) {
+        return parseUnits(valueString, decimals).toString();
+    }
+    else if (components.length === 2) {
+        const trimmedFraction = components[1].substring(0, decimals);
+        return parseUnits(`${components[0]}.${trimmedFraction}`, decimals).toString();
+    }
+    else {
+        throw new Error(`Cannot convert ${valueString} to wei`);
+    }
+}
+/**
+ * Try to parse the given value into BigNumber.js BigNumber
+ * @param value The value to parse.
+ * @returns Parsed value in BigNumber.js BigNumber type.
+ */
+export function tryParseAmount(value) {
+    try {
+        if (!value)
+            return null;
+        const parsed = BigNumber(value);
+        if (!parsed || parsed.isNaN() || !parsed.isFinite())
+            return null;
+        else
+            return parsed;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Checks if an amount is equal of nearly equal to balance within a small margin of error
+ * Necessary because amounts in the UI are often rounded
+ * @param amount1 The amount to compare.
+ * @param amount2 The amount to compare.
+ * @returns true/false.
+ */
+export function eqAmountApproximate(amount1, amount2, maxDifference) {
+    // Is difference btwn amounts less than maxDifference
+    return BigNumber(amount1).minus(amount2).abs().lte(maxDifference);
+}
+/**
+ * Converts a value with `fromDecimals` decimals to a value with `toDecimals` decimals.
+ * Incurs a loss of precision when `fromDecimals` > `toDecimals`.
+ * @param fromDecimals The number of decimals `value` has.
+ * @param toDecimals The number of decimals to convert `value` to.
+ * @param value The value to convert.
+ * @returns `value` represented with `toDecimals` decimals in string type.
+ */
+export function convertDecimalsToIntegerString(fromDecimals, toDecimals, value) {
+    const converted = convertDecimals(fromDecimals, toDecimals, value);
+    return converted.integerValue(BigNumber.ROUND_FLOOR).toString(10);
+}
+export function convertDecimals(fromDecimals, toDecimals, value) {
+    const amount = BigNumber(value);
+    if (fromDecimals === toDecimals)
+        return amount;
+    else if (fromDecimals > toDecimals) {
+        const difference = fromDecimals - toDecimals;
+        return amount.div(BigNumber(10).pow(difference));
+    }
+    // fromDecimals < toDecimals
+    else {
+        const difference = toDecimals - fromDecimals;
+        return amount.times(BigNumber(10).pow(difference));
+    }
+}
+// Default gas limit buffer percentage
+const DEFAULT_GAS_LIMIT_BUFFER_PERCENT = 10;
+/**
+ * Calculates the gas limit with a buffer added to the estimated gas.
+ * @param estimatedGas The estimated gas for the transaction.
+ * @param bufferPercent The percentage to add as a buffer (default: 10%).
+ * @returns The calculated gas limit with the buffer added.
+ */
+export function addBufferToGasLimit(estimatedGas, bufferPercent = DEFAULT_GAS_LIMIT_BUFFER_PERCENT) {
+    const bufferMultiplier = 100 + bufferPercent;
+    return estimatedGas.mul(bufferMultiplier).div(100);
+}
+/**
+ * Calculates the amount from the origin chain scaled to the destination chain
+ * This calculation is in line with the FungibleTokenRouter contract _outboundAmount
+ * and _inboundAmount functions
+ * @param fromScale The origin scale number.
+ * @param toScale The destination scale number.
+ * @param amount The number to scale.
+ * @param precisionFactor  Number used to get accurate conversion for smaller numbers.
+ * Take into account the resulting amount will be have this precision factor multiplied into it.
+ */
+export function convertToScaledAmount({ amount, fromScale, toScale, precisionFactor, }) {
+    if (!fromScale || !toScale || fromScale === toScale)
+        return amount * BigInt(Math.floor(precisionFactor));
+    const scaledAmount = amount * BigInt(Math.floor((fromScale * precisionFactor) / toScale));
+    return scaledAmount;
+}
+//# sourceMappingURL=amount.js.map

package/dist/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AACnC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;;;GAIG;AACH,MAAM,UAAU,OAAO,CACrB,KAAyC,EACzC,QAAQ,GAAG,sBAAsB;IAEjC,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9C,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IAC9E,OAAO,UAAU,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAyC,EACzC,QAAQ,GAAG,sBAAsB,EACjC,eAAwB;IAExB,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IACvB,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9D,IAAI,MAAM,CAAC,MAAM,EAAE;QAAE,OAAO,GAAG,CAAC;IAChC,eAAe,KAAK,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC;IACrE,OAAO,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,KAAK,CACnB,KAAyC,EACzC,QAAQ,GAAG,sBAAsB;IAEjC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,kEAAkE;IAClE,0EAA0E;IAC1E,kCAAkC;IAClC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAChD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,UAAU,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtD,CAAC;SAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC7D,OAAO,UAAU,CACf,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,EACrC,QAAQ,CACT,CAAC,QAAQ,EAAE,CAAC;IACf,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,WAAW,SAAS,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAyC;IAEzC,IAAI,CAAC;QACH,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YAAE,OAAO,IAAI,CAAC;;YAC5D,OAAO,MAAM,CAAC;IACrB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAwB,EACxB,OAAwB,EACxB,aAA8B;IAE9B,qDAAqD;IACrD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAoB,EACpB,UAAkB,EAClB,KAAsB;IAEtB,MAAM,SAAS,GAAG,eAAe,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACnE,OAAO,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAoB,EACpB,UAAkB,EAClB,KAAsB;IAEtB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAI,YAAY,KAAK,UAAU;QAAE,OAAO,MAAM,CAAC;SAC1C,IAAI,YAAY,GAAG,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC;QAC7C,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,4BAA4B;SACvB,CAAC;QACJ,MAAM,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QAC7C,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAED,sCAAsC;AACtC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,YAA8B,EAC9B,gBAAwB,gCAAgC;IAExD,MAAM,gBAAgB,GAAG,GAAG,GAAG,aAAa,CAAC;IAC7C,OAAO,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACpC,MAAM,EACN,SAAS,EACT,OAAO,EACP,eAAe,GAMhB;IACC,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,IAAI,SAAS,KAAK,OAAO;QACjD,OAAO,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtD,MAAM,YAAY,GAChB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,eAAe,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IACvE,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/amount.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=amount.test.d.ts.map

package/dist/amount.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.test.d.ts","sourceRoot":"","sources":["../src/amount.test.ts"],"names":[],"mappings":""}

package/dist/amount.test.js

@@ -0,0 +1,113 @@
+import { expect } from 'chai';
+import { convertToScaledAmount, eqAmountApproximate, fromWei, fromWeiRounded, toWei, } from './amount.js';
+describe('fromWei', () => {
+    it('parses and converts correctly', () => {
+        expect(fromWei(1, 0)).to.equal('1');
+        expect(fromWei('1000000', 6)).to.equal('1');
+        expect(fromWei('1000000000000000000')).to.equal('1');
+        expect(fromWei('1000000000000000000.1234')).to.equal('1');
+    });
+});
+describe('fromWeiRounded', () => {
+    it('parses and converts correctly', () => {
+        expect(fromWeiRounded(1, 0)).to.equal('1.0000');
+        expect(fromWeiRounded('1000000', 6)).to.equal('1.0000');
+        expect(fromWeiRounded('1000000000000000000')).to.equal('1.0000');
+        expect(fromWeiRounded('1000000000000000000.1234')).to.equal('1.0000');
+    });
+    it('rounds correctly', () => {
+        expect(fromWeiRounded(1234567890, 6, 2)).to.equal('1234.56');
+        expect(fromWeiRounded('1234567890', 6, 4)).to.equal('1234.5678');
+        expect(fromWeiRounded('10000000000000000000')).to.equal('10.0000');
+        expect(fromWeiRounded('10000000000000000000', 18, 0)).to.equal('10');
+    });
+    it('can drop decimals for large numbers', () => {
+        expect(fromWeiRounded('10001000000000000000000')).to.equal('10001.00');
+        expect(fromWeiRounded('10001000000000000000', 15, 4)).to.equal('10001.0000');
+    });
+});
+describe('toWei', () => {
+    it('parses and converts correctly', () => {
+        expect(toWei(1, 0)).to.equal('1');
+        expect(toWei('1', 6)).to.equal('1000000');
+        expect(toWei('123.456')).to.equal('123456000000000000000');
+        expect(toWei('1.00000000000000000001')).to.equal('1000000000000000000');
+        expect(toWei('1.00000000000000000001', 6)).to.equal('1000000');
+    });
+});
+describe('eqAmountApproximate', () => {
+    it('compares correctly', () => {
+        expect(eqAmountApproximate(1, 1.001, 0.001)).to.be.true;
+        expect(eqAmountApproximate(9, 9.001, 0.01)).to.be.true;
+        expect(eqAmountApproximate('9876543210', '9876543210', '1')).to.be.true;
+        expect(eqAmountApproximate('9876543210', '9876543212', '1')).to.be.false;
+    });
+});
+describe('convertToScaledAmount', () => {
+    it('returns the original amount when scales are equal or undefined', () => {
+        const amount = 1000n;
+        const precisionFactor = 100;
+        const expectedAmount = amount * BigInt(Math.floor(precisionFactor));
+        expect(convertToScaledAmount({ toScale: 6, amount, precisionFactor: 100 })).to.equal(expectedAmount);
+        expect(convertToScaledAmount({ fromScale: 6, amount, precisionFactor: 100 })).to.equal(expectedAmount);
+        expect(convertToScaledAmount({
+            fromScale: 6,
+            toScale: 6,
+            amount,
+            precisionFactor: 100,
+        })).to.equal(expectedAmount);
+    });
+    it('scales properly when fromScale is higher than toScale', () => {
+        expect(convertToScaledAmount({
+            fromScale: 10,
+            toScale: 1,
+            amount: 10n,
+            precisionFactor: 100000,
+        })).to.equal(10000000n);
+        expect(convertToScaledAmount({
+            fromScale: 8,
+            toScale: 2,
+            amount: 99n,
+            precisionFactor: 100000,
+        })).to.equal(39600000n);
+        expect(convertToScaledAmount({
+            fromScale: 7,
+            toScale: 2,
+            amount: 1n,
+            precisionFactor: 100000,
+        })).to.equal(350000n);
+        expect(convertToScaledAmount({
+            fromScale: 5,
+            toScale: 3,
+            amount: 10n,
+            precisionFactor: 1000,
+        })).to.equal(16660n);
+    });
+    it('scales properly when fromScale is lower than toScale', () => {
+        expect(convertToScaledAmount({
+            fromScale: 1,
+            toScale: 10,
+            amount: 10n,
+            precisionFactor: 100000,
+        })).to.equal(100000n);
+        expect(convertToScaledAmount({
+            fromScale: 2,
+            toScale: 8,
+            amount: 99n,
+            precisionFactor: 100000,
+        })).to.equal(2475000n);
+        expect(convertToScaledAmount({
+            fromScale: 2,
+            toScale: 7,
+            amount: 1n,
+            precisionFactor: 100000,
+        })).to.equal(28571n);
+        expect(convertToScaledAmount({
+            fromScale: 3,
+            toScale: 5,
+            amount: 10n,
+            precisionFactor: 1000,
+        })).to.equal(6000n);
+    });
+});
+//# sourceMappingURL=amount.test.js.map

package/dist/amount.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.test.js","sourceRoot":"","sources":["../src/amount.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,OAAO,EACP,cAAc,EACd,KAAK,GACN,MAAM,aAAa,CAAC;AAErB,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjE,MAAM,CAAC,cAAc,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,MAAM,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvE,MAAM,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5D,YAAY,CACb,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACxE,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACxD,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACvD,MAAM,CAAC,mBAAmB,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACxE,MAAM,CAAC,mBAAmB,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,eAAe,GAAG,GAAG,CAAC;QAC5B,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;QAEpE,MAAM,CACJ,qBAAqB,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC,CACpE,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC3B,MAAM,CACJ,qBAAqB,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC,CACtE,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC3B,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM;YACN,eAAe,EAAE,GAAG;SACrB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,SAAW,CAAC,CAAC;QACxB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,SAAW,CAAC,CAAC;QACxB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,EAAE;YACV,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,OAAQ,CAAC,CAAC;QACrB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,IAAK;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,MAAO,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,OAAQ,CAAC,CAAC;QACrB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,QAAU,CAAC,CAAC;QACvB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,EAAE;YACV,eAAe,EAAE,MAAO;SACzB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,MAAO,CAAC,CAAC;QACpB,MAAM,CACJ,qBAAqB,CAAC;YACpB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,GAAG;YACX,eAAe,EAAE,IAAK;SACvB,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/arrays.d.ts

@@ -0,0 +1,11 @@
+interface Sliceable {
+    length: number;
+    slice: (i: number, j: number) => any;
+}
+export declare function chunk<T extends Sliceable>(str: T, size: number): T[];
+export declare function exclude<T>(item: T, list: T[]): T[];
+export declare function randomElement<T>(list: T[]): T;
+export declare function sortArrayByKey<T extends Record<keyof T, any>>(array: T[], sortKey: keyof T): T[];
+export declare function arrayEqual<T>(a: T[], b: T[]): boolean;
+export {};
+//# sourceMappingURL=arrays.d.ts.map

package/dist/arrays.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.d.ts","sourceRoot":"","sources":["../src/arrays.ts"],"names":[],"mappings":"AAIA,UAAU,SAAS;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;CACtC;AAED,wBAAgB,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,OAM9D;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAE5C;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAEzC;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAC3D,KAAK,EAAE,CAAC,EAAE,EACV,OAAO,EAAE,MAAM,CAAC,GACf,CAAC,EAAE,CAEL;AAGD,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAMrD"}

package/dist/arrays.js

@@ -0,0 +1,26 @@
+import { sortBy } from 'lodash-es';
+import { randomInt } from './math.js';
+export function chunk(str, size) {
+    const R = [];
+    for (let i = 0; i < str.length; i += size) {
+        R.push(str.slice(i, i + size));
+    }
+    return R;
+}
+export function exclude(item, list) {
+    return list.filter((i) => i !== item);
+}
+export function randomElement(list) {
+    return list[randomInt(list.length)];
+}
+export function sortArrayByKey(array, sortKey) {
+    return sortBy(array, [(item) => item[sortKey]]);
+}
+// Validates that 2 arrays are equal in both ordering and elements
+export function arrayEqual(a, b) {
+    if (a.length !== b.length) {
+        return false;
+    }
+    return a.every((item, idx) => item === b[idx]);
+}
+//# sourceMappingURL=arrays.js.map

package/dist/arrays.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.js","sourceRoot":"","sources":["../src/arrays.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAOtC,MAAM,UAAU,KAAK,CAAsB,GAAM,EAAE,IAAY;IAC7D,MAAM,CAAC,GAAa,EAAE,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,OAAO,CAAI,IAAO,EAAE,IAAS;IAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,IAAS;IACxC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,KAAU,EACV,OAAgB;IAEhB,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,UAAU,CAAI,CAAM,EAAE,CAAM;IAC1C,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC"}

package/dist/arrays.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=arrays.test.d.ts.map

package/dist/arrays.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.test.d.ts","sourceRoot":"","sources":["../src/arrays.test.ts"],"names":[],"mappings":""}

package/dist/arrays.test.js

@@ -0,0 +1,77 @@
+import { expect } from 'chai';
+import { chunk, exclude, randomElement, sortArrayByKey } from './arrays.js';
+describe('Arrays utilities', () => {
+    describe('chunk', () => {
+        it('should split an array into chunks of the specified size', () => {
+            const result = chunk([1, 2, 3, 4, 5], 2);
+            expect(result).to.deep.equal([[1, 2], [3, 4], [5]]);
+        });
+        it('should return an empty array when input is empty', () => {
+            const result = chunk([], 2);
+            expect(result).to.deep.equal([]);
+        });
+        it('should handle chunk size larger than array length', () => {
+            const result = chunk([1, 2], 5);
+            expect(result).to.deep.equal([[1, 2]]);
+        });
+    });
+    describe('exclude', () => {
+        it('should exclude the specified item from the list', () => {
+            const result = exclude(2, [1, 2, 3, 2]);
+            expect(result).to.deep.equal([1, 3]);
+        });
+        it('should return the same list if item is not found', () => {
+            const result = exclude(4, [1, 2, 3]);
+            expect(result).to.deep.equal([1, 2, 3]);
+        });
+        it('should return an empty list if all items are excluded', () => {
+            const result = exclude(1, [1, 1, 1]);
+            expect(result).to.deep.equal([]);
+        });
+    });
+    describe('randomElement', () => {
+        beforeEach(() => { });
+        it('should return a random element from the list', () => {
+            const list = [10, 20, 30];
+            const result = randomElement(list);
+            expect(result).to.be.oneOf(list);
+        });
+        it('should handle an empty list gracefully', () => {
+            const result = randomElement([]);
+            expect(result).to.be.undefined;
+        });
+    });
+    describe('sortArrayByKey', () => {
+        it('should sort objects by string key in ascending order', () => {
+            const array = [
+                { name: 'Charlie', id: 3 },
+                { name: 'Alice', id: 1 },
+                { name: 'Bob', id: 2 },
+            ];
+            const result = sortArrayByKey(array, 'name');
+            expect(result).to.deep.equal([
+                { name: 'Alice', id: 1 },
+                { name: 'Bob', id: 2 },
+                { name: 'Charlie', id: 3 },
+            ]);
+        });
+        it('should sort objects by numeric key in ascending order', () => {
+            const array = [
+                { name: 'Charlie', value: 30 },
+                { name: 'Alice', value: 10 },
+                { name: 'Bob', value: 20 },
+            ];
+            const result = sortArrayByKey(array, 'value');
+            expect(result).to.deep.equal([
+                { name: 'Alice', value: 10 },
+                { name: 'Bob', value: 20 },
+                { name: 'Charlie', value: 30 },
+            ]);
+        });
+        it('should return an empty array when input is empty', () => {
+            const result = sortArrayByKey([], 'any');
+            expect(result).to.deep.equal([]);
+        });
+    });
+});
+//# sourceMappingURL=arrays.test.js.map

package/dist/arrays.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.test.js","sourceRoot":"","sources":["../src/arrays.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE5E,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAErB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,IAAI,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAC1B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;YACjC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,KAAK,GAAG;gBACZ,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,EAAE;gBAC1B,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE;gBACxB,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,EAAE;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC3B,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE;gBACxB,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,EAAE;gBACtB,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,KAAK,GAAG;gBACZ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC9B,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC5B,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;aAC3B,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC3B,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC5B,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC1B,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE;aAC/B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/async.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Return a promise that resolves in ms milliseconds.
+ * @param ms Time to wait
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Wait up to a given amount of time, and throw an error if the promise does not resolve in time.
+ * @param promise The promise to timeout on.
+ * @param timeoutMs How long to wait for the promise in milliseconds.
+ * @param message The error message if a timeout occurs.
+ */
+export declare function timeout<T>(promise: Promise<T>, timeoutMs?: number, message?: string): Promise<T>;
+/**
+ * Run a callback with a timeout.
+ * @param timeoutMs How long to wait for the promise in milliseconds.
+ * @param callback The callback to run.
+ * @returns callback return value
+ * @throws Error if the timeout is reached before the callback completes
+ */
+export declare function runWithTimeout<T>(timeoutMs: number, callback: () => Promise<T>): Promise<T>;
+/**
+ * Executes a fetch request that fails after a timeout via an AbortController.
+ * @param resource resource to fetch (e.g URL)
+ * @param options fetch call options object
+ * @param timeout timeout MS (default 10_000)
+ * @returns fetch response
+ */
+export declare function fetchWithTimeout(resource: RequestInfo, options?: RequestInit, timeout?: number): Promise<Response>;
+/**
+ * Retries an async function with exponential backoff.
+ * Always executes at least once, even if `attempts` is 0 or negative.
+ * Stops retrying if `error.isRecoverable` is set to false.
+ * @param runner callback to run
+ * @param attempts max number of attempts (defaults to 5, minimum 1)
+ * @param baseRetryMs base delay between attempts in milliseconds (defaults to 50ms)
+ * @returns runner return value
+ */
+export declare function retryAsync<T>(runner: () => Promise<T> | T, attempts?: number, baseRetryMs?: number): Promise<T>;
+/**
+ * Run a callback with a timeout, and retry if the callback throws an error.
+ * @param runner callback to run
+ * @param delayMs base delay between attempts
+ * @param maxAttempts maximum number of attempts
+ * @returns runner return value
+ */
+export declare function pollAsync<T>(runner: () => Promise<T>, delayMs?: number, maxAttempts?: number | undefined): Promise<T>;
+/**
+ * An enhanced Promise.race that returns
+ * objects with the promise itself and index
+ * instead of just the resolved value.
+ */
+export declare function raceWithContext<T>(promises: Array<Promise<T>>): Promise<{
+    resolved: T;
+    promise: Promise<T>;
+    index: number;
+}>;
+/**
+ * Map an async function over a list xs with a given concurrency level
+ * Forked from https://github.com/celo-org/developer-tooling/blob/0c61e7e02c741fe10ecd1d733a33692d324cdc82/packages/sdk/base/src/async.ts#L128
+ *
+ * @param concurrency number of `mapFn` concurrent executions
+ * @param xs list of value
+ * @param mapFn mapping function
+ */
+export declare function concurrentMap<A, B>(concurrency: number, xs: A[], mapFn: (val: A, idx: number) => Promise<B>): Promise<B[]>;
+//# sourceMappingURL=async.d.ts.map