@gearbox-protocol/sdk 14.0.0 → 14.1.0

package/dist/cjs/sdk/market/pool/index.js

@@ -18,11 +18,13 @@ module.exports = __toCommonJS(pool_exports);
 __reExport(pool_exports, require("./GaugeContract.js"), module.exports);
 __reExport(pool_exports, require("./LinearInterestRateModelContract.js"), module.exports);
 __reExport(pool_exports, require("./PoolSuite.js"), module.exports);
+__reExport(pool_exports, require("./PoolV310Contract.js"), module.exports);
 __reExport(pool_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./GaugeContract.js"),
   ...require("./LinearInterestRateModelContract.js"),
   ...require("./PoolSuite.js"),
+  ...require("./PoolV310Contract.js"),
   ...require("./types.js")
 });

package/dist/cjs/sdk/market/pricefeeds/PriceFeedsRegister.js

@@ -237,13 +237,13 @@ class PriceFeedRegister extends import_base.SDKConstruct {
    * Loads PARTIAL information about all updatable price feeds from MarketCompressor
    * Discovered price feeds are not saved anywhere in PriceFeedRegister, and can later be used to load price feed updates
    */
-  async getPartialUpdatablePriceFeeds(configurators, pools) {
+  async getPartialUpdatablePriceFeeds(configurators) {
     const [priceFeedCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
       import_constants.AP_PRICE_FEED_COMPRESSOR,
       import_constants.VERSION_RANGE_310
     );
     this.logger?.debug(
-      { configurators, pools },
+      { configurators },
       `calling getUpdatablePriceFeeds in block ${this.sdk.currentBlock}`
     );
     const result = await this.client.readContract({
@@ -253,7 +253,7 @@ class PriceFeedRegister extends import_base.SDKConstruct {
       args: [
         {
           configurators,
-          pools: pools ?? [],
+          pools: [],
           underlying: import_constants.ADDRESS_0X0
         }
       ],

package/dist/cjs/sdk/options.js

@@ -44,6 +44,12 @@ const AttachOptionsSchema = import_v4.z.object({
   addressProvider: (0, import_utils.ZodAddress)().optional(),
   /** Addresses of market configurator contracts to load. */
   marketConfigurators: import_v4.z.array((0, import_utils.ZodAddress)()).optional(),
+  /**
+   * Addresses of KYC factory contracts to load.
+   * If not set, all default KYC factories for the chain are loaded
+   * (from {@link GearboxChain.kycFactories})
+   **/
+  kycFactories: import_v4.z.array((0, import_utils.ZodAddress)()).optional(),
   /** Pin SDK to a specific block number during attach. */
   blockNumber: import_v4.z.union([import_v4.z.bigint().nonnegative(), import_v4.z.number().int().nonnegative()]).optional(),
   /** Skip fetching updatable price feeds on attach and sync. */

package/dist/cjs/sdk/pools/PoolService.js

@@ -22,6 +22,7 @@ __export(PoolService_exports, {
 });
 module.exports = __toCommonJS(PoolService_exports);
 var import_generated = require("../../abi/310/generated.js");
+var import_iERC20 = require("../../abi/iERC20.js");
 var import_iERC20ZapperDeposits = require("../../abi/iERC20ZapperDeposits.js");
 var import_iETHZapperDeposits = require("../../abi/iETHZapperDeposits.js");
 var import_iZapper = require("../../abi/iZapper.js");
@@ -30,28 +31,73 @@ var import_constants = require("../constants/index.js");
 var import_utils = require("../utils/index.js");
 class PoolService extends import_base.SDKConstruct {
   /**
-   * @inheritdoc IPoolsService.getDepositTokensIn
+   * {@inheritDoc IPoolsService.getDepositTokensIn}
    */
   getDepositTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensIn(pool, false);
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return [underlying.asset];
+      }
+    }
     return this.#depositTokensIn(pool, true);
   }
   /**
-   * @inheritdoc IPoolsService.getDepositTokensOut
+   * {@inheritDoc IPoolsService.getDepositTokensOut}
    */
   getDepositTokensOut(pool, tokenIn) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensOut(pool, tokenIn, false);
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return [];
+      }
+    }
     return this.#depositTokensOut(pool, tokenIn, true);
   }
   /**
-   * @inheritdoc IPoolsService.getDepositMetadata
+   * {@inheritDoc IPoolsService.getDepositMetadata}
    */
   getDepositMetadata(pool, tokenIn, tokenOut) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT: {
+          return this.#depositMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return {
+            zapper: void 0,
+            approveTarget: underlying.liquidityProvider.addr,
+            permissible: false,
+            type: "kyc-on-demand"
+          };
+      }
+    }
     return this.#depositMetadata("classic", pool, tokenIn, tokenOut, true);
   }
   /**
-   * @inheritdoc IPoolsService.addLiquidity
+   * {@inheritDoc IPoolsService.addLiquidity}
    */
   addLiquidity(props) {
     const { collateral, meta, permit, referralCode, pool, wallet } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === import_base.KYC_UNDERLYING_ON_DEMAND) {
+        return void 0;
+      }
+    }
     const { zapper } = meta;
     if (zapper && (0, import_utils.hexEq)(zapper.tokenIn.addr, import_constants.NATIVE_ADDRESS)) {
       return {
@@ -91,22 +137,51 @@ class PoolService extends import_base.SDKConstruct {
     }
   }
   /**
-   * @inheritdoc IPoolsService.getWithdrawalTokensIn
+   * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
    */
   getWithdrawalTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensIn(pool, false);
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return [];
+      }
+    }
     return this.#withdrawalTokensIn(pool, true);
   }
   /**
-   * @inheritdoc IPoolsService.getWithdrawalTokensOut
+   * {@inheritDoc IPoolsService.getWithdrawalTokensOut}
    */
   getWithdrawalTokensOut(pool, tokenIn) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensOut(pool, tokenIn, false);
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return [underlying.asset];
+      }
+    }
     return this.#withdrawalTokensOut(pool, tokenIn, true);
   }
   /**
-   * @inheritdoc IPoolsService.removeLiquidity
+   * {@inheritDoc IPoolsService.removeLiquidity}
    */
   removeLiquidity(props) {
     const { pool, amount, meta, wallet, permit } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === import_base.KYC_UNDERLYING_ON_DEMAND) {
+        return {
+          abi: import_iERC20.ierc20Abi,
+          functionName: "approve",
+          args: [underlying.liquidityProvider, 0n],
+          target: underlying.asset
+        };
+      }
+    }
     if (meta.zapper) {
       return permit ? {
         target: meta.zapper.baseParams.addr,
@@ -135,9 +210,30 @@ class PoolService extends import_base.SDKConstruct {
     };
   }
   /**
-   * @inheritdoc IPoolsService.getWithdrawalMetadata
+   * {@inheritDoc IPoolsService.getWithdrawalMetadata}
    */
   getWithdrawalMetadata(pool, tokenIn, tokenOut) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case import_base.KYC_UNDERLYING_DEFAULT: {
+          return this.#withdrawalMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case import_base.KYC_UNDERLYING_ON_DEMAND:
+          return {
+            zapper: void 0,
+            approveTarget: void 0,
+            permissible: false,
+            type: "kyc-on-demand"
+          };
+      }
+    }
     return this.#withdrawalMetadata("classic", pool, tokenIn, tokenOut, true);
   }
   /**
@@ -297,8 +393,6 @@ class PoolService extends import_base.SDKConstruct {
       zapper,
       // Approval target is zapper when routed, otherwise the pool contract.
       approveTarget: zapper?.baseParams.addr ?? pool.pool.address,
-      // TODO: instead of permissible, return permitType depending on tokenIn
-      // "none" | "eip2612" | "dai_like";
       permissible: !!zapper && !(0, import_utils.hexEq)(tokenIn, import_constants.NATIVE_ADDRESS),
       type
     };
@@ -326,8 +420,6 @@ class PoolService extends import_base.SDKConstruct {
       zapper,
       // Approval target exists only for zapper-based withdrawals.
       approveTarget: zapper?.baseParams.addr,
-      // TODO: instead of permissible, return permitType depending on tokenIn
-      // "none" | "eip2612" | "dai_like";
       permissible: !!zapper,
       type
     };

package/dist/cjs/sdk/utils/viem/executeDelegatedMulticalls.js

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var executeDelegatedMulticalls_exports = {};
+__export(executeDelegatedMulticalls_exports, {
+  executeDelegatedMulticalls: () => executeDelegatedMulticalls
+});
+module.exports = __toCommonJS(executeDelegatedMulticalls_exports);
+var import_simulateWithPriceUpdates = require("./simulateWithPriceUpdates.js");
+async function executeDelegatedMulticalls(client, multicalls, opts) {
+  if (!multicalls.length) return;
+  const results = await (0, import_simulateWithPriceUpdates.simulateWithPriceUpdates)(client, {
+    ...opts,
+    contracts: multicalls.map((d) => d.call)
+  });
+  for (let i = 0; i < multicalls.length; i++) {
+    multicalls[i].onResult(results[i]);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  executeDelegatedMulticalls
+});

package/dist/cjs/sdk/utils/viem/index.js

@@ -16,6 +16,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var viem_exports = {};
 module.exports = __toCommonJS(viem_exports);
 __reExport(viem_exports, require("./cast.js"), module.exports);
+__reExport(viem_exports, require("./executeDelegatedMulticalls.js"), module.exports);
 __reExport(viem_exports, require("./sendRawTx.js"), module.exports);
 __reExport(viem_exports, require("./simulateMulticall.js"), module.exports);
 __reExport(viem_exports, require("./simulateWithPriceUpdates.js"), module.exports);
@@ -23,6 +24,7 @@ __reExport(viem_exports, require("./watchBlocksAsync.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./cast.js"),
+  ...require("./executeDelegatedMulticalls.js"),
   ...require("./sendRawTx.js"),
   ...require("./simulateMulticall.js"),
   ...require("./simulateWithPriceUpdates.js"),

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

@@ -0,0 +1,125 @@
+const iDSRegistryServiceAbi = [
+  {
+    type: "function",
+    name: "ACCREDITED",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "APPROVED",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "KYC_APPROVED",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "NONE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "PENDING",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "PROFESSIONAL",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "QUALIFIED",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "REJECTED",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "uint8" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "addWallet",
+    inputs: [
+      { name: "wallet", type: "address", internalType: "address" },
+      { name: "investorId", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getInvestor",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "string", internalType: "string" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isInvestor",
+    inputs: [{ name: "investorId", type: "string", internalType: "string" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isWallet",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "registerInvestor",
+    inputs: [
+      { name: "investorId", type: "string", internalType: "string" },
+      { name: "collisionHash", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setAttribute",
+    inputs: [
+      { name: "investorId", type: "string", internalType: "string" },
+      { name: "attributeId", type: "uint8", internalType: "uint8" },
+      { name: "value", type: "uint256", internalType: "uint256" },
+      { name: "expiry", type: "uint256", internalType: "uint256" },
+      { name: "proof", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setCountry",
+    inputs: [
+      { name: "investorId", type: "string", internalType: "string" },
+      { name: "country", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+export {
+  iDSRegistryServiceAbi
+};

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

@@ -0,0 +1,47 @@
+const iDSTokenAbi = [
+  {
+    type: "function",
+    name: "REGISTRY_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "TRUST_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "burn",
+    inputs: [
+      { name: "from", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" },
+      { name: "reason", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getDSService",
+    inputs: [{ name: "serviceId", type: "uint256", internalType: "uint256" }],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "issueTokens",
+    inputs: [
+      { name: "to", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+export {
+  iDSTokenAbi
+};

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

@@ -0,0 +1,172 @@
+const iKYCCompressorAbi = [
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getKYCInvestorData",
+    inputs: [
+      { name: "investor", type: "address", internalType: "address" },
+      { name: "factories", type: "address[]", internalType: "address[]" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct IKYCCompressor.KYCInvestorData[]",
+        components: [
+          {
+            name: "creditAccounts",
+            type: "tuple[]",
+            internalType: "struct IKYCCompressor.KYCCreditAccountData[]",
+            components: [
+              {
+                name: "creditAccount",
+                type: "address",
+                internalType: "address"
+              },
+              { name: "wallet", type: "address", internalType: "address" },
+              { name: "frozen", type: "bool", internalType: "bool" },
+              { name: "extraDetails", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "extraDetails", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getKYCMarketsData",
+    inputs: [
+      { name: "configurators", type: "address[]", internalType: "address[]" },
+      { name: "factories", type: "address[]", internalType: "address[]" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct IKYCCompressor.KYCUnderlyingData[]",
+        components: [
+          {
+            name: "baseParams",
+            type: "tuple",
+            internalType: "struct BaseParams",
+            components: [
+              { name: "addr", type: "address", internalType: "address" },
+              { name: "version", type: "uint256", internalType: "uint256" },
+              {
+                name: "contractType",
+                type: "bytes32",
+                internalType: "bytes32"
+              },
+              {
+                name: "serializedParams",
+                type: "bytes",
+                internalType: "bytes"
+              }
+            ]
+          },
+          { name: "asset", type: "address", internalType: "address" },
+          { name: "factory", type: "address", internalType: "address" },
+          { name: "extraDetails", type: "bytes", internalType: "bytes" }
+        ]
+      },
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct IKYCCompressor.KYCFactoryData[]",
+        components: [
+          {
+            name: "baseParams",
+            type: "tuple",
+            internalType: "struct BaseParams",
+            components: [
+              { name: "addr", type: "address", internalType: "address" },
+              { name: "version", type: "uint256", internalType: "uint256" },
+              {
+                name: "contractType",
+                type: "bytes32",
+                internalType: "bytes32"
+              },
+              {
+                name: "serializedParams",
+                type: "bytes",
+                internalType: "bytes"
+              }
+            ]
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            internalType: "struct TokenData[]",
+            components: [
+              { name: "addr", type: "address", internalType: "address" },
+              { name: "symbol", type: "string", internalType: "string" },
+              { name: "name", type: "string", internalType: "string" },
+              { name: "decimals", type: "uint8", internalType: "uint8" }
+            ]
+          },
+          { name: "extraDetails", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "setSubcompressor",
+    inputs: [
+      { name: "subcompressor", type: "address", internalType: "address" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "subcompressors",
+    inputs: [
+      { name: "domain", type: "bytes32", internalType: "bytes32" },
+      { name: "postfix", type: "bytes32", internalType: "bytes32" }
+    ],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "error",
+    name: "CallerIsNotInstanceOwnerException",
+    inputs: [{ name: "caller", type: "address", internalType: "address" }]
+  },
+  {
+    type: "error",
+    name: "InvalidDomainException",
+    inputs: [{ name: "domain", type: "bytes32", internalType: "bytes32" }]
+  },
+  {
+    type: "error",
+    name: "InvalidKYCFactoryException",
+    inputs: [{ name: "factory", type: "address", internalType: "address" }]
+  },
+  {
+    type: "error",
+    name: "InvalidMarketConfiguratorException",
+    inputs: [
+      { name: "marketConfigurator", type: "address", internalType: "address" }
+    ]
+  }
+];
+export {
+  iKYCCompressorAbi
+};