@curvefi/llamalend-api 1.0.31 → 1.0.32

package/README.md

@@ -891,6 +891,45 @@ import llamalend from "@curvefi/llamalend-api";
 })()
 ```
 
+### Force Update User State for lendMarket
+
+After executing certain transactions, it's recommended to force update the user's state in the cache to ensure data consistency:
+
+```ts
+// Methods after which you should call forceUpdateUserState:
+// - createLoan()
+// - leverage.createLoan()
+// - borrowMore()
+// - partialSelfLiquidate()
+// - repay()
+
+// Basic usage (after successful transaction):
+const txHash = await lendMarket.createLoan(0.5, 1000, 5);
+// Wait for transaction to be mined and confirmed
+await lendMarket.forceUpdateUserState(txHash);
+
+// With specific user address:
+await lendMarket.forceUpdateUserState(txHash, "0x123...");
+
+// The method sends a request with new_tx parameter and clears the cache
+// to get fresh user state data
+// Important: Only call after successful transaction confirmation
+```
+
+**Why use forceUpdateUserState?**
+- Ensures data consistency after successful transactions
+- Clears cached user state data
+- Forces fresh API request with transaction hash
+- Prevents stale data issues
+- **Important**: Only call after transaction is successfully mined and confirmed
+
+**When to use:**
+- After `createLoan()` - when creating a new loan
+- After `leverage.createLoan()` - when creating a leveraged position
+- After `borrowMore()` - when increasing loan amount
+- After `partialSelfLiquidate()` - when partially liquidating position
+- After `repay()` - when repaying loan
+
 ### User loss for lendMarket
 ```ts
 (async () => {
@@ -2360,4 +2399,5 @@ import llamalend from "@curvefi/llamalend-api";
     //
     //     '50': [ '759.898822708156242647', '1560.282492846180089068' ]
     // }
-```
+```
+

package/lib/external-api.d.ts

@@ -11,6 +11,7 @@ type UserCollateral = {
     total_deposit_from_user_usd_value: number;
 };
 export declare const _getUserCollateral: ((network: INetworkName, controller: string, user: string) => Promise<UserCollateral>) & memoize.Memoized<(network: INetworkName, controller: string, user: string) => Promise<UserCollateral>>;
+export declare const _getUserCollateralForce: (network: INetworkName, controller: string, user: string, newTx: string) => Promise<void>;
 export declare const _getUserCollateralCrvUsd: ((network: INetworkName, controller: string, user: string) => Promise<string>) & memoize.Memoized<(network: INetworkName, controller: string, user: string) => Promise<string>>;
 export declare const _getMarketsData: ((network: INetworkName) => Promise<IMarketData>) & memoize.Memoized<(network: INetworkName) => Promise<IMarketData>>;
 export declare function _getQuoteOdos(this: Llamalend, fromToken: string, toToken: string, _amount: bigint, blacklist: string, pathVizImage: boolean, slippage?: number): Promise<IQuoteOdos>;

package/lib/external-api.js

@@ -124,6 +124,10 @@ export const _getUserCollateral = memoize((network, controller, user) => __await
     promise: true,
     maxAge: 60 * 1000, // 1m
 });
+export const _getUserCollateralForce = (network, controller, user, newTx) => __awaiter(void 0, void 0, void 0, function* () {
+    yield fetch(`https://prices.curve.finance/v1/lending/collateral_events/${network}/${controller}/${user}?new_tx=${newTx}`);
+    _getUserCollateral.delete(network, controller, user);
+});
 export const _getUserCollateralCrvUsd = memoize((network, controller, user) => __awaiter(void 0, void 0, void 0, function* () {
     const url = `https://prices.curve.finance/v1/crvusd/collateral_events/${network}/${controller}/${user}`;
     const response = yield fetch(url);

package/lib/lendMarkets/LendMarketTemplate.d.ts

@@ -519,4 +519,5 @@ export declare class LendMarketTemplate {
     currentLeverage(userAddress?: string): Promise<string>;
     currentPnL(userAddress?: string): Promise<Record<string, string>>;
     userBoost(address?: string): Promise<string>;
+    forceUpdateUserState(newTx: string, userAddress?: string): Promise<void>;
 }

package/lib/lendMarkets/LendMarketTemplate.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import memoize from "memoizee";
 import BigNumber from "bignumber.js";
 import { _getAddress, parseUnits, BN, toBN, fromBN, getBalances, _ensureAllowance, ensureAllowance, hasAllowance, ensureAllowanceEstimateGas, _cutZeros, formatUnits, formatNumber, MAX_ALLOWANCE, MAX_ACTIVE_BAND, _mulBy1_3, _getUsdRate, DIGas, smartNumber, } from "../utils.js";
-import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getMarketsData } from "../external-api.js";
+import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getUserCollateralForce, _getMarketsData } from "../external-api.js";
 import ERC20Abi from '../constants/abis/ERC20.json' with { type: 'json' };
 import { cacheKey, cacheStats } from "../cache/index.js";
 const DAY = 86400;
@@ -2799,4 +2799,12 @@ export class LendMarketTemplate {
             return boostBN.toFixed(4).replace(/([0-9])0+$/, '$1');
         });
     }
+    forceUpdateUserState(newTx, userAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const address = userAddress || this.llamalend.signerAddress;
+            if (!address)
+                throw Error("Need to connect wallet or pass address into args");
+            yield _getUserCollateralForce(this.llamalend.constants.NETWORK_NAME, this.addresses.controller, address, newTx);
+        });
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/llamalend-api",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "description": "JavaScript library for Curve Lending",
   "main": "lib/index.js",
   "author": "Macket",

package/src/external-api.ts

@@ -136,6 +136,17 @@ export const _getUserCollateral = memoize(
     }
 )
 
+export const _getUserCollateralForce = async (
+    network: INetworkName, 
+    controller: string, 
+    user: string, 
+    newTx: string
+): Promise<void> => {
+    await fetch(`https://prices.curve.finance/v1/lending/collateral_events/${network}/${controller}/${user}?new_tx=${newTx}`);
+
+    _getUserCollateral.delete(network, controller, user);
+}
+
 export const _getUserCollateralCrvUsd = memoize(
     async (network: INetworkName, controller: string, user: string): Promise<string> => {
         const url = `https://prices.curve.finance/v1/crvusd/collateral_events/${network}/${controller}/${user}`;

package/src/lendMarkets/LendMarketTemplate.ts

@@ -23,7 +23,7 @@ import {
     smartNumber,
 } from "../utils.js";
 import {IDict, TGas, TAmount, IReward, IQuoteOdos, IOneWayMarket, IPartialFrac} from "../interfaces.js";
-import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getMarketsData } from "../external-api.js";
+import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getUserCollateralForce, _getMarketsData } from "../external-api.js";
 import ERC20Abi from '../constants/abis/ERC20.json' with {type: 'json'};
 import {cacheKey, cacheStats} from "../cache/index.js";
 
@@ -3160,4 +3160,16 @@ export class LendMarketTemplate {
 
         return boostBN.toFixed(4).replace(/([0-9])0+$/, '$1');
     }
+
+    public async forceUpdateUserState(newTx: string, userAddress?: string): Promise<void> {
+        const address = userAddress || this.llamalend.signerAddress;
+        if (!address) throw Error("Need to connect wallet or pass address into args");
+        
+        await _getUserCollateralForce(
+            this.llamalend.constants.NETWORK_NAME,
+            this.addresses.controller,
+            address,
+            newTx
+        );
+    }
 }