@0xkoaj/sdk 0.0.1-beta.1 → 0.0.1-beta.10

package/dist/services/quotes/types.d.ts

@@ -0,0 +1,204 @@
+import { GasSpeed, SupportedGasValues } from '../gas/types';
+import { BaseTokenMetadata } from '../metadata/types';
+import { Address, BigIntish, ChainId, SupportInChain, TimeString, TokenAddress, BuiltTransaction, AmountsOfToken } from '../../types';
+import { Either } from '../../utility-types';
+import { CompareQuotesBy, CompareQuotesUsing } from './quote-compare';
+import { QuoteSourceMetadata, QuoteSourceSupport } from './quote-sources/types';
+import { SourceConfig } from './source-registry';
+export type GlobalQuoteSourceConfig = {
+    referrer?: {
+        address: Address;
+        name: string;
+    };
+    disableValidation?: boolean;
+};
+export type SourceId = string;
+export type SourceMetadata = QuoteSourceMetadata<QuoteSourceSupport>;
+export type IQuoteService = {
+    supportedSources(): Record<SourceId, SourceMetadata>;
+    supportedChains(): ChainId[];
+    supportedSourcesInChain(_: {
+        chainId: ChainId;
+    }): Record<SourceId, SourceMetadata>;
+    supportedGasSpeeds(): Record<ChainId, SupportInChain<SupportedGasValues>>;
+    estimateQuotes(_: {
+        request: EstimatedQuoteRequest;
+        config?: {
+            timeout?: TimeString;
+        };
+    }): Record<SourceId, Promise<EstimatedQuoteResponse>>;
+    estimateAllQuotes<IgnoreFailed extends boolean = true>(_: {
+        request: EstimatedQuoteRequest;
+        config?: {
+            ignoredFailed?: IgnoreFailed;
+            sort?: {
+                by: CompareQuotesBy;
+                using?: CompareQuotesUsing;
+            };
+            timeout?: TimeString;
+        };
+    }): Promise<IgnoreFailedResponses<IgnoreFailed, EstimatedQuoteResponse>[]>;
+    getQuotes(_: {
+        request: QuoteRequest;
+        config?: {
+            timeout?: TimeString;
+        };
+    }): Record<SourceId, Promise<QuoteResponse>>;
+    getAllQuotes<IgnoreFailed extends boolean = true>(_: {
+        request: QuoteRequest;
+        config?: {
+            ignoredFailed?: IgnoreFailed;
+            sort?: {
+                by: CompareQuotesBy;
+                using?: CompareQuotesUsing;
+            };
+            timeout?: TimeString;
+        };
+    }): Promise<IgnoreFailedResponses<IgnoreFailed, QuoteResponse>[]>;
+    getBestQuote(_: {
+        request: QuoteRequest;
+        config?: {
+            choose?: {
+                by: CompareQuotesBy;
+                using?: CompareQuotesUsing;
+            };
+            timeout?: TimeString;
+        };
+    }): Promise<QuoteResponse>;
+    getAllQuotesWithTxs<IgnoreFailed extends boolean = true>(_: {
+        request: QuoteRequest;
+        config?: {
+            ignoredFailed?: IgnoreFailed;
+            sort?: {
+                by: CompareQuotesBy;
+                using?: CompareQuotesUsing;
+            };
+            timeout?: TimeString;
+        };
+    }): Promise<IgnoreFailedResponses<IgnoreFailed, QuoteResponseWithTx>[]>;
+    buildTxs(_: {
+        quotes: Record<SourceId, Promise<QuoteResponseRelevantForTxBuild>> | Record<SourceId, QuoteResponseRelevantForTxBuild>;
+        sourceConfig?: SourceConfig;
+        config?: {
+            timeout?: TimeString;
+        };
+    }): Record<SourceId, Promise<QuoteTransaction>>;
+    buildAllTxs<IgnoreFailed extends boolean = true>(_: {
+        quotes: Record<SourceId, Promise<QuoteResponseRelevantForTxBuild>> | Promise<Record<SourceId, QuoteResponseRelevantForTxBuild>> | Record<SourceId, QuoteResponseRelevantForTxBuild>;
+        sourceConfig?: SourceConfig;
+        config?: {
+            timeout?: TimeString;
+            ignoredFailed?: IgnoreFailed;
+        };
+    }): Promise<Record<SourceId, IgnoreFailedResponses<IgnoreFailed, QuoteTransaction>>>;
+};
+export type QuoteRequest = {
+    chainId: ChainId;
+    sellToken: TokenAddress;
+    buyToken: TokenAddress;
+    order: {
+        type: 'sell';
+        sellAmount: BigIntish;
+    } | {
+        type: 'buy';
+        buyAmount: BigIntish;
+    };
+    slippagePercentage: number;
+    takerAddress: Address;
+    recipient?: Address;
+    gasSpeed?: {
+        speed: GasSpeed;
+        requirement?: 'required' | 'best effort';
+    };
+    txValidFor?: TimeString;
+    filters?: Either<{
+        includeSources: SourceId[];
+    }, {
+        excludeSources: SourceId[];
+    }>;
+    includeNonTransferSourcesWhenRecipientIsSet?: boolean;
+    estimateBuyOrdersWithSellOnlySources?: boolean;
+    sourceConfig?: SourceConfig;
+};
+type TokenWithOptionalPrice = BaseTokenMetadata & {
+    address: TokenAddress;
+    price?: number;
+};
+export type QuoteResponse<CustomQuoteSourceData extends Record<string, any> = Record<string, any>> = {
+    chainId: ChainId;
+    sellToken: TokenWithOptionalPrice;
+    buyToken: TokenWithOptionalPrice;
+    sellAmount: AmountsOfToken;
+    buyAmount: AmountsOfToken;
+    maxSellAmount: AmountsOfToken;
+    minBuyAmount: AmountsOfToken;
+    gas?: {
+        estimatedGas: bigint;
+        estimatedCost: bigint;
+        estimatedCostInUnits: string;
+        gasTokenSymbol: string;
+        estimatedCostInUSD?: string;
+        gasTokenPrice?: number;
+    };
+    accounts: {
+        takerAddress: Address;
+        recipient: Address;
+    };
+    source: {
+        id: SourceId;
+        allowanceTarget: Address;
+        name: string;
+        logoURI: string;
+    };
+    type: 'sell' | 'buy';
+    customData: CustomQuoteSourceData;
+};
+export type QuoteResponseRelevantForTxBuild<CustomQuoteSourceData extends Record<string, any> = Record<string, any>> = {
+    chainId: ChainId;
+    sellToken: {
+        address: Address;
+    };
+    buyToken: {
+        address: Address;
+    };
+    sellAmount: {
+        amount: bigint;
+    };
+    buyAmount: {
+        amount: bigint;
+    };
+    maxSellAmount: {
+        amount: bigint;
+    };
+    minBuyAmount: {
+        amount: bigint;
+    };
+    accounts: {
+        takerAddress: Address;
+        recipient: Address;
+    };
+    source: {
+        id: SourceId;
+    };
+    type: 'sell' | 'buy';
+    customData: CustomQuoteSourceData;
+};
+export type QuoteResponseWithTx<CustomQuoteSourceData extends Record<string, any> = Record<string, any>> = QuoteResponse<CustomQuoteSourceData> & {
+    tx: QuoteTransaction;
+};
+export type QuoteTransaction = BuiltTransaction & {
+    from: Address;
+};
+export type EstimatedQuoteRequest = Omit<QuoteRequest, 'takerAddress' | 'recipient' | 'txValidFor'>;
+export type EstimatedQuoteResponse<CustomQuoteSourceData extends Record<string, any> = Record<string, any>> = Omit<QuoteResponse<CustomQuoteSourceData>, 'accounts'>;
+export type IgnoreFailedResponses<IgnoredFailed extends boolean, Response> = IgnoredFailed extends true ? Response : Response | FailedResponse;
+export type FailedResponse = {
+    failed: true;
+    source: {
+        id: string;
+        name: string;
+        logoURI: string;
+    };
+    error: any;
+};
+export {};

package/dist/services/quotes/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/services/quotes/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/quotes/types.ts"],"names":[],"mappings":""}

package/dist/shared/abis/erc20.d.ts

@@ -0,0 +1,86 @@
+declare const _default: readonly [{
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "name";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: false;
+    readonly inputs: readonly [{
+        readonly name: "_from";
+        readonly type: "address";
+    }, {
+        readonly name: "_to";
+        readonly type: "address";
+    }, {
+        readonly name: "_value";
+        readonly type: "uint256";
+    }];
+    readonly name: "transferFrom";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "decimals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [{
+        readonly name: "_owner";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "balance";
+        readonly type: "uint256";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [];
+    readonly name: "symbol";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly constant: true;
+    readonly inputs: readonly [{
+        readonly name: "_owner";
+        readonly type: "address";
+    }, {
+        readonly name: "_spender";
+        readonly type: "address";
+    }];
+    readonly name: "allowance";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly payable: false;
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+export default _default;

package/dist/shared/abis/erc20.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = [
+    {
+        constant: true,
+        inputs: [],
+        name: 'name',
+        outputs: [
+            {
+                name: '',
+                type: 'string',
+            },
+        ],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        constant: false,
+        inputs: [
+            {
+                name: '_from',
+                type: 'address',
+            },
+            {
+                name: '_to',
+                type: 'address',
+            },
+            {
+                name: '_value',
+                type: 'uint256',
+            },
+        ],
+        name: 'transferFrom',
+        outputs: [
+            {
+                name: '',
+                type: 'bool',
+            },
+        ],
+        payable: false,
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+    {
+        constant: true,
+        inputs: [],
+        name: 'decimals',
+        outputs: [
+            {
+                name: '',
+                type: 'uint8',
+            },
+        ],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        constant: true,
+        inputs: [
+            {
+                name: '_owner',
+                type: 'address',
+            },
+        ],
+        name: 'balanceOf',
+        outputs: [
+            {
+                name: 'balance',
+                type: 'uint256',
+            },
+        ],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        constant: true,
+        inputs: [],
+        name: 'symbol',
+        outputs: [
+            {
+                name: '',
+                type: 'string',
+            },
+        ],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        constant: true,
+        inputs: [
+            {
+                name: '_owner',
+                type: 'address',
+            },
+            {
+                name: '_spender',
+                type: 'address',
+            },
+        ],
+        name: 'allowance',
+        outputs: [
+            {
+                name: '',
+                type: 'uint256',
+            },
+        ],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+];
+//# sourceMappingURL=erc20.js.map

package/dist/shared/abis/erc20.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc20.js","sourceRoot":"","sources":["../../../src/shared/abis/erc20.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb;QACE,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,MAAM;aACb;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;IACD;QACE,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,OAAO;aACd;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ;aACf;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IAED;QACE,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,OAAO,EAAE,KAAK;QACd,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACO,CAAC"}

package/dist/shared/alchemy.d.ts

@@ -0,0 +1,7 @@
+import { ChainId } from '../types';
+export declare const ALCHEMY_NETWORKS: Record<ChainId, {
+    key: string;
+    price: {
+        supported: boolean;
+    };
+}>;

package/dist/shared/alchemy.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALCHEMY_NETWORKS = void 0;
+const _chains_1 = require("../chains");
+exports.ALCHEMY_NETWORKS = {
+    [_chains_1.Chains.ETHEREUM.chainId]: { key: 'eth-mainnet', price: { supported: true } },
+    [_chains_1.Chains.ETHEREUM_SEPOLIA.chainId]: { key: 'eth-sepolia', price: { supported: false } },
+    [_chains_1.Chains.OPTIMISM.chainId]: { key: 'opt-mainnet', price: { supported: true } },
+    [_chains_1.Chains.ARBITRUM.chainId]: { key: 'arb-mainnet', price: { supported: true } },
+    [_chains_1.Chains.POLYGON.chainId]: { key: 'polygon-mainnet', price: { supported: true } },
+    [_chains_1.Chains.POLYGON_MUMBAI.chainId]: { key: 'polygon-mumbai', price: { supported: false } },
+    [_chains_1.Chains.ASTAR.chainId]: { key: 'astar-mainnet', price: { supported: false } },
+    [_chains_1.Chains.BLAST.chainId]: { key: 'blast-mainnet', price: { supported: true } },
+    [_chains_1.Chains.BNB_CHAIN.chainId]: { key: 'bnb-mainnet', price: { supported: true } },
+    [_chains_1.Chains.AVALANCHE.chainId]: { key: 'avax-mainnet', price: { supported: true } },
+    [_chains_1.Chains.FANTOM.chainId]: { key: 'fantom-mainnet', price: { supported: true } },
+    [_chains_1.Chains.METIS_ANDROMEDA.chainId]: { key: 'metis-mainnet', price: { supported: true } },
+    [_chains_1.Chains.POLYGON_ZKEVM.chainId]: {
+        key: 'polygonzkevm-mainnet',
+        price: { supported: true },
+    },
+    [_chains_1.Chains.BASE.chainId]: { key: 'base-mainnet', price: { supported: true } },
+    [_chains_1.Chains.GNOSIS.chainId]: { key: 'gnosis-mainnet', price: { supported: true } },
+    [_chains_1.Chains.SCROLL.chainId]: { key: 'scroll-mainnet', price: { supported: true } },
+    [_chains_1.Chains.opBNB.chainId]: { key: 'opbnb-mainnet', price: { supported: true } },
+    [_chains_1.Chains.MANTLE.chainId]: { key: 'mantle-mainnet', price: { supported: false } },
+    [_chains_1.Chains.ROOTSTOCK.chainId]: { key: 'rootstock-mainnet', price: { supported: false } },
+    [_chains_1.Chains.LINEA.chainId]: { key: 'linea-mainnet', price: { supported: true } },
+    [_chains_1.Chains.SONIC.chainId]: { key: 'sonic-mainnet', price: { supported: false } },
+    [_chains_1.Chains.ZK_SYNC_ERA.chainId]: { key: 'zksync-mainnet', price: { supported: true } },
+    [_chains_1.Chains.CELO.chainId]: { key: 'celo-mainnet', price: { supported: false } },
+    [_chains_1.Chains.PLASMA.chainId]: { key: 'plasma-mainnet', price: { supported: false } },
+    [_chains_1.Chains.UNICHAIN.chainId]: { key: 'unichain-mainnet', price: { supported: false } },
+};
+//# sourceMappingURL=alchemy.js.map

package/dist/shared/alchemy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alchemy.js","sourceRoot":"","sources":["../../src/shared/alchemy.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAGpB,QAAA,gBAAgB,GAAoE;IAC/F,CAAC,gBAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC7E,CAAC,gBAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IACtF,CAAC,gBAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC7E,CAAC,gBAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC7E,CAAC,gBAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAChF,CAAC,gBAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IACvF,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IAC7E,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC5E,CAAC,gBAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC9E,CAAC,gBAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC/E,CAAC,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC9E,CAAC,gBAAM,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IACtF,CAAC,gBAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;QAC9B,GAAG,EAAE,sBAAsB;QAC3B,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE;KAC3B;IACD,CAAC,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC1E,CAAC,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC9E,CAAC,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC9E,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC5E,CAAC,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IAC/E,CAAC,gBAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,mBAAmB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IACrF,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC5E,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IAC7E,CAAC,gBAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IACnF,CAAC,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IAC3E,CAAC,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;IAC/E,CAAC,gBAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;CACpF,CAAC"}

package/dist/shared/auto-update-cache.d.ts

@@ -0,0 +1,23 @@
+import { TimeString } from '../types';
+type CacheConstructorParams<Value> = {
+    calculate: () => Promise<Value>;
+    config: AutoUpdateCacheConfig;
+};
+export type AutoUpdateCacheConfig = {
+    valid?: 'always' | {
+        onlyFor: TimeString;
+    };
+    update: {
+        every: TimeString;
+        ifFailsTryAgainIn?: TimeString;
+    };
+};
+export declare class AutoUpdateCache<Value> {
+    private readonly calculate;
+    private readonly config;
+    private cache;
+    constructor({ calculate, config }: CacheConstructorParams<Value>);
+    getValue(): Value | undefined;
+    private update;
+}
+export {};

package/dist/shared/auto-update-cache.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoUpdateCache = void 0;
+const ms_1 = __importDefault(require("ms"));
+const DEFAULT_RETRY_TIME = '5Minutes';
+class AutoUpdateCache {
+    constructor({ calculate, config }) {
+        this.calculate = calculate;
+        this.config = config;
+        this.cache = { lastUpdated: 0, value: undefined };
+        const isInvalid = config.valid && config.valid !== 'always' && (0, ms_1.default)(config.valid.onlyFor) <= (0, ms_1.default)(config.update.every);
+        if (isInvalid)
+            throw new Error(`'onlyFor' must be greater than 'every'`);
+        this.update();
+    }
+    getValue() {
+        const now = Date.now();
+        const isValid = ({ lastUpdated }) => !this.config.valid || this.config.valid === 'always' || (this.config.valid.onlyFor && lastUpdated >= now - (0, ms_1.default)(this.config.valid.onlyFor));
+        return this.cache && isValid(this.cache) ? this.cache.value : undefined;
+    }
+    async update() {
+        try {
+            const result = await this.calculate();
+            if (result !== undefined) {
+                this.cache = { lastUpdated: Date.now(), value: result };
+            }
+            setTimeout(() => this.update(), (0, ms_1.default)(this.config.update.every));
+        }
+        catch (error) {
+            setTimeout(() => this.update(), (0, ms_1.default)(this.config.update.ifFailsTryAgainIn ?? DEFAULT_RETRY_TIME));
+        }
+    }
+}
+exports.AutoUpdateCache = AutoUpdateCache;
+//# sourceMappingURL=auto-update-cache.js.map

package/dist/shared/auto-update-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto-update-cache.js","sourceRoot":"","sources":["../../src/shared/auto-update-cache.ts"],"names":[],"mappings":";;;;;;AACA,4CAAoB;AAMpB,MAAM,kBAAkB,GAAe,UAAU,CAAC;AAOlD,MAAa,eAAe;IAK1B,YAAY,EAAE,SAAS,EAAE,MAAM,EAAiC;QAC9D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAElD,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAA,YAAE,EAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,IAAA,YAAE,EAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEnH,IAAI,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAEzE,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,QAAQ;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,OAAO,GAAG,CAAC,EAAE,WAAW,EAA8B,EAAE,EAAE,CAC9D,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,WAAW,IAAI,GAAG,GAAG,IAAA,YAAE,EAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAE5I,OAAO,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAC1D,CAAC;YACD,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAA,YAAE,EAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAA,YAAE,EAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,IAAI,kBAAkB,CAAC,CAAC,CAAC;QAClG,CAAC;IACH,CAAC;CACF;AArCD,0CAqCC"}

package/dist/shared/concurrent-lru-cache.d.ts

@@ -0,0 +1,66 @@
+import { TimeString } from '../types';
+import { StringValue } from 'ms';
+export type ExpirationConfigOptions = {
+    useCachedValue: 'always' | {
+        ifUnder: StringValue;
+    };
+    useCachedValueIfCalculationFailed: 'always' | {
+        ifUnder: StringValue;
+    };
+};
+export type CacheConfig = {
+    expiration: ExpirationConfigOptions;
+    maxSize: number;
+};
+type ValidKey = string | number | symbol;
+type CacheConstructorParams<Context, Key extends ValidKey, Value> = {
+    calculate: (context: Context, keys: Key[]) => Promise<Record<Key, Value>>;
+    config: CacheConfig;
+};
+export declare class ConcurrentLRUCache<Key extends ValidKey, Value> {
+    private readonly cache;
+    constructor({ calculate, config, }: {
+        calculate: (keys: Key[]) => Promise<Record<Key, Value>>;
+    } & {
+        config: CacheConfig;
+    });
+    getOrCalculateSingle({ key, expirationConfig, timeout, }: {
+        key: Key;
+        expirationConfig?: Partial<ExpirationConfigOptions>;
+        timeout?: TimeString;
+    }): Promise<Value | undefined>;
+    getOrCalculate({ keys, expirationConfig, timeout, }: {
+        keys: Key[];
+        expirationConfig?: Partial<ExpirationConfigOptions>;
+        timeout?: TimeString;
+    }): Promise<Record<Key, Value>>;
+    holdsValidValue(key: Key, expirationConfig?: ExpirationConfigOptions): boolean;
+    holdsValidValues(keys: Key[], expirationConfig?: ExpirationConfigOptions): Record<Key, boolean>;
+    invalidate(keys: Key[]): void;
+    populate(values: Record<Key, Value>): void;
+}
+export declare class ConcurrentLRUCacheWithContext<Context, Key extends ValidKey, Value> {
+    private readonly calculate;
+    private readonly storableKeyMapper;
+    private readonly expirationConfig;
+    private readonly beingCalculated;
+    private readonly cache;
+    constructor({ calculate, config }: CacheConstructorParams<Context, Key, Value>);
+    getOrCalculateSingle({ key, context, expirationConfig, timeout, }: {
+        key: Key;
+        context: Context;
+        expirationConfig?: Partial<ExpirationConfigOptions>;
+        timeout?: TimeString;
+    }): Promise<Value | undefined>;
+    getOrCalculate({ keys, context, expirationConfig, timeout, }: {
+        keys: Key[];
+        context: Context;
+        expirationConfig?: Partial<ExpirationConfigOptions>;
+        timeout?: TimeString;
+    }): Promise<Record<Key, Value>>;
+    holdsValidValue(key: Key, expirationConfig?: ExpirationConfigOptions): boolean;
+    holdsValidValues(keys: Key[], expirationConfig?: ExpirationConfigOptions): Record<Key, boolean>;
+    invalidate(keys: Key[]): void;
+    populate(values: Record<Key, Value>): void;
+}
+export {};