@hinkal/common 0.2.10 → 0.2.11

package/types/ethereum-network.types.d.mts

@@ -0,0 +1,142 @@
+import { ContractInterface } from 'ethers';
+export type ContractMetadata = {
+    abi?: ContractInterface;
+    address?: string;
+};
+export declare enum ContractType {
+    HinkalContract = 0,
+    HinkalHelperContract = 1,
+    CrossChainAccessTokenContract = 2,
+    CrossChainAccessTokenManagerContract = 3,
+    UniswapV3FactoryContract = 4,
+    UniswapV3PoolContract = 5,
+    UniswapV3QuoterContract = 6,
+    ERC20Contract = 7,
+    WATokenContract = 8,
+    OneInchExternalActionContract = 9,
+    MerkleTreeContract = 10,
+    ContractWithNonces = 11,
+    PermitterContract = 12,
+    CurveWrappedMainPool = 13,
+    CurveReadingWrapper = 14,
+    CurvePoolLPTokenAmountCalculator2 = 15,
+    CurvePoolLPTokenAmountCalculator3 = 16,
+    CurvePoolLPTokenAmountCalculator4 = 17,
+    CurvePoolLPTokenAmountCalculatorDynamic = 18,
+    CurvePoolLPTokenAmountCalculator2OneArg = 19,
+    CurvePoolLPTokenAmountCalculator3OneArg = 20,
+    CurvePoolLPTokenAmountCalculator4OneArg = 21,
+    CurvePoolWithIntCoins = 22,
+    CurveExternalAction = 23,
+    WrappedStakedCurveLp = 24,
+    WrappedStakedRewardsCurveLp = 25,
+    CurveGauge = 26,
+    ConvexBooster = 27,
+    ConvexBoosterMainnet = 28,
+    ConvexRewardPool = 29,
+    ConvexCvxLocker = 30,
+    ConvexStakePool = 31,
+    ConvexCvxCRVWrapper = 32,
+    ConvexCxvCrvUtillities = 33,
+    ConvexExternalAction = 34,
+    WrappedStakedConvexLp = 35,
+    CurvePoolWithIntBalances = 36,
+    CurveZaps = 37,
+    BeefyVault = 38,
+    BeefyZap = 39,
+    BeefyRouter = 40,
+    BeefyZapOneInch = 41,
+    BeefyExternalAction = 42,
+    BeefyStakeExternalAction = 43,
+    BeefyStrategy = 44,
+    WrappedStakedBeefyLp = 45,
+    UniswapV2PoolContract = 46,
+    LidoWstEther = 47,
+    LidoStEther = 48,
+    LidoStMatic = 49,
+    LidoWithdrawalQueueERC721 = 50,
+    LidoStakeManager = 51,
+    PoLidoNFT = 52,
+    PendleGeneralExternalAction = 53,
+    PendleRouter = 54,
+    WstPendleLPToken = 55,
+    WstYtToken = 56,
+    VolatileVault = 57,
+    VolatileTokenAction = 58,
+    HinkalWrapper = 59,
+    HinkalWrapper2 = 60,
+    HinkalStakeExternalAction = 61,
+    HToken = 62
+}
+export interface ContractData {
+    hinkalAddress: string;
+    hinkalABI: ContractInterface;
+    hinkalHelperAddress?: string;
+    hinkalHelperABI?: ContractInterface;
+    crossChainAccessTokenAddress?: string;
+    crossChainAccessTokenABI?: ContractInterface;
+    crossChainAccessTokenManagerAddress?: string;
+    crossChainAccessTokenManagerABI?: ContractInterface;
+    permitterAddress?: string;
+    permitterABI?: ContractInterface;
+    uniswapExternalActionAddress?: string;
+    odosExternalActionInstanceAddress?: string;
+    oneInchExternalActionInstanceAddress?: string;
+    waTokenABI?: ContractInterface;
+    curveWrappedMainPoolAbi?: ContractInterface;
+    curveReadingWrapperAbi?: ContractInterface;
+    CurvePoolWithIntCoins?: ContractInterface;
+    curveExternalActionInstanceAddress?: string;
+    curveExternalActionABI?: ContractInterface;
+    curveExternalActionDynamicInstanceAddress?: string;
+    curveStakeExternalActionInstanceAddress?: string;
+    curveExternalActionDynamicABI?: ContractInterface;
+    wrappedStakedCurveLpABI?: ContractInterface;
+    wrappedStrakedRewardsCurveLpABI?: ContractInterface;
+    convexExternalActionInstanceAddress?: string;
+    convexExternalActionABI?: ContractInterface;
+    wrappedStakedConvexLpABI?: ContractInterface;
+    beefyExternalActionInstanceAddress?: string;
+    beefyStakeExternalActionInstanceAddress?: string;
+    BeefyExternalActionABI?: ContractInterface;
+    BeefyStakeExternalActionABI?: ContractInterface;
+    WrappedStakedBeefyLpABI: ContractInterface;
+    lidoExternalActionEthAddress?: string;
+    lidoExternalActionMaticAddress?: string;
+    pendleExternalActionABI?: ContractInterface;
+    pendleExternalActionInstanceAddress?: string;
+    pendleLPExternalActionABI?: ContractInterface;
+    pendleLPExternalActionInstanceAddress?: string;
+    WstYtTokenABI?: ContractInterface;
+    volatileVaultInstanceAddress?: string;
+    VolatileVaultABI?: ContractInterface;
+    volatileTokenActionInstanceAddress?: string;
+    VolatileTokenActionABI?: ContractInterface;
+    hinkalWrapperAddress?: string;
+    hinkalWrapper2Address?: string;
+    HinkalWrapperABI?: ContractInterface;
+    HinkalWrapper2ABI?: ContractInterface;
+    WstPendleLPABI?: ContractInterface;
+    hinkalStakeExternalActionAddress?: string;
+    HinkalStakeExternalActionABI?: ContractInterface;
+    HTokenABI?: ContractInterface;
+    hETHOracleAddress?: string;
+    HTokenOracleABI?: ContractInterface;
+    emporiumAddress?: string;
+}
+export interface EthereumNetwork {
+    name: string;
+    chainId: number;
+    rpcUrl: string;
+    maxPageSize?: number;
+    fetchRpcUrl?: string;
+    privateMempoolRpcUrl?: string;
+    contractData: ContractData;
+    supported?: boolean;
+    quoterV2Address?: string;
+    uniswapV3FactoryAddress?: string;
+    accessTokenMintingFee?: string;
+    pollingInterval?: number;
+    gasStationUrl?: string;
+    priority?: number;
+}

package/types/external-action.types.d.mts

@@ -0,0 +1,28 @@
+export declare enum ExternalActionId {
+    Transact = "Transact",
+    Uniswap = "Uniswap",
+    Odos = "Odos",
+    OneInch = "OneInch",
+    Curve = "Curve",
+    CurveDynamic = "CurveDynamic",
+    CurveCRV = "CurveCRV",
+    CurveCRVRewards = "CurveCRVRewards",
+    Convex = "Convex",
+    Beefy = "Beefy",
+    BeefyStake = "BeefyStake",
+    Volatile = "Volatile",
+    LidoETH = "LidoETH",
+    LidoMATIC = "LidoMATIC",
+    LidoETHNFT = "LidoETHNFT",
+    LidoMATICNFT = "LidoMATICNFT",
+    Pendle = "Pendle",
+    PendleLP = "PendleLP",
+    HinkalStake = "HinkalStake",
+    Connext = "Connext",
+    Emporium = "Emporium"
+}
+export interface ExternalActionData {
+    externalActionId: 0n | ExternalActionId;
+    externalAddress: string;
+    externalActionMetadata: string;
+}

package/types/hinkal.stake.types.d.mts

@@ -0,0 +1,11 @@
+export declare enum HinkalStakeMode {
+    Deposit = "Deposit",
+    Stake = "Stake",
+    Unstake = "Unstake"
+}
+export interface StakeArgs {
+    mode: HinkalStakeMode;
+    stakedTokenRecipient: string;
+    stakeBlinding: bigint;
+    depositorAddress: string;
+}

package/types/hinkal.types.d.mts

@@ -0,0 +1,150 @@
+import { ExternalActionId } from './external-action.types';
+/**
+ * Configuration options for the Hinkal system.
+ */
+export type HinkalConfig = {
+    /**
+     * Path to the cache file used for storing temporary data.
+     * It should be a valid file path string.
+     */
+    cacheFilePath?: string;
+    /**
+     * Indicator to use caching on a file level.
+     * Node only.
+     */
+    useFileCache?: boolean;
+    /**
+     * Indicator controlling wether the proof should be constructed remotely in secure enclave.
+     */
+    generateProofRemotely?: boolean;
+};
+export declare enum EventType {
+    BalanceChange = "BalanceChange",
+    NetworkChange = "NetworkChange",
+    KycNeeded = "KycNeeded",
+    AccountChanged = "AccountChanged",
+    ShowConnect = "ShowConnect",
+    ShowNetworkPopup = "ShowNetworkPopup",
+    MerkleTreeUpdated = "MerkleTreeUpdated",
+    MerkleTreeResetStarted = "MerkleTreeResetStarted",
+    MerkleTreeResetFinished = "MerkleTreeResetFinished"
+}
+export declare enum IntegrationProvider {
+    UNISWAP = 1,
+    ODOS = 2,
+    ONEINCH = 3,
+    PENDLE = 4,
+    ALL = 5,
+    NONE = 6
+}
+export declare enum StakeProvider {
+    CurveAavePool = 0
+}
+export declare enum CurveAction {
+    Deposit = 0,
+    WithdrawInt = 11,// case of int
+    WithdrawUint = 12,// case of uint
+    WithdrawImbalance = 13,
+    Stake = 2,
+    Unstake = 3,
+    GetCRV = 4
+}
+export declare enum ConvexAction {
+    StakeLP = 0,
+    UnStakeLP = 1,
+    ClaimRewardsLP = 2
+}
+export declare enum BeefyAction {
+    Deposit = 0,
+    DepositRegular = 1,
+    DepositOneInchSingle = 2,
+    DepositOneInchUniswap = 3,
+    DepositOneInchSolidly = 4,
+    Withdraw = 5,
+    WithdrawRegular = 6,
+    WithdrawOneInchSingle = 7,
+    WithdrawOneInchUniswapAndSolidly = 8,
+    WithdrawBoth = 9,
+    Stake = 10,
+    Unstake = 11,
+    GetRewards = 12
+}
+export declare enum LidoVariant {
+    Ethereum = "Ethereum",
+    Polygon = "Polygon"
+}
+export declare enum LidoAction {
+    Stake = 0,
+    Request = 1,
+    Claim = 2
+}
+export declare enum PendleAction {
+    Deposit = 0,
+    Withdraw = 1,
+    SwapFromYt = 2,
+    SwapToYt = 3,
+    SwapPt = 4,
+    Mint = 5,
+    Redeem = 6,
+    Checkpoint = 7,
+    PoolRemove = 8
+}
+export declare enum PendleLPAction {
+    AddOrRemoveLiquidity = 0,
+    Checkpoint = 1,
+    Invalid = 99
+}
+export declare enum VolatileAction {
+    Persist = 0,
+    Deposit = 1,
+    Withdraw = 2,
+    Swap = 3
+}
+export declare enum HinkalStakeAction {
+    DepositOrStake = 0,
+    Unstake = 1
+}
+export type VolatileHelperData = {
+    action: VolatileAction;
+    isRelayerOff?: boolean;
+    recipientAddress?: string;
+    baseExternalActionMetadata?: string;
+    baseExternalActionId?: ExternalActionId;
+};
+export type ValidExternalAction = CurveAction | ConvexAction | BeefyAction | LidoAction | PendleAction | VolatileAction | PendleLPAction;
+export declare enum INTERACTION {
+    WITHDRAW = "WITHDRAW",
+    SWAP = "SWAP",
+    CURVE_DEPOSIT = "CURVE_DEPOSIT",
+    CURVE_WITHDRAW = "CURVE_WITHDRAW",
+    CURVE_WITHDRAW_INBALANCED = "CURVE_WITHDRAW_INBALANCED",
+    STAKING = "STAKING",
+    UNSTAKING = "UNSTAKING",
+    CLAIMING = "CLAIMING",
+    BEEFY = "BEEFY",
+    BEEFY_STAKE = "BEEFY_STAKE",
+    BEEFY_UNSTAKE = "BEEFY_UNSTAKE",
+    BEEFY_GET_REWARDS = "BEEFY_GET_REWARDS",
+    LIDO_STAKE = "LIDO_STAKE",
+    LIDO_REQUEST = "LIDO_REQUEST",
+    LIDO_CLAIM = "LIDO_CLAIM",
+    PENDLE_TRANSACT = "PENDLE_TRANSACT",
+    PENDLE_YT_IN_SWAP = "PENDLE_YT_IN_SWAP",
+    PENDLE_YT_OUT_SWAP = "PENDLE_YT_OUT_SWAP",
+    PENDLE_PT_SWAP = "PENDLE_PT_SWAP",
+    PENDLE_MINT = "PENDLE_MINT",
+    PENDLE_REDEEM = "PENDLE_REDEEM",
+    PENDLE_CLAIM = "PENDLE_CLAIM",
+    PENDLE_LP = "PENDLE_LP",
+    PENDLE_LP_CLAIM = "PENDLE_LP_CLAIM",
+    VOLATILE_WITHDRAW = "VOLATILE_WITHDRAW",
+    VOLATILE_SWAP = "VOLATILE_SWAP",
+    EMPORIUM = "EMPORIUM",
+    NONE = "NONE"
+}
+export declare enum UserProgress {
+    NOT_STARTED = 0,
+    CONNECTED = 1,
+    KYC = 2,
+    COMPLETED = 3
+}

package/types/hinkalTvl.types.d.mts

@@ -0,0 +1,4 @@
+export interface ITvlData {
+    value: number;
+    date: number;
+}

package/types/index.d.mts

@@ -0,0 +1,27 @@
+export * from './API.types';
+export * from './axelar.types';
+export * from './beefy.types';
+export * from './big-intable.types';
+export * from './circom-data.types';
+export * from './commitments.types';
+export * from './IMultiThreadedUtxoUtils';
+export * from './crypto.types';
+export * from './ethereum-network.types';
+export * from './external-action.types';
+export * from './hinkal.types';
+export * from './kyc.types';
+export * from './relayer.types';
+export * from './snark.types';
+export * from './token.types';
+export * from './slippage.types';
+export * from './transactions.types';
+export * from './time.types';
+export * from './rewards.types';
+export * from './pendle.types';
+export * from './pendle.api.types';
+export * from './curve.types';
+export * from './hinkal.stake.types';
+export * from './duneAPI.types';
+export * from './admin.types';
+export * from './ICacheDevice';
+export * from './hinkalTvl.types';

package/types/kyc.types.d.mts

@@ -0,0 +1,39 @@
+export declare enum VERIFICATION_TYPE {
+    USER = "USER",
+    BUSINESS = "BUSINESS"
+}
+export declare const VerificationTypes: VERIFICATION_TYPE[];
+export declare enum Passports {
+    AiPriseKyc = 0,
+    AiPriseKyb = 1,
+    BABPassport = 2,
+    GalxePassport = 3,
+    ZkMePassport = 4,
+    CoinbasePassport = 5,
+    AuthentoPassport = 6,
+    AuthentoPassportKyb = 7,
+    ReclaimCoinbasePassport = 8,
+    ReclaimBNBPassport = 9,
+    ReclaimOKXPassport = 10,
+    ReclaimGatePassport = 11,
+    ReclaimKucoinPassport = 12,
+    ReclaimMexcPassport = 13,
+    ReclaimHtxPassport = 14
+}
+export declare enum KycVerificationResult {
+    APPROVED = "APPROVED",// The user is verified. The verification process successfully completed.
+    DECLINED = "DECLINED",// The user is not verified. The verification process successfully completed.
+    REVIEW = "REVIEW",// The end user or business needs to be manually looked at. The verification process successfully completed.
+    UNKNOWN = "UNKNOWN"
+}
+export declare enum KycVerificationStatus {
+    COMPLETED = "COMPLETED",// The verification process successfully completed.
+    FAILED = "FAILED",// The verification process failed. status_reasons(explained below) should have more details.
+    PENDING = "PENDING",// The verification process is waiting for a third-party API to complete its processing.
+    RUNNING = "RUNNING",// The verification process is running.
+    NOT_STARTED = "NOT_STARTED"
+}
+export interface VerificationData {
+    verificationResult: KycVerificationResult;
+    verificationStatus: KycVerificationStatus;
+}

package/types/pendle.api.types.d.mts

@@ -0,0 +1,233 @@
+import { PendleMarket, PendleSwapType } from './pendle.types';
+import { ERC20Token } from './token.types';
+export type PendleAPIMarket = {
+    id: string;
+    chainId: number;
+    address: string;
+    name: string;
+    symbol: string;
+    expiry: Date;
+    pt: PendleAPIAsset;
+    yt: PendleAPIAsset;
+    sy: PendleAPIAsset;
+    lp: PendleAPIAsset;
+    accountingAsset: PendleAPIAsset;
+    underlyingAsset: PendleAPIAsset;
+    basePricingAsset: PendleAPIAsset;
+    rewardTokens: PendleAPIAsset[] | undefined;
+    inputTokens: PendleAPIAsset[] | undefined;
+    outputTokens: PendleAPIAsset[] | undefined;
+    protocol: string;
+    underlyingPool: string;
+    simpleName: string;
+    simpleSymbol: string;
+    simpleIcon: string;
+    proName: string;
+    proSymbol: string;
+    proIcon: string;
+    farmName: string;
+    farmSymbol: string;
+    farmSimpleName: string;
+    farmSimpleSymbol: string;
+    farmSimpleIcon: string;
+    farmProName: string;
+    farmProSymbol: string;
+    farmProIcon: string;
+    assetRepresentation: string;
+    isWhitelistedPro: boolean;
+    isWhitelistedSimple: boolean;
+    votable: boolean;
+    isActive: boolean;
+    accentColor: string;
+    totalPt: number;
+    totalSy: number;
+    totalLp: number;
+    totalActiveSupply: number;
+    liquidity: {
+        usd: number;
+        acc: number;
+    };
+    tradingVolume: {
+        usd: number;
+    };
+    underlyingInterestApy: number;
+    underlyingRewardApy: number;
+    underlyingApy: number;
+    impliedApy: number;
+    ytFloatingApy: number;
+    ptDiscount: number;
+    swapFeeApy: number;
+    pendleApy: number;
+    arbApy: number;
+    aggregatedApy: number;
+    maxBoostedApy: number;
+    lpRewardApy: number;
+    voterApy: number;
+    estimatedDailyPoolRewards: {
+        asset: PendleAPIAsset;
+        amount: number;
+    }[];
+    dataUpdatedAt: Date;
+    liquidityChange24h: number;
+    tradingVolumeChange24h: number;
+    underlyingApyChange24h: number;
+    impliedApyChange24h: number;
+    ytFloatingApyChange24h: number;
+    categoryIds: [];
+    timestamp: Date;
+    scalarRoot: number;
+    initialAnchor: number;
+};
+export type PendleAPIAsset = {
+    id?: string;
+    chainId: number;
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    expiry: Date;
+    accentColor: string;
+    price: {
+        usd: number;
+        acc: number;
+    };
+    priceUpdatedAt: Date;
+    baseType: string;
+    types: string[];
+    protocol: string;
+    underlyingPool: string;
+    simpleName: string;
+    simpleSymbol: string;
+    simpleIcon: string;
+    proName: string;
+    proSymbol: string;
+    proIcon: string;
+    zappable: boolean;
+};
+export type PendleAPIResponse<T> = {
+    transaction: {
+        data: string;
+        to: string;
+    };
+    methodName: string;
+    data: T;
+};
+export type PendleAPISwapResponseData = {
+    /** when swapping for Yt */
+    amountYtOut?: string;
+    /** when swapping for Pt */
+    amountPtOut?: string;
+    /** when swapping Yt or Pt for Token */
+    amountTokenOut?: string;
+    amountSyFeeFromLimit: string;
+    amountSyFeeFromMarket: string;
+    priceImpact: number;
+};
+export type PendleAPIMintResponseData = {
+    amountPyOut?: string;
+    priceImpact: number;
+};
+export type PendleAPIRedeemResponseData = {
+    amountTokenOut?: string;
+    priceImpact: number;
+};
+export type PendleAPIError = {
+    message: string;
+    code: string;
+    issues: [
+        {
+            message: string;
+        }
+    ];
+};
+export type CallApiPendleSwapParams = {
+    chainId: number;
+    receiverAddr: string;
+    market: PendleMarket;
+    tokenIn: ERC20Token;
+    tokenOut: ERC20Token;
+    amountTokenIn: string;
+    slippage: number;
+    syTokenInAddr?: string;
+    syTokenOutAddr?: string;
+    swapType?: PendleSwapType;
+};
+export type CallApiPendleMintParams = {
+    chainId: number;
+    receiverAddr: string;
+    ytAddress: string;
+    tokenIn: ERC20Token;
+    amountTokenIn: string;
+    syTokenInAddr?: string;
+    slippage: number;
+};
+export type CallApiPendleLiquidityCommonParams = {
+    chainId: number;
+    receiverAddr: string;
+    market: PendleMarket;
+    slippage: number;
+};
+export type CallApiPendleAddLiquiditySingleTokenParams = CallApiPendleLiquidityCommonParams & {
+    tokenIn: ERC20Token;
+    syTokenInAddr?: string;
+    amountTokenIn: bigint;
+};
+export type CallApiPendleAddLiquiditySingleSyParams = CallApiPendleLiquidityCommonParams & {
+    amountSyIn: bigint;
+};
+export type CallApiPendleAddLiquiditySinglePtParams = CallApiPendleLiquidityCommonParams & {
+    amountPtIn: bigint;
+};
+export type CallApiPendleAddLiquidityDualTokenAndPtParams = CallApiPendleLiquidityCommonParams & {
+    tokenIn: ERC20Token;
+    syTokenInAddr?: string;
+    amountTokenDesired: bigint;
+    amountPtDesired: bigint;
+};
+export type CallApiPendleAddLiquidityDualSyAndPtParams = CallApiPendleLiquidityCommonParams & {
+    amountSyDesired: bigint;
+    amountPtDesired: bigint;
+};
+export type CallApiPendleRemoveLiquidityCommonParams = CallApiPendleLiquidityCommonParams & {
+    amountLpToRemove: bigint;
+};
+export type CallApiPendleRemoveLiquidityTokenParams = CallApiPendleRemoveLiquidityCommonParams & {
+    tokenOut: ERC20Token;
+    syTokenOutAddr?: string;
+};
+export type CallApiPendleRedeemParams = {
+    chainId: number;
+    receiverAddr: string;
+    ytAddress: string;
+    tokenOut: ERC20Token;
+    amountTokenIn: string;
+    syTokenOutAddr?: string;
+    slippage: number;
+};
+export type PendleMarketTransactionsAPI = {
+    id: string;
+    chainId: number;
+    txHash: string;
+    blockNumber: number;
+    timestamp: string;
+    action: string;
+    origin: string;
+    market: PendleAPIMarket;
+    inputs: {
+        asset: PendleAPIAsset;
+        amount: number;
+    }[];
+    outputs: {
+        asset: PendleAPIAsset;
+        amount: number;
+    }[];
+    user: string;
+    valuation: {
+        usd: number;
+        acc: number;
+    };
+    implicitSwapFeeSy: number;
+    explicitSwapFeeSy: number;
+    impliedApy: number;
+    gasUsed: number;
+};