@gearbox-protocol/sdk 16.0.0-next.2 → 16.0.0-next.21

package/dist/esm/onchain/accounts/credit-account-compressor/CreditAccountCompressor.js

@@ -0,0 +1,191 @@
+import { AddressSet } from "../../utils/AddressSet.js";
+import { AP_CREDIT_ACCOUNT_COMPRESSOR } from "../../constants/address-provider.js";
+import { ADDRESS_0X0 } from "../../constants/addresses.js";
+import { MAX_UINT256 } from "../../constants/math.js";
+import { VERSION_RANGE_310 } from "../../constants/versions.js";
+import "../../constants/index.js";
+import { hexEq } from "../../utils/hex.js";
+import "../../utils/index.js";
+import { SDKConstruct } from "../../base/SDKConstruct.js";
+import "../../base/index.js";
+import { simulateWithPriceUpdates } from "../../utils/viem/simulateWithPriceUpdates.js";
+import "../../utils/viem/index.js";
+import { iRWAFactoryAbi } from "../../../abi/rwa/iRWAFactory.js";
+import { CreditAccountCompressorV310Contract } from "./CreditAccountCompressorV310Contract.js";
+//#region src/onchain/accounts/credit-account-compressor/CreditAccountCompressor.ts
+/**
+* Reads credit accounts of the current chain.
+*
+* Stitches the credit account compressor together with the RWA factories (for
+* accounts owned via an investor EOA), and describes the result as raw
+* account data.
+*
+* TODO: create and deploy new compressor contract onchain to avoid all this stitching
+**/
+var CreditAccountCompressor = class extends SDKConstruct {
+	/**
+	* Reads data of a single credit account.
+	*
+	* When the compressor cannot value the account with current prices, the read
+	* is retried with price feed updates applied.
+	*
+	* @param account - Credit account address.
+	* @param blockNumber - Block to read at, defaults to the latest block.
+	* @returns Account data, or `undefined` if the account does not exist.
+	**/
+	async getCreditAccountData(account, blockNumber) {
+		const contract = this.#contract;
+		const raw = await contract.getCreditAccountData(account, blockNumber);
+		if (!raw) return;
+		const marketSuite = this.sdk.marketRegister.findByCreditManager(raw.creditManager);
+		const factory = marketSuite.rwaFactory;
+		let ca;
+		let investor;
+		if (raw.success) {
+			ca = raw;
+			investor = await factory?.getInvestor(raw.creditAccount, false);
+		} else {
+			const { txs: priceUpdateTxs } = await marketSuite.priceOracle.priceUpdateTxsForAccount(raw);
+			[ca, investor] = await simulateWithPriceUpdates(this.client, {
+				priceUpdates: priceUpdateTxs,
+				contracts: [contract.dataCall(account), ...factory ? [{
+					abi: iRWAFactoryAbi,
+					address: factory.address,
+					functionName: "getInvestor",
+					args: [raw.creditAccount]
+				}] : []],
+				blockNumber,
+				gas: this.sdk.gasLimit
+			});
+		}
+		return {
+			...ca,
+			investor
+		};
+	}
+	/**
+	* Reads all credit accounts matching the options, sorted by health factor
+	* ascending.
+	*
+	* @param options - {@link GetCreditAccountsOptions}
+	* @param blockNumber - Block to read at, defaults to the latest block.
+	**/
+	async getCreditAccounts(options, blockNumber) {
+		const { creditManager, includeZeroDebt = false, maxHealthFactor = MAX_UINT256, minHealthFactor = 0n, owner = ADDRESS_0X0, ignoreReservePrices = false } = options ?? {};
+		const target = creditManager ?? {
+			configurators: this.#marketConfigurators,
+			creditManagers: [],
+			pools: [],
+			underlying: "0x0000000000000000000000000000000000000000"
+		};
+		const { txs: priceUpdateTxs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(ignoreReservePrices ? { main: true } : void 0);
+		return (await this.#contract.getCreditAccounts(target, {
+			owner,
+			includeZeroDebt,
+			minHealthFactor,
+			maxHealthFactor
+		}, {
+			blockNumber,
+			priceUpdateTxs
+		})).sort((a, b) => Number(a.healthFactor - b.healthFactor));
+	}
+	/**
+	* Reads all credit accounts of a borrower, sorted by health factor
+	* ascending.
+	*
+	* Covers accounts the borrower owns directly and RWA accounts they own as an
+	* investor, which are owned on-chain by an RWA factory.
+	*
+	* @param borrower - Wallet address.
+	* @param options - {@link GetCreditAccountsOptions}
+	* @param blockNumber - Block to read at, defaults to the latest block.
+	**/
+	async getBorrowerCreditAccounts(borrower, options, blockNumber) {
+		const { creditManager, includeZeroDebt = false, maxHealthFactor = MAX_UINT256, minHealthFactor = 0n, ignoreReservePrices = false } = options ?? {};
+		const { txs: priceUpdateTxs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(ignoreReservePrices ? { main: true } : void 0);
+		const rwaAccountAddresses = (await this.sdk.rwa.getInvestorData(borrower, void 0, blockNumber)).flatMap((d) => d.creditAccounts.map((ca) => ca.creditAccount));
+		const cmFilter = creditManager ? {
+			configurators: [],
+			creditManagers: [creditManager],
+			pools: [],
+			underlying: ADDRESS_0X0
+		} : {
+			configurators: this.#marketConfigurators,
+			creditManagers: [],
+			pools: [],
+			underlying: ADDRESS_0X0
+		};
+		const permissiveFilter = {
+			owner: borrower,
+			includeZeroDebt: true,
+			minHealthFactor: 0n,
+			maxHealthFactor: MAX_UINT256,
+			reverting: false
+		};
+		const contract = this.#contract;
+		const rwaContracts = rwaAccountAddresses.map((account) => contract.dataCall(account));
+		const getCreditAccountsContracts = [false, true].map((reverting) => contract.accountsCall([
+			cmFilter,
+			{
+				...permissiveFilter,
+				reverting
+			},
+			0n
+		]));
+		const allContracts = [...rwaContracts, ...getCreditAccountsContracts];
+		const results = await simulateWithPriceUpdates(this.client, {
+			priceUpdates: priceUpdateTxs,
+			contracts: allContracts,
+			blockNumber,
+			gas: this.sdk.gasLimit
+		});
+		const rwaResults = results.slice(0, rwaAccountAddresses.length);
+		const normalResults = results.slice(rwaAccountAddresses.length);
+		const seen = new AddressSet();
+		const allCAs = [];
+		for (const ca of rwaResults) if (!seen.has(ca.creditAccount)) {
+			seen.add(ca.creditAccount);
+			allCAs.push({
+				...ca,
+				investor: borrower
+			});
+		}
+		for (const [accounts] of normalResults) for (const ca of accounts) if (!seen.has(ca.creditAccount)) {
+			seen.add(ca.creditAccount);
+			allCAs.push({
+				...ca,
+				investor: void 0
+			});
+		}
+		const filtered = allCAs.filter((ca) => {
+			if (!includeZeroDebt && ca.debt === 0n) return false;
+			if (ca.healthFactor < minHealthFactor) return false;
+			if (ca.healthFactor > maxHealthFactor) return false;
+			if (creditManager && !hexEq(ca.creditManager, creditManager)) return false;
+			return true;
+		});
+		this.logger?.debug(`loaded ${allCAs.length} borrower credit accounts (${rwaResults.length} RWA, ${filtered.length} after filter)`);
+		return filtered.sort((a, b) => Number(a.healthFactor - b.healthFactor));
+	}
+	/**
+	* Credit account compressor contract of the current chain.
+	*
+	* Resolved on every access, because the address provider is only populated
+	* once the SDK is attached or hydrated. The contracts register acts as the
+	* cache: instances register themselves there on construction, and a
+	* re-hydrated SDK with a different compressor address simply misses and
+	* builds a new wrapper.
+	**/
+	get #contract() {
+		const [address] = this.sdk.addressProvider.mustGetLatest(AP_CREDIT_ACCOUNT_COMPRESSOR, VERSION_RANGE_310);
+		return this.sdk.getContract(address) ?? new CreditAccountCompressorV310Contract(this.sdk, address);
+	}
+	/**
+	* Addresses of market configurators the SDK is attached to.
+	**/
+	get #marketConfigurators() {
+		return this.sdk.marketRegister.marketConfigurators.map((mc) => mc.address);
+	}
+};
+//#endregion
+export { CreditAccountCompressor };

package/dist/esm/onchain/accounts/credit-account-compressor/CreditAccountCompressorV310Contract.js

@@ -0,0 +1,141 @@
+import { BaseContract } from "../../base/BaseContract.js";
+import "../../base/index.js";
+import { simulateWithPriceUpdates } from "../../utils/viem/simulateWithPriceUpdates.js";
+import "../../utils/viem/index.js";
+import { creditAccountCompressorAbi } from "../../../abi/compressors/creditAccountCompressor.js";
+//#region src/onchain/accounts/credit-account-compressor/CreditAccountCompressorV310Contract.ts
+const abi = creditAccountCompressorAbi;
+/**
+* V3.10 credit account compressor.
+*
+* Wraps the compressor ABI and nothing else: single-account reads, paginated
+* multi-account reads, and call descriptors for callers that need to batch
+* these reads with calls to other contracts.
+**/
+var CreditAccountCompressorV310Contract = class extends BaseContract {
+	#sdk;
+	constructor(sdk, address) {
+		super(sdk, {
+			addr: address,
+			name: "CreditAccountCompressorV310",
+			abi,
+			version: 310
+		});
+		this.#sdk = sdk;
+	}
+	/**
+	* Reads data of a single credit account.
+	*
+	* @param account - Credit account address.
+	* @param blockNumber - Block to read at, defaults to the latest block.
+	* @returns Account data, or `undefined` if the compressor reverted, which it
+	* does when the account does not exist.
+	**/
+	async getCreditAccountData(account, blockNumber) {
+		try {
+			return await this.client.readContract({
+				abi,
+				address: this.address,
+				functionName: "getCreditAccountData",
+				args: [account],
+				blockNumber,
+				gas: this.#sdk.gasLimit
+			});
+		} catch (_e) {
+			return;
+		}
+	}
+	/**
+	* Reads all credit accounts matching the filters, in the order the
+	* compressor returns them.
+	*
+	* Two compressor quirks are handled here: results are paginated, and the
+	* `reverting` account filter is exclusive, so accounts whose collateral
+	* computation reverts are only returned by a second pass.
+	*
+	* @param target - Credit managers to query.
+	* @param query - Account-level filters, without `reverting`.
+	* @param options - Block, price updates and page size.
+	**/
+	async getCreditAccounts(target, query, options) {
+		const { batchSize, blockNumber, priceUpdateTxs } = options ?? {};
+		const allCAs = [];
+		let revertingOffset = 0;
+		for (const reverting of [false, true]) {
+			let offset = 0n;
+			revertingOffset = allCAs.length;
+			do {
+				const [accounts, newOffset] = await this.#getCreditAccounts(batchSize ? [
+					target,
+					{
+						...query,
+						reverting
+					},
+					offset,
+					batchSize
+				] : [
+					target,
+					{
+						...query,
+						reverting
+					},
+					offset
+				], priceUpdateTxs, blockNumber);
+				allCAs.push(...accounts);
+				offset = newOffset;
+			} while (offset !== 0n);
+		}
+		this.logger?.debug(`loaded ${allCAs.length} credit accounts (${allCAs.length - revertingOffset} reverting)`);
+		return allCAs;
+	}
+	/**
+	* Descriptor of a `getCreditAccountData` call on this compressor.
+	**/
+	dataCall(account) {
+		return {
+			abi,
+			address: this.address,
+			functionName: "getCreditAccountData",
+			args: [account]
+		};
+	}
+	/**
+	* Descriptor of a `getCreditAccounts` call on this compressor.
+	**/
+	accountsCall(args) {
+		return {
+			abi,
+			address: this.address,
+			functionName: "getCreditAccounts",
+			args
+		};
+	}
+	/**
+	* One page of `getCreditAccounts`, with price updates applied when the
+	* accounts hold tokens with on-demand price feeds.
+	**/
+	async #getCreditAccounts(args, priceUpdateTxs, blockNumber) {
+		let resp;
+		if (priceUpdateTxs?.length) [resp] = await simulateWithPriceUpdates(this.client, {
+			priceUpdates: priceUpdateTxs,
+			contracts: [this.accountsCall(args)],
+			blockNumber,
+			gas: this.#sdk.gasLimit
+		});
+		else resp = await this.client.readContract({
+			abi,
+			address: this.address,
+			functionName: "getCreditAccounts",
+			args,
+			blockNumber,
+			gas: this.#sdk.gasLimit
+		});
+		this.logger?.debug({
+			accounts: resp[0]?.length ?? 0,
+			nextOffset: Number(resp[1])
+		}, "got credit accounts");
+		return resp;
+	}
+};
+//#endregion
+export { CreditAccountCompressorV310Contract };

package/dist/esm/onchain/accounts/index.js

@@ -0,0 +1,28 @@
+import { PeripheryCompressorV310Contract } from "./bots/PeripheryCompressorV310Contract.js";
+import { AccountBotsService } from "./bots/AccountBotsService.js";
+import "./bots/index.js";
+import { CreditAccountCompressorV310Contract } from "./credit-account-compressor/CreditAccountCompressorV310Contract.js";
+import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.js";
+import "./credit-account-compressor/index.js";
+import { CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
+import { borrowable } from "./intents/guards.js";
+import { fetchCreditAccountSlice, toCreditAccountSlice } from "./intents/utils/credit-account-slice.js";
+import { CreditAccountOperationsService } from "./intents/index.js";
+import { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
+import { LiquidationsService } from "./liquidations/LiquidationsService.js";
+import { MultichainLiquidationsService } from "./liquidations/MultichainLiquidationsService.js";
+import "./liquidations/index.js";
+import "./types.js";
+import { DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, decodeDelayedIntent, encodeDelayedIntent } from "./withdrawal-compressor/intent-codec.js";
+import { AbstractWithdrawalCompressorContract, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal } from "./withdrawal-compressor/AbstractWithdrawalCompressorContract.js";
+import { getWithdrawalCompressorAddress } from "./withdrawal-compressor/addresses.js";
+import { InvalidDelayedIntentError } from "./withdrawal-compressor/errors.js";
+import { RedemptionLoggerV310Contract } from "./withdrawal-compressor/RedemptionLoggerV310Contract.js";
+import { createRedemptionLogger } from "./withdrawal-compressor/createRedemptionLogger.js";
+import { WithdrawalCompressorV310Contract } from "./withdrawal-compressor/WithdrawalCompressorV310Contract.js";
+import { WithdrawalCompressorV311Contract } from "./withdrawal-compressor/WithdrawalCompressorV311Contract.js";
+import { toWithdrawalStatus } from "./withdrawal-compressor/types.js";
+import { WithdrawalCompressorV313Contract } from "./withdrawal-compressor/WithdrawalCompressorV313Contract.js";
+import { createWithdrawalCompressor } from "./withdrawal-compressor/createWithdrawalCompressor.js";
+import "./withdrawal-compressor/index.js";
+export { AbstractWithdrawalCompressorContract, AccountBotsService, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, InvalidDelayedIntentError, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, PeripheryCompressorV310Contract, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, borrowable, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

package/dist/esm/onchain/accounts/intents/guards.js

@@ -0,0 +1,164 @@
+import { MIN_HEALTH_FACTOR_FACADE, checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkForbiddenToken, checkMarketExpired, checkQuotaLimit } from "../../validation/checks.js";
+import { raise } from "../../validation/refusal.js";
+import { toToken } from "../../validation/token.js";
+import { eq } from "./utils/common.js";
+import { isPhantomToken } from "./utils/pick-token.js";
+//#region src/onchain/accounts/intents/guards.ts
+/**
+* What the market itself refuses, checked before anything is quoted.
+*
+* The planners answer for the arithmetic of an intent and the ledger for the
+* balances it moves, but neither can see that the facade is paused or that the
+* pool has run out of what it lends. On-chain those come back as a reverted
+* multicall with a selector no form can explain, so they are read from the
+* loaded market and reported as refusals instead.
+*
+* Every guard here refuses something the market decides rather than something
+* the arithmetic cannot do, which is why all six of their reasons are
+* `blocking`: the walk that hit one still reached an end state, and a caller
+* gets that state alongside the refusal.
+*/
+/**
+* The facade takes no multicall while it is paused or past its expiration, so
+* every intent the engine previews would revert on arrival.
+*/
+function assertMarketOperable(suite) {
+	const creditManager = suite.creditManager.address;
+	raise(checkCreditManagerPaused({
+		isPaused: suite.isPaused,
+		creditManager
+	}), `${creditManager} is paused`);
+	raise(checkMarketExpired({
+		isExpired: suite.isExpired,
+		creditManager,
+		expirationDate: suite.creditFacade.expirationDate
+	}), `${creditManager} expired at ${suite.creditFacade.expirationDate}`);
+}
+/**
+* What the pool will hand this manager in one transaction: the tightest of its
+* free liquidity, the manager's remaining debt limit and the per-block cap the
+* facade puts on a single borrow. A zero multiplier switches borrowing off
+* outright, which reads here as nothing being available.
+*/
+function borrowable(suite) {
+	const { pool } = suite.market.pool;
+	const { maxDebtPerBlockMultiplier, maxDebt } = suite.creditFacade;
+	if (maxDebtPerBlockMultiplier === 0) return {
+		limit: 0n,
+		binding: "facadePerBlockCap"
+	};
+	const available = pool.creditManagerDebtParams.get(suite.creditManager.address)?.available;
+	return [
+		{
+			limit: pool.availableLiquidity,
+			binding: "poolAvailableLiquidity"
+		},
+		{
+			limit: maxDebt * BigInt(maxDebtPerBlockMultiplier),
+			binding: "facadePerBlockCap"
+		},
+		...available === void 0 ? [] : [{
+			limit: available,
+			binding: "managerDebtAvailable"
+		}]
+	].reduce((a, b) => b.limit < a.limit ? b : a);
+}
+/** The pool has to be able to lend what the plan means to draw. */
+function assertCanBorrow(sdk, suite, amount) {
+	const { limit, binding } = borrowable(suite);
+	raise(checkBorrowLimit({
+		requested: amount,
+		available: limit,
+		binding,
+		underlying: toToken(sdk, suite.market.pool.underlying)
+	}), `borrow: ${amount} exceeds what the pool can lend now (${limit})`);
+}
+/**
+* What the account is allowed to end up holding more of than it started with.
+*
+* A forbidden token may be sold and may leave, but its balance must not grow —
+* the facade checks exactly that at the end of the multicall. A token the
+* market takes no quota for is not forbidden, only worthless as collateral:
+* buying one builds a position the collateral check cannot count, so the plan
+* is refused before it is signed rather than after it reverts.
+*
+* The underlying answers to neither rule, and a phantom token is a redemption
+* in flight rather than a holding.
+*/
+function assertGrowthAllowed(args) {
+	const { sdk, suite, market, before, after } = args;
+	const forbidden = suite.forbiddenTokens;
+	const underlying = market.pool.underlying;
+	for (const { token, balance } of after) {
+		if (balance <= (before.find((a) => eq(a.token, token))?.balance ?? 0n)) continue;
+		raise(checkForbiddenToken({
+			token: toToken(sdk, token),
+			isForbidden: forbidden.some((f) => eq(f, token))
+		}), `${token} is forbidden in this market and the plan buys more of it`);
+		if (eq(token, underlying) || isPhantomToken(sdk, token)) continue;
+		if (!market.pool.pqk.hasActiveQuota(token)) raise(checkQuotaLimit({
+			token: toToken(sdk, token),
+			requested: void 0,
+			available: 0n,
+			underlying: toToken(sdk, underlying)
+		}), `${token} takes no quota in this market, so it counts as no collateral`);
+	}
+}
+/**
+* The facade weighs the account against its debt at the end of every multicall
+* and reverts if the collateral does not cover it, so a plan that lands the
+* account below water is refused here.
+*
+* The bar is the facade's own `1.0`, because this guard answers one question:
+* would the transaction revert. It is deliberately not `MIN_HF_LIMITED`, and
+* the three bars in this codebase are three different jobs:
+*
+* - here, `1.0` — what the facade enforces, so what a plan must clear to land;
+* - `maxWithdrawCollateral` sizes at `MIN_HF_LIMITED + 2` — a *sizing* helper
+*   leaving headroom, which is not the same as a validity check;
+* - a form refuses at or below `MIN_HF_LIMITED` (`MIN_HEALTH_FACTOR_FORM`).
+*
+* Raising this one to `MIN_HF_LIMITED` was tried and reverted: it made
+* `maxWithdraw` hand back a ceiling this guard then refused, and it blocked
+* small top-ups of an account sitting in `[1.0, 1.01)` — the very operations
+* that rescue it. A form wanting the stricter bar has `validateHF`.
+*
+* Note that a position already underwater cannot be nursed back one step at a
+* time — the check is on where the transaction ends, not on whether it
+* improved things.
+*
+* @remarks
+* The caller decides the pricing the factor was computed at: main prices, or
+* the safe ones the facade switches to when the call hands funds over. A token
+* whose reserve feed the SDK cannot read keeps its main price, so a plan can
+* still be refused on-chain after passing here.
+*/
+function assertCollateralised(healthFactorBps, safePrices) {
+	const required = MIN_HEALTH_FACTOR_FACADE;
+	raise(checkCollateralised({
+		healthFactor: healthFactorBps,
+		required,
+		safePrices
+	}), `the account would end at a health factor of ${healthFactorBps}, below ${required}`);
+}
+/**
+* A quota can only be raised as far as the market still has room for: past the
+* token's limit the keeper takes nothing more, whoever is asking.
+*/
+function assertQuotaHeadroom(sdk, market, increases) {
+	const underlying = market.pool.underlying;
+	for (const { token, balance } of increases) {
+		if (balance <= 0n) continue;
+		const quota = market.pool.pqk.quotas.get(token);
+		if (!quota) continue;
+		const left = quota.limit - quota.totalQuoted;
+		raise(checkQuotaLimit({
+			token: toToken(sdk, token),
+			requested: balance,
+			available: left,
+			underlying: toToken(sdk, underlying)
+		}), `${token} has ${left} of quota left, the plan needs ${balance}`);
+	}
+}
+//#endregion
+export { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaHeadroom, borrowable };