@continuumdao/ctm-mpc-defi 0.2.5 → 0.2.6

package/dist/protocols/evm/gmx/index.d.ts

@@ -0,0 +1,469 @@
+import { b as KeyGenSubsetForPermit, M as MultisignBuildResult, e as ProtocolModule } from '../../../types-BfjWdw1j.js';
+import { Address } from 'viem';
+import { E as EvmChainDetail } from '../../../types-DUeNJLr9.js';
+
+/** GMX V2 production chains supported in Continuum multi-sign v1. */
+declare const GMX_SUPPORTED_CHAIN_IDS: readonly [42161, 43114];
+type GmxSupportedChainId = (typeof GMX_SUPPORTED_CHAIN_IDS)[number];
+declare function isGmxChainSupported(chainId: number): chainId is GmxSupportedChainId;
+
+type GmxApiSdkInstance = {
+    fetchMarkets: () => Promise<GmxMarketRow[]>;
+    fetchMarketsTickers: (args?: {
+        symbols?: string[];
+    }) => Promise<unknown[]>;
+    fetchOhlcv: (args: {
+        symbol: string;
+        timeframe: string;
+        limit?: number;
+        since?: number;
+    }) => Promise<Array<{
+        timestamp: number;
+        open: string;
+        high: string;
+        low: string;
+        close: string;
+    }>>;
+    fetchTokens: () => Promise<GmxTokenRow[]>;
+    fetchTokensData: () => Promise<unknown[]>;
+    fetchPositionsInfo: (args: {
+        address: string;
+        includeRelatedOrders?: boolean;
+    }) => Promise<GmxPositionRow[]>;
+    fetchOrders: (args: {
+        address: string;
+    }) => Promise<GmxOrderRow[]>;
+    fetchStakingPower: (args: {
+        address: string;
+    }) => Promise<Record<string, unknown>>;
+    fetchApy: (params?: Record<string, unknown>) => Promise<Record<string, unknown>>;
+    prepareOrder: (args: Record<string, unknown>) => Promise<GmxPrepareOrderResponse>;
+    prepareCancelOrder: (args: Record<string, unknown>) => Promise<GmxPrepareOrderResponse>;
+};
+type GmxMarketRow = {
+    symbol: string;
+    marketTokenAddress: string;
+    indexTokenAddress?: string;
+    longTokenAddress?: string;
+    shortTokenAddress?: string;
+    isSpotOnly?: boolean;
+    isListed?: boolean;
+};
+type GmxTokenRow = {
+    symbol: string;
+    address: string;
+    decimals: number;
+};
+type GmxPositionRow = {
+    key?: string;
+    indexName?: string;
+    isLong?: boolean;
+    sizeInUsd?: bigint | string | number;
+    collateralUsd?: bigint | string | number;
+    marketAddress?: string;
+};
+type GmxOrderRow = {
+    key?: string;
+    isLong?: boolean;
+    sizeDeltaUsd?: bigint | string | number;
+    triggerPrice?: bigint | string | number;
+};
+type GmxPrepareOrderResponse = {
+    requestId?: string;
+    payloadType: 'transaction' | 'typed-data';
+    mode: string;
+    payload: {
+        to?: string;
+        data?: string;
+        value?: string | bigint | number;
+    };
+    estimates?: Record<string, unknown>;
+};
+declare function getGmxApiSdk(chainId: number): GmxApiSdkInstance;
+
+/** Parse a USD amount to GMX 30-decimal fixed point. */
+declare function parseGmxUsd30(amountHuman: string): bigint;
+declare function parseGmxTokenAmount(amountHuman: string, decimals: number): bigint;
+
+type GmxMarketApySource = {
+    apy?: number;
+    baseApy?: number;
+    bonusApr?: number;
+};
+declare function gmxFormatApyPercent(apy: number | null | undefined): string | null;
+declare function gmxLookupMarketApy(apyByMarket: Record<string, GmxMarketApySource>, marketTokenAddress: string): GmxMarketApySource | null;
+declare function gmxEnrichGmMarketRowWithApy<T extends {
+    marketTokenAddress: string;
+}>(row: T, apyByMarket: Record<string, GmxMarketApySource>): T & {
+    apy: number | null;
+    baseApy: number | null;
+    bonusApr: number | null;
+    apyPercentLabel: string | null;
+};
+
+declare function gmxFetchMarkets(chainId: number): Promise<GmxMarketRow[]>;
+declare function gmxFetchTokens(chainId: number): Promise<GmxTokenRow[]>;
+declare function gmxResolveTokenBySymbol(chainId: number, symbol: string): Promise<GmxTokenRow>;
+declare function gmxIsCollateralTokenSupported(chainId: number, tokenAddress: string): Promise<boolean>;
+/** Parse collateral pool tokens from e.g. `ETH/USD [WETH-USDC]` → `WETH`, `USDC`. */
+declare function gmxMarketCollateralTokens(marketSymbol: string): string[];
+declare function gmxMarketAcceptsCollateral(marketSymbol: string, collateralSymbol: string): boolean;
+declare function gmxMarketsForCollateralSymbol(chainId: number, collateralSymbol: string): Promise<GmxMarketRow[]>;
+declare function gmxResolveMarketBySymbol(chainId: number, symbol: string): Promise<GmxMarketRow>;
+declare function gmxResolveMarketByGmTokenAddress(chainId: number, gmTokenAddress: string): Promise<GmxMarketRow | null>;
+type GmxGmMarketSummaryRow = {
+    symbol: string;
+    marketTokenAddress: string;
+    longTokenSymbol: string | null;
+    shortTokenSymbol: string | null;
+    apy: number | null;
+    baseApy: number | null;
+    bonusApr: number | null;
+    apyPercentLabel: string | null;
+};
+declare function gmxFetchGmMarketsSummary(chainId: number): Promise<GmxGmMarketSummaryRow[]>;
+
+type GmxPositionDisplayRow = {
+    key: string;
+    indexName: string;
+    isLong: boolean;
+    sizeUsd: string | null;
+    collateralUsd: string | null;
+    collateralSymbol: string | null;
+    entryPriceUsd: string | null;
+    markPriceUsd: string | null;
+    liquidationPriceUsd: string | null;
+    leverageLabel: string | null;
+    pnlUsd: string | null;
+};
+declare function gmxFormatPositionsForDisplay(chainId: number, positions: Array<Record<string, unknown>>): Promise<GmxPositionDisplayRow[]>;
+
+declare function gmxFetchPositionsForExecutor(args: {
+    chainId: number;
+    executorAddress: string;
+}): Promise<{
+    positions: Array<Record<string, unknown>>;
+}>;
+declare function gmxFetchPositionDisplayRows(args: {
+    chainId: number;
+    executorAddress: string;
+}): Promise<GmxPositionDisplayRow[]>;
+declare function gmxFetchOrdersForExecutor(args: {
+    chainId: number;
+    executorAddress: string;
+}): Promise<GmxOrderRow[]>;
+declare function gmxFetchMarketsSummary(args: {
+    chainId: number;
+}): Promise<{
+    markets: {
+        symbol: string;
+        marketTokenAddress: string;
+        maxLeverageLabel: string | null;
+    }[];
+}>;
+declare function gmxFetchCollateralTokens(args: {
+    chainId: number;
+}): Promise<{
+    symbol: string;
+    address: string;
+    decimals: number;
+}[]>;
+declare function gmxFetchGmMarkets(args: {
+    chainId: number;
+}): Promise<{
+    markets: GmxGmMarketSummaryRow[];
+}>;
+/** GM liquidity pool APY per market (sorted highest APY first). Read-only. */
+declare function gmxFetchGmApy(args: {
+    chainId: number;
+}): Promise<{
+    markets: GmxGmMarketSummaryRow[];
+}>;
+declare function gmxFetchStakingPower(args: {
+    chainId: number;
+    executorAddress: string;
+}): Promise<{
+    stakingPower: any;
+}>;
+declare function gmxFetchGmMarketForToken(args: {
+    chainId: number;
+    gmTokenAddress: string;
+}): Promise<{
+    market: null;
+} | {
+    market: {
+        symbol: string;
+        marketTokenAddress: string;
+        longTokenSymbol: string | null;
+        shortTokenSymbol: string | null;
+        gmDecimals: number;
+    };
+}>;
+declare function gmxGmxTokenAddress(chainId: number): string;
+declare function gmxIsGmMarketTokenAddress(chainId: number, tokenAddress: string): Promise<boolean>;
+declare function gmxIsGmxStakeTokenAddress(chainId: number, tokenAddress: string): boolean;
+
+type GmxMultisignCommon = {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: EvmChainDetail;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+};
+type GmxIncreaseOrderArgs = GmxMultisignCommon & {
+    symbol: string;
+    direction: 'long' | 'short';
+    orderType: 'market' | 'limit';
+    sizeUsdHuman: string;
+    collateralToken: string;
+    collateralAmountHuman: string;
+    triggerPriceUsdHuman?: string;
+    slippageBps?: number;
+    executionFeeBufferBps?: number;
+    isNativeIn?: boolean;
+    /** Wrapped native (WETH/WAVAX); required when `isNativeIn`. */
+    nativeWrapped?: Address;
+};
+type GmxDecreaseOrderArgs = GmxMultisignCommon & {
+    symbol: string;
+    direction: 'long' | 'short';
+    orderType: 'market' | 'limit';
+    sizeUsdHuman: string;
+    collateralToken: string;
+    receiveToken?: string;
+    triggerPriceUsdHuman?: string;
+    keepLeverage?: boolean;
+    slippageBps?: number;
+    executionFeeBufferBps?: number;
+    /** When true, receive native gas token (GMX unwraps WETH/WAVAX in the order). */
+    isNativeOut?: boolean;
+};
+type GmxCancelOrderArgs = GmxMultisignCommon & {
+    orderId: string;
+};
+declare function buildEvmMultisignBodyGmxIncreaseBatch(args: GmxIncreaseOrderArgs): Promise<MultisignBuildResult>;
+declare function buildEvmMultisignBodyGmxDecreaseBatch(args: GmxDecreaseOrderArgs): Promise<MultisignBuildResult>;
+/** Alias: limit increase uses orderType limit on increase builder. */
+declare const buildEvmMultisignBodyGmxLimitIncreaseBatch: typeof buildEvmMultisignBodyGmxIncreaseBatch;
+/** Alias: limit decrease uses orderType limit on decrease builder. */
+declare const buildEvmMultisignBodyGmxLimitDecreaseBatch: typeof buildEvmMultisignBodyGmxDecreaseBatch;
+declare function buildEvmMultisignBodyGmxCancelBatch(args: GmxCancelOrderArgs): Promise<MultisignBuildResult>;
+
+type GmxGmMultisignCommon = {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: EvmChainDetail;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+};
+type GmxGmDepositArgs = GmxGmMultisignCommon & {
+    marketSymbol: string;
+    collateralToken: string;
+    collateralAmountHuman: string;
+    executionFeeBufferBps?: number;
+    isNativeIn?: boolean;
+    nativeWrapped?: Address;
+};
+type GmxGmWithdrawArgs = GmxGmMultisignCommon & {
+    marketSymbol: string;
+    gmAmountHuman: string;
+    gmDecimals?: number;
+    executionFeeBufferBps?: number;
+    isNativeOut?: boolean;
+};
+declare function buildEvmMultisignBodyGmxGmDepositBatch(args: GmxGmDepositArgs): Promise<MultisignBuildResult>;
+declare function buildEvmMultisignBodyGmxGmWithdrawBatch(args: GmxGmWithdrawArgs): Promise<MultisignBuildResult>;
+
+type GmxStakeMultisignCommon = {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    rpcUrl: string;
+    chainDetail: EvmChainDetail;
+    useCustomGas: boolean;
+    customGasChainDetails?: Record<string, unknown> | null;
+    executorAddress: Address;
+    purposeText: string;
+};
+type GmxStakeGmxArgs = GmxStakeMultisignCommon & {
+    amountHuman: string;
+    gmxDecimals?: number;
+};
+type GmxUnstakeGmxArgs = GmxStakeMultisignCommon & {
+    amountHuman: string;
+    gmxDecimals?: number;
+};
+declare function buildEvmMultisignBodyGmxStakeGmxBatch(args: GmxStakeGmxArgs): Promise<MultisignBuildResult>;
+declare function buildEvmMultisignBodyGmxUnstakeGmxBatch(args: GmxUnstakeGmxArgs): Promise<MultisignBuildResult>;
+
+declare function gmxContractAddress(chainId: number, name: string): Address;
+
+declare function gmxEstimateGmExecutionFee(args: {
+    chainId: number;
+    rpcUrl: string;
+    operation: 'deposit' | 'withdrawal';
+    executionFeeBufferBps?: number;
+}): Promise<bigint>;
+declare function gmxZeroAddress(): Address;
+
+type GmxGmLiquidityPositionRow = {
+    symbol: string;
+    marketTokenAddress: string;
+    longTokenSymbol: string | null;
+    shortTokenSymbol: string | null;
+    gmDecimals: number;
+    gmBalanceWei: string;
+    gmBalanceHuman: string;
+    apyPercentLabel: string | null;
+    tokenListSymbol: string;
+    tokenListName: string;
+};
+declare function gmxFetchGmLiquidityPositions(args: {
+    chainId: number;
+    executorAddress: string;
+    rpcUrl: string;
+    includeZeroBalance?: boolean;
+}): Promise<{
+    rows: GmxGmLiquidityPositionRow[];
+}>;
+
+/** Format a GMX 30-decimal USD bigint as a human-readable dollar string. */
+declare function formatGmxUsd30(value: bigint | string | number | null | undefined): string | null;
+/** Decimal USD string suitable for amount inputs (no currency symbol). */
+declare function formatGmxUsd30HumanInput(value: bigint | string | number | null | undefined): string | null;
+/** Trim trailing zeros from a decimal token amount string. */
+declare function formatGmxTokenAmountHuman(amountWei: bigint, decimals: number): string;
+/** GMX leverage is returned in basis points (size / effective collateral * 10_000). */
+declare function formatGmxLeverageBps(value: bigint | string | number | null | undefined): string | null;
+
+type GmxTradeEstimate = {
+    direction: 'long' | 'short';
+    marketSymbol: string;
+    sizeUsdHuman: string;
+    collateralSymbol: string;
+    collateralAmountHuman: string | null;
+    /** Current open position size (Close tab); use for MAX and validation. */
+    openPositionSizeUsdHuman: string | null;
+    openPositionSizeUsdLabel: string | null;
+    entryPriceUsd: string | null;
+    liquidationPriceUsd: string | null;
+    leverageLabel: string | null;
+    maxLeverageLabel: string | null;
+    minCollateralAmountHuman: string | null;
+    exceedsMaxLeverage: boolean;
+    note: string | null;
+};
+declare function gmxEstimateIncreasePreview(args: {
+    chainId: number;
+    symbol: string;
+    direction: 'long' | 'short';
+    sizeUsdHuman: string;
+    collateralToken: string;
+    collateralAmountHuman: string;
+    executorAddress?: string;
+}): Promise<GmxTradeEstimate>;
+type GmxClosePositionCap = {
+    openPositionSizeUsdHuman: string | null;
+    openPositionSizeUsdLabel: string | null;
+};
+declare function gmxFetchClosePositionCap(args: {
+    chainId: number;
+    symbol: string;
+    direction: 'long' | 'short';
+    executorAddress: string;
+}): Promise<GmxClosePositionCap>;
+declare function gmxEstimateDecreasePreview(args: {
+    chainId: number;
+    symbol: string;
+    direction: 'long' | 'short';
+    sizeUsdHuman: string;
+    collateralToken: string;
+    executorAddress: string;
+}): Promise<GmxTradeEstimate>;
+declare function gmxAssertIncreaseOrderWithinMaxLeverage(args: {
+    chainId: number;
+    symbol: string;
+    direction: 'long' | 'short';
+    sizeUsdHuman: string;
+    collateralToken: string;
+    collateralAmountHuman: string;
+    executorAddress?: string;
+}): Promise<void>;
+/** Returns true when close size is positive and does not exceed the open position. */
+declare function gmxIsCloseSizeWithinPosition(args: {
+    closeSizeUsdHuman: string;
+    openPositionSizeUsdHuman: string;
+}): boolean;
+
+declare function gmxMarketMaxLeverageBps(marketInfo: Record<string, unknown>): number;
+declare function gmxMarketMaxLeverageLabel(marketInfo: Record<string, unknown>): string | null;
+
+type GmxOhlcvCandleRow = {
+    timestampMs: number;
+    timeLabel: string;
+    open: string;
+    high: string;
+    low: string;
+    close: string;
+};
+type GmxMarketPrices = {
+    symbol: string;
+    indexLabel: string;
+    collateralSymbol: string;
+    indexMarkUsd: string | null;
+    collateralUsd: string | null;
+    indexPerCollateral: string | null;
+    fetchedAtMs: number;
+};
+type GmxMarketSnapshot = GmxMarketPrices & {
+    ohlcvTimeframe: GmxOhlcvTimeframe;
+    ohlcv: GmxOhlcvCandleRow[];
+};
+declare const GMX_OHLCV_TIMEFRAMES: readonly ["1m", "5m", "15m", "1h", "4h", "1d", "1w", "1M"];
+type GmxOhlcvTimeframe = (typeof GMX_OHLCV_TIMEFRAMES)[number];
+declare function assertGmxOhlcvTimeframe(timeframe: string): GmxOhlcvTimeframe;
+declare function gmxFetchMarketPrices(args: {
+    chainId: number;
+    symbol: string;
+    collateralSymbol: string;
+}): Promise<GmxMarketPrices>;
+declare function gmxFetchOhlcv(args: {
+    chainId: number;
+    symbol: string;
+    timeframe?: string;
+    limit?: number;
+    sort?: 'asc' | 'desc';
+}): Promise<{
+    symbol: string;
+    timeframe: GmxOhlcvTimeframe;
+    candles: GmxOhlcvCandleRow[];
+}>;
+declare function gmxFetchMarketSnapshot(args: {
+    chainId: number;
+    symbol: string;
+    collateralSymbol: string;
+    ohlcvTimeframe?: string;
+}): Promise<GmxMarketSnapshot>;
+
+/** Wrapped native collateral symbol GMX perp markets accept (not the zero-address gas token). */
+declare const GMX_WRAPPED_NATIVE_SYMBOL_BY_CHAIN: Partial<Record<number, string>>;
+/** Native gas token symbol for GMX receiveToken unwrap on decrease. */
+declare const GMX_NATIVE_GAS_SYMBOL_BY_CHAIN: Partial<Record<number, string>>;
+declare function gmxWrappedNativeSymbolForChain(chainId: number): string | null;
+declare function gmxNativeGasSymbolForChain(chainId: number): string | null;
+declare function gmxFindWrappedNativeToken(tokens: readonly GmxTokenRow[], chainId: number): GmxTokenRow | null;
+/** Map node asset row address to GMX collateral lookup key (native gas row → wrapped ERC-20). */
+declare function gmxKeyForNodeAssetRow(args: {
+    contractAddress: string;
+    nativeWrapped: string | null;
+}): string | null;
+
+declare const GMX_PROTOCOL_ID = "gmx";
+declare const gmxProtocolModule: ProtocolModule;
+
+export { GMX_NATIVE_GAS_SYMBOL_BY_CHAIN, GMX_OHLCV_TIMEFRAMES, GMX_PROTOCOL_ID, GMX_SUPPORTED_CHAIN_IDS, GMX_WRAPPED_NATIVE_SYMBOL_BY_CHAIN, type GmxApiSdkInstance, type GmxCancelOrderArgs, type GmxClosePositionCap, type GmxDecreaseOrderArgs, type GmxGmDepositArgs, type GmxGmLiquidityPositionRow, type GmxGmMarketSummaryRow, type GmxGmWithdrawArgs, type GmxIncreaseOrderArgs, type GmxMarketApySource, type GmxMarketPrices, type GmxMarketRow, type GmxMarketSnapshot, type GmxOhlcvCandleRow, type GmxOhlcvTimeframe, type GmxOrderRow, type GmxPositionDisplayRow, type GmxPositionRow, type GmxPrepareOrderResponse, type GmxStakeGmxArgs, type GmxSupportedChainId, type GmxTokenRow, type GmxTradeEstimate, type GmxUnstakeGmxArgs, assertGmxOhlcvTimeframe, buildEvmMultisignBodyGmxCancelBatch, buildEvmMultisignBodyGmxDecreaseBatch, buildEvmMultisignBodyGmxGmDepositBatch, buildEvmMultisignBodyGmxGmWithdrawBatch, buildEvmMultisignBodyGmxIncreaseBatch, buildEvmMultisignBodyGmxLimitDecreaseBatch, buildEvmMultisignBodyGmxLimitIncreaseBatch, buildEvmMultisignBodyGmxStakeGmxBatch, buildEvmMultisignBodyGmxUnstakeGmxBatch, formatGmxLeverageBps, formatGmxTokenAmountHuman, formatGmxUsd30, formatGmxUsd30HumanInput, getGmxApiSdk, gmxAssertIncreaseOrderWithinMaxLeverage, gmxContractAddress, gmxEnrichGmMarketRowWithApy, gmxEstimateDecreasePreview, gmxEstimateGmExecutionFee, gmxEstimateIncreasePreview, gmxFetchClosePositionCap, gmxFetchCollateralTokens, gmxFetchGmApy, gmxFetchGmLiquidityPositions, gmxFetchGmMarketForToken, gmxFetchGmMarkets, gmxFetchGmMarketsSummary, gmxFetchMarketPrices, gmxFetchMarketSnapshot, gmxFetchMarkets, gmxFetchMarketsSummary, gmxFetchOhlcv, gmxFetchOrdersForExecutor, gmxFetchPositionDisplayRows, gmxFetchPositionsForExecutor, gmxFetchStakingPower, gmxFetchTokens, gmxFindWrappedNativeToken, gmxFormatApyPercent, gmxFormatPositionsForDisplay, gmxGmxTokenAddress, gmxIsCloseSizeWithinPosition, gmxIsCollateralTokenSupported, gmxIsGmMarketTokenAddress, gmxIsGmxStakeTokenAddress, gmxKeyForNodeAssetRow, gmxLookupMarketApy, gmxMarketAcceptsCollateral, gmxMarketCollateralTokens, gmxMarketMaxLeverageBps, gmxMarketMaxLeverageLabel, gmxMarketsForCollateralSymbol, gmxNativeGasSymbolForChain, gmxProtocolModule, gmxResolveMarketByGmTokenAddress, gmxResolveMarketBySymbol, gmxResolveTokenBySymbol, gmxWrappedNativeSymbolForChain, gmxZeroAddress, isGmxChainSupported, parseGmxTokenAmount, parseGmxUsd30 };