@talismn/token-rates 3.0.22 → 4.0.0

package/dist/index.d.mts

@@ -1,115 +1,161 @@
-import { TokenId, Token } from '@talismn/chaindata-provider';
-
-declare const tryToDeleteOldTokenRatesDb: () => void;
-
+import { NetworkId, SubDTaoToken, Token, TokenId, TokenList } from "@talismn/chaindata-provider";
+import { IChainConnectorDot } from "@talismn/chain-connectors";
+//#region src/types.d.ts
 declare const SUPPORTED_CURRENCIES: {
-    readonly btc: {
-        readonly name: "Bitcoin";
-        readonly symbol: "₿";
-    };
-    readonly eth: {
-        readonly name: "Ethereum";
-        readonly symbol: "Ξ";
-    };
-    readonly dot: {
-        readonly name: "Polkadot";
-        readonly symbol: "D";
-    };
-    readonly tao: {
-        readonly name: "Bittensor";
-        readonly symbol: "τ";
-    };
-    readonly usd: {
-        readonly name: "US Dollar";
-        readonly symbol: "$";
-    };
-    readonly cny: {
-        readonly name: "Chinese Yuan";
-        readonly symbol: "¥";
-    };
-    readonly eur: {
-        readonly name: "Euro";
-        readonly symbol: "€";
-    };
-    readonly gbp: {
-        readonly name: "British Pound";
-        readonly symbol: "£";
-    };
-    readonly cad: {
-        readonly name: "Canadian Dollar";
-        readonly symbol: "C$";
-    };
-    readonly aud: {
-        readonly name: "Australian Dollar";
-        readonly symbol: "A$";
-    };
-    readonly nzd: {
-        readonly name: "New Zealand Dollar";
-        readonly symbol: "NZ$";
-    };
-    readonly jpy: {
-        readonly name: "Japanese Yen";
-        readonly symbol: "¥";
-    };
-    readonly rub: {
-        readonly name: "Russian Ruble";
-        readonly symbol: "₽";
-    };
-    readonly krw: {
-        readonly name: "South Korean Won";
-        readonly symbol: "₩";
-    };
-    readonly idr: {
-        readonly name: "Indonesian Rupiah";
-        readonly symbol: "Rp";
-    };
-    readonly php: {
-        readonly name: "Philippine Peso";
-        readonly symbol: "₱";
-    };
-    readonly thb: {
-        readonly name: "Thai Baht";
-        readonly symbol: "฿";
-    };
-    readonly vnd: {
-        readonly name: "Vietnamese Dong";
-        readonly symbol: "₫";
-    };
-    readonly inr: {
-        readonly name: "Indian Rupee";
-        readonly symbol: "₹";
-    };
-    readonly try: {
-        readonly name: "Turkish Lira";
-        readonly symbol: "₺";
-    };
-    readonly sgd: {
-        readonly name: "Singapore Dollar";
-        readonly symbol: "S$";
-    };
+  readonly btc: {
+    readonly name: "Bitcoin";
+    readonly symbol: "₿";
+  };
+  readonly eth: {
+    readonly name: "Ethereum";
+    readonly symbol: "Ξ";
+  };
+  readonly dot: {
+    readonly name: "Polkadot";
+    readonly symbol: "D";
+  };
+  readonly tao: {
+    readonly name: "Bittensor";
+    readonly symbol: "τ";
+  };
+  readonly usd: {
+    readonly name: "US Dollar";
+    readonly symbol: "$";
+  };
+  readonly cny: {
+    readonly name: "Chinese Yuan";
+    readonly symbol: "¥";
+  };
+  readonly eur: {
+    readonly name: "Euro";
+    readonly symbol: "€";
+  };
+  readonly gbp: {
+    readonly name: "British Pound";
+    readonly symbol: "£";
+  };
+  readonly cad: {
+    readonly name: "Canadian Dollar";
+    readonly symbol: "C$";
+  };
+  readonly aud: {
+    readonly name: "Australian Dollar";
+    readonly symbol: "A$";
+  };
+  readonly nzd: {
+    readonly name: "New Zealand Dollar";
+    readonly symbol: "NZ$";
+  };
+  readonly jpy: {
+    readonly name: "Japanese Yen";
+    readonly symbol: "¥";
+  };
+  readonly rub: {
+    readonly name: "Russian Ruble";
+    readonly symbol: "₽";
+  };
+  readonly krw: {
+    readonly name: "South Korean Won";
+    readonly symbol: "₩";
+  };
+  readonly idr: {
+    readonly name: "Indonesian Rupiah";
+    readonly symbol: "Rp";
+  };
+  readonly php: {
+    readonly name: "Philippine Peso";
+    readonly symbol: "₱";
+  };
+  readonly thb: {
+    readonly name: "Thai Baht";
+    readonly symbol: "฿";
+  };
+  readonly vnd: {
+    readonly name: "Vietnamese Dong";
+    readonly symbol: "₫";
+  };
+  readonly inr: {
+    readonly name: "Indian Rupee";
+    readonly symbol: "₹";
+  };
+  readonly try: {
+    readonly name: "Turkish Lira";
+    readonly symbol: "₺";
+  };
+  readonly sgd: {
+    readonly name: "Singapore Dollar";
+    readonly symbol: "S$";
+  };
 };
 type TokenRatesStorage = {
-    tokenRates: TokenRatesList;
+  tokenRates: TokenRatesList;
 };
 type TokenRatesList = Record<TokenId, TokenRates>;
 type TokenRates = Record<TokenRateCurrency, TokenRateData | null>;
 type TokenRateData = {
-    price: number;
-    marketCap?: number;
-    change24h?: number;
+  price: number;
+  marketCap?: number;
+  change24h?: number;
 };
 type TokenRateCurrency = keyof typeof SUPPORTED_CURRENCIES;
 declare const newTokenRates: () => TokenRates;
-
+//#endregion
+//#region src/fetchDTaoTokenRates.d.ts
+type FetchDTaoTokenRatesOptions = {
+  /** substrate chain connector of the host (only its `send` method is used, for one state_call per invocation) */
+  connector: IChainConnectorDot;
+  /** the bittensor network id, defaults to "bittensor" (mainnet) */
+  networkId?: NetworkId;
+  /** token list to price — non-dtao tokens (and dtao tokens with a coingeckoId) are ignored */
+  tokens: TokenList;
+  /** freshly fetched rates list — dtao rates derive from the network's native TAO token rates in it */
+  tokenRates: TokenRatesList;
+  /** previous rates list, used as keep-last fallback when fetching fails */
+  previousRates: TokenRatesList;
+  /** custom fetch for the tao-data api (eg with auth headers), defaults to global fetch */
+  customFetch?: typeof fetch;
+  /** tao-data api url, defaults to https://tda.talisman.xyz */
+  taoDataApiUrl?: string;
+  /** per-request timeout for the chain call and the tao-data api call, defaults to 10s */
+  timeoutMs?: number;
+};
+/**
+ * Rates entries for the bittensor dtao (subnet alpha) tokens of `tokens`, priced from their
+ * subnet pool combined with the TAO rates in `tokenRates`. On chain-fetch failure, falls
+ * back to the token's entry in `previousRates` (keep-last). Never throws — a dtao pricing
+ * failure must not discard the rates list it gets merged into.
+ *
+ * Hosts remain responsible for WHEN to call this (network enabled state, refresh cadence)
+ * and for merging the result into their rates list/store.
+ */
+declare const fetchDTaoTokenRates: ({ connector, networkId, tokens, tokenRates, previousRates, customFetch, taoDataApiUrl, timeoutMs }: FetchDTaoTokenRatesOptions) => Promise<TokenRatesList>;
+//#endregion
+//#region src/getDTaoTokenRates.d.ts
+/**
+ * Rates of a bittensor dtao (subnet alpha) token, derived from its network's native TAO rates
+ * scaled by the subnet pool price. To be used for tokens that don't have a coingecko id.
+ *
+ * @param token
+ * @param tokenRates must contain the rates of the network's native (TAO) token
+ * @param scaledAlphaPrice current TAO-per-alpha pool price, fixed-point scaled by 10^9 (rao)
+ * @param alphaPriceChange24h 24h change of the pool price (alpha vs TAO) in percent, when known
+ */
+declare const getDTaoTokenRates: (token: SubDTaoToken, tokenRates: TokenRatesList, scaledAlphaPrice: string | bigint, alphaPriceChange24h?: number | null) => TokenRates | null;
+//#endregion
+//#region src/TalismanTokenRatesDatabase.d.ts
+declare const tryToDeleteOldTokenRatesDb: () => void;
+//#endregion
+//#region src/TokenRates.d.ts
 declare class TokenRatesError extends Error {
-    response?: Response;
-    constructor(message: string, response?: Response);
+  response?: Response;
+  constructor(message: string, response?: Response);
 }
 declare const ALL_CURRENCY_IDS: TokenRateCurrency[];
 type CoinsApiConfig = {
-    apiUrl: string;
+  apiUrl: string;
 };
 declare const DEFAULT_COINSAPI_CONFIG: CoinsApiConfig;
 declare function fetchTokenRates(tokens: Record<TokenId, Token>, currencyIds?: TokenRateCurrency[], config?: CoinsApiConfig): Promise<TokenRatesList>;
-
-export { ALL_CURRENCY_IDS, type CoinsApiConfig, DEFAULT_COINSAPI_CONFIG, SUPPORTED_CURRENCIES, type TokenRateCurrency, type TokenRateData, type TokenRates, TokenRatesError, type TokenRatesList, type TokenRatesStorage, fetchTokenRates, newTokenRates, tryToDeleteOldTokenRatesDb };
+//#endregion
+export { ALL_CURRENCY_IDS, CoinsApiConfig, DEFAULT_COINSAPI_CONFIG, FetchDTaoTokenRatesOptions, SUPPORTED_CURRENCIES, TokenRateCurrency, TokenRateData, TokenRates, TokenRatesError, TokenRatesList, TokenRatesStorage, fetchDTaoTokenRates, fetchTokenRates, getDTaoTokenRates, newTokenRates, tryToDeleteOldTokenRatesDb };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/fetchDTaoTokenRates.ts","../src/getDTaoTokenRates.ts","../src/TalismanTokenRatesDatabase.ts","../src/TokenRates.ts"],"mappings":";;;cAEa;WACX;aAAO;aAAiB;;WACxB;aAAO;aAAkB;;WACzB;aAAO;aAAkB;;WACzB;aAAO;aAAmB;;WAE1B;aAAO;aAAmB;;WAC1B;aAAO;aAAsB;;WAC7B;aAAO;aAAc;;WACrB;aAAO;aAAuB;;WAC9B;aAAO;aAAyB;;WAChC;aAAO;aAA2B;;WAClC;aAAO;aAA4B;;WACnC;aAAO;aAAsB;;WAC7B;aAAO;aAAuB;;WAC9B;aAAO;aAA0B;;WACjC;aAAO;aAA2B;;WAClC;aAAO;aAAyB;;WAChC;aAAO;aAAmB;;WAC1B;aAAO;aAAyB;;WAChC;aAAO;aAAsB;;WAC7B;aAAO;aAAsB;;WAE7B;aAAO;aAA0B;;;KAIvB;EAAsB,YAAY;;KAElC,iBAAiB,OAAO,SAAS;KACjC,aAAa,OAAO,mBAAmB;KAEvC;EAAkB;EAAe;EAAoB;;KACrD,iCAAiC;cAEhC,qBAAoB;;;KCkCrB;;EAEV,WAAW;;EAEX,YAAY;;EAEZ,QAAQ;;EAER,YAAY;;EAEZ,eAAe;;EAEf,qBAAqB;;EAErB;;EAEA;;;;;;;;;;;cAYW,wBAAmB,WAAA,WAAA,QAAA,YAAA,eAAA,aAAA,eAAA,aAS7B,+BAA6B,QAAQ;;;;;;;;;;;;cCnE3B,oBAAiB,OACrB,cAAY,YACP,gBAAc,mCACO,wCADrB;;;cC3CD;;;cCUA,wBAAwB;EACnC,WAAW;EACX,YAAY,iBAAiB,WAAW;;cAM7B,kBAAwD;KACzD;EACV;;cAGW,yBAAyB;iBAGhB,gBACpB,QAAQ,OAAO,SAAS,QACxB,cAAa,qBACb,SAAQ,iBACP,QAAQ"}

package/dist/index.d.ts

@@ -1,115 +1,161 @@
-import { TokenId, Token } from '@talismn/chaindata-provider';
-
-declare const tryToDeleteOldTokenRatesDb: () => void;
-
+import { IChainConnectorDot } from "@talismn/chain-connectors";
+import { NetworkId, SubDTaoToken, Token, TokenId, TokenList } from "@talismn/chaindata-provider";
+//#region src/types.d.ts
 declare const SUPPORTED_CURRENCIES: {
-    readonly btc: {
-        readonly name: "Bitcoin";
-        readonly symbol: "₿";
-    };
-    readonly eth: {
-        readonly name: "Ethereum";
-        readonly symbol: "Ξ";
-    };
-    readonly dot: {
-        readonly name: "Polkadot";
-        readonly symbol: "D";
-    };
-    readonly tao: {
-        readonly name: "Bittensor";
-        readonly symbol: "τ";
-    };
-    readonly usd: {
-        readonly name: "US Dollar";
-        readonly symbol: "$";
-    };
-    readonly cny: {
-        readonly name: "Chinese Yuan";
-        readonly symbol: "¥";
-    };
-    readonly eur: {
-        readonly name: "Euro";
-        readonly symbol: "€";
-    };
-    readonly gbp: {
-        readonly name: "British Pound";
-        readonly symbol: "£";
-    };
-    readonly cad: {
-        readonly name: "Canadian Dollar";
-        readonly symbol: "C$";
-    };
-    readonly aud: {
-        readonly name: "Australian Dollar";
-        readonly symbol: "A$";
-    };
-    readonly nzd: {
-        readonly name: "New Zealand Dollar";
-        readonly symbol: "NZ$";
-    };
-    readonly jpy: {
-        readonly name: "Japanese Yen";
-        readonly symbol: "¥";
-    };
-    readonly rub: {
-        readonly name: "Russian Ruble";
-        readonly symbol: "₽";
-    };
-    readonly krw: {
-        readonly name: "South Korean Won";
-        readonly symbol: "₩";
-    };
-    readonly idr: {
-        readonly name: "Indonesian Rupiah";
-        readonly symbol: "Rp";
-    };
-    readonly php: {
-        readonly name: "Philippine Peso";
-        readonly symbol: "₱";
-    };
-    readonly thb: {
-        readonly name: "Thai Baht";
-        readonly symbol: "฿";
-    };
-    readonly vnd: {
-        readonly name: "Vietnamese Dong";
-        readonly symbol: "₫";
-    };
-    readonly inr: {
-        readonly name: "Indian Rupee";
-        readonly symbol: "₹";
-    };
-    readonly try: {
-        readonly name: "Turkish Lira";
-        readonly symbol: "₺";
-    };
-    readonly sgd: {
-        readonly name: "Singapore Dollar";
-        readonly symbol: "S$";
-    };
+  readonly btc: {
+    readonly name: "Bitcoin";
+    readonly symbol: "₿";
+  };
+  readonly eth: {
+    readonly name: "Ethereum";
+    readonly symbol: "Ξ";
+  };
+  readonly dot: {
+    readonly name: "Polkadot";
+    readonly symbol: "D";
+  };
+  readonly tao: {
+    readonly name: "Bittensor";
+    readonly symbol: "τ";
+  };
+  readonly usd: {
+    readonly name: "US Dollar";
+    readonly symbol: "$";
+  };
+  readonly cny: {
+    readonly name: "Chinese Yuan";
+    readonly symbol: "¥";
+  };
+  readonly eur: {
+    readonly name: "Euro";
+    readonly symbol: "€";
+  };
+  readonly gbp: {
+    readonly name: "British Pound";
+    readonly symbol: "£";
+  };
+  readonly cad: {
+    readonly name: "Canadian Dollar";
+    readonly symbol: "C$";
+  };
+  readonly aud: {
+    readonly name: "Australian Dollar";
+    readonly symbol: "A$";
+  };
+  readonly nzd: {
+    readonly name: "New Zealand Dollar";
+    readonly symbol: "NZ$";
+  };
+  readonly jpy: {
+    readonly name: "Japanese Yen";
+    readonly symbol: "¥";
+  };
+  readonly rub: {
+    readonly name: "Russian Ruble";
+    readonly symbol: "₽";
+  };
+  readonly krw: {
+    readonly name: "South Korean Won";
+    readonly symbol: "₩";
+  };
+  readonly idr: {
+    readonly name: "Indonesian Rupiah";
+    readonly symbol: "Rp";
+  };
+  readonly php: {
+    readonly name: "Philippine Peso";
+    readonly symbol: "₱";
+  };
+  readonly thb: {
+    readonly name: "Thai Baht";
+    readonly symbol: "฿";
+  };
+  readonly vnd: {
+    readonly name: "Vietnamese Dong";
+    readonly symbol: "₫";
+  };
+  readonly inr: {
+    readonly name: "Indian Rupee";
+    readonly symbol: "₹";
+  };
+  readonly try: {
+    readonly name: "Turkish Lira";
+    readonly symbol: "₺";
+  };
+  readonly sgd: {
+    readonly name: "Singapore Dollar";
+    readonly symbol: "S$";
+  };
 };
 type TokenRatesStorage = {
-    tokenRates: TokenRatesList;
+  tokenRates: TokenRatesList;
 };
 type TokenRatesList = Record<TokenId, TokenRates>;
 type TokenRates = Record<TokenRateCurrency, TokenRateData | null>;
 type TokenRateData = {
-    price: number;
-    marketCap?: number;
-    change24h?: number;
+  price: number;
+  marketCap?: number;
+  change24h?: number;
 };
 type TokenRateCurrency = keyof typeof SUPPORTED_CURRENCIES;
 declare const newTokenRates: () => TokenRates;
-
+//#endregion
+//#region src/fetchDTaoTokenRates.d.ts
+type FetchDTaoTokenRatesOptions = {
+  /** substrate chain connector of the host (only its `send` method is used, for one state_call per invocation) */
+  connector: IChainConnectorDot;
+  /** the bittensor network id, defaults to "bittensor" (mainnet) */
+  networkId?: NetworkId;
+  /** token list to price — non-dtao tokens (and dtao tokens with a coingeckoId) are ignored */
+  tokens: TokenList;
+  /** freshly fetched rates list — dtao rates derive from the network's native TAO token rates in it */
+  tokenRates: TokenRatesList;
+  /** previous rates list, used as keep-last fallback when fetching fails */
+  previousRates: TokenRatesList;
+  /** custom fetch for the tao-data api (eg with auth headers), defaults to global fetch */
+  customFetch?: typeof fetch;
+  /** tao-data api url, defaults to https://tda.talisman.xyz */
+  taoDataApiUrl?: string;
+  /** per-request timeout for the chain call and the tao-data api call, defaults to 10s */
+  timeoutMs?: number;
+};
+/**
+ * Rates entries for the bittensor dtao (subnet alpha) tokens of `tokens`, priced from their
+ * subnet pool combined with the TAO rates in `tokenRates`. On chain-fetch failure, falls
+ * back to the token's entry in `previousRates` (keep-last). Never throws — a dtao pricing
+ * failure must not discard the rates list it gets merged into.
+ *
+ * Hosts remain responsible for WHEN to call this (network enabled state, refresh cadence)
+ * and for merging the result into their rates list/store.
+ */
+declare const fetchDTaoTokenRates: ({ connector, networkId, tokens, tokenRates, previousRates, customFetch, taoDataApiUrl, timeoutMs }: FetchDTaoTokenRatesOptions) => Promise<TokenRatesList>;
+//#endregion
+//#region src/getDTaoTokenRates.d.ts
+/**
+ * Rates of a bittensor dtao (subnet alpha) token, derived from its network's native TAO rates
+ * scaled by the subnet pool price. To be used for tokens that don't have a coingecko id.
+ *
+ * @param token
+ * @param tokenRates must contain the rates of the network's native (TAO) token
+ * @param scaledAlphaPrice current TAO-per-alpha pool price, fixed-point scaled by 10^9 (rao)
+ * @param alphaPriceChange24h 24h change of the pool price (alpha vs TAO) in percent, when known
+ */
+declare const getDTaoTokenRates: (token: SubDTaoToken, tokenRates: TokenRatesList, scaledAlphaPrice: string | bigint, alphaPriceChange24h?: number | null) => TokenRates | null;
+//#endregion
+//#region src/TalismanTokenRatesDatabase.d.ts
+declare const tryToDeleteOldTokenRatesDb: () => void;
+//#endregion
+//#region src/TokenRates.d.ts
 declare class TokenRatesError extends Error {
-    response?: Response;
-    constructor(message: string, response?: Response);
+  response?: Response;
+  constructor(message: string, response?: Response);
 }
 declare const ALL_CURRENCY_IDS: TokenRateCurrency[];
 type CoinsApiConfig = {
-    apiUrl: string;
+  apiUrl: string;
 };
 declare const DEFAULT_COINSAPI_CONFIG: CoinsApiConfig;
 declare function fetchTokenRates(tokens: Record<TokenId, Token>, currencyIds?: TokenRateCurrency[], config?: CoinsApiConfig): Promise<TokenRatesList>;
-
-export { ALL_CURRENCY_IDS, type CoinsApiConfig, DEFAULT_COINSAPI_CONFIG, SUPPORTED_CURRENCIES, type TokenRateCurrency, type TokenRateData, type TokenRates, TokenRatesError, type TokenRatesList, type TokenRatesStorage, fetchTokenRates, newTokenRates, tryToDeleteOldTokenRatesDb };
+//#endregion
+export { ALL_CURRENCY_IDS, CoinsApiConfig, DEFAULT_COINSAPI_CONFIG, FetchDTaoTokenRatesOptions, SUPPORTED_CURRENCIES, TokenRateCurrency, TokenRateData, TokenRates, TokenRatesError, TokenRatesList, TokenRatesStorage, fetchDTaoTokenRates, fetchTokenRates, getDTaoTokenRates, newTokenRates, tryToDeleteOldTokenRatesDb };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/fetchDTaoTokenRates.ts","../src/getDTaoTokenRates.ts","../src/TalismanTokenRatesDatabase.ts","../src/TokenRates.ts"],"mappings":";;;cAEa;WACX;aAAO;aAAiB;;WACxB;aAAO;aAAkB;;WACzB;aAAO;aAAkB;;WACzB;aAAO;aAAmB;;WAE1B;aAAO;aAAmB;;WAC1B;aAAO;aAAsB;;WAC7B;aAAO;aAAc;;WACrB;aAAO;aAAuB;;WAC9B;aAAO;aAAyB;;WAChC;aAAO;aAA2B;;WAClC;aAAO;aAA4B;;WACnC;aAAO;aAAsB;;WAC7B;aAAO;aAAuB;;WAC9B;aAAO;aAA0B;;WACjC;aAAO;aAA2B;;WAClC;aAAO;aAAyB;;WAChC;aAAO;aAAmB;;WAC1B;aAAO;aAAyB;;WAChC;aAAO;aAAsB;;WAC7B;aAAO;aAAsB;;WAE7B;aAAO;aAA0B;;;KAIvB;EAAsB,YAAY;;KAElC,iBAAiB,OAAO,SAAS;KACjC,aAAa,OAAO,mBAAmB;KAEvC;EAAkB;EAAe;EAAoB;;KACrD,iCAAiC;cAEhC,qBAAoB;;;KCkCrB;;EAEV,WAAW;;EAEX,YAAY;;EAEZ,QAAQ;;EAER,YAAY;;EAEZ,eAAe;;EAEf,qBAAqB;;EAErB;;EAEA;;;;;;;;;;;cAYW,wBAAmB,WAAA,WAAA,QAAA,YAAA,eAAA,aAAA,eAAA,aAS7B,+BAA6B,QAAQ;;;;;;;;;;;;cCnE3B,oBAAiB,OACrB,cAAY,YACP,gBAAc,mCACO,wCADrB;;;cC3CD;;;cCUA,wBAAwB;EACnC,WAAW;EACX,YAAY,iBAAiB,WAAW;;cAM7B,kBAAwD;KACzD;EACV;;cAGW,yBAAyB;iBAGhB,gBACpB,QAAQ,OAAO,SAAS,QACxB,cAAa,qBACb,SAAQ,iBACP,QAAQ"}