fix: check quota limits when opening accounts

Author: doomsower

src/dev/AccountOpener.ts

@@ -7,7 +7,6 @@ import type {
   CreditAccountData,
   CreditAccountsService,
   CreditSuite,
-  GearboxSDK,
   ILogger,
 } from "../sdk";
 import {
@@ -19,6 +18,7 @@ import {
   ierc20Abi,
   MAX_UINT256,
   PERCENTAGE_FACTOR,
+  SDKConstruct,
   sendRawTx,
 } from "../sdk";
 import { type AnvilClient, createAnvilClient } from "./createAnvilClient";
@@ -34,7 +34,7 @@ export interface TargetAccount {
   slippage?: number;
 }
 
-export class AccountOpener {
+export class AccountOpener extends SDKConstruct {
   #service: CreditAccountsService;
   #anvil: AnvilClient;
   #logger?: ILogger;
@@ -45,6 +45,7 @@ export class AccountOpener {
     service: CreditAccountsService,
     options: AccountOpenerOptions = {},
   ) {
+    super(service.sdk);
     this.#service = service;
     this.#logger = childLogger("AccountOpener", service.sdk.logger);
     this.#anvil = createAnvilClient({
@@ -135,26 +136,23 @@ export class AccountOpener {
     });
     logger?.debug(strategy, "found open strategy");
     const debt = minDebt * BigInt(leverage - 1);
-    const collateralLT = BigInt(cm.collateralTokens[collateral]);
-    const inUnderlying = collateral.toLowerCase() === underlying.toLowerCase();
+    const averageQuota = this.#getCollateralQuota(
+      cm,
+      collateral,
+      strategy.amount,
+      debt,
+    );
+    const minQuota = this.#getCollateralQuota(
+      cm,
+      collateral,
+      strategy.minAmount,
+      debt,
+    );
+    logger?.debug({ averageQuota, minQuota }, "calculated quotas");
     const { tx, calls } = await this.#service.openCA({
       creditManager: cm.creditManager.address,
-      averageQuota: inUnderlying
-        ? []
-        : [
-            {
-              token: collateral,
-              balance: this.#calcQuota(strategy.amount, debt, collateralLT),
-            },
-          ],
-      minQuota: inUnderlying
-        ? []
-        : [
-            {
-              token: collateral,
-              balance: this.#calcQuota(strategy.minAmount, debt, collateralLT),
-            },
-          ],
+      averageQuota,
+      minQuota,
       collateral: [{ token: underlying, balance: minDebt }],
       debt,
       calls: strategy.calls,
@@ -369,6 +367,38 @@ export class AccountOpener {
     return this.#borrower;
   }
 
+  #getCollateralQuota(
+    cm: CreditSuite,
+    collateral: Address,
+    amount: bigint,
+    debt: bigint,
+  ): Asset[] {
+    const { underlying, collateralTokens } = cm;
+    const inUnderlying = collateral.toLowerCase() === underlying.toLowerCase();
+    if (inUnderlying) {
+      return [];
+    }
+    const collateralLT = BigInt(collateralTokens[collateral]);
+    const market = this.sdk.marketRegister.findByCreditManager(
+      cm.creditManager.address,
+    );
+    const quotaInfo = market.pool.pqk.quotas.mustGet(collateral);
+    const availableQuota = quotaInfo.limit - quotaInfo.totalQuoted;
+    if (availableQuota <= 0n) {
+      throw new Error(
+        `quota exceeded for asset ${this.labelAddress(collateral)} in ${cm.name}`,
+      );
+    }
+    const desiredQuota = this.#calcQuota(amount, debt, collateralLT);
+
+    return [
+      {
+        token: collateral,
+        balance: desiredQuota < availableQuota ? desiredQuota : availableQuota,
+      },
+    ];
+  }
+
   #calcQuota(amount: bigint, debt: bigint, lt: bigint): bigint {
     let quota = (amount * lt) / PERCENTAGE_FACTOR;
     quota = debt < quota ? debt : quota;
@@ -377,8 +407,4 @@ export class AccountOpener {
 
     return (quota / PERCENTAGE_FACTOR) * PERCENTAGE_FACTOR;
   }
-
-  private get sdk(): GearboxSDK {
-    return this.#service.sdk;
-  }
 }

src/sdk/accounts/CreditAccountsService.ts

@@ -632,8 +632,8 @@ export class CreditAccountsService extends SDKConstruct {
       calls: openPathCalls,
     } = props;
 
-    const cmFactory = this.sdk.marketRegister.findCreditManager(creditManager);
-    const cm = cmFactory.creditManager;
+    const cmSuite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const cm = cmSuite.creditManager;
 
     const priceUpdatesCalls = await this.getPriceUpdatesForFacade(
       cm.address,
@@ -652,14 +652,10 @@ export class CreditAccountsService extends SDKConstruct {
         : []),
     ];
 
-    const tx = cmFactory.creditFacade.openCreditAccount(
-      to,
-      calls,
-      referralCode,
-    );
+    const tx = cmSuite.creditFacade.openCreditAccount(to, calls, referralCode);
     tx.value = ethAmount.toString(10);
 
-    return { calls, tx, creditFacade: cmFactory.creditFacade };
+    return { calls, tx, creditFacade: cmSuite.creditFacade };
   }
 
   /**
@@ -727,7 +723,7 @@ export class CreditAccountsService extends SDKConstruct {
       const market = this.sdk.marketRegister.findByCreditManager(
         acc.creditManager,
       );
-      const pool = market.poolFactory.pool.address;
+      const pool = market.pool.pool.address;
       oracleByPool.set(pool, market.priceOracle);
 
       for (const t of acc.tokens) {
@@ -740,9 +736,9 @@ export class CreditAccountsService extends SDKConstruct {
     }
     // priceFeeds can contain PriceFeeds from different markets
     const priceFeeds: Array<IPriceFeedContract> = [];
-    for (const [pool, priceFeedFactory] of oracleByPool.entries()) {
+    for (const [pool, oracle] of oracleByPool.entries()) {
       const tokens = Array.from(tokensByPool.get(pool) ?? []);
-      priceFeeds.push(...priceFeedFactory.priceFeedsForTokens(tokens));
+      priceFeeds.push(...oracle.priceFeedsForTokens(tokens));
     }
     return this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(priceFeeds);
   }
@@ -765,7 +761,7 @@ export class CreditAccountsService extends SDKConstruct {
     const market = this.sdk.marketRegister.findByCreditManager(creditManager);
     const cm =
       this.sdk.marketRegister.findCreditManager(creditManager).creditManager;
-    const pool = market.poolFactory.pool.address;
+    const pool = market.pool.pool.address;
 
     oracleByPool.set(pool, market.priceOracle);
 

src/sdk/market/MarketRegister.ts

@@ -11,7 +11,7 @@ import { simulateMulticall } from "../utils/viem";
 import type { CreditSuite } from "./CreditSuite";
 import type { MarketConfiguratorContract } from "./MarketConfiguratorContract";
 import { MarketSuite } from "./MarketSuite";
-import type { PoolFactory } from "./PoolFactory";
+import type { PoolSuite } from "./PoolSuite";
 import { rawTxToMulticallPriceUpdate } from "./pricefeeds";
 
 export class MarketRegister extends SDKConstruct {
@@ -48,7 +48,7 @@ export class MarketRegister extends SDKConstruct {
   public async syncState(): Promise<void> {
     const pools = this.markets
       .filter(m => m.dirty)
-      .map(m => m.poolFactory.pool.address);
+      .map(m => m.pool.pool.address);
     if (pools.length) {
       this.#logger?.debug(`need to reload ${pools.length} markets`);
       await this.#loadMarkets([], pools);
@@ -148,8 +148,8 @@ export class MarketRegister extends SDKConstruct {
     return this.markets.map(market => market.stateHuman(raw));
   }
 
-  public get pools(): PoolFactory[] {
-    return this.markets.map(market => market.poolFactory);
+  public get pools(): PoolSuite[] {
+    return this.markets.map(market => market.pool);
   }
 
   public get creditManagers(): CreditSuite[] {

src/sdk/market/MarketSuite.ts

@@ -6,14 +6,14 @@ import type { GearboxSDK } from "../GearboxSDK";
 import type { MarketStateHuman } from "../types";
 import { CreditSuite } from "./CreditSuite";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract";
-import { PoolFactory } from "./PoolFactory";
+import { PoolSuite } from "./PoolSuite";
 import { PriceOracleV300Contract } from "./PriceOracleV300Contract";
 import { PriceOracleV310Contract } from "./PriceOracleV310Contract";
 
 export class MarketSuite extends SDKConstruct {
   public readonly acl: Address;
   public readonly configurator: MarketConfiguratorContract;
-  public readonly poolFactory: PoolFactory;
+  public readonly pool: PoolSuite;
   public readonly priceOracle:
     | PriceOracleV300Contract
     | PriceOracleV310Contract;
@@ -50,7 +50,7 @@ export class MarketSuite extends SDKConstruct {
       sdk.provider.addressLabels.set(t.addr as Address, t.symbol);
     }
 
-    this.poolFactory = new PoolFactory(sdk, marketData);
+    this.pool = new PoolSuite(sdk, marketData);
     this.zappers = marketData.zappers;
 
     for (let i = 0; i < marketData.creditManagers.length; i++) {
@@ -75,15 +75,15 @@ export class MarketSuite extends SDKConstruct {
   override get dirty(): boolean {
     return (
       this.configurator.dirty ||
-      this.poolFactory.dirty ||
+      this.pool.dirty ||
       this.priceOracle.dirty ||
       this.creditManagers.some(cm => cm.dirty)
     );
   }
 
   public stateHuman(raw = true): MarketStateHuman {
     return {
-      pool: this.poolFactory.stateHuman(raw),
+      pool: this.pool.stateHuman(raw),
       creditManagers: this.creditManagers.map(cm => cm.stateHuman(raw)),
       priceOracle: this.priceOracle.stateHuman(raw),
       pausableAdmins: this.state.pausableAdmins.map(a => this.labelAddress(a)),

src/sdk/market/PoolFactory.ts src/sdk/market/PoolSuite.tssrc/sdk/market/PoolFactory.ts renamed to src/sdk/market/PoolSuite.ts

@@ -2,13 +2,13 @@ import type { Address } from "viem";
 
 import { type MarketData, SDKConstruct } from "../base";
 import type { GearboxSDK } from "../GearboxSDK";
-import type { PoolFactoryStateHuman } from "../types";
+import type { PoolSuiteStateHuman } from "../types";
 import { GaugeContract } from "./GaugeContract";
 import { LinearModelContract } from "./LinearModelContract";
 import { PoolContract } from "./PoolContract";
 import { PoolQuotaKeeperContract } from "./PoolQuotaKeeperContract";
 
-export class PoolFactory extends SDKConstruct {
+export class PoolSuite extends SDKConstruct {
   public readonly pool: PoolContract;
   public readonly pqk: PoolQuotaKeeperContract;
   public readonly gauge: GaugeContract;
@@ -50,7 +50,7 @@ export class PoolFactory extends SDKConstruct {
     );
   }
 
-  public stateHuman(raw = true): PoolFactoryStateHuman {
+  public stateHuman(raw = true): PoolSuiteStateHuman {
     return {
       pool: this.pool.stateHuman(raw),
       poolQuotaKeeper: this.pqk.stateHuman(raw),

src/sdk/market/index.ts

@@ -11,8 +11,8 @@ export * from "./LinearModelContract";
 export * from "./MarketRegister";
 export * from "./MarketSuite";
 export * from "./PoolContract";
-export * from "./PoolFactory";
 export * from "./PoolQuotaKeeperContract";
+export * from "./PoolSuite";
 export * from "./pricefeeds";
 export {
   IPriceOracleContract,

src/sdk/market/pricefeeds/PriceFeedsRegister.ts

@@ -52,7 +52,7 @@ export type PriceFeedRegisterHooks = {
 
 /**
  * PriceFeedRegister acts as a chain-level cache to avoid creating multiple contract instances.
- * It's reused by PriceFeedFactory belonging to different markets
+ * It's reused by PriceOracles belonging to different markets
  *
  **/
 export class PriceFeedRegister

src/sdk/market/pricefeeds/utils.ts

@@ -5,7 +5,7 @@ import type { RawTx } from "../../types";
 
 /**
  * Helper method to convert our RawTx into viem's multicall format
- * Involves decoding what was previously encoded, but it's better than adding another method to PriceFeedFactory
+ * Involves decoding what was previously encoded, but it's better than adding another method to PriceOracle
  * @param tx
  * @returns
  */

src/sdk/types/state-human.ts

@@ -180,7 +180,7 @@ export interface LinearModelStateHuman extends BaseContractStateHuman {
   isBorrowingMoreU2Forbidden: boolean;
 }
 
-export interface PoolFactoryStateHuman {
+export interface PoolSuiteStateHuman {
   pool: PoolStateHuman;
   poolQuotaKeeper: PoolQuotaKeeperStateHuman;
   linearModel?: LinearModelStateHuman;
@@ -193,7 +193,7 @@ export interface ZapperStateHuman extends BaseContractStateHuman {
 }
 
 export interface MarketStateHuman {
-  pool: PoolFactoryStateHuman;
+  pool: PoolSuiteStateHuman;
   creditManagers: CreditSuiteStateHuman[];
   priceOracle: PriceOracleV3StateHuman;
   pausableAdmins: string[];