@gearbox-protocol/sdk 13.6.0 → 13.7.0-kyc.1

package/dist/esm/abi/kyc/iSecuritizeKYCFactory.js

@@ -0,0 +1,295 @@
+const iSecuritizeKYCFactoryAbi = [
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getCreditAccounts",
+    inputs: [{ name: "investor", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "address[]", internalType: "address[]" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getDegenNFT",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getInvestor",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getTokens",
+    inputs: [],
+    outputs: [{ name: "", type: "address[]", internalType: "address[]" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getWallet",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isCreditAccount",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isFrozen",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "multicall",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      {
+        name: "calls",
+        type: "tuple[]",
+        internalType: "struct MultiCall[]",
+        components: [
+          { name: "target", type: "address", internalType: "address" },
+          { name: "callData", type: "bytes", internalType: "bytes" }
+        ]
+      },
+      {
+        name: "tokensToRegister",
+        type: "address[]",
+        internalType: "address[]"
+      },
+      {
+        name: "signaturesToCache",
+        type: "tuple[]",
+        internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "signature",
+            type: "tuple",
+            internalType: "struct ISecuritizeDegenNFT.Signature",
+            components: [
+              { name: "deadline", type: "uint256", internalType: "uint256" },
+              { name: "signature", type: "bytes", internalType: "bytes" }
+            ]
+          }
+        ]
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "openCreditAccount",
+    inputs: [
+      { name: "creditManager", type: "address", internalType: "address" },
+      {
+        name: "calls",
+        type: "tuple[]",
+        internalType: "struct MultiCall[]",
+        components: [
+          { name: "target", type: "address", internalType: "address" },
+          { name: "callData", type: "bytes", internalType: "bytes" }
+        ]
+      },
+      {
+        name: "tokensToRegister",
+        type: "address[]",
+        internalType: "address[]"
+      },
+      {
+        name: "signaturesToCache",
+        type: "tuple[]",
+        internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "signature",
+            type: "tuple",
+            internalType: "struct ISecuritizeDegenNFT.Signature",
+            components: [
+              { name: "deadline", type: "uint256", internalType: "uint256" },
+              { name: "signature", type: "bytes", internalType: "bytes" }
+            ]
+          }
+        ]
+      }
+    ],
+    outputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "wallet", type: "address", internalType: "address" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "precomputeWalletAddress",
+    inputs: [
+      { name: "creditManager", type: "address", internalType: "address" },
+      { name: "investor", type: "address", internalType: "address" }
+    ],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "serialize",
+    inputs: [],
+    outputs: [{ name: "serializedData", type: "bytes", internalType: "bytes" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "setFrozenStatus",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "frozen", type: "bool", internalType: "bool" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setInvestor",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "investor", type: "address", internalType: "address" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "event",
+    name: "CreateWallet",
+    inputs: [
+      {
+        name: "creditAccount",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "wallet",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "investor",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      }
+    ],
+    anonymous: false
+  },
+  {
+    type: "event",
+    name: "SetFrozenStatus",
+    inputs: [
+      {
+        name: "creditAccount",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      { name: "frozen", type: "bool", indexed: false, internalType: "bool" }
+    ],
+    anonymous: false
+  },
+  {
+    type: "event",
+    name: "SetInvestor",
+    inputs: [
+      {
+        name: "creditAccount",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "oldInvestor",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "newInvestor",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      }
+    ],
+    anonymous: false
+  },
+  {
+    type: "error",
+    name: "CallerIsNotInvestorException",
+    inputs: [
+      { name: "caller", type: "address", internalType: "address" },
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ]
+  },
+  {
+    type: "error",
+    name: "FrozenCreditAccountException",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ]
+  },
+  {
+    type: "error",
+    name: "InvalidCreditManagerException",
+    inputs: [
+      { name: "creditManager", type: "address", internalType: "address" }
+    ]
+  },
+  {
+    type: "error",
+    name: "InvalidUnderlyingTokenException",
+    inputs: [{ name: "underlying", type: "address", internalType: "address" }]
+  },
+  {
+    type: "error",
+    name: "UnknownCreditAccountException",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" }
+    ]
+  },
+  { type: "error", name: "ZeroAddressException", inputs: [] }
+];
+export {
+  iSecuritizeKYCFactoryAbi
+};

package/dist/esm/dev/AccountOpener.js

@@ -6,7 +6,7 @@ import {
   parseEventLogs
 } from "viem";
 import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";
-import { iCreditFacadeV310Abi, iPoolV310Abi } from "../abi/310/generated.js";
+import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
 import { ierc20Abi } from "../abi/iERC20.js";
 import {
   ADDRESS_0X0,
@@ -15,6 +15,7 @@ import {
   childLogger,
   MAX_UINT256,
   PERCENTAGE_FACTOR,
+  PoolService,
   SDKConstruct,
   sendRawTx
 } from "../sdk/index.js";
@@ -43,6 +44,7 @@ class AccountOpener extends SDKConstruct {
   #minDebtMultiplier;
   #allowMint;
   #leverageDelta;
+  #poolService;
   constructor(service, options_ = {}) {
     super(service.sdk);
     const {
@@ -68,6 +70,7 @@ class AccountOpener extends SDKConstruct {
     this.#poolDepositMultiplier = BigInt(poolDepositMultiplier);
     this.#minDebtMultiplier = BigInt(minDebtMultiplier);
     this.#leverageDelta = BigInt(leverageDelta);
+    this.#poolService = new PoolService(service.sdk);
     this.#logger?.info(
       {
         borrower: privateKeyToAccount(this.borrowerKey).address,
@@ -105,6 +108,10 @@ class AccountOpener extends SDKConstruct {
       },
       "opening credit accounts"
     );
+    await Promise.all([
+      this.sdk.tokensMeta.loadTokenData(),
+      this.sdk.marketRegister.loadZappers()
+    ]);
     let deposits = [];
     if (depositIntoPools) {
       try {
@@ -456,9 +463,34 @@ class AccountOpener extends SDKConstruct {
       this.#logger?.debug(
         `depositor balance in underlying: ${this.sdk.tokensMeta.formatBN(pool.underlying, allowance, { symbol: true })}`
       );
+      const tokensOut = this.#poolService.getDepositTokensOut(
+        address,
+        underlying
+      );
+      this.#logger?.debug(
+        { tokensOut: tokensOut.map((t) => this.labelAddress(t)) },
+        "deposit tokens out"
+      );
+      if (tokensOut.length === 0) {
+        throw new Error(`no tokens out found for pool ${poolName}`);
+      }
+      const tokenOut = tokensOut[0];
+      const metadata = this.#poolService.getDepositMetadata(
+        address,
+        underlying,
+        tokenOut
+      );
+      this.logger?.debug(
+        {
+          underlying: this.labelAddress(underlying),
+          tokenOut: this.labelAddress(tokenOut),
+          ...metadata
+        },
+        "pool deposit metadata"
+      );
       txHash = await this.#anvil.writeContract({
         account: depositor,
-        address: underlying,
+        address: metadata.approveTarget,
         abi: ierc20Abi,
         functionName: "approve",
         args: [address, allowance],
@@ -475,12 +507,21 @@ class AccountOpener extends SDKConstruct {
       this.#logger?.debug(
         `depositor approved underlying for pool ${poolName}: ${txHash}`
       );
+      const depositCall = this.#poolService.addLiquidity({
+        collateral: { token: underlying, balance: amount },
+        pool: address,
+        wallet: depositor.address,
+        meta: metadata
+      });
+      if (!depositCall) {
+        throw new Error(`no deposit call could be created for ${poolName}`);
+      }
       txHash = await this.#anvil.writeContract({
         account: depositor,
-        address,
-        abi: iPoolV310Abi,
-        functionName: "deposit",
-        args: [amount, depositor.address],
+        address: depositCall.target,
+        abi: depositCall.abi,
+        functionName: depositCall.functionName,
+        args: depositCall.args,
         chain: this.#anvil.chain
       });
       receipt = await this.#anvil.waitForTransactionReceipt({ hash: txHash });

package/dist/esm/history/errors.js

@@ -33,6 +33,8 @@ class AdapterTraceAlignmentError extends Error {
     this.actual = actual;
     this.name = "AdapterTracesAlignmentError";
   }
+  expected;
+  actual;
 }
 class UnexpectedFacadeEventOrderError extends Error {
   constructor(e) {

package/dist/esm/sdk/GearboxSDK.js

@@ -16,6 +16,7 @@ import {
   VERSION_RANGE_310
 } from "./constants/index.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/index.js";
+import { KYCRegistry } from "./market/kyc/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import {
@@ -24,7 +25,10 @@ import {
 import { createRouter } from "./router/index.js";
 import { formatTimestamp, TypedObjectUtils, toAddress } from "./utils/index.js";
 import { Hooks } from "./utils/internal/index.js";
-import { getLogsSafe } from "./utils/viem/index.js";
+import {
+  executeDelegatedMulticalls,
+  getLogsSafe
+} from "./utils/viem/index.js";
 const ERR_NOT_ATTACHED = new Error("Gearbox SDK not attached");
 const STATE_VERSION = 1;
 function createClient(opts, network) {
@@ -77,6 +81,7 @@ class GearboxSDK extends ChainContractsRegister {
   #addressProvider;
   #attachConfig;
   #marketRegister;
+  #kyc;
   #priceFeeds;
   /**
    * Gas limit applied to read-only `eth_call` requests.
@@ -121,6 +126,7 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators: mcs,
+      kycFactories: kfs,
       strictContractTypes,
       gasLimit
     } = options;
@@ -130,6 +136,7 @@ class GearboxSDK extends ChainContractsRegister {
       addressProvider = ADDRESS_PROVIDER_V310;
     }
     const marketConfigurators = mcs ?? TypedObjectUtils.keys(client.chain.defaultMarketConfigurators);
+    const kycFactories = kfs ?? client.chain.kycFactories;
     return new GearboxSDK({
       client,
       logger,
@@ -142,6 +149,7 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators,
+      kycFactories,
       redstone,
       pyth
     });
@@ -191,6 +199,7 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators,
+      kycFactories,
       redstone,
       pyth
     } = opts;
@@ -201,6 +210,7 @@ class GearboxSDK extends ChainContractsRegister {
         chainId: this.chainId,
         addressProvider,
         marketConfigurators,
+        kycFactories,
         blockNumber,
         ignoreMarkets
       },
@@ -235,10 +245,34 @@ class GearboxSDK extends ChainContractsRegister {
     );
     await this.#addressProvider.syncState(this.currentBlock);
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
-    await this.#marketRegister.loadMarkets(
-      marketConfigurators,
-      ignoreUpdateablePrices
-    );
+    this.#kyc = new KYCRegistry(this);
+    if (!marketConfigurators.length) {
+      this.logger?.warn(
+        "no market configurators provided, skipping market loading"
+      );
+    } else {
+      const delegated = [
+        ...this.#marketRegister.getLoadMulticalls(marketConfigurators),
+        ...this.#kyc.getLoadMulticalls(marketConfigurators, kycFactories)
+      ];
+      let txs = [];
+      if (!ignoreUpdateablePrices) {
+        const updatables = await this.#priceFeeds.getPartialUpdatablePriceFeeds(
+          marketConfigurators
+        );
+        const updates = await this.#priceFeeds.generatePriceFeedsUpdateTxs(updatables);
+        txs = updates.txs;
+      }
+      this.logger?.debug(
+        { configurators: marketConfigurators },
+        `calling getMarkets with ${txs.length} price updates in block ${this.currentBlock}`
+      );
+      await executeDelegatedMulticalls(this.client, delegated, {
+        priceUpdates: txs,
+        blockNumber: this.currentBlock,
+        gas: this.gasLimit
+      });
+    }
     const pluginsList = TypedObjectUtils.entries(this.plugins);
     const pluginResponse = await Promise.allSettled(
       pluginsList.map(([name, plugin]) => {
@@ -284,12 +318,15 @@ class GearboxSDK extends ChainContractsRegister {
     );
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
     this.#marketRegister.hydrate(state.markets);
+    this.#kyc = new KYCRegistry(this);
+    this.#kyc.setState(state.kyc);
     this.#attachConfig = {
       ...opts,
       addressProvider: this.addressProvider.address,
       marketConfigurators: this.marketRegister.marketConfigurators.map(
         (m) => m.address
       ),
+      kycFactories: this.kyc.factories.map((f) => f.address),
       blockNumber: this.currentBlock
     };
     for (const [name, plugin] of TypedObjectUtils.entries(this.plugins)) {
@@ -373,6 +410,7 @@ class GearboxSDK extends ChainContractsRegister {
         addressProviderV3: this.addressProvider.stateHuman(raw)
       },
       tokens: this.tokensMeta.values(),
+      kyc: this.kyc.stateHuman(raw),
       plugins: Object.fromEntries(
         TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
           name,
@@ -398,6 +436,7 @@ class GearboxSDK extends ChainContractsRegister {
       timestamp: this.timestamp,
       addressProvider: this.addressProvider.state,
       markets: this.marketRegister.state,
+      kyc: this.kyc.state,
       plugins: Object.fromEntries(
         TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
           name,
@@ -594,6 +633,17 @@ class GearboxSDK extends ChainContractsRegister {
     }
     return this.#marketRegister;
   }
+  /**
+   * KYC register for KYC-wrapped underlying tokens and factories.
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
+  get kyc() {
+    if (this.#kyc === void 0) {
+      throw ERR_NOT_ATTACHED;
+    }
+    return this.#kyc;
+  }
   /**
    * Resolves the appropriate router contract for a given credit manager,
    * credit facade, or explicit version range.