@hinkal/common 0.2.9 → 0.2.11

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;
+};

package/types/pendle.types.d.mts

@@ -0,0 +1,222 @@
+import { PendleAction, PendleLPAction } from './hinkal.types';
+export declare enum PendleTabs {
+    Trade = "TRADE",
+    Earn = "EARN"
+}
+export declare enum PendleTradeGeneralTabs {
+    Markets = "Market",
+    Pools = "Pools",
+    Dashboard = "Dashboard"
+}
+export declare enum PendleTradeTabs {
+    Swap = "Swap",
+    Mint = "Mint"
+}
+export declare enum PendlePoolTabs {
+    Zap = "Zap",
+    Manual = "Manual"
+}
+export declare enum PendlePoolZapTabs {
+    ZapIn = "Zap In",
+    ZapOut = "Zap Out"
+}
+export declare enum PendlePoolManualTabs {
+    AddLiquidity = "Add Liquidity",
+    RemoveLiquidity = "Remove Liquidity"
+}
+export declare enum PendleDashboardTabs {
+    YT = "YT",
+    LP = "LP"
+}
+export declare enum PendleEarnTabs {
+    Pool = "Pool",
+    Stake = "Stake"
+}
+export declare enum PendleChains {
+    Ethereum = "ethereum",
+    Arbitrum = "arbitrum",
+    BNB = "bnb",
+    Optimism = "optimism"
+}
+export declare enum PendleAssetType {
+    IB = "IB",
+    GENERIC = "GENERIC",
+    PENDLE_LP = "PENDLE_LP",
+    NATIVE = "NATIVE",
+    PT = "PT",
+    SY = "SY",
+    YT = "YT"
+}
+export declare enum PendleSwapType {
+    SwapExactTokenForYt = "SwapExactTokenForYt",
+    SwapExactTokenForPt = "SwapExactTokenForPt",
+    SwapExactYtForToken = "SwapExactYtForToken",
+    SwapExactPtForToken = "SwapExactPtForToken"
+}
+export type PendleAsset = {
+    id: string;
+    chainId: number;
+    address: string;
+    name: string;
+    proName: string;
+    symbol: string;
+    decimals: number;
+    icon: string;
+    baseAssetType: PendleAssetType;
+    assetTypes: PendleAssetType[];
+    expiry: Date;
+    price: {
+        usd: number;
+        acc: number;
+    };
+    priceUpdatedAt: Date;
+    protocol: string;
+    underlyingPool: string;
+    zappable: boolean;
+};
+export type PendleMarket = {
+    id: string;
+    address: string;
+    aggregatedApy: number;
+    chainId: number;
+    name: string;
+    symbol: string;
+    icon: string;
+    maturity: Date;
+    underlyingAPY: number;
+    impliedAPY: number;
+    lp: PendleAsset;
+    maxBoostedApy: number;
+    pt: PendleAsset;
+    sy: PendleAsset;
+    yt: PendleAsset;
+    underlyingAsset: PendleAsset;
+    basePricingAsset: PendleAsset;
+    rewardTokens: PendleAsset[] | [];
+    inputTokens: PendleAsset[] | [];
+    outputTokens: PendleAsset[] | [];
+    totalPt: number;
+    totalSy: number;
+    totalLp: number;
+    totalActiveSupply: number;
+    liquidity: {
+        usd: number;
+        acc: number;
+    };
+    tradingVolume: {
+        usd: number;
+    };
+    ytFloatingApy: number;
+    swapFeeApy: number;
+    pendleApy: number;
+    arbApy: number;
+    estimatedDailyPoolRewards: {
+        asset: PendleAsset;
+        amount: number;
+    }[];
+    liquidityChange24h: number;
+    tradingVolumeChange24h: number;
+    underlyingApyChange24h: number;
+    impliedApyChange24h: number;
+    ytFloatingApyChange24h: number;
+    accentColor: string;
+};
+export type PendleMarketAssetStatistics = {
+    liquidity: {
+        value: number;
+        change: number;
+    };
+    volume: {
+        value: number;
+        change: number;
+    };
+    underlyingAPY: {
+        value: number;
+        change: number;
+    };
+    fixedAPY: {
+        value: number;
+        change: number;
+    } | undefined;
+    impliedAPY: {
+        value: number;
+        change: number;
+    } | undefined;
+    longTermAPY: {
+        value: number;
+        change: number;
+    } | undefined;
+};
+export declare enum PendleMarketTransactionTypes {
+    mintPY = "MINT_PY",
+    redeemPY = "REDEEM_PY",
+    addLiquidity = "ADD_LIQUIDITY",
+    removeLiquidity = "REMOVE_LIQUIDITY",
+    swapPT = "SWAP_PT",
+    swapYT = "SWAP_YT",
+    swapPY = "SWAP_PY"
+}
+export type PendleMarketTransactions = {
+    type: PendleMarketTransactionTypes;
+    hash: string;
+    value: number;
+    tokensIn: {
+        token: PendleAsset | undefined;
+        amount: number;
+    }[] | undefined;
+    tokensOut: {
+        token: PendleAsset | undefined;
+        amount: number;
+    }[] | undefined;
+    time: Date;
+};
+export type PriceHistoricalData = {
+    time: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+};
+export type PendleAssetPriceHistoricalData = {
+    total: number;
+    currency: string;
+    timeFrame: string;
+    timestampStart: string;
+    timestampEnd: string;
+    results: PriceHistoricalData[] | undefined;
+};
+export type APYHistoricalData = {
+    timestamp: string;
+    underlyingApy: number;
+    impliedApy: number;
+};
+export type PendleMarketAPYHistoricalData = {
+    total: number;
+    timestampStart: string;
+    timestampEnd: string;
+    results: APYHistoricalData[] | undefined;
+};
+export type VolumeHistoricalData = {
+    time: string;
+    volume: number;
+};
+export type PendleMarketVolumeHistoricalData = {
+    total: number;
+    timestampStart: string;
+    timestampEnd: string;
+    results: VolumeHistoricalData[] | undefined;
+};
+export type PendleMarketDataKeyType = keyof PendleMarket;
+export type PendleMetadata = {
+    pendleAction: PendleAction;
+    ytAddress: string;
+    userAddress?: string;
+    evmData?: string;
+    isRelayerOff?: boolean;
+};
+export type PendleLPMetadata = {
+    pendleLPAction: PendleLPAction;
+    lpAddress: string;
+    evmData: string;
+};

package/types/relayer.types.d.mts

@@ -0,0 +1,25 @@
+export interface RelayerTransaction {
+    to: string;
+    from: string;
+    contractAddress: string | null;
+    gasUsed: {
+        type: string;
+        hex: string;
+    };
+    logsBloom: string;
+    blockHash: string;
+    transactionHash: string;
+    blockNumber: number;
+    confirmations: number;
+    cumulativeGasUsed: {
+        type: string;
+        hex: string;
+    };
+    effectiveGasPrice: {
+        type: string;
+        hex: string;
+    };
+    status: number;
+    type: number;
+    byzantium: boolean;
+}