@curvefi/api 2.72.5 → 2.72.6

package/README.md

@@ -24,7 +24,10 @@ import curve from "@curvefi/api";
 
     // 4. Without RPC
     await curve.init('NoRPC', {chainId: 1, networkName: 'ETHEREUM'});
-    
+
+    // 5. API-only metadata (RPC stays live for quotes/routing)
+    await curve.init('JsonRpc', { url: <RPC_URL> }, { chainId: 1, apiOnlyMetadata: true });
+
     // Fetch factory pools
     await curve.factory.fetchPools();
     await curve.crvUSDFactory.fetchPools();
@@ -38,6 +41,10 @@ import curve from "@curvefi/api";
 
 **Note 2.** Web3 init requires the address. Therefore, it can be initialized only after receiving the address.
 
+**Note 3.** ```apiOnlyMetadata``` (default ```false```) makes the library source pool metadata and TVL **exclusively from the HTTP APIs**, with no on-chain reads during `fetchPools` or route-graph building. Unlike `NoRPC`, the RPC provider stays live and is still used for user-facing quotes/routing — this is intended for backends that want to avoid hammering RPC nodes (e.g. rate-limited public endpoints) while initializing and listing pools. Two effects to be aware of:
+- Factory gauge implementations are not read on-chain (`gaugeImplementation()` returns the zero address).
+- Pools with no TVL in the API — including LLAMMAs, whose TVL is on-chain-only — are treated as 0 liquidity and therefore **excluded from the route graph**, instead of falling back to on-chain liquidity reads.
+
 **Wrong ❌️**
 ```tsx
 import type { FunctionComponent } from 'react'

package/lib/curve.d.ts

@@ -12,6 +12,7 @@ export type ContractItem = {
 export declare class Curve implements ICurve {
     provider: ethers.BrowserProvider | ethers.JsonRpcProvider;
     isNoRPC: boolean;
+    apiOnlyMetadata: boolean;
     multicallProvider: MulticallProvider;
     signer: ethers.Signer | null;
     signerAddress: string;
@@ -56,6 +57,7 @@ export declare class Curve implements ICurve {
         gasStrategy?: IGasStrategy;
         chainId?: number;
         poolsData?: Record<IPoolType, IExtendedPoolDataFromApi>;
+        apiOnlyMetadata?: boolean;
     }): Promise<void>;
     initContract: (address: string, abi: any, provider: BrowserProvider | JsonRpcProvider | Signer) => Contract;
     initMulticallContract: (address: string, abi: any) => MulticallContract;

package/lib/curve.js

@@ -97,7 +97,7 @@ export class Curve {
             }
             this.constants.FACTORY_POOLS_DATA = yield this._filterHiddenPools(this.constants.FACTORY_POOLS_DATA, isFiltered);
             this._updateDecimalsAndGauges(this.constants.FACTORY_POOLS_DATA);
-            this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory"] = this.isNoRPC ? null : yield this.contracts[this.constants.ALIASES.factory].contract.gauge_implementation(this.constantOptions);
+            this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory"] = (this.isNoRPC || this.apiOnlyMetadata) ? null : yield this.contracts[this.constants.ALIASES.factory].contract.gauge_implementation(this.constantOptions);
         });
         this.fetchCrvusdFactoryPools = (...args_1) => __awaiter(this, [...args_1], void 0, function* (useApi = true, isFiltered = false) {
             if (!("crvusd_factory" in this.constants.ALIASES))
@@ -128,7 +128,7 @@ export class Curve {
             }
             this.constants.CRYPTO_FACTORY_POOLS_DATA = yield this._filterHiddenPools(this.constants.CRYPTO_FACTORY_POOLS_DATA, isFiltered);
             this._updateDecimalsAndGauges(this.constants.CRYPTO_FACTORY_POOLS_DATA);
-            this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-crypto"] = this.isNoRPC ? null : yield this.contracts[this.constants.ALIASES.crypto_factory].contract.gauge_implementation(this.constantOptions);
+            this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-crypto"] = (this.isNoRPC || this.apiOnlyMetadata) ? null : yield this.contracts[this.constants.ALIASES.crypto_factory].contract.gauge_implementation(this.constantOptions);
         });
         this.fetchStableNgFactoryPools = (...args_1) => __awaiter(this, [...args_1], void 0, function* (useApi = true, isFiltered = false) {
             if (!("stable_ng_factory" in this.constants.ALIASES))
@@ -160,11 +160,11 @@ export class Curve {
             this.constants.TWOCRYPTO_FACTORY_POOLS_DATA = yield this._filterHiddenPools(this.constants.TWOCRYPTO_FACTORY_POOLS_DATA, isFiltered);
             this._updateDecimalsAndGauges(this.constants.TWOCRYPTO_FACTORY_POOLS_DATA);
             if (this.chainId === 1) {
-                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-twocrypto"] = this.isNoRPC ? null :
+                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-twocrypto"] = (this.isNoRPC || this.apiOnlyMetadata) ? null :
                     yield this.contracts[this.constants.ALIASES.twocrypto_factory].contract.gauge_implementation(this.constantOptions);
             }
             else {
-                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-twocrypto"] = this.isNoRPC ? null :
+                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-twocrypto"] = (this.isNoRPC || this.apiOnlyMetadata) ? null :
                     yield this.contracts[this.constants.ALIASES.child_gauge_factory].contract.get_implementation(this.constantOptions);
             }
         });
@@ -183,11 +183,11 @@ export class Curve {
             this.constants.TRICRYPTO_FACTORY_POOLS_DATA = yield this._filterHiddenPools(this.constants.TRICRYPTO_FACTORY_POOLS_DATA, isFiltered);
             this._updateDecimalsAndGauges(this.constants.TRICRYPTO_FACTORY_POOLS_DATA);
             if (this.chainId === 1) {
-                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-tricrypto"] = this.isNoRPC ? null :
+                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-tricrypto"] = (this.isNoRPC || this.apiOnlyMetadata) ? null :
                     yield this.contracts[this.constants.ALIASES.tricrypto_factory].contract.gauge_implementation(this.constantOptions);
             }
             else {
-                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-tricrypto"] = this.isNoRPC ? null :
+                this.constants.FACTORY_GAUGE_IMPLEMENTATIONS["factory-tricrypto"] = (this.isNoRPC || this.apiOnlyMetadata) ? null :
                     yield this.contracts[this.constants.ALIASES.child_gauge_factory].contract.get_implementation(this.constantOptions);
             }
         });
@@ -364,6 +364,7 @@ export class Curve {
         this.provider = null;
         this.signer = null;
         this.isNoRPC = false;
+        this.apiOnlyMetadata = false;
         this.signerAddress = '';
         this.chainId = 1;
         this.isLiteChain = false;
@@ -402,16 +403,17 @@ export class Curve {
     init(providerType_1, providerSettings_1) {
         return __awaiter(this, arguments, void 0, function* (providerType, providerSettings, options = {} // gasPrice in Gwei
         ) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
             this.provider = null;
             this.signer = null;
             this.isNoRPC = false;
+            this.apiOnlyMetadata = (_a = options.apiOnlyMetadata) !== null && _a !== void 0 ? _a : false;
             this.signerAddress = '';
             this.chainId = 1;
             this.multicallProvider = null;
             this.contracts = {};
             this.feeData = {};
-            this.gasStrategy = (_a = options.gasStrategy) !== null && _a !== void 0 ? _a : 'standard';
+            this.gasStrategy = (_b = options.gasStrategy) !== null && _b !== void 0 ? _b : 'standard';
             this.constantOptions = { gasLimit: 12000000 };
             this.options = {};
             this.nativeTokenAddress = NETWORK_CONSTANTS[1].NATIVE_COIN.address;
@@ -459,7 +461,7 @@ export class Curve {
                 if (providerSettings.privateKey) {
                     signerPromise = Promise.resolve(new ethers.Wallet(providerSettings.privateKey, this.provider));
                 }
-                else if (!((_b = providerSettings.url) === null || _b === void 0 ? void 0 : _b.startsWith("https://rpc.gnosischain.com"))) {
+                else if (!((_c = providerSettings.url) === null || _c === void 0 ? void 0 : _c.startsWith("https://rpc.gnosischain.com"))) {
                     signerPromise = this.provider.getSigner().catch(() => null);
                 }
                 // Web3 provider
@@ -506,11 +508,11 @@ export class Curve {
             this.constants.ALIASES = network_constants.ALIASES;
             this.constants.ALIASES.anycall = "0x37414a8662bc1d25be3ee51fb27c2686e2490a89";
             this.constants.ALIASES.voting_escrow_oracle = "0x12F407340697Ae0b177546E535b91A5be021fBF9";
-            this.constants.POOLS_DATA = (_c = network_constants.POOLS_DATA) !== null && _c !== void 0 ? _c : {};
-            this.constants.LLAMMAS_DATA = (_d = network_constants.LLAMMAS_DATA) !== null && _d !== void 0 ? _d : {};
+            this.constants.POOLS_DATA = (_d = network_constants.POOLS_DATA) !== null && _d !== void 0 ? _d : {};
+            this.constants.LLAMMAS_DATA = (_e = network_constants.LLAMMAS_DATA) !== null && _e !== void 0 ? _e : {};
             for (const poolId in this.constants.POOLS_DATA)
                 this.constants.POOLS_DATA[poolId].in_api = true;
-            this.constants.COINS = (_e = network_constants.COINS) !== null && _e !== void 0 ? _e : {};
+            this.constants.COINS = (_f = network_constants.COINS) !== null && _f !== void 0 ? _f : {};
             this.constants.DECIMALS = extractDecimals(Object.assign(Object.assign({}, this.constants.POOLS_DATA), this.constants.LLAMMAS_DATA));
             this.constants.DECIMALS[this.constants.NATIVE_TOKEN.address] = 18;
             this.constants.DECIMALS[this.constants.NATIVE_TOKEN.wrappedAddress] = 18;
@@ -519,18 +521,18 @@ export class Curve {
                 this.constants.API_CONSTANTS = network_constants.API_CONSTANTS;
             }
             const [cTokens, yTokens, ycTokens, aTokens] = [
-                (_f = network_constants.cTokens) !== null && _f !== void 0 ? _f : [],
-                (_g = network_constants.yTokens) !== null && _g !== void 0 ? _g : [],
-                (_h = network_constants.ycTokens) !== null && _h !== void 0 ? _h : [],
-                (_j = network_constants.aTokens) !== null && _j !== void 0 ? _j : [],
+                (_g = network_constants.cTokens) !== null && _g !== void 0 ? _g : [],
+                (_h = network_constants.yTokens) !== null && _h !== void 0 ? _h : [],
+                (_j = network_constants.ycTokens) !== null && _j !== void 0 ? _j : [],
+                (_k = network_constants.aTokens) !== null && _k !== void 0 ? _k : [],
             ];
             const customAbiTokens = [...cTokens, ...yTokens, ...ycTokens, ...aTokens];
             if (this.isLiteChain) {
                 this.constants.STABLE_FACTORY_CONSTANTS.stableNgBasePoolZap = network_constants.stableNgBasePoolZap;
             }
             else {
-                this.constants.STABLE_FACTORY_CONSTANTS = (_k = STABLE_FACTORY_CONSTANTS[this.chainId]) !== null && _k !== void 0 ? _k : {};
-                this.constants.CRYPTO_FACTORY_CONSTANTS = (_l = CRYPTO_FACTORY_CONSTANTS[this.chainId]) !== null && _l !== void 0 ? _l : {};
+                this.constants.STABLE_FACTORY_CONSTANTS = (_l = STABLE_FACTORY_CONSTANTS[this.chainId]) !== null && _l !== void 0 ? _l : {};
+                this.constants.CRYPTO_FACTORY_CONSTANTS = (_m = CRYPTO_FACTORY_CONSTANTS[this.chainId]) !== null && _m !== void 0 ? _m : {};
             }
             if (this.chainId === 5000) {
                 this.constantOptions = {};

package/lib/index.d.ts

@@ -19,6 +19,7 @@ export declare const createCurve: () => {
         gasStrategy?: import("./interfaces.js").IGasStrategy;
         chainId?: number;
         poolsData?: Record<import("./interfaces.js").IPoolType, import("./interfaces.js").IExtendedPoolDataFromApi>;
+        apiOnlyMetadata?: boolean;
     } | undefined) => Promise<void>;
     chainId: number;
     signerAddress: string;
@@ -76,6 +77,7 @@ export declare const createCurve: () => {
     getIsLiteChain: () => boolean;
     isNoRPC: boolean;
     fetchPoolByAddress: (poolAddress: string) => Promise<string>;
+    apiOnlyMetadata: boolean;
     factory: {
         fetchPools: (useApi?: boolean, isFiltered?: boolean) => Promise<void>;
         fetchNewPools: () => Promise<string[]>;
@@ -359,6 +361,7 @@ declare const _default: {
         gasStrategy?: import("./interfaces.js").IGasStrategy;
         chainId?: number;
         poolsData?: Record<import("./interfaces.js").IPoolType, import("./interfaces.js").IExtendedPoolDataFromApi>;
+        apiOnlyMetadata?: boolean;
     } | undefined) => Promise<void>;
     chainId: number;
     signerAddress: string;
@@ -416,6 +419,7 @@ declare const _default: {
     getIsLiteChain: () => boolean;
     isNoRPC: boolean;
     fetchPoolByAddress: (poolAddress: string) => Promise<string>;
+    apiOnlyMetadata: boolean;
     factory: {
         fetchPools: (useApi?: boolean, isFiltered?: boolean) => Promise<void>;
         fetchNewPools: () => Promise<string[]>;

package/lib/index.js

@@ -25,6 +25,7 @@ export const createCurve = () => {
             this.signerAddress = _curve.signerAddress;
             this.chainId = _curve.chainId;
             this.isNoRPC = _curve.isNoRPC;
+            this.apiOnlyMetadata = _curve.apiOnlyMetadata;
         });
     }
     return {
@@ -68,6 +69,7 @@ export const createCurve = () => {
         getIsLiteChain: _curve.getIsLiteChain.bind(_curve),
         isNoRPC: _curve.isNoRPC,
         fetchPoolByAddress: _curve.fetchPoolByAddress.bind(_curve),
+        apiOnlyMetadata: _curve.apiOnlyMetadata,
         factory: {
             fetchPools: _curve.fetchFactoryPools.bind(_curve),
             fetchNewPools: _curve.fetchNewFactoryPools.bind(_curve),

package/lib/router.js

@@ -34,6 +34,8 @@ function _getTVL(poolId_1, _a) {
             if (totalLiquidity !== undefined)
                 return Number(totalLiquidity);
         }
+        if (this.apiOnlyMetadata)
+            return 0;
         return Number(yield getPool.call(this, poolId).stats.totalLiquidityMemoized());
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/api",
-  "version": "2.72.5",
+  "version": "2.72.6",
   "description": "JavaScript library for curve.finance",
   "main": "lib/index.js",
   "author": "Macket",