@gearbox-protocol/sdk 13.7.0-kyc.5 → 13.7.0-kyc.7

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

@@ -22,6 +22,62 @@ __export(iDSRegistryService_exports, {
 });
 module.exports = __toCommonJS(iDSRegistryService_exports);
 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",
@@ -62,6 +118,29 @@ const iDSRegistryServiceAbi = [
     ],
     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"
   }
 ];
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/sdk/accounts/AbstractCreditAccountsService.js

@@ -840,7 +840,8 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
       calls: openPathCalls,
       callsAfter,
       minQuota,
-      averageQuota
+      averageQuota,
+      kycOptions
     } = props;
     const cmSuite = this.sdk.marketRegister.findCreditManager(creditManager);
     const cm = cmSuite.creditManager;
@@ -874,7 +875,13 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     if (reopenCreditAccount) {
       tx = await this.multicallTx(cmSuite, reopenCreditAccount, calls);
     } else {
-      tx = await this.openCreditAccountTx(cmSuite, to, calls, referralCode);
+      tx = await this.openCreditAccountTx(
+        cmSuite,
+        to,
+        calls,
+        referralCode,
+        kycOptions
+      );
     }
     tx.value = ethAmount.toString(10);
     return { calls, tx, creditFacade: cmSuite.creditFacade };
@@ -1343,9 +1350,6 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     const marketSuite = this.sdk.marketRegister.findByPool(suite.pool);
     const factory = marketSuite.kycFactory;
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.openCreditAccount(
         suite.creditManager.address,
         calls,
@@ -1359,7 +1363,7 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
    * @param suite
    * @param creditAccount
    * @param calls
-   * @param options
+   * @param kycOptions
    * @returns
    */
   async multicallTx(suite, creditAccount, calls, kycOptions) {
@@ -1368,9 +1372,6 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     );
     const factory = marketSuite.kycFactory;
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.multicall(creditAccount, calls, kycOptions);
     }
     return suite.creditFacade.multicall(creditAccount, calls);
@@ -1398,9 +1399,6 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
       return suite.creditFacade.closeCreditAccount(creditAccount, calls);
     }
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.multicall(creditAccount, calls, kycOptions);
     }
     return suite.creditFacade.multicall(creditAccount, calls);

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

@@ -141,7 +141,7 @@ class SecuritizeKYCFactory extends import_base.BaseContract {
    * {@inheritDoc IKYCFactory.multicall}
    */
   multicall(creditAccount, calls, options) {
-    const { tokensToRegister, signaturesToCache } = options;
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
     return this.createRawTx({
       functionName: "multicall",
       args: [creditAccount, calls, tokensToRegister, signaturesToCache]
@@ -177,7 +177,7 @@ class SecuritizeKYCFactory extends import_base.BaseContract {
    * {@inheritDoc IKYCFactory.openCreditAccount}
    */
   openCreditAccount(creditManager, calls, options) {
-    const { tokensToRegister, signaturesToCache } = options;
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
     return this.createRawTx({
       functionName: "openCreditAccount",
       args: [creditManager, calls, tokensToRegister, signaturesToCache]

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

@@ -1,4 +1,60 @@
 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",
@@ -39,6 +95,29 @@ const iDSRegistryServiceAbi = [
     ],
     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 {

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

@@ -835,7 +835,8 @@ class AbstractCreditAccountService extends SDKConstruct {
       calls: openPathCalls,
       callsAfter,
       minQuota,
-      averageQuota
+      averageQuota,
+      kycOptions
     } = props;
     const cmSuite = this.sdk.marketRegister.findCreditManager(creditManager);
     const cm = cmSuite.creditManager;
@@ -869,7 +870,13 @@ class AbstractCreditAccountService extends SDKConstruct {
     if (reopenCreditAccount) {
       tx = await this.multicallTx(cmSuite, reopenCreditAccount, calls);
     } else {
-      tx = await this.openCreditAccountTx(cmSuite, to, calls, referralCode);
+      tx = await this.openCreditAccountTx(
+        cmSuite,
+        to,
+        calls,
+        referralCode,
+        kycOptions
+      );
     }
     tx.value = ethAmount.toString(10);
     return { calls, tx, creditFacade: cmSuite.creditFacade };
@@ -1338,9 +1345,6 @@ class AbstractCreditAccountService extends SDKConstruct {
     const marketSuite = this.sdk.marketRegister.findByPool(suite.pool);
     const factory = marketSuite.kycFactory;
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.openCreditAccount(
         suite.creditManager.address,
         calls,
@@ -1354,7 +1358,7 @@ class AbstractCreditAccountService extends SDKConstruct {
    * @param suite
    * @param creditAccount
    * @param calls
-   * @param options
+   * @param kycOptions
    * @returns
    */
   async multicallTx(suite, creditAccount, calls, kycOptions) {
@@ -1363,9 +1367,6 @@ class AbstractCreditAccountService extends SDKConstruct {
     );
     const factory = marketSuite.kycFactory;
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.multicall(creditAccount, calls, kycOptions);
     }
     return suite.creditFacade.multicall(creditAccount, calls);
@@ -1393,9 +1394,6 @@ class AbstractCreditAccountService extends SDKConstruct {
       return suite.creditFacade.closeCreditAccount(creditAccount, calls);
     }
     if (factory) {
-      if (!kycOptions) {
-        throw new Error("KYC options are required for KYC factories");
-      }
       return factory.multicall(creditAccount, calls, kycOptions);
     }
     return suite.creditFacade.multicall(creditAccount, calls);

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

@@ -118,7 +118,7 @@ class SecuritizeKYCFactory extends BaseContract {
    * {@inheritDoc IKYCFactory.multicall}
    */
   multicall(creditAccount, calls, options) {
-    const { tokensToRegister, signaturesToCache } = options;
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
     return this.createRawTx({
       functionName: "multicall",
       args: [creditAccount, calls, tokensToRegister, signaturesToCache]
@@ -154,7 +154,7 @@ class SecuritizeKYCFactory extends BaseContract {
    * {@inheritDoc IKYCFactory.openCreditAccount}
    */
   openCreditAccount(creditManager, calls, options) {
-    const { tokensToRegister, signaturesToCache } = options;
+    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
     return this.createRawTx({
       functionName: "openCreditAccount",
       args: [creditManager, calls, tokensToRegister, signaturesToCache]

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

@@ -1,4 +1,84 @@
 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 [{
@@ -68,4 +148,44 @@ export declare const iDSRegistryServiceAbi: readonly [{
     }];
     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/sdk/accounts/AbstractCreditAccountsService.d.ts

@@ -209,7 +209,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * @param suite
      * @param creditAccount
      * @param calls
-     * @param options
+     * @param kycOptions
      * @returns
      */
     protected multicallTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[], kycOptions?: KYCOperationParams): Promise<RawTx>;

package/dist/types/sdk/accounts/types.d.ts

@@ -3,7 +3,7 @@ import type { creditAccountCompressorAbi } from "../../abi/compressors/creditAcc
 import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
 import type { ConnectedBotData, Construct, CreditAccountData } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
-import type { CreditSuite, PriceUpdate } from "../market/index.js";
+import type { CreditSuite, KYCOperationParams, PriceUpdate } from "../market/index.js";
 import type { KYCOpenAccountRequirements } from "../market/kyc/index.js";
 import type { Asset, RouterCASlice, RouterCloseResult } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
@@ -427,6 +427,15 @@ export interface OpenCAProps extends PrepareUpdateQuotasProps {
      * Referral code to open credit account with
      */
     referralCode: bigint;
+    /**
+     * KYC options to open credit account with, required for KYC factories
+     * First we ask for getOpenAccountRequirements,
+     * then perform necessary actions (e.g. for Securitize, convert requiredSignatures to signaturesToCache)
+     * to produce KYCOperationParams
+     * If getOpenAccountRequirements returned undefined, we need to pass undefined here too;
+     * It means that no KYC actions are required (e.g. when we open second credit account)
+     */
+    kycOptions?: KYCOperationParams;
 }
 export interface ChangeDeptProps {
     /**

package/dist/types/sdk/market/kyc/securitize/SecuritizeKYCFactory.d.ts

@@ -415,7 +415,7 @@ export declare class SecuritizeKYCFactory extends BaseContract<abi> implements I
     /**
      * {@inheritDoc IKYCFactory.multicall}
      */
-    multicall(creditAccount: Address, calls: MultiCall[], options: SecuritizeOperationParams): RawTx;
+    multicall(creditAccount: Address, calls: MultiCall[], options?: SecuritizeOperationParams): RawTx;
     /**
      * {@inheritDoc IKYCFactory.getOpenAccountRequirements}
      */
@@ -423,7 +423,7 @@ export declare class SecuritizeKYCFactory extends BaseContract<abi> implements I
     /**
      * {@inheritDoc IKYCFactory.openCreditAccount}
      */
-    openCreditAccount(creditManager: Address, calls: MultiCall[], options: SecuritizeOperationParams): RawTx;
+    openCreditAccount(creditManager: Address, calls: MultiCall[], options?: SecuritizeOperationParams): RawTx;
     stateHuman(_raw?: boolean): SecuritizeKYCFactoryStateHuman;
 }
 export {};

package/dist/types/sdk/market/kyc/types.d.ts

@@ -134,9 +134,9 @@ export interface IKYCFactory<T extends KYCFactoryType = KYCFactoryType> extends
      * @param creditAccount - credit account address
      * @param calls - calls to perform
      * @param options - factory-specific parameters (e.g. tokens to
-     *   register, signatures to cache).
+     *   register, signatures to cache). Undefined value means that no KYC actions are required
      **/
-    multicall(creditAccount: Address, calls: MultiCall[], options: KYCOperationParams<T>): RawTx;
+    multicall(creditAccount: Address, calls: MultiCall[], options?: KYCOperationParams<T>): RawTx;
     /**
      * Checks if the user can open a credit account with this factory.
      * @param investor - investor address
@@ -153,8 +153,9 @@ export interface IKYCFactory<T extends KYCFactoryType = KYCFactoryType> extends
      * @param calls - initial calls to perform
      * @param options - factory-specific parameters (e.g. tokens to
      *   register, signatures to cache).
+     * Undefined value means that no KYC actions are required (e.g. when we open second credit account)
      **/
-    openCreditAccount(creditManager: Address, calls: MultiCall[], options: KYCOperationParams<T>): RawTx;
+    openCreditAccount(creditManager: Address, calls: MultiCall[], options?: KYCOperationParams<T>): RawTx;
 }
 /**
  * Narrows an {@link IKYCFactory} to a specific factory type.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "13.7.0-kyc.5",
+  "version": "13.7.0-kyc.7",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",