@shapeshiftoss/utils 1.0.3-alpha.1 → 1.0.3

package/dist/cjs/historyTimeframe.js

@@ -1,36 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHistoryTimeframeBounds = void 0;
-const types_1 = require("@shapeshiftoss/types");
-const dayjs_1 = __importDefault(require("dayjs"));
-const assertUnreachable_1 = require("./assertUnreachable");
-const getHistoryTimeframeBounds = (timeframe, end = (0, dayjs_1.default)().endOf('day')) => {
-    let start = end; // Shut up typescript.
-    switch (timeframe) {
-        case types_1.HistoryTimeframe.HOUR:
-            start = end.subtract(1, 'day');
-            break;
-        case types_1.HistoryTimeframe.DAY:
-            start = end.subtract(1, 'day');
-            break;
-        case types_1.HistoryTimeframe.WEEK:
-            start = end.subtract(1, 'week');
-            break;
-        case types_1.HistoryTimeframe.MONTH:
-            start = end.subtract(1, 'month');
-            break;
-        case types_1.HistoryTimeframe.YEAR:
-            start = end.subtract(1, 'year');
-            break;
-        case types_1.HistoryTimeframe.ALL:
-            start = end.subtract(5, 'years');
-            break;
-        default:
-            (0, assertUnreachable_1.assertUnreachable)(timeframe);
-    }
-    return { start, end };
-};
-exports.getHistoryTimeframeBounds = getHistoryTimeframeBounds;

package/dist/cjs/index.d.ts

@@ -1,24 +0,0 @@
-import type { AssetId } from '@shapeshiftoss/caip';
-export * from './makeAsset/makeAsset';
-export * from './assertUnreachable';
-export * from './sha256';
-export * from './chainIdToFeeAsset';
-export * from './chainIdToFeeAssetId';
-export * from './utxo';
-export * from './bignumber/bignumber';
-export * from './basisPoints';
-export * from './baseUnits/baseUnits';
-export * from './promises';
-export * from './treasury';
-export * from './timeout';
-export * from './createThrottle';
-export * from './historyTimeframe';
-export * from './getNativeFeeAssetReference';
-export * from './assetData';
-export * from './unfreeze';
-export * from './getAssetNamespaceFromChainId';
-export * from './getChainShortName';
-export declare const isSome: <T>(option: T | null | undefined) => option is T;
-export declare const isToken: (assetId: AssetId) => boolean;
-export declare const isSplToken: (assetId: AssetId) => boolean;
-export declare const contractAddressOrUndefined: (assetId: AssetId) => import("@shapeshiftoss/caip").AssetReference | undefined;

package/dist/cjs/index.js

@@ -1,58 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contractAddressOrUndefined = exports.isSplToken = exports.isToken = exports.isSome = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const lodash_1 = require("lodash");
-__exportStar(require("./makeAsset/makeAsset"), exports);
-__exportStar(require("./assertUnreachable"), exports);
-__exportStar(require("./sha256"), exports);
-__exportStar(require("./chainIdToFeeAsset"), exports);
-__exportStar(require("./chainIdToFeeAssetId"), exports);
-__exportStar(require("./utxo"), exports);
-__exportStar(require("./bignumber/bignumber"), exports);
-__exportStar(require("./basisPoints"), exports);
-__exportStar(require("./baseUnits/baseUnits"), exports);
-__exportStar(require("./promises"), exports);
-__exportStar(require("./treasury"), exports);
-__exportStar(require("./timeout"), exports);
-__exportStar(require("./createThrottle"), exports);
-__exportStar(require("./historyTimeframe"), exports);
-__exportStar(require("./getNativeFeeAssetReference"), exports);
-__exportStar(require("./assetData"), exports);
-__exportStar(require("./unfreeze"), exports);
-__exportStar(require("./getAssetNamespaceFromChainId"), exports);
-__exportStar(require("./getChainShortName"), exports);
-const isSome = (option) => !(0, lodash_1.isUndefined)(option) && !(0, lodash_1.isNull)(option);
-exports.isSome = isSome;
-const isToken = (assetId) => {
-    switch ((0, caip_1.fromAssetId)(assetId).assetNamespace) {
-        case caip_1.ASSET_NAMESPACE.erc20:
-        case caip_1.ASSET_NAMESPACE.erc721:
-        case caip_1.ASSET_NAMESPACE.erc1155:
-        case caip_1.ASSET_NAMESPACE.splToken:
-            return true;
-        default:
-            return false;
-    }
-};
-exports.isToken = isToken;
-const isSplToken = (assetId) => {
-    return (0, caip_1.fromAssetId)(assetId).assetNamespace === caip_1.ASSET_NAMESPACE.splToken;
-};
-exports.isSplToken = isSplToken;
-const contractAddressOrUndefined = (assetId) => (0, exports.isToken)(assetId) || (0, exports.isSplToken)(assetId) ? (0, caip_1.fromAssetId)(assetId).assetReference : undefined;
-exports.contractAddressOrUndefined = contractAddressOrUndefined;

package/dist/cjs/makeAsset/makeAsset.d.ts

@@ -1,10 +0,0 @@
-import type { AssetId } from '@shapeshiftoss/caip';
-import type { Asset } from '@shapeshiftoss/types';
-export type MinimalAsset = Partial<Asset> & Pick<Asset, 'assetId' | 'symbol' | 'name' | 'precision'>;
-/**
- * utility to create an asset from minimal asset data from external sources at runtime
- * e.g. zapper/zerion/etherscan
- * required fields are assetId, symbol, name, precision
- * the rest can be inferred from existing data
- */
-export declare const makeAsset: (assetsById: Partial<Record<AssetId, Asset>>, minimalAsset: MinimalAsset) => Asset;

package/dist/cjs/makeAsset/makeAsset.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAsset = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const chainIdToFeeAsset_1 = require("../chainIdToFeeAsset");
-const sha256_1 = require("../sha256");
-/**
- * utility to create an asset from minimal asset data from external sources at runtime
- * e.g. zapper/zerion/etherscan
- * required fields are assetId, symbol, name, precision
- * the rest can be inferred from existing data
- */
-const makeAsset = (assetsById, minimalAsset) => {
-    const { assetId } = minimalAsset;
-    const color = (() => {
-        if (minimalAsset.color)
-            return minimalAsset.color;
-        const shaAssetId = (0, sha256_1.sha256)(assetId);
-        return `#${shaAssetId.slice(0, 6)}`;
-    })();
-    const chainId = (() => {
-        if (minimalAsset.chainId)
-            return minimalAsset.chainId;
-        return (0, caip_1.fromAssetId)(assetId).chainId;
-    })();
-    // currently, dynamic assets are LP pairs, and they have two icon urls and are rendered differently
-    const icon = minimalAsset?.icon ?? '';
-    const explorerLinks = (() => {
-        const feeAsset = (0, chainIdToFeeAsset_1.chainIdToFeeAsset)(assetsById, chainId);
-        return {
-            explorer: feeAsset?.explorer ?? '',
-            explorerTxLink: feeAsset?.explorerTxLink ?? '',
-            explorerAddressLink: feeAsset?.explorerAddressLink ?? '',
-        };
-    })();
-    return Object.assign({}, minimalAsset, explorerLinks, {
-        chainId,
-        color,
-        icon,
-        relatedAssetKey: null,
-        isPrimary: true,
-        isChainSpecific: true,
-    });
-};
-exports.makeAsset = makeAsset;

package/dist/cjs/makeAsset/makeAsset.test.d.ts

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

package/dist/cjs/makeAsset/makeAsset.test.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const caip_1 = require("@shapeshiftoss/caip");
-const vitest_1 = require("vitest");
-const makeAsset_1 = require("./makeAsset");
-const ETH = {
-    assetId: caip_1.ethAssetId,
-    chainId: caip_1.ethChainId,
-    symbol: 'ETH',
-    name: 'Ethereum',
-    precision: 18,
-    color: '#FFFFFF',
-    icon: 'https://rawcdn.githack.com/trustwallet/assets/32e51d582a890b3dd3135fe3ee7c20c2fd699a6d/blockchains/ethereum/info/logo.png',
-    explorer: 'https://etherscan.io',
-    explorerTxLink: 'https://etherscan.io/tx/',
-    explorerAddressLink: 'https://etherscan.io/address/',
-    relatedAssetKey: null,
-};
-(0, vitest_1.describe)('makeAsset', () => {
-    (0, vitest_1.it)('can make erc20 shitcoins', () => {
-        const assetReference = '0xfoobar0000000000000000000000000000000000';
-        const assetNamespace = caip_1.ASSET_NAMESPACE.erc20;
-        const symbol = 'FOOO';
-        const name = 'Humble Panda';
-        const precision = 18;
-        const chainId = caip_1.ethChainId;
-        const assetId = (0, caip_1.toAssetId)({ chainId, assetNamespace, assetReference });
-        const minimalAsset = { assetId, symbol, precision, name };
-        const assetsById = { [ETH.assetId]: ETH };
-        const asset = (0, makeAsset_1.makeAsset)(assetsById, minimalAsset);
-        const asset2 = (0, makeAsset_1.makeAsset)(assetsById, minimalAsset);
-        // doesn't molest asset id, precision, symbol, name
-        (0, vitest_1.expect)(asset?.assetId).toEqual(assetId);
-        (0, vitest_1.expect)(asset?.name).toEqual(name);
-        (0, vitest_1.expect)(asset?.symbol).toEqual(symbol);
-        (0, vitest_1.expect)(asset?.precision).toEqual(precision);
-        // belongs to correct chain
-        (0, vitest_1.expect)(asset?.chainId).toEqual(chainId);
-        // inherits fee asset explorer links
-        (0, vitest_1.expect)(asset?.explorer).toEqual(ETH.explorer);
-        (0, vitest_1.expect)(asset?.explorerTxLink).toEqual(ETH.explorerTxLink);
-        (0, vitest_1.expect)(asset?.explorerAddressLink).toEqual(ETH.explorerAddressLink);
-        // is deterministic on color and icon
-        (0, vitest_1.expect)(asset?.color).toEqual(asset2?.color);
-        (0, vitest_1.expect)(asset?.icon).toEqual(asset2?.icon);
-    });
-});

package/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type": "commonjs"}

package/dist/cjs/promises.d.ts

@@ -1,4 +0,0 @@
-import type { Result } from '@sniptt/monads';
-export declare const isFulfilled: <T>(promise: PromiseSettledResult<T>) => promise is PromiseFulfilledResult<T>;
-export declare const isRejected: <T>(promise: PromiseSettledResult<T>) => promise is PromiseRejectedResult;
-export declare const isResolvedErr: <U, V, T extends Result<U, V>>(promise: PromiseSettledResult<T>) => promise is PromiseRejectedResult;

package/dist/cjs/promises.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isResolvedErr = exports.isRejected = exports.isFulfilled = void 0;
-const isFulfilled = (promise) => promise.status === 'fulfilled';
-exports.isFulfilled = isFulfilled;
-const isRejected = (promise) => promise.status === 'rejected';
-exports.isRejected = isRejected;
-const isResolvedErr = (promise) => 'value' in promise && promise.value.isErr();
-exports.isResolvedErr = isResolvedErr;

package/dist/cjs/sha256.d.ts

@@ -1 +0,0 @@
-export declare const sha256: (input: string) => string;

package/dist/cjs/sha256.js

@@ -1,9 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sha256 = void 0;
-const node_crypto_1 = __importDefault(require("node:crypto"));
-const sha256 = (input) => node_crypto_1.default.createHash('sha256').update(input).digest('hex');
-exports.sha256 = sha256;

package/dist/cjs/timeout.d.ts

@@ -1,7 +0,0 @@
-import type { Result } from '@sniptt/monads';
-export declare const timeout: <SuccessType, FallbackType>(promise: Promise<SuccessType>, timeoutMs: number, fallbackValue: FallbackType) => Promise<SuccessType | FallbackType>;
-export declare const timeoutMonadic: <Left, Right>(promise: Promise<Result<Left, Right>>, timeoutMs: number, timeoutRight: Right) => Promise<Result<Left, Right>>;
-export declare const timeoutMonadicWithOriginal: <Ok, ErrType>(promise: Promise<Result<Ok, ErrType>>, timeoutMs: number, timeoutErr: ErrType) => {
-    timed: Promise<Result<Ok, ErrType>>;
-    original: Promise<Result<Ok, ErrType>>;
-};

package/dist/cjs/timeout.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeoutMonadicWithOriginal = exports.timeoutMonadic = exports.timeout = void 0;
-const monads_1 = require("@sniptt/monads");
-const timeout = (promise, timeoutMs, fallbackValue) => {
-    return Promise.race([
-        promise,
-        new Promise(resolve => setTimeout(() => {
-            resolve(fallbackValue);
-        }, timeoutMs)),
-    ]);
-};
-exports.timeout = timeout;
-const timeoutMonadic = (promise, timeoutMs, timeoutRight) => {
-    return Promise.race([
-        promise,
-        new Promise(resolve => setTimeout(() => {
-            resolve((0, monads_1.Err)(timeoutRight));
-        }, timeoutMs)),
-    ]);
-};
-exports.timeoutMonadic = timeoutMonadic;
-const timeoutMonadicWithOriginal = (promise, timeoutMs, timeoutErr) => {
-    return {
-        timed: Promise.race([
-            promise,
-            new Promise(resolve => setTimeout(() => {
-                resolve((0, monads_1.Err)(timeoutErr));
-            }, timeoutMs)),
-        ]),
-        original: promise,
-    };
-};
-exports.timeoutMonadicWithOriginal = timeoutMonadicWithOriginal;

package/dist/cjs/treasury.d.ts

@@ -1,16 +0,0 @@
-import type { ChainId } from '@shapeshiftoss/caip';
-import { KnownChainIds } from '@shapeshiftoss/types';
-export declare const treasuryChainIds: readonly [KnownChainIds.EthereumMainnet, KnownChainIds.AvalancheMainnet, KnownChainIds.OptimismMainnet, KnownChainIds.BnbSmartChainMainnet, KnownChainIds.PolygonMainnet, KnownChainIds.GnosisMainnet, KnownChainIds.ArbitrumMainnet, KnownChainIds.BaseMainnet, KnownChainIds.SolanaMainnet, KnownChainIds.BitcoinMainnet];
-export type TreasuryChainId = (typeof treasuryChainIds)[number];
-export declare const isTreasuryChainId: (chainId: ChainId) => chainId is KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet | KnownChainIds.OptimismMainnet | KnownChainIds.BnbSmartChainMainnet | KnownChainIds.PolygonMainnet | KnownChainIds.GnosisMainnet | KnownChainIds.ArbitrumMainnet | KnownChainIds.BaseMainnet | KnownChainIds.BitcoinMainnet | KnownChainIds.SolanaMainnet;
-export declare const DAO_TREASURY_ETHEREUM_MAINNET = "0x90a48d5cf7343b08da12e067680b4c6dbfe551be";
-export declare const DAO_TREASURY_OPTIMISM = "0x6268d07327f4fb7380732dc6d63d95F88c0E083b";
-export declare const DAO_TREASURY_AVALANCHE = "0x74d63F31C2335b5b3BA7ad2812357672b2624cEd";
-export declare const DAO_TREASURY_POLYGON = "0xB5F944600785724e31Edb90F9DFa16dBF01Af000";
-export declare const DAO_TREASURY_GNOSIS = "0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3";
-export declare const DAO_TREASURY_BSC = "0x8b92b1698b57bEDF2142297e9397875ADBb2297E";
-export declare const DAO_TREASURY_ARBITRUM = "0x38276553F8fbf2A027D901F8be45f00373d8Dd48";
-export declare const DAO_TREASURY_BASE = "0x9c9aA90363630d4ab1D9dbF416cc3BBC8d3Ed502";
-export declare const DAO_TREASURY_SOLANA = "Bh7R3MeJ98D7Ersxh7TgVQVQUSmDMqwrFVHH9DLfb4u3";
-export declare const DAO_TREASURY_BITCOIN = "bc1qr2whxtd0gvqnctcxlynwejp6fvntv0mtxkv0dlv02vyale8h69ysm6l32n";
-export declare const DAO_TREASURY_NEAR = "f471d0b0f90593d85125f38aaf5458748d6f23fd5b437b844d293d8e87557070";

package/dist/cjs/treasury.js

@@ -1,34 +0,0 @@
-"use strict";
-// Wallets relating to the ShapeShift DAO Treasury
-// https://forum.shapeshift.com/thread/dao-treasuries-and-multisigs-43646
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DAO_TREASURY_NEAR = exports.DAO_TREASURY_BITCOIN = exports.DAO_TREASURY_SOLANA = exports.DAO_TREASURY_BASE = exports.DAO_TREASURY_ARBITRUM = exports.DAO_TREASURY_BSC = exports.DAO_TREASURY_GNOSIS = exports.DAO_TREASURY_POLYGON = exports.DAO_TREASURY_AVALANCHE = exports.DAO_TREASURY_OPTIMISM = exports.DAO_TREASURY_ETHEREUM_MAINNET = exports.isTreasuryChainId = exports.treasuryChainIds = void 0;
-const types_1 = require("@shapeshiftoss/types");
-exports.treasuryChainIds = [
-    types_1.KnownChainIds.EthereumMainnet,
-    types_1.KnownChainIds.AvalancheMainnet,
-    types_1.KnownChainIds.OptimismMainnet,
-    types_1.KnownChainIds.BnbSmartChainMainnet,
-    types_1.KnownChainIds.PolygonMainnet,
-    types_1.KnownChainIds.GnosisMainnet,
-    types_1.KnownChainIds.ArbitrumMainnet,
-    types_1.KnownChainIds.BaseMainnet,
-    types_1.KnownChainIds.SolanaMainnet,
-    types_1.KnownChainIds.BitcoinMainnet,
-];
-const isTreasuryChainId = (chainId) => {
-    return exports.treasuryChainIds.includes(chainId);
-};
-exports.isTreasuryChainId = isTreasuryChainId;
-// Safes
-exports.DAO_TREASURY_ETHEREUM_MAINNET = '0x90a48d5cf7343b08da12e067680b4c6dbfe551be';
-exports.DAO_TREASURY_OPTIMISM = '0x6268d07327f4fb7380732dc6d63d95F88c0E083b';
-exports.DAO_TREASURY_AVALANCHE = '0x74d63F31C2335b5b3BA7ad2812357672b2624cEd';
-exports.DAO_TREASURY_POLYGON = '0xB5F944600785724e31Edb90F9DFa16dBF01Af000';
-exports.DAO_TREASURY_GNOSIS = '0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3';
-exports.DAO_TREASURY_BSC = '0x8b92b1698b57bEDF2142297e9397875ADBb2297E';
-exports.DAO_TREASURY_ARBITRUM = '0x38276553F8fbf2A027D901F8be45f00373d8Dd48';
-exports.DAO_TREASURY_BASE = '0x9c9aA90363630d4ab1D9dbF416cc3BBC8d3Ed502';
-exports.DAO_TREASURY_SOLANA = 'Bh7R3MeJ98D7Ersxh7TgVQVQUSmDMqwrFVHH9DLfb4u3';
-exports.DAO_TREASURY_BITCOIN = 'bc1qr2whxtd0gvqnctcxlynwejp6fvntv0mtxkv0dlv02vyale8h69ysm6l32n';
-exports.DAO_TREASURY_NEAR = 'f471d0b0f90593d85125f38aaf5458748d6f23fd5b437b844d293d8e87557070';

package/dist/cjs/unfreeze.d.ts

@@ -1,4 +0,0 @@
-/**
- * Creates a shallow clone to allow mutation of a readonly object
- */
-export declare const unfreeze: <T>(obj: Readonly<T>) => T;

package/dist/cjs/unfreeze.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unfreeze = void 0;
-/**
- * Creates a shallow clone to allow mutation of a readonly object
- */
-const unfreeze = (obj) => {
-    return { ...obj };
-};
-exports.unfreeze = unfreeze;

package/dist/cjs/utxo.d.ts

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

package/dist/cjs/utxo.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUtxoChainId = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const isUtxoChainId = (chainId) => (0, caip_1.fromChainId)(chainId).chainNamespace === caip_1.CHAIN_NAMESPACE.Utxo;
-exports.isUtxoChainId = isUtxoChainId;