@gearbox-protocol/sdk 13.6.0-kyc.6 → 13.6.0

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

@@ -1,420 +0,0 @@
-import { type Address } from "viem";
-import { BaseContract } from "../../../base/index.js";
-import type { GearboxSDK } from "../../../GearboxSDK.js";
-import type { MultiCall, RawTx } from "../../../types/index.js";
-import type { DStokenData, IKYCFactory, KYCCompressorInvestorData, KYCFactoryData } from "../types.js";
-import type { SecuritizeInvestorData, SecuritizeKYCFactoryStateHuman, SecuritizeOpenAccountRequirements, SecuritizeRegisterMessage } 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<SecuritizeInvestorData, SecuritizeOpenAccountRequirements> {
-    #private;
-    readonly degenNFT: Address;
-    readonly owner: Address;
-    readonly dsTokens: DStokenData[];
-    constructor(sdk: GearboxSDK, data: KYCFactoryData);
-    /**
-     * {@inheritDoc IKYCFactory.decodeInvestorData}
-     */
-    decodeInvestorData(data: KYCCompressorInvestorData): SecuritizeInvestorData;
-    /**
-     * {@inheritDoc IKYCFactory.getInvestor}
-     */
-    getInvestor(creditAccount: Address, fromCache?: boolean): Promise<Address>;
-    /**
-     * {@inheritDoc IKYCFactory.precomputeWalletAddress}
-     */
-    precomputeWalletAddress(creditManager: Address, investor: Address): Promise<Address>;
-    /**
-     * {@inheritDoc IKYCFactory.getWallet}
-     */
-    getWallet(creditAccount: Address): Promise<Address>;
-    /**
-     * {@inheritDoc IKYCFactory.multicall}
-     */
-    multicall(creditAccount: Address, calls: MultiCall[], tokensToRegister: Address[], signaturesToCache: SecuritizeRegisterMessage[]): RawTx;
-    /**
-     * {@inheritDoc IKYCFactory.getOpenAccountRequirements}
-     */
-    getOpenAccountRequirements(investor: Address): Promise<SecuritizeOpenAccountRequirements | undefined>;
-    /**
-     * {@inheritDoc IKYCFactory.openCreditAccount}
-     */
-    openCreditAccount(creditManager: Address, calls: MultiCall[], tokensToRegister: Address[], signaturesToCache: SecuritizeRegisterMessage[]): RawTx;
-    stateHuman(_raw?: boolean): SecuritizeKYCFactoryStateHuman;
-}
-export {};

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

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

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

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

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

@@ -1,107 +0,0 @@
-import type { Address, Hex } from "viem";
-import type { BaseContractStateHuman } from "../../../types/index.js";
-import type { OpenAccountRequirements } from "../types.js";
-import type { KYC_FACTORY_SECURITIZE } from "./constants.js";
-/**
- * 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 {
-    /** 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[];
-    }[];
-}
-export interface SecuritizeOpenAccountRequirements extends OpenAccountRequirements {
-    type: typeof KYC_FACTORY_SECURITIZE;
-    /**
-     * User must visit securitize website to register these tokens
-     */
-    tokensToRegister: Address[];
-    /**
-     * User must sign these messages to gearbox and provide EIP-712 signatures
-     * as {@link SecuritizeRegisterMessage} to gearbox
-     */
-    requiredSignatures: SecuritizeRegisterVaultMessage[];
-}

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

@@ -1,136 +0,0 @@
-import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
-import type { Address, ContractFunctionParameters } from "viem";
-import type { iKYCCompressorAbi } from "../../../abi/kyc/iKYCCompressor.js";
-import type { IBaseContract, Unarray } from "../../base/index.js";
-import type { MultiCall, RawTx } from "../../types/index.js";
-import type { SecuritizeInvestorData, SecuritizeKYCFactoryStateHuman, SecuritizeRegisterMessage } from "./securitize/types.js";
-/**
- * Discriminated union of all known KYC factory contract type strings.
- **/
-export declare const KYC_FACTORY_TYPES: readonly ["KYC_FACTORY::SECURITIZE"];
-/**
- * String literal union of known KYC factory types.
- **/
-export type KYCFactoryType = (typeof KYC_FACTORY_TYPES)[number];
-/**
- * Raw return type of `KYCCompressor.getKYCMarketsData`.
- **/
-export type KYCCompressorResponse = AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCMarketsData">["outputs"]>;
-/**
- * On-chain state of a KYC underlying token.
- **/
-export type KYCUnderlyingData = Unarray<KYCCompressorResponse[0]>;
-/**
- * On-chain state of a KYC factory.
- **/
-export type KYCFactoryData = Unarray<KYCCompressorResponse[1]>;
-/**
- * Typed contract call parameters for `KYCCompressor.getKYCMarketsData`.
- **/
-export type KYCCompressorCall = ContractFunctionParameters<typeof iKYCCompressorAbi, "view", "getKYCMarketsData">;
-/**
- * Single element of the `KYCCompressor.getKYCInvestorData` return array.
- * Contains per-factory credit accounts and factory-specific extra details.
- **/
-export type KYCCompressorInvestorData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCInvestorData">["outputs"]>[0]>;
-/**
- * Full KYC compressor response, used as the persisted/hydrated state.
- **/
-export type KYCState = KYCCompressorResponse;
-/**
- * Decoded DSToken data from the SecuritizeDegenNFT contract.
- * Mirrors `ISecuritizeDegenNFT.DSTokenData`.
- **/
-export interface DStokenData {
-    /** DSToken address. */
-    address: Address;
-    /** Securitize VaultRegistrar for this token. */
-    registrar: Address;
-    /** Addresses authorised to register vaults for this token. */
-    operators: Address[];
-}
-/**
- * Investor data decoded from the KYC compressor.
- **/
-export type InvestorData = SecuritizeInvestorData;
-/**
- * Human-readable KYC factory state.
- **/
-export type KYCFactoryStateHuman = SecuritizeKYCFactoryStateHuman;
-/**
- * Human-readable snapshot of the full KYC registry state.
- **/
-export interface KYCStateHuman {
-    /** State of each loaded KYC factory. */
-    factories: KYCFactoryStateHuman[];
-}
-/**
- * Base type returned by {@link IKYCFactory.getOpenAccountRequirements} when an
- * investor needs to perform additional steps before opening a credit account.
- * Each KYC factory implementation extends this with factory-specific fields
- * (e.g. tokens to register, signatures to provide).
- *
- **/
-export interface OpenAccountRequirements {
-    /**
-     * Discriminant identifying which KYC factory produced these requirements.
-     */
-    type: KYCFactoryType;
-}
-export interface IKYCFactory<TInvestorData, TOpenAccountRequirements extends OpenAccountRequirements> extends IBaseContract {
-    /**
-     * @internal
-     *
-     * Compressor provider encoded extra details for investor data
-     * Each factory knows how to decode its own extra details
-     *
-     * @param data raw KYCCompressor InvestorData
-     */
-    decodeInvestorData(data: KYCCompressorInvestorData): TInvestorData;
-    /**
-     * Returns the investor address for a credit account.
-     * @param creditAccount credit account address
-     * @param fromCache if true, use and update an in-memory cache (creditAccount -> investor). On cache miss, loads from contract and stores the result for future calls.
-     */
-    getInvestor(creditAccount: Address, fromCache?: boolean): Promise<Address>;
-    /**
-     * Precomputes the wallet address for a credit account.
-     * TODO: this is securitize-specific, but until there is no other KYC factory, we will keep it here
-     * @param creditManager credit manager address
-     * @param investor investor address
-     */
-    precomputeWalletAddress(creditManager: Address, investor: Address): Promise<Address>;
-    /**
-     * Returns the wallet address for a credit account.
-     * Wallet is a smart contract that owns the credit account, and
-     * it is different from the investor address (actual user)
-     * @param creditAccount credit account address
-     */
-    getWallet(creditAccount: Address): Promise<Address>;
-    /**
-     * Creates a raw transaction to perform operations on a credit account.
-     * Similar to {@link CreditFacadeV310Contract.multicall}
-     *
-     * @param creditAccount credit account address
-     * @param calls calls to perform
-     * @param tokensToRegister - TODO: this is securitize-specific, but until there is no other KYC factory, we will keep it here
-     * @param signaturesToCache - TODO: this is securitize-specific, but until there is no other KYC factory, we will keep it here
-     */
-    multicall(creditAccount: Address, calls: MultiCall[], tokensToRegister: Address[], signaturesToCache: SecuritizeRegisterMessage[]): RawTx;
-    /**
-     * Checks if the user can open a credit account with this factory.
-     * TODO: there should be one more parameter with desired strategy - e.g. tokensToRegister for securitize
-     * @param investor investor address
-     * @returns open account requirements for the investor or undefined if the user can open a credit account without any further actions
-     */
-    getOpenAccountRequirements(investor: Address): Promise<TOpenAccountRequirements | undefined>;
-    /**
-     * Creates a raw transaction to open a credit account.
-     * Similar to {@link CreditFacadeV310Contract.openCreditAccount}
-     * @param creditManager credit manager address
-     * @param calls initial calls to perform
-     * @param tokensToRegister - TODO: this is securitize-specific, but until there is no other KYC factory, we will keep it here
-     * @param signaturesToCache - TODO: this is securitize-specific, but until there is no other KYC factory, we will keep it here
-     */
-    openCreditAccount(creditManager: Address, calls: MultiCall[], tokensToRegister: Address[], signaturesToCache: SecuritizeRegisterMessage[]): RawTx;
-}