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

package/dist/esm/sdk/market/kyc/securitize/SecuritizeKYCFactory.js

@@ -0,0 +1,220 @@
+import { decodeAbiParameters } from "viem";
+import { iSecuritizeKYCFactoryAbi } from "../../../../abi/kyc/iSecuritizeKYCFactory.js";
+import { BaseContract } from "../../../base/index.js";
+import { AddressMap, AddressSet } from "../../../utils/index.js";
+import { KYC_FACTORY_SECURITIZE } from "./constants.js";
+const abi = iSecuritizeKYCFactoryAbi;
+class SecuritizeKYCFactory extends BaseContract {
+  #sdk;
+  #investorCache = new AddressMap();
+  degenNFT;
+  owner;
+  dsTokens;
+  contractType = KYC_FACTORY_SECURITIZE;
+  constructor(sdk, data) {
+    super(sdk, {
+      ...data.baseParams,
+      name: "SecuritizeKYCFactory",
+      abi
+    });
+    this.#sdk = sdk;
+    const decoded = decodeAbiParameters(
+      [
+        { name: "owner", type: "address" },
+        { name: "degenNFT", type: "address" },
+        {
+          name: "dsTokensData",
+          type: "tuple[]",
+          components: [
+            { name: "token", type: "address" },
+            { name: "registrar", type: "address" },
+            { name: "operators", type: "address[]" }
+          ]
+        }
+      ],
+      data.baseParams.serializedParams
+    );
+    this.owner = decoded[0];
+    this.degenNFT = decoded[1];
+    for (const t of data.tokens) {
+      this.tokensMeta.upsert(t.addr, t);
+    }
+    this.dsTokens = decoded[2].map((t) => ({
+      address: t.token,
+      registrar: t.registrar,
+      operators: [...t.operators]
+    }));
+  }
+  /**
+   * {@inheritDoc IKYCFactory.decodeInvestorData}
+   */
+  decodeInvestorData(data) {
+    const { creditAccounts, extraDetails } = data;
+    const [registeredTokens, cachedSignatures, registerVaultMessages] = decodeAbiParameters(
+      [
+        { name: "registeredTokens", type: "address[]" },
+        {
+          name: "cachedSignatures",
+          type: "tuple[]",
+          components: [...registerMessageTuple]
+        },
+        {
+          name: "registerVaultMessages",
+          type: "tuple[]",
+          components: [...registerVaultMessageTuple]
+        }
+      ],
+      extraDetails
+    );
+    return {
+      factory: this.address,
+      cachedSignatures: [...cachedSignatures],
+      registerVaultMessages: [...registerVaultMessages],
+      registeredTokens: [...registeredTokens],
+      creditAccounts: creditAccounts.map((ca) => {
+        const [registeredTokens2] = decodeAbiParameters(
+          [{ name: "registeredTokens", type: "address[]" }],
+          ca.extraDetails
+        );
+        return {
+          ...ca,
+          registeredTokens: [...registeredTokens2]
+        };
+      })
+    };
+  }
+  /**
+   * {@inheritDoc IKYCFactory.getInvestor}
+   */
+  async getInvestor(creditAccount, fromCache) {
+    if (fromCache && this.#investorCache.has(creditAccount)) {
+      return this.#investorCache.mustGet(creditAccount);
+    }
+    const investor = await this.contract.read.getInvestor([creditAccount]);
+    if (fromCache) {
+      this.#investorCache.upsert(creditAccount, investor);
+    }
+    return investor;
+  }
+  /**
+   * {@inheritDoc IKYCFactory.getApprovalAddress}
+   */
+  async getApprovalAddress(options) {
+    if ("creditAccount" in options) {
+      return this.getWallet(options.creditAccount);
+    }
+    return this.#precomputeWalletAddress(
+      options.creditManager,
+      options.borrower
+    );
+  }
+  /**
+   * {@inheritDoc IKYCFactory.getWallet}
+   */
+  async getWallet(creditAccount) {
+    return this.contract.read.getWallet([creditAccount]);
+  }
+  /**
+   * {@inheritDoc IKYCFactory.multicall}
+   */
+  multicall(creditAccount, calls, options) {
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
+    return this.createRawTx({
+      functionName: "multicall",
+      args: [creditAccount, calls, tokensToRegister, signaturesToCache]
+    });
+  }
+  /**
+   * {@inheritDoc IKYCFactory.getOpenAccountRequirements}
+   */
+  async getOpenAccountRequirements(investor) {
+    const [investorData] = await this.#sdk.kyc.getInvestorData(investor, [
+      this.address
+    ]);
+    const dsTokens = new AddressSet(this.dsTokens.map((t) => t.address));
+    const desiredTokens = dsTokens;
+    const registredTokens = new AddressSet(investorData.registeredTokens);
+    const signedTokens = new AddressSet(
+      investorData.cachedSignatures.map((s) => s.token)
+    );
+    const unsignedTokens = desiredTokens.difference(signedTokens);
+    const tokensToRegister = desiredTokens.difference(registredTokens);
+    const requiredSignatures = investorData.registerVaultMessages.filter(
+      (m) => unsignedTokens.has(m.token)
+    );
+    if (tokensToRegister.size === 0 && requiredSignatures.length === 0) {
+      return void 0;
+    }
+    return {
+      type: KYC_FACTORY_SECURITIZE,
+      tokensToRegister: Array.from(tokensToRegister),
+      requiredSignatures
+    };
+  }
+  /**
+   * {@inheritDoc IKYCFactory.openCreditAccount}
+   */
+  openCreditAccount(creditManager, calls, options) {
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
+    return this.createRawTx({
+      functionName: "openCreditAccount",
+      args: [creditManager, calls, tokensToRegister, signaturesToCache]
+    });
+  }
+  stateHuman(_raw) {
+    return {
+      ...super.stateHuman(_raw),
+      owner: this.labelAddress(this.owner),
+      degenNFT: this.labelAddress(this.degenNFT),
+      dsTokens: this.dsTokens.map((t) => ({
+        ...this.tokensMeta.mustGet(t.address),
+        registrar: this.labelAddress(t.registrar),
+        operators: t.operators.map((o) => this.labelAddress(o))
+      }))
+    };
+  }
+  /**
+   * Precomputes the wallet address that will own a new credit account
+   * for the given investor in the given credit manager.
+   *
+   * @param creditManager - credit manager address
+   * @param investor - investor address
+   **/
+  async #precomputeWalletAddress(creditManager, investor) {
+    return this.contract.read.precomputeWalletAddress([
+      creditManager,
+      investor
+    ]);
+  }
+}
+const registerMessageTuple = [
+  { name: "token", type: "address" },
+  {
+    name: "signature",
+    type: "tuple",
+    components: [
+      { name: "deadline", type: "uint256" },
+      { name: "signature", type: "bytes" }
+    ]
+  }
+];
+const registerVaultMessageTuple = [
+  {
+    name: "domain",
+    type: "tuple",
+    components: [
+      { name: "name", type: "string" },
+      { name: "version", type: "string" },
+      { name: "chainId", type: "uint256" },
+      { name: "verifyingContract", type: "address" }
+    ]
+  },
+  { name: "investor", type: "address" },
+  { name: "operator", type: "address" },
+  { name: "token", type: "address" },
+  { name: "nonce", type: "uint256" },
+  { name: "deadline", type: "uint256" }
+];
+export {
+  SecuritizeKYCFactory
+};

package/dist/esm/sdk/market/kyc/securitize/constants.js

@@ -0,0 +1,4 @@
+const KYC_FACTORY_SECURITIZE = "KYC_FACTORY::SECURITIZE";
+export {
+  KYC_FACTORY_SECURITIZE
+};

package/dist/esm/sdk/market/kyc/securitize/index.js

@@ -0,0 +1,3 @@
+export * from "./constants.js";
+export * from "./SecuritizeKYCFactory.js";
+export * from "./types.js";

package/dist/esm/sdk/market/kyc/types.js

@@ -0,0 +1,9 @@
+import { KYC_FACTORY_SECURITIZE } from "./securitize/index.js";
+const KYC_FACTORY_TYPES = [KYC_FACTORY_SECURITIZE];
+function isKYCFactory(factory, type) {
+  return factory.contractType === type;
+}
+export {
+  KYC_FACTORY_TYPES,
+  isKYCFactory
+};

package/dist/esm/sdk/market/pool/PoolSuite.js

@@ -55,6 +55,9 @@ class PoolSuite extends SDKConstruct {
   get underlying() {
     return this.pool.underlying;
   }
+  get kycFactory() {
+    return this.pool.kycFactory;
+  }
   get dirty() {
     return this.pool.dirty || this.rateKeeper.dirty || this.pqk.dirty || this.interestRateModel.dirty;
   }

package/dist/esm/sdk/market/pool/PoolV310Contract.js

@@ -10,13 +10,15 @@ import {
 const abi = [...iPoolV310Abi, ...iPausableAbi];
 class PoolV310Contract extends BaseContract {
   creditManagerDebtParams;
-  constructor(options, data) {
+  #sdk;
+  constructor(sdk, data) {
     const { baseParams, creditManagerDebtParams, ...rest } = data;
-    super(options, {
+    super(sdk, {
       ...data.baseParams,
       name: `PoolV3(${data.name})`,
       abi
     });
+    this.#sdk = sdk;
     Object.assign(this, rest);
     this.creditManagerDebtParams = new AddressMap(
       creditManagerDebtParams.map((p) => [p.creditManager, p])
@@ -28,6 +30,13 @@ class PoolV310Contract extends BaseContract {
       symbol: data.symbol
     });
   }
+  get kycFactory() {
+    const meta = this.#sdk.tokensMeta.mustGet(this.underlying);
+    if (this.#sdk.tokensMeta.isKYCUnderlying(meta)) {
+      return this.#sdk.mustGetContract(meta.kycFactory);
+    }
+    return void 0;
+  }
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

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

@@ -1,4 +1,5 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
+export * from "./PoolV310Contract.js";
 export * from "./types.js";

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

@@ -221,13 +221,13 @@ class PriceFeedRegister extends 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(
       AP_PRICE_FEED_COMPRESSOR,
       VERSION_RANGE_310
     );
     this.logger?.debug(
-      { configurators, pools },
+      { configurators },
       `calling getUpdatablePriceFeeds in block ${this.sdk.currentBlock}`
     );
     const result = await this.client.readContract({
@@ -237,7 +237,7 @@ class PriceFeedRegister extends SDKConstruct {
       args: [
         {
           configurators,
-          pools: pools ?? [],
+          pools: [],
           underlying: ADDRESS_0X0
         }
       ],

package/dist/esm/sdk/options.js

@@ -16,6 +16,12 @@ const SDKOptions = z.object({
    * (from {@link GearboxChain.defaultMarketConfigurators})
    **/
   marketConfigurators: z.array(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: z.array(ZodAddress()).optional(),
   /**
    * Pin SDK to a specific block number during attach.
    * When set, all on-chain reads use this block instead of `latest`.

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

@@ -1,34 +1,84 @@
 import { iPoolV310Abi } from "../../abi/310/generated.js";
+import { ierc20Abi } from "../../abi/iERC20.js";
 import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
 import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
 import { iZapperAbi } from "../../abi/iZapper.js";
-import { SDKConstruct } from "../base/index.js";
+import {
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
+  SDKConstruct
+} from "../base/index.js";
 import { NATIVE_ADDRESS } from "../constants/index.js";
 import { AddressSet, hexEq } from "../utils/index.js";
 class PoolService extends SDKConstruct {
   /**
-   * @inheritdoc IPoolsService.getDepositTokensIn
+   * {@inheritDoc IPoolsService.getDepositTokensIn}
    */
   getDepositTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensIn(pool, false);
+        case 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 KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensOut(pool, tokenIn, false);
+        case 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 KYC_UNDERLYING_DEFAULT: {
+          return this.#depositMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case 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 === KYC_UNDERLYING_ON_DEMAND) {
+        return void 0;
+      }
+    }
     const { zapper } = meta;
     if (zapper && hexEq(zapper.tokenIn.addr, NATIVE_ADDRESS)) {
       return {
@@ -68,22 +118,51 @@ class PoolService extends SDKConstruct {
     }
   }
   /**
-   * @inheritdoc IPoolsService.getWithdrawalTokensIn
+   * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
    */
   getWithdrawalTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensIn(pool, false);
+        case 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 KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensOut(pool, tokenIn, false);
+        case 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 === KYC_UNDERLYING_ON_DEMAND) {
+        return {
+          abi: ierc20Abi,
+          functionName: "approve",
+          args: [underlying.liquidityProvider, 0n],
+          target: underlying.asset
+        };
+      }
+    }
     if (meta.zapper) {
       return permit ? {
         target: meta.zapper.baseParams.addr,
@@ -112,9 +191,30 @@ class PoolService extends 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 KYC_UNDERLYING_DEFAULT: {
+          return this.#withdrawalMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case 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);
   }
   /**
@@ -274,8 +374,6 @@ class PoolService extends 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 && !hexEq(tokenIn, NATIVE_ADDRESS),
       type
     };
@@ -303,8 +401,6 @@ class PoolService extends 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/esm/sdk/utils/viem/executeDelegatedMulticalls.js

@@ -0,0 +1,14 @@
+import { simulateWithPriceUpdates } from "./simulateWithPriceUpdates.js";
+async function executeDelegatedMulticalls(client, multicalls, opts) {
+  if (!multicalls.length) return;
+  const results = await simulateWithPriceUpdates(client, {
+    ...opts,
+    contracts: multicalls.map((d) => d.call)
+  });
+  for (let i = 0; i < multicalls.length; i++) {
+    multicalls[i].onResult(results[i]);
+  }
+}
+export {
+  executeDelegatedMulticalls
+};

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

@@ -1,4 +1,5 @@
 export * from "./cast.js";
+export * from "./executeDelegatedMulticalls.js";
 export * from "./getLogsPaginated.js";
 export * from "./getLogsSafe.js";
 export * from "./sendRawTx.js";

package/dist/types/abi/kyc/iDSRegistryService.d.ts

@@ -0,0 +1,71 @@
+export declare const iDSRegistryServiceAbi: readonly [{
+    readonly type: "function";
+    readonly name: "addWallet";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getInvestor";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isInvestor";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isWallet";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "registerInvestor";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "collisionHash";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}];

package/dist/types/abi/kyc/iDSToken.d.ts

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