@shapeshiftoss/utils 1.0.3 → 1.0.5

package/dist/esm/assetData/decodeAssetData.js

@@ -0,0 +1,102 @@
+import { fromAssetId } from '@shapeshiftoss/caip';
+import { pick } from 'lodash';
+import { assertUnreachable } from '../assertUnreachable.js';
+import { FIELDS } from './constants.js';
+import { getBaseAsset } from './getBaseAsset.js';
+const decodeAssetId = (encodedAssetId, assetIdPrefixes) => {
+    // Performance sensitive. `lastIndexOf` + `substring` faster than `split`
+    const colonIndex = encodedAssetId.lastIndexOf(':');
+    const prefixIdx = Number(encodedAssetId.substring(0, colonIndex));
+    const assetReference = encodedAssetId.substring(colonIndex + 1);
+    // Performance sensitive. String concatenation faster than template literal
+    return assetIdPrefixes[prefixIdx] + ':' + assetReference;
+};
+export const decodeAssetData = (encodedAssetData, shouldAddNetworkName = false) => {
+    const { assetIdPrefixes, encodedAssetIds, encodedAssets } = encodedAssetData;
+    const sortedAssetIds = encodedAssetIds.map(encodedAssetId => decodeAssetId(encodedAssetId, assetIdPrefixes));
+    const assetData = encodedAssets.reduce((acc, encodedAsset, idx) => {
+        const assetId = sortedAssetIds[idx];
+        const { chainId } = fromAssetId(assetId);
+        const baseAsset = getBaseAsset(chainId);
+        // Initialize with default values for the chain
+        const asset = Object.assign({
+            assetId,
+            chainId,
+            symbol: '',
+            name: '',
+            precision: 0,
+            color: '',
+            icon: undefined,
+            explorer: '',
+            explorerAddressLink: '',
+            explorerTxLink: '',
+            relatedAssetKey: null,
+        }, pick(baseAsset, ['explorer', 'explorerAddressLink', 'explorerTxLink']));
+        if (assetId === baseAsset?.assetId) {
+            asset.networkName = baseAsset.networkName;
+            asset.networkIcon = baseAsset.networkIcon;
+            asset.networkColor = baseAsset.networkColor;
+        }
+        // Apply each field's decoded value to the asset
+        FIELDS.forEach((field, fieldIdx) => {
+            const value = encodedAsset[fieldIdx];
+            switch (field) {
+                case 'icon': {
+                    const iconOrIcons = value;
+                    if (iconOrIcons.length === 1) {
+                        asset.icon = iconOrIcons[0];
+                    }
+                    else if (iconOrIcons.length > 1) {
+                        asset.icons = iconOrIcons;
+                    }
+                    break;
+                }
+                case 'relatedAssetKey': {
+                    const assetIdx = value;
+                    const relatedAssetId = assetIdx === null ? null : sortedAssetIds[assetIdx];
+                    // if (relatedAssetId === undefined) throw Error()
+                    if (relatedAssetId &&
+                        relatedAssetId !== asset.assetId &&
+                        baseAsset.networkName &&
+                        shouldAddNetworkName) {
+                        asset.name = `${asset.name} on ${baseAsset.networkName}`;
+                    }
+                    asset.relatedAssetKey = relatedAssetId;
+                    asset.isPrimary = relatedAssetId === null || relatedAssetId === asset.assetId;
+                    asset.isChainSpecific = relatedAssetId === null;
+                    break;
+                }
+                case 'name':
+                    asset.name = value;
+                    break;
+                case 'precision':
+                    asset.precision = value;
+                    break;
+                case 'color':
+                    asset.color = value;
+                    break;
+                case 'symbol':
+                    asset.symbol = value;
+                    break;
+                case 'isPool': {
+                    const isPool = value;
+                    if (isPool) {
+                        asset.isPool = true;
+                    }
+                    break;
+                }
+                case 'assetIdx':
+                    // Skip assetIdx as we already have assetId
+                    break;
+                default:
+                    assertUnreachable(field);
+            }
+        });
+        acc[assetId] = asset;
+        return acc;
+    }, {});
+    return {
+        assetData,
+        sortedAssetIds,
+    };
+};

package/dist/esm/assetData/decodeRelatedAssetIndex.d.ts

@@ -0,0 +1,3 @@
+import type { AssetId } from '@shapeshiftoss/caip';
+import type { EncodedRelatedAssetIndex } from './types.js';
+export declare const decodeRelatedAssetIndex: (encodedRelatedAssetIndex: EncodedRelatedAssetIndex, sortedAssetIds: AssetId[]) => Record<AssetId, AssetId[]>;

package/dist/esm/assetData/decodeRelatedAssetIndex.js

@@ -0,0 +1,10 @@
+export const decodeRelatedAssetIndex = (encodedRelatedAssetIndex, sortedAssetIds) => {
+    const result = {};
+    for (let assetIdx = 0; assetIdx < sortedAssetIds.length; assetIdx++) {
+        const assetId = sortedAssetIds[assetIdx];
+        if (!encodedRelatedAssetIndex[assetIdx])
+            continue;
+        result[assetId] = encodedRelatedAssetIndex[assetIdx].map(innerAssetIdx => sortedAssetIds[innerAssetIdx]);
+    }
+    return result;
+};

package/dist/esm/assetData/encodeAssetData.d.ts

@@ -0,0 +1,4 @@
+import type { AssetId } from '@shapeshiftoss/caip';
+import type { AssetsById } from '@shapeshiftoss/types';
+import type { EncodedAssetData } from './types.js';
+export declare const encodeAssetData: (sortedAssetIds: AssetId[], assetsById: AssetsById) => EncodedAssetData;

package/dist/esm/assetData/encodeAssetData.js

@@ -0,0 +1,68 @@
+import { assertUnreachable } from '../assertUnreachable.js';
+import { FIELDS } from './constants.js';
+const encodeAssetIds = (sortedAssetIds) => {
+    const assetIdPrefixes = [];
+    const encodedAssetIds = [];
+    for (const assetId of sortedAssetIds) {
+        // `indexOf` + `substring` faster than `split`
+        const colonIndex = assetId.lastIndexOf(':');
+        const prefix = assetId.substring(0, colonIndex);
+        const assetReference = assetId.substring(colonIndex + 1);
+        const prefixIdx = (() => {
+            const prefixIdx = assetIdPrefixes.indexOf(prefix);
+            if (prefixIdx !== -1) {
+                return prefixIdx;
+            }
+            else {
+                assetIdPrefixes.push(prefix);
+                return assetIdPrefixes.length - 1;
+            }
+        })();
+        encodedAssetIds.push(`${prefixIdx}:${assetReference}`);
+    }
+    return {
+        assetIdPrefixes,
+        encodedAssetIds,
+    };
+};
+const encodeField = (field, assetIdToAssetIdx, asset) => {
+    switch (field) {
+        case 'assetIdx':
+            return assetIdToAssetIdx[asset.assetId];
+        case 'name':
+            return asset.name;
+        case 'precision':
+            return asset.precision;
+        case 'color':
+            return asset.color;
+        case 'icon':
+            return (asset.icon ? [asset.icon] : asset.icons ?? []);
+        case 'symbol':
+            return asset.symbol;
+        case 'relatedAssetKey':
+            return (!asset.relatedAssetKey ? null : assetIdToAssetIdx[asset.relatedAssetKey]);
+        case 'isPool':
+            return (asset.isPool ? 1 : 0);
+        default:
+            return assertUnreachable(field);
+    }
+};
+export const encodeAssetData = (sortedAssetIds, assetsById) => {
+    const { assetIdPrefixes, encodedAssetIds } = encodeAssetIds(sortedAssetIds);
+    const assetIdToAssetIdx = sortedAssetIds.reduce((acc, val, idx) => {
+        acc[val] = idx;
+        return acc;
+    }, {});
+    const encodedAssets = [];
+    for (let i = 0; i < encodedAssetIds.length; i++) {
+        const assetId = sortedAssetIds[i];
+        const asset = assetsById[assetId];
+        const record = FIELDS.map(field => encodeField(field, assetIdToAssetIdx, asset));
+        encodedAssets.push(record);
+    }
+    return {
+        assetIdPrefixes,
+        encodedAssetIds,
+        encodedAssets,
+    };
+};

package/dist/esm/assetData/encodeRelatedAssetIndex.d.ts

@@ -0,0 +1,3 @@
+import type { AssetId } from '@shapeshiftoss/caip';
+import type { EncodedRelatedAssetIndex } from './types.js';
+export declare const encodeRelatedAssetIndex: (relatedAssetIndex: Record<AssetId, AssetId[]>, sortedAssetIds: AssetId[]) => EncodedRelatedAssetIndex;

package/dist/esm/assetData/encodeRelatedAssetIndex.js

@@ -0,0 +1,16 @@
+export const encodeRelatedAssetIndex = (relatedAssetIndex, sortedAssetIds) => {
+    const assetIdToAssetIdx = sortedAssetIds.reduce((acc, val, idx) => {
+        acc[val] = idx;
+        return acc;
+    }, {});
+    const result = {};
+    for (const [assetId, relatedAssets] of Object.entries(relatedAssetIndex)) {
+        if (!relatedAssets.length)
+            continue;
+        const assetIdx = assetIdToAssetIdx[assetId];
+        result[assetIdx] = relatedAssets.map(assetId => {
+            return assetIdToAssetIdx[assetId];
+        });
+    }
+    return result;
+};

package/dist/esm/assetData/getBaseAsset.d.ts

@@ -0,0 +1,3 @@
+import type { ChainId } from '@shapeshiftoss/caip';
+import type { Asset } from '@shapeshiftoss/types';
+export declare const getBaseAsset: (chainId: ChainId) => Readonly<Asset>;

package/dist/esm/assetData/getBaseAsset.js

@@ -0,0 +1,62 @@
+import { KnownChainIds } from '@shapeshiftoss/types';
+import { assertUnreachable } from '../assertUnreachable.js';
+import { arbitrum, arbitrumNova, atom, avax, base, bitcoin, bitcoincash, bnbsmartchain, dogecoin, ethereum, gnosis, hyperevm, katana, litecoin, mayachain, monad, near, optimism, plasma, polygon, solana, starknet, sui, thorchain, tron, zcash, } from './baseAssets.js';
+export const getBaseAsset = (chainId) => {
+    const knownChainId = chainId;
+    switch (knownChainId) {
+        case KnownChainIds.EthereumMainnet:
+            return ethereum;
+        case KnownChainIds.AvalancheMainnet:
+            return avax;
+        case KnownChainIds.OptimismMainnet:
+            return optimism;
+        case KnownChainIds.BnbSmartChainMainnet:
+            return bnbsmartchain;
+        case KnownChainIds.PolygonMainnet:
+            return polygon;
+        case KnownChainIds.GnosisMainnet:
+            return gnosis;
+        case KnownChainIds.ArbitrumMainnet:
+            return arbitrum;
+        case KnownChainIds.ArbitrumNovaMainnet:
+            return arbitrumNova;
+        case KnownChainIds.BaseMainnet:
+            return base;
+        case KnownChainIds.SolanaMainnet:
+            return solana;
+        case KnownChainIds.SuiMainnet:
+            return sui;
+        case KnownChainIds.StarknetMainnet:
+            return starknet;
+        case KnownChainIds.BitcoinMainnet:
+            return bitcoin;
+        case KnownChainIds.BitcoinCashMainnet:
+            return bitcoincash;
+        case KnownChainIds.DogecoinMainnet:
+            return dogecoin;
+        case KnownChainIds.LitecoinMainnet:
+            return litecoin;
+        case KnownChainIds.CosmosMainnet:
+            return atom;
+        case KnownChainIds.ThorchainMainnet:
+            return thorchain;
+        case KnownChainIds.MayachainMainnet:
+            return mayachain;
+        case KnownChainIds.TronMainnet:
+            return tron;
+        case KnownChainIds.MonadMainnet:
+            return monad;
+        case KnownChainIds.HyperEvmMainnet:
+            return hyperevm;
+        case KnownChainIds.PlasmaMainnet:
+            return plasma;
+        case KnownChainIds.KatanaMainnet:
+            return katana;
+        case KnownChainIds.NearMainnet:
+            return near;
+        case KnownChainIds.ZcashMainnet:
+            return zcash;
+        default:
+            return assertUnreachable(knownChainId);
+    }
+};

package/dist/esm/assetData/index.d.ts

@@ -0,0 +1,7 @@
+export * from './encodeAssetData.js';
+export * from './decodeAssetData.js';
+export * from './baseAssets.js';
+export * from './getBaseAsset.js';
+export * from './encodeRelatedAssetIndex.js';
+export * from './decodeRelatedAssetIndex.js';
+export * from './types.js';

package/dist/esm/assetData/index.js

@@ -0,0 +1,7 @@
+export * from './encodeAssetData.js';
+export * from './decodeAssetData.js';
+export * from './baseAssets.js';
+export * from './getBaseAsset.js';
+export * from './encodeRelatedAssetIndex.js';
+export * from './decodeRelatedAssetIndex.js';
+export * from './types.js';

package/dist/esm/assetData/relatedAssetIndex.test.d.ts

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

package/dist/esm/assetData/relatedAssetIndex.test.js

@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vitest';
+import { decodeRelatedAssetIndex } from './decodeRelatedAssetIndex.js';
+import { encodeRelatedAssetIndex } from './encodeRelatedAssetIndex.js';
+// Order of these is deliberately shuffled to test sorting is preserved
+const mockSortedAssetIds = [
+    'eip155:1/erc20:0xeeecd285f60e802ecb6d8d8d37790c887f9a4b33',
+    'eip155:1/erc20:0xeeee2a2e650697d2a8e8bc990c2f3d04203be06f',
+    'eip155:1/erc20:0xeed3ae7b0f8b5b9bb8c035a9941382b1822671cd',
+    'eip155:1/erc20:0xf073bac22dab7faf4a3dd6c6189a70d54110525c',
+    'eip155:1/erc20:0xeee0fe52299f2de8e2ed5111cd521ab67dcf0faf',
+    'eip155:1/erc20:0xeeda34a377dd0ca676b9511ee1324974fa8d980d',
+    'bip122:000000000019d6689c085ae165831e93/slip44:0', // BTC
+];
+const mockRelatedAssetIndex = {
+    'eip155:1/erc20:0xeeee2a2e650697d2a8e8bc990c2f3d04203be06f': [
+        'eip155:1/erc20:0xeeee2a2e650697d2a8e8bc990c2f3d04203be06f',
+        'eip155:1/erc20:0xf073bac22dab7faf4a3dd6c6189a70d54110525c',
+    ],
+    'eip155:1/erc20:0xf073bac22dab7faf4a3dd6c6189a70d54110525c': [
+        'eip155:1/erc20:0xeeee2a2e650697d2a8e8bc990c2f3d04203be06f',
+        'eip155:1/erc20:0xf073bac22dab7faf4a3dd6c6189a70d54110525c',
+    ],
+};
+describe('relatedAssetIndex', () => {
+    it('can encode and decode related asset index as a complete round trip', () => {
+        const encodedRelatedAssetIndex = encodeRelatedAssetIndex(mockRelatedAssetIndex, mockSortedAssetIds);
+        const decodedRelatedAssetIndex = decodeRelatedAssetIndex(encodedRelatedAssetIndex, mockSortedAssetIds);
+        expect(decodedRelatedAssetIndex).toEqual(mockRelatedAssetIndex);
+    });
+});

package/dist/esm/assetData/types.d.ts

@@ -0,0 +1,28 @@
+import type { FIELDS } from './constants.js';
+export type Field = (typeof FIELDS)[number];
+export type FieldToType = {
+    assetIdx: number;
+    name: string;
+    precision: number;
+    color: string;
+    icon: string[];
+    symbol: string;
+    relatedAssetKey: number | null;
+    isPool: 0 | 1;
+};
+export type EncodedAsset = [
+    FieldToType['assetIdx'],
+    FieldToType['name'],
+    FieldToType['precision'],
+    FieldToType['color'],
+    FieldToType['icon'],
+    FieldToType['symbol'],
+    FieldToType['relatedAssetKey'],
+    FieldToType['isPool']
+];
+export type EncodedAssetData = {
+    assetIdPrefixes: string[];
+    encodedAssetIds: string[];
+    encodedAssets: EncodedAsset[];
+};
+export type EncodedRelatedAssetIndex = Record<number, number[]>;

package/dist/esm/assetData/types.js

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

package/dist/esm/baseUnits/baseUnits.d.ts

@@ -0,0 +1,5 @@
+import BigNumber from 'bignumber.js';
+import type { BN } from '../bignumber/bignumber.js';
+export declare const fromBaseUnit: (value: BigNumber.Value, precision: number, displayDecimals?: number) => string;
+export declare const toBaseUnit: (amount: BigNumber.Value | undefined, precision: number, roundingMode?: BigNumber.RoundingMode) => string;
+export declare const firstNonZeroDecimal: (number: BN) => string | undefined;

package/dist/esm/baseUnits/baseUnits.js

@@ -0,0 +1,23 @@
+import BigNumber from 'bignumber.js';
+import { bn, bnOrZero } from '../bignumber/bignumber.js';
+// Converts from base unit to a precision/ish number
+// - If no displayDecimals are provided, it will use the full precision of the number being converted
+// - If displayDecimals are provided, it will use that precision, to return e.g a human, precision, or number stripped to any arbitrary decimal places
+// and use the ROUND_DOWN rounding mode
+export const fromBaseUnit = (value, precision, displayDecimals) => {
+    const precisionNumber = bnOrZero(value).div(bn(10).pow(precision));
+    if (typeof displayDecimals === 'number') {
+        return precisionNumber
+            .decimalPlaces(displayDecimals, BigNumber.ROUND_DOWN)
+            .toFixed(displayDecimals);
+    }
+    return precisionNumber.toFixed();
+};
+export const toBaseUnit = (amount, precision, roundingMode) => {
+    return bnOrZero(amount)
+        .times(bn(10).exponentiatedBy(bnOrZero(precision)))
+        .toFixed(0, roundingMode);
+};
+export const firstNonZeroDecimal = (number) => {
+    return number.toFixed(10).match(/^-?\d*\.?0*\d{0,2}/)?.[0];
+};

package/dist/esm/baseUnits/baseUnits.test.d.ts

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

package/dist/esm/baseUnits/baseUnits.test.js

@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vitest';
+import { fromBaseUnit } from './baseUnits.js';
+describe('@/lib/math', () => {
+    describe('fromBaseUnit', () => {
+        it('should correctly convert and round down with given displayDecimals', () => {
+            const result = fromBaseUnit(123456789, 4, 2);
+            expect(result).toBe('12345.67');
+        });
+        it('should correctly convert without displayDecimals and return full precision', () => {
+            const result = fromBaseUnit(123456789, 4);
+            expect(result).toBe('12345.6789');
+        });
+        it('should correctly convert and round down with given displayDecimals for another input', () => {
+            const result = fromBaseUnit(987654321, 6, 3);
+            expect(result).toBe('987.654');
+        });
+        it('should correctly convert without displayDecimals and return full precision for another input', () => {
+            const result = fromBaseUnit(987654321, 6);
+            expect(result).toBe('987.654321');
+        });
+        it('should correctly convert and round down with given displayDecimals for high precision input', () => {
+            const result = fromBaseUnit('182912819182912192', 18, 8);
+            expect(result).toBe('0.18291281');
+        });
+        it('should correctly convert without displayDecimals and return full precision for high precision input', () => {
+            const result = fromBaseUnit('182912819182912192', 18);
+            expect(result).toBe('0.182912819182912192');
+        });
+    });
+});

package/dist/esm/basisPoints.d.ts

@@ -0,0 +1,23 @@
+import type { BigNumber } from './bignumber/bignumber.js';
+export declare const convertBasisPointsToDecimalPercentage: (basisPoints: BigNumber.Value) => BigNumber;
+export declare const convertDecimalPercentageToBasisPoints: (decimalPercentage: BigNumber.Value) => BigNumber;
+export declare const convertBasisPointsToPercentage: (basisPoints: BigNumber.Value) => BigNumber;
+export declare const convertPercentageToBasisPoints: (percentage: BigNumber.Value) => BigNumber;
+/**
+ * Subtracts basis point amount from a given value.
+ *
+ * @param value The value to subtract basis points from.
+ * @param basisPoints The number of basis points to subtract.
+ * @param roundingMode
+ * @returns The new number that is the input value minus the basis points of the value.
+ */
+export declare const subtractBasisPointAmount: (value: string, basisPoints: BigNumber.Value, roundingMode?: BigNumber.RoundingMode) => string;
+/**
+ * Adds basis point amount from a given value.
+ *
+ * @param value The value to subtract basis points from.
+ * @param basisPoints The number of basis points to subtract.
+ * @param roundingMode
+ * @returns The new number that is the input value minus the basis points of the value.
+ */
+export declare const addBasisPointAmount: (value: string, basisPoints: BigNumber.Value, roundingMode?: BigNumber.RoundingMode) => string;

package/dist/esm/basisPoints.js

@@ -0,0 +1,39 @@
+import { bn, bnOrZero } from './bignumber/bignumber.js';
+export const convertBasisPointsToDecimalPercentage = (basisPoints) => bnOrZero(basisPoints).div(10000);
+export const convertDecimalPercentageToBasisPoints = (decimalPercentage) => bnOrZero(decimalPercentage).times(10000);
+export const convertBasisPointsToPercentage = (basisPoints) => bnOrZero(basisPoints).div(100);
+export const convertPercentageToBasisPoints = (percentage) => bnOrZero(percentage).times(100);
+/**
+ * Subtracts basis point amount from a given value.
+ *
+ * @param value The value to subtract basis points from.
+ * @param basisPoints The number of basis points to subtract.
+ * @param roundingMode
+ * @returns The new number that is the input value minus the basis points of the value.
+ */
+export const subtractBasisPointAmount = (value, basisPoints, roundingMode) => {
+    const bigNumValue = bn(value);
+    // Basis point is 1/100th of a percent
+    const percentValue = convertBasisPointsToDecimalPercentage(basisPoints);
+    const subtractValue = bigNumValue.times(percentValue);
+    // Subtract basis points from the original value
+    const resultValue = bigNumValue.minus(subtractValue);
+    return roundingMode !== undefined ? resultValue.toFixed(0, roundingMode) : resultValue.toFixed();
+};
+/**
+ * Adds basis point amount from a given value.
+ *
+ * @param value The value to subtract basis points from.
+ * @param basisPoints The number of basis points to subtract.
+ * @param roundingMode
+ * @returns The new number that is the input value minus the basis points of the value.
+ */
+export const addBasisPointAmount = (value, basisPoints, roundingMode) => {
+    const bigNumValue = bn(value);
+    // Basis point is 1/100th of a percent
+    const percentValue = convertBasisPointsToDecimalPercentage(basisPoints);
+    const addValue = bigNumValue.times(percentValue);
+    // Subtract basis points from the original value
+    const resultValue = bigNumValue.plus(addValue);
+    return roundingMode !== undefined ? resultValue.toFixed(0, roundingMode) : resultValue.toFixed();
+};

package/dist/esm/bignumber/bignumber.d.ts

@@ -0,0 +1,11 @@
+import BigNumber from 'bignumber.js';
+export { default as BigNumber } from 'bignumber.js';
+export type BN = BigNumber;
+export declare const bn: (n: BigNumber.Value, base?: number) => BN;
+export declare const bnOrZero: (n: BigNumber.Value | null | undefined) => BN;
+export declare const positiveOrZero: (n: BigNumber.Value | null | undefined) => BN;
+export declare const convertPrecision: ({ value, inputExponent, outputExponent, }: {
+    value: BigNumber.Value;
+    inputExponent?: number | undefined;
+    outputExponent?: number | undefined;
+}) => BigNumber;

package/dist/esm/bignumber/bignumber.js

@@ -0,0 +1,16 @@
+import BigNumber from 'bignumber.js';
+export { default as BigNumber } from 'bignumber.js';
+export const bn = (n, base = 10) => new BigNumber(n, base);
+export const bnOrZero = (n) => {
+    const value = bn(n || 0);
+    return value.isFinite() ? value : bn(0);
+};
+export const positiveOrZero = (n) => {
+    const value = bn(n || 0);
+    return value.isPositive() ? value : bn(0);
+};
+export const convertPrecision = ({ value, inputExponent = 0, outputExponent = 0, }) => {
+    return bnOrZero(value)
+        .dividedBy(bn(10).exponentiatedBy(inputExponent))
+        .multipliedBy(bn(10).exponentiatedBy(outputExponent));
+};

package/dist/esm/bignumber/bignumber.test.d.ts

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

package/dist/esm/bignumber/bignumber.test.js

@@ -0,0 +1,50 @@
+import { describe, expect, it } from 'vitest';
+import { BigNumber, bn, bnOrZero, convertPrecision } from './bignumber.js';
+describe('bignumber', () => {
+    describe('bnOrZero', () => {
+        it('returns an instance of bignumber', () => {
+            const zero = bnOrZero(0);
+            expect(zero).toBeInstanceOf(BigNumber);
+            const one = bnOrZero(1);
+            expect(one).toBeInstanceOf(BigNumber);
+            const foo = bnOrZero('foo');
+            expect(foo).toBeInstanceOf(BigNumber);
+            expect(foo.toString()).toBe('0');
+            const empty = bnOrZero('');
+            expect(empty).toBeInstanceOf(BigNumber);
+            expect(empty.toString()).toBe('0');
+        });
+    });
+    describe('convertPrecision', () => {
+        it('can convert values for increased precision', () => {
+            const value = '1234';
+            const expectation = bn('1234000');
+            const result = convertPrecision({ value, inputExponent: 3, outputExponent: 6 });
+            expect(result).toEqual(expectation);
+        });
+        it('can convert values for decreased precision', () => {
+            const value = '1234000';
+            const expectation = bn('1234');
+            const result = convertPrecision({ value, inputExponent: 6, outputExponent: 3 });
+            expect(result).toEqual(expectation);
+        });
+        it('treats 0 as 0 when increasing precision', () => {
+            const value = '0';
+            const expectation = bn('0');
+            const result = convertPrecision({ value, inputExponent: 12, outputExponent: 18 });
+            expect(result).toEqual(expectation);
+        });
+        it('treats 0 as 0 when decreasing precision', () => {
+            const value = '0';
+            const expectation = bn('0');
+            const result = convertPrecision({ value, inputExponent: 18, outputExponent: 12 });
+            expect(result).toEqual(expectation);
+        });
+        it('does not remove decimals with rounding', () => {
+            const value = '1234567';
+            const expectation = bn('1234.567');
+            const result = convertPrecision({ value, inputExponent: 6, outputExponent: 3 });
+            expect(result).toEqual(expectation);
+        });
+    });
+});

package/dist/esm/chainIdToFeeAsset.d.ts

@@ -0,0 +1,3 @@
+import type { AssetId, ChainId } from '@shapeshiftoss/caip';
+import type { Asset } from '@shapeshiftoss/types';
+export declare const chainIdToFeeAsset: (assetsById: Partial<Record<AssetId, Asset>>, chainId: ChainId) => Asset | undefined;

package/dist/esm/chainIdToFeeAsset.js

@@ -0,0 +1,5 @@
+import { chainIdToFeeAssetId } from './chainIdToFeeAssetId.js';
+export const chainIdToFeeAsset = (assetsById, chainId) => {
+    const assetId = chainIdToFeeAssetId(chainId);
+    return assetsById[assetId];
+};

package/dist/esm/chainIdToFeeAssetId.d.ts

@@ -0,0 +1,2 @@
+import type { AssetId, ChainId } from '@shapeshiftoss/caip';
+export declare const chainIdToFeeAssetId: (_chainId: ChainId) => AssetId;