@gearbox-protocol/sdk 13.3.3 → 13.4.0-beta.2

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -4,7 +4,7 @@ import { MAX_UINT256 } from "../constants/math.js";
 import { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
 class CreditAccountServiceV310 extends AbstractCreditAccountService {
   /**
-   * Implements {@link ICreditAccountsService.setBot}
+   * {@inheritDoc ICreditAccountsService.setBot}
    */
   async setBot({
     botAddress,
@@ -14,10 +14,6 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     const cm = this.sdk.marketRegister.findCreditManager(
       targetContract.creditManager
     );
-    const priceUpdatesCalls = targetContract.type === "creditAccount" ? await this.getPriceUpdatesForFacade({
-      creditManager: targetContract.creditManager,
-      creditAccount: targetContract
-    }) : [];
     const permissions = defaultPermissions !== null ? defaultPermissions : await getContract({
       address: botAddress,
       client: this.sdk.client,
@@ -41,12 +37,16 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
         args: [botAddress, permissions]
       })
     };
-    const calls = [...priceUpdatesCalls, addBotCall];
+    const calls = targetContract.type === "creditAccount" ? await this.prependPriceUpdates(
+      targetContract.creditManager,
+      [addBotCall],
+      targetContract
+    ) : [addBotCall];
     const tx = targetContract.type === "creditAccount" ? cm.creditFacade.multicall(targetContract.creditAccount, calls) : void 0;
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.withdrawCollateral}
+   * {@inheritDoc ICreditAccountsService.withdrawCollateral}
    */
   async withdrawCollateral({
     creditAccount,
@@ -58,12 +58,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     const cm = this.sdk.marketRegister.findCreditManager(
       creditAccount.creditManager
     );
-    const priceUpdatesCalls = await this.getPriceUpdatesForFacade({
-      creditManager: creditAccount.creditManager,
-      creditAccount
-    });
-    const calls = [
-      ...priceUpdatesCalls,
+    const operationCalls = [
       ...assetsToWithdraw.map(
         (a) => this.prepareWithdrawToken(
           creditAccount.creditFacade,
@@ -77,11 +72,16 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
         averageQuota
       })
     ];
+    const calls = await this.prependPriceUpdates(
+      creditAccount.creditManager,
+      operationCalls,
+      creditAccount
+    );
     const tx = cm.creditFacade.multicall(creditAccount.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayCreditAccount}
    */
   async repayCreditAccount({
     operation,
@@ -99,12 +99,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
       tokensToClaim,
       creditAccount: ca
     });
-    const priceUpdates = await this.getPriceUpdatesForFacade({
-      creditManager: ca.creditManager,
-      creditAccount: ca
-    });
-    const calls = [
-      ...operation === "close" ? [] : priceUpdates,
+    const operationCalls = [
       ...this.prepareAddCollateral(ca.creditFacade, addCollateral, permits),
       ...this.prepareDisableQuotas(ca),
       ...this.prepareDecreaseDebt(ca),
@@ -113,11 +108,12 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
         (t) => this.prepareWithdrawToken(ca.creditFacade, t.token, MAX_UINT256, to)
       )
     ];
+    const calls = operation === "close" ? operationCalls : await this.prependPriceUpdates(ca.creditManager, operationCalls, ca);
     const tx = operation === "close" ? cm.creditFacade.closeCreditAccount(ca.creditAccount, calls) : cm.creditFacade.multicall(ca.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayAndLiquidateCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
    */
   async repayAndLiquidateCreditAccount({
     collateralAssets,
@@ -133,19 +129,19 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
       tokensToClaim,
       creditAccount: ca
     });
-    const priceUpdates = await this.getPriceUpdatesForFacade({
-      creditManager: ca.creditManager,
-      creditAccount: ca
-    });
     const addCollateral = collateralAssets.filter((a) => a.balance > 0);
-    const calls = [
-      ...priceUpdates,
+    const operationCalls = [
       ...this.prepareAddCollateral(ca.creditFacade, addCollateral, permits),
       ...claimPath.calls,
       ...assetsToWithdraw.map(
         (t) => this.prepareWithdrawToken(ca.creditFacade, t.token, MAX_UINT256, to)
       )
     ];
+    const calls = await this.prependPriceUpdates(
+      ca.creditManager,
+      operationCalls,
+      ca
+    );
     const tx = cm.creditFacade.liquidateCreditAccount(
       ca.creditAccount,
       to,
@@ -154,7 +150,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.claimFarmRewards}
+   * {@inheritDoc ICreditAccountsService.claimFarmRewards}
    */
   async claimFarmRewards({
     calls: externalCalls,
@@ -175,16 +171,15 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
       });
     }
     if (claimPath.calls.length === 0) throw new Error("No path to execute");
-    const priceUpdatesCalls = await this.getPriceUpdatesForFacade({
-      creditManager: ca.creditManager,
-      creditAccount: ca,
-      desiredQuotas: averageQuota
-    });
-    const calls = [
-      ...priceUpdatesCalls,
+    const operationCalls = [
       ...claimPath.calls,
       ...this.prepareUpdateQuotas(ca.creditFacade, { minQuota, averageQuota })
     ];
+    const calls = await this.prependPriceUpdates(
+      ca.creditManager,
+      operationCalls,
+      ca
+    );
     const tx = cm.creditFacade.multicall(ca.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
   }

package/dist/esm/sdk/accounts/multicall-utils.js

@@ -0,0 +1,69 @@
+import {
+  decodeFunctionData,
+  getAbiItem,
+  toFunctionSelector
+} from "viem";
+import { iCreditFacadeMulticallV310Abi } from "../../abi/310/generated.js";
+import { AddressMap } from "../utils/AddressMap.js";
+import { AddressSet } from "../utils/AddressSet.js";
+const ON_DEMAND_SELECTOR = toFunctionSelector(
+  getAbiItem({
+    abi: iCreditFacadeMulticallV310Abi,
+    name: "onDemandPriceUpdates"
+  })
+);
+const UPDATE_QUOTA_SELECTOR = toFunctionSelector(
+  getAbiItem({
+    abi: iCreditFacadeMulticallV310Abi,
+    name: "updateQuota"
+  })
+);
+function extractPriceUpdates(calls) {
+  const priceUpdates = [];
+  const remainingCalls = [];
+  for (const call of calls) {
+    if (isOnDemandPriceUpdateCall(call)) {
+      const decoded = decodeFunctionData({
+        abi: iCreditFacadeMulticallV310Abi,
+        data: call.callData
+      });
+      const updates = decoded.args[0];
+      priceUpdates.push(...updates);
+    } else {
+      remainingCalls.push(call);
+    }
+  }
+  return { priceUpdates, remainingCalls };
+}
+function extractQuotaTokens(calls) {
+  const tokens = new AddressSet();
+  for (const { callData } of calls) {
+    if (callData.slice(0, 10) !== UPDATE_QUOTA_SELECTOR) {
+      continue;
+    }
+    const decoded = decodeFunctionData({
+      abi: iCreditFacadeMulticallV310Abi,
+      data: callData
+    });
+    const [token, quotaChange] = decoded.args;
+    if (quotaChange > 0n) {
+      tokens.add(token);
+    }
+  }
+  return tokens;
+}
+function mergePriceUpdates(existing, generated) {
+  const seen = new AddressMap();
+  for (const u of [...generated, ...existing]) {
+    seen.upsert(u.priceFeed, u);
+  }
+  return seen.values();
+}
+function isOnDemandPriceUpdateCall(call) {
+  return call.callData.slice(0, 10) === ON_DEMAND_SELECTOR;
+}
+export {
+  extractPriceUpdates,
+  extractQuotaTokens,
+  mergePriceUpdates
+};

package/dist/esm/sdk/base/BaseContract.js

@@ -35,11 +35,30 @@ class ContractParseError extends BaseError {
   }
 }
 class BaseContract extends Construct {
+  /**
+   * Viem contract instance for direct read calls
+   **/
   contract;
+  /**
+   * Contract ABI
+   **/
   abi;
+  /**
+   * Gearbox contract type identifier (e.g. `"CREDIT_MANAGER"`), or empty string if unknown.
+   **/
   contractType;
+  /**
+   * Contract version number.
+   * @default 0
+   **/
   version;
+  /**
+   * On-chain address of the contract.
+   **/
   address;
+  /**
+   * Display name for the contract.
+   **/
   name;
   constructor(options, args) {
     super(options);
@@ -63,6 +82,7 @@ class BaseContract extends Construct {
       register.setAddressLabel(this.address, this.name);
     }
   }
+  /** {@inheritDoc IBaseContract.stateHuman} */
   stateHuman(_ = true) {
     return {
       address: this.labelAddress(this.address),
@@ -71,9 +91,10 @@ class BaseContract extends Construct {
     };
   }
   /**
-   * Updates (or not) contract's internal state from event
-   * @param _log
-   */
+   * Applies an on-chain event to update this contract's local state.
+   *
+   * @param _log - Decoded event log emitted by this contract.
+   **/
   processLog(_log) {
   }
   /**
@@ -148,9 +169,8 @@ class BaseContract extends Construct {
     }
   }
   /**
-   * Same as {@link stingifyFunctionData}, but throws if error occurs
-   * @param calldata
-   * @returns
+   * Same as {@link stringifyFunctionData}, but throws if error occurs.
+   * @param calldata - Raw ABI-encoded calldata.
    */
   mustStringifyFunctionData(calldata) {
     const decoded = decodeFunctionData({

package/dist/esm/sdk/base/ChainContractsRegister.js

@@ -9,8 +9,8 @@ class ChainContractsRegister {
   labels = new AddressMap([], "labels");
   client;
   /**
-   * Token metadata such as symbol and decimals
-   */
+   * Shared token metadata (symbol, decimals) for all tokens known on this chain.
+   **/
   tokensMeta;
   logger;
   constructor(client, logger) {
@@ -18,6 +18,9 @@ class ChainContractsRegister {
     this.tokensMeta = new TokensMeta(client);
     this.logger = logger;
   }
+  /**
+   * Clears all registered contracts, address labels, and token metadata.
+   **/
   resetContracts() {
     this.logger?.debug(
       `resetting contacts register with ${this.contracts.size} contracts`
@@ -26,9 +29,19 @@ class ChainContractsRegister {
     this.contracts.clear();
     this.tokensMeta.reset();
   }
+  /**
+   * Looks up a contract by address.
+   * @param address - On-chain address.
+   * @returns The contract wrapper, or `undefined` if not registered.
+   */
   getContract(address) {
     return this.contracts.get(address);
   }
+  /**
+   * Looks up a contract by address, throwing if not found.
+   * @param address - On-chain address.
+   * @throws If no contract is registered at this address.
+   */
   mustGetContract(address) {
     const contract = this.contracts.mustGet(address);
     if (!contract) {
@@ -36,9 +49,21 @@ class ChainContractsRegister {
     }
     return contract;
   }
+  /**
+   * Registers (or replaces) a contract at the given address.
+   * @param address - On-chain address.
+   * @param contract - Contract wrapper instance.
+   */
   setContract(address, contract) {
     this.contracts.upsert(address, contract);
   }
+  /**
+   * Assigns a human-readable label to an address for use in logging and
+   * parsed call output.
+   * @param address - On-chain address.
+   * @param label - Static label string, or a function that receives the
+   *   current label and returns a new one.
+   */
   setAddressLabel(address, label) {
     if (address === NOT_DEPLOYED) {
       return;
@@ -49,13 +74,25 @@ class ChainContractsRegister {
       this.labels.upsert(address, label(this.labels.get(address)));
     }
   }
+  /**
+   * Returns a display string for an address, incorporating its label if one exists.
+   * @param address - On-chain address.
+   * @param omitAddress - When `true`, returns only the label (no address prefix).
+   *   Falls back to the raw address when no label is set.
+   */
   labelAddress(address, omitAddress) {
     const label = this.labels.get(address);
     return label ? omitAddress ? label : `${address} [${label}]` : address;
   }
+  /**
+   * The viem {@link Chain} object for this register's connected client.
+   **/
   get chain() {
     return this.client.chain;
   }
+  /**
+   * Numeric chain ID (e.g. `1` for Ethereum mainnet).
+   **/
   get chainId() {
     return this.client.chain.id;
   }

package/dist/esm/sdk/base/Construct.js

@@ -4,9 +4,6 @@ class Construct {
   logger;
   client;
   #register;
-  /**
-   * Indicates that contract state needs to be updated
-   */
   #dirty = false;
   constructor(options) {
     if (options instanceof ChainContractsRegister) {
@@ -38,12 +35,22 @@ class Construct {
   safeGetRegister() {
     return this.#register;
   }
+  /**
+   * The viem {@link Chain} object associated with the connected client.
+   **/
   get chain() {
     return this.client.chain;
   }
+  /**
+   * Numeric chain ID (e.g. `1` for Ethereum mainnet).
+   **/
   get chainId() {
     return this.client.chain.id;
   }
+  /**
+   * Gearbox network type for this chain (e.g. `"Mainnet"`, `"Arbitrum"`).
+   * @throws If the chain was not created by the Gearbox SDK.
+   */
   get networkType() {
     if ("network" in this.chain) {
       return this.chain.network;
@@ -51,6 +58,7 @@ class Construct {
     throw new Error(`chain ${this.chain.id} is not a Gearbox SDK chain`);
   }
   /**
+   * @internal
    * Indicates that contract state diverged from onchain state and needs to be updated
    */
   get dirty() {
@@ -59,6 +67,9 @@ class Construct {
   set dirty(value) {
     this.#dirty = value;
   }
+  /**
+   * Information about tokens known on this chain
+   */
   get tokensMeta() {
     return this.register.tokensMeta;
   }
@@ -66,6 +77,7 @@ class Construct {
     return this.#register?.labelAddress(address, omitAddress) ?? address;
   }
   /**
+   * @internal
    * Returns list of addresses that should be watched for events to sync state
    */
   get watchAddresses() {

package/dist/esm/sdk/base/TokensMeta.js

@@ -12,13 +12,26 @@ class TokensMeta extends AddressMap {
     super(void 0, "tokensMeta");
     this.#client = client;
   }
+  /**
+   * Clears all token metadata
+   **/
   reset() {
     this.clear();
     this.#phantomTokensLoaded = void 0;
   }
+  /**
+   * Returns the symbol string for a token.
+   * @param token - Token address.
+   * @throws If the token is not in the registry.
+   */
   symbol(token) {
     return this.mustGet(token).symbol;
   }
+  /**
+   * Returns the decimal count for a token.
+   * @param token - Token address.
+   * @throws If the token is not in the registry.
+   */
   decimals(token) {
     return this.mustGet(token).decimals;
   }
@@ -53,9 +66,19 @@ class TokensMeta extends AddressMap {
     const asStr = formatBN(amount, this.decimals(token), precision);
     return symbol ? `${asStr} ${this.symbol(token)}` : asStr;
   }
+  /**
+   * Finds a token by its symbol (e.g. `"USDC"`).
+   * @param symbol - Case-sensitive ticker symbol.
+   * @returns The matching metadata, or `undefined` if no token has this symbol.
+   */
   findBySymbol(symbol) {
     return this.values().find((v) => v.symbol === symbol);
   }
+  /**
+   * Finds a token by its symbol, throwing if not found.
+   * @param symbol - Case-sensitive ticker symbol.
+   * @throws If no token matches the symbol.
+   */
   mustFindBySymbol(symbol) {
     const meta = this.findBySymbol(symbol);
     if (!meta) {

package/dist/esm/sdk/constants/address-provider.js

@@ -1,4 +1,3 @@
-import { NOT_DEPLOYED } from "./addresses.js";
 const NO_VERSION = 0;
 const AP_ACCOUNT_FACTORY = "ACCOUNT_FACTORY";
 const AP_ACL = "ACL";
@@ -32,28 +31,8 @@ const AP_WETH_GATEWAY = "WETH_GATEWAY";
 const AP_WETH_TOKEN = "WETH_TOKEN";
 const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
-const ADDRESS_PROVIDER = {
-  Mainnet: "0x9ea7b04Da02a5373317D745c1571c84aaD03321D",
-  Arbitrum: "0x7d04eCdb892Ae074f03B5D0aBA03796F90F3F2af",
-  Optimism: "0x3761ca4BFAcFCFFc1B8034e69F19116dD6756726",
-  Base: NOT_DEPLOYED,
-  Sonic: "0x4b27b296273B72d7c7bfee1ACE93DC081467C41B",
-  // New networks
-  MegaETH: NOT_DEPLOYED,
-  Monad: NOT_DEPLOYED,
-  Berachain: NOT_DEPLOYED,
-  Avalanche: NOT_DEPLOYED,
-  BNB: NOT_DEPLOYED,
-  WorldChain: NOT_DEPLOYED,
-  Etherlink: NOT_DEPLOYED,
-  Hemi: NOT_DEPLOYED,
-  Lisk: NOT_DEPLOYED,
-  Plasma: NOT_DEPLOYED,
-  Somnia: NOT_DEPLOYED
-};
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 export {
-  ADDRESS_PROVIDER,
   ADDRESS_PROVIDER_V310,
   AP_ACCOUNT_FACTORY,
   AP_ACL,

package/dist/esm/sdk/core/AbstractAddressProviderContract.js

@@ -33,6 +33,9 @@ class AbstractAddressProviderContract extends BaseContract {
       this.#addresses[k][version] = overriden;
     }
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getAddress}
+   **/
   getAddress(contract, version = NO_VERSION) {
     if (!this.#addresses[contract]) {
       throw new Error(`Address ${contract}, version: ${version} not found`);
@@ -43,6 +46,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getLatest}
+   **/
   getLatest(contract, range) {
     const allVersions = this.#addresses[contract];
     if (!allVersions) {
@@ -62,6 +68,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return [address, version];
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.mustGetLatest}
+   **/
   mustGetLatest(contract, range) {
     const result = this.getLatest(contract, range);
     if (!result) {
@@ -69,6 +78,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.state}
+   **/
   get state() {
     return {
       baseParams: {
@@ -80,6 +92,9 @@ class AbstractAddressProviderContract extends BaseContract {
       addresses: this.#addresses
     };
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.stateHuman}
+   **/
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),