@gearbox-protocol/sdk 14.0.0 → 14.1.0

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 "./sendRawTx.js";
 export * from "./simulateMulticall.js";
 export * from "./simulateWithPriceUpdates.js";

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

@@ -0,0 +1,191 @@
+export declare const iDSRegistryServiceAbi: readonly [{
+    readonly type: "function";
+    readonly name: "ACCREDITED";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "APPROVED";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "KYC_APPROVED";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "NONE";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "PENDING";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "PROFESSIONAL";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "QUALIFIED";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "REJECTED";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    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";
+}, {
+    readonly type: "function";
+    readonly name: "setAttribute";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "attributeId";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "proof";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setCountry";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "country";
+        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";
+}];

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

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