@gearbox-protocol/sdk 14.0.0 → 14.1.0

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

@@ -0,0 +1,429 @@
+import { type Address } from "viem";
+import type { GetOpenAccountRequirementsProps } from "../../../accounts/types.js";
+import { BaseContract } from "../../../base/index.js";
+import type { OnchainSDK } from "../../../OnchainSDK.js";
+import type { MultiCall, RawTx } from "../../../types/index.js";
+import type { IKYCFactory, KYCCompressorInvestorData, KYCFactoryData } from "../types.js";
+import { KYC_FACTORY_SECURITIZE } from "./constants.js";
+import type { DStokenData, SecuritizeInvestorData, SecuritizeKYCFactoryStateHuman, SecuritizeOpenAccountRequirements, SecuritizeOperationParams } from "./types.js";
+declare const abi: 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: "getCreditAccounts";
+    readonly inputs: readonly [{
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getDegenNFT";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        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: "isFrozen";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        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: "multicall";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "signaturesToCache";
+        readonly type: "tuple[]";
+        readonly internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "signature";
+            readonly type: "tuple";
+            readonly internalType: "struct ISecuritizeDegenNFT.Signature";
+            readonly components: readonly [{
+                readonly name: "deadline";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "signature";
+                readonly type: "bytes";
+                readonly internalType: "bytes";
+            }];
+        }];
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "openCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "signaturesToCache";
+        readonly type: "tuple[]";
+        readonly internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "signature";
+            readonly type: "tuple";
+            readonly internalType: "struct ISecuritizeDegenNFT.Signature";
+            readonly components: readonly [{
+                readonly name: "deadline";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "signature";
+                readonly type: "bytes";
+                readonly internalType: "bytes";
+            }];
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "precomputeWalletAddress";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "serialize";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    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: "event";
+    readonly name: "CreateWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly indexed: false;
+        readonly internalType: "bool";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "oldInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "CallerIsNotInvestorException";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "FrozenCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidCreditManagerException";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidUnderlyingTokenException";
+    readonly inputs: readonly [{
+        readonly name: "underlying";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "UnknownCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ZeroAddressException";
+    readonly inputs: readonly [];
+}];
+type abi = typeof abi;
+export declare class SecuritizeKYCFactory extends BaseContract<abi> implements IKYCFactory<typeof KYC_FACTORY_SECURITIZE> {
+    #private;
+    readonly degenNFT: Address;
+    readonly owner: Address;
+    readonly dsTokens: DStokenData[];
+    readonly contractType = "KYC_FACTORY::SECURITIZE";
+    constructor(sdk: OnchainSDK, data: KYCFactoryData);
+    /**
+     * {@inheritDoc IKYCFactory.decodeInvestorData}
+     */
+    decodeInvestorData(data: KYCCompressorInvestorData): SecuritizeInvestorData;
+    /**
+     * {@inheritDoc IKYCFactory.getInvestor}
+     */
+    getInvestor(creditAccount: Address, fromCache?: boolean): Promise<Address>;
+    /**
+     * {@inheritDoc IKYCFactory.getApprovalAddress}
+     */
+    getApprovalAddress(options: {
+        creditManager: Address;
+        borrower: Address;
+    } | {
+        creditManager: Address;
+        creditAccount: Address;
+    }): Promise<Address>;
+    /**
+     * {@inheritDoc IKYCFactory.getWallet}
+     */
+    getWallet(creditAccount: Address): Promise<Address>;
+    /**
+     * {@inheritDoc IKYCFactory.multicall}
+     */
+    multicall(creditAccount: Address, calls: MultiCall[], options?: SecuritizeOperationParams): RawTx;
+    /**
+     * {@inheritDoc IKYCFactory.getOpenAccountRequirements}
+     */
+    getOpenAccountRequirements(investor: Address, props: GetOpenAccountRequirementsProps): Promise<SecuritizeOpenAccountRequirements | undefined>;
+    /**
+     * {@inheritDoc IKYCFactory.openCreditAccount}
+     */
+    openCreditAccount(creditManager: Address, calls: MultiCall[], options?: SecuritizeOperationParams): RawTx;
+    stateHuman(_raw?: boolean): SecuritizeKYCFactoryStateHuman;
+}
+export {};

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

@@ -0,0 +1 @@
+export declare const KYC_FACTORY_SECURITIZE = "KYC_FACTORY::SECURITIZE";

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

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

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

@@ -0,0 +1,136 @@
+import type { Address, Hex } from "viem";
+import type { BaseContractStateHuman } from "../../../types/index.js";
+import type { KYC_FACTORY_SECURITIZE } from "./constants.js";
+/**
+ * On-chain data about Securitize DSTokens
+ **/
+export interface DStokenData {
+    /** DSToken address. */
+    address: Address;
+    /** Securitize VaultRegistrar for this token. */
+    registrar: Address;
+    /** Addresses authorised to register vaults for this token. */
+    operators: Address[];
+}
+/**
+ * Cached registration signature for a single DSToken, stored in the
+ * @see SecuritizeDegenNFT in https://github.com/Gearbox-protocol/periphery-v3
+ *
+ **/
+export interface SecuritizeRegisterMessage {
+    /** DSToken address the signature authorises. */
+    token: Address;
+    /** EIP-712 deadline + raw signature bytes. */
+    signature: SecuritizeSignature;
+}
+/**
+ * Deadline-bound EIP-712 signature produced by the investor.
+ *
+ **/
+export interface SecuritizeSignature {
+    /** Unix timestamp after which the signature is no longer valid. */
+    deadline: bigint;
+    /** Raw EIP-712 signature bytes. */
+    signature: Hex;
+}
+/**
+ * EIP-712 typed-data message that must be signed by the investor to allow the
+ * KYC factory to register a credit account as a vault in Securitize's VaultRegistrar
+ * @see VaultRegistrar in https://github.com/Gearbox-protocol/periphery-v3
+ *
+ **/
+export interface SecuritizeRegisterVaultMessage {
+    /** EIP-712 domain from the VaultRegistrar contract. */
+    domain: {
+        name: string;
+        version: string;
+        chainId: bigint;
+        verifyingContract: Address;
+    };
+    /** Investor EOA that will sign the message. */
+    investor: Address;
+    /** Operator address (the DegenNFT contract). */
+    operator: Address;
+    /** DSToken address to register for. */
+    token: Address;
+    /** Monotonic nonce from VaultRegistrar (investor, operator). */
+    nonce: bigint;
+    /** Unix timestamp after which the message is no longer valid. */
+    deadline: bigint;
+}
+/**
+ * Per-credit-account data decoded from the KYC compressor's
+ * `getCreditAccountData` extra details for a Securitize factory.
+ **/
+export interface SecuritizeCreditAccountData {
+    /** Credit account address. */
+    creditAccount: Address;
+    /** SecuritizeWallet proxy that owns the credit account. */
+    wallet: Address;
+    /** Whether the Securitize admin has frozen this account. */
+    frozen: boolean;
+    /** DSToken addresses where this credit account is registered as a vault. */
+    registeredTokens: Address[];
+}
+/**
+ * Investor-level data decoded from the KYC compressor's `getKYCInvestorData`
+ * extra details for a Securitize factory.
+ **/
+export interface SecuritizeInvestorData {
+    type: typeof KYC_FACTORY_SECURITIZE;
+    /** Securitize KYC factory address that produced this data. */
+    factory: Address;
+    /** Credit accounts owned by the investor through this factory. */
+    creditAccounts: SecuritizeCreditAccountData[];
+    /** DSToken addresses where the investor is already registered. */
+    registeredTokens: Address[];
+    /** Cached signatures still valid and reusable for registration. */
+    cachedSignatures: SecuritizeRegisterMessage[];
+    /** EIP-712 messages the investor must sign to register new vaults. */
+    registerVaultMessages: SecuritizeRegisterVaultMessage[];
+}
+/**
+ * Human-readable serialisation of {@link SecuritizeKYCFactory} state.
+ **/
+export interface SecuritizeKYCFactoryStateHuman extends BaseContractStateHuman {
+    owner: string;
+    degenNFT: string;
+    dsTokens: {
+        addr: string;
+        symbol: string;
+        name: string;
+        decimals: number;
+        registrar: string;
+        operators: string[];
+    }[];
+}
+/**
+ * Factory-specific parameters for {@link SecuritizeKYCFactory.multicall}
+ * and {@link SecuritizeKYCFactory.openCreditAccount}.
+ **/
+export interface SecuritizeOperationParams {
+    type: typeof KYC_FACTORY_SECURITIZE;
+    /** DSToken addresses to register for this operation. */
+    tokensToRegister: Address[];
+    /** Cached EIP-712 registration signatures to store on-chain. */
+    signaturesToCache: SecuritizeRegisterMessage[];
+}
+export interface SecuritizeOpenAccountRequirements {
+    type: typeof KYC_FACTORY_SECURITIZE;
+    /**
+     * User must visit securitize website to register these tokens
+     * May be empty if user already registered all required tokens
+     */
+    securitizeTokensToRegister: Address[];
+    /**
+     * Desired tokens to register for this operation, must be always present on open credit account
+     * Come from strategy configuration
+     * Passed to openCreditAccount contract call on securitize factory
+     */
+    tokensToRegister: Address[];
+    /**
+     * User must sign these messages to gearbox and provide EIP-712 signatures
+     * as {@link SecuritizeRegisterMessage} to gearbox
+     */
+    requiredSignatures: SecuritizeRegisterVaultMessage[];
+}