@continuumdao/ctm-mpc-defi 0.2.50 → 0.2.51

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

@@ -0,0 +1,465 @@
+/** Aligns with app NonEvmChainType + 'evm'. Extend as mpc-auth adds chains. */
+type ChainCategory = 'evm' | 'solana' | 'near' | 'sui' | 'ton' | 'stellar';
+type MultisignBuildResult = {
+    bodyForSign: Record<string, unknown>;
+    messageToSign: string;
+};
+type EvmTokenKind = 'native' | 'erc20' | 'erc721' | 'ctmerc20' | 'ctmrwa1';
+type SolanaTokenKind = 'native' | 'spl' | 'spl2022';
+type NearTokenKind = 'native' | 'nep141';
+type TokenRef = {
+    category: 'evm';
+    kind: EvmTokenKind;
+    address: `0x${string}`;
+} | {
+    category: 'solana';
+    kind: SolanaTokenKind;
+    mint: string;
+} | {
+    category: 'near';
+    kind: NearTokenKind;
+    contractId: string;
+};
+type ParamDoc = {
+    type: string;
+    required: boolean;
+    description: string;
+};
+type ProtocolActionDescriptor = {
+    id: string;
+    protocolId: string;
+    chainCategory: ChainCategory;
+    description: string;
+    commonParams: Array<'keyGen' | 'purposeText' | 'useCustomGas' | 'useCustomFees'>;
+    params: Record<string, ParamDoc>;
+};
+type ChainSupportContext = {
+    chainCategory: ChainCategory;
+    chainId: string | number;
+};
+interface ProtocolModule {
+    id: string;
+    chainCategory: ChainCategory;
+    isChainSupported(ctx: ChainSupportContext): boolean | Promise<boolean>;
+    isTokenSupported(token: TokenRef): boolean | Promise<boolean>;
+    actions: ProtocolActionDescriptor[];
+}
+type KeyGenSubset = {
+    pubkeyhex?: string;
+    keylist?: string[];
+    ClientKeys?: Record<string, string>;
+    groupId?: string;
+    GroupId?: string;
+};
+/** App-compatible alias used by multisign builders and Permit2 helpers. */
+type KeyGenSubsetForPermit = KeyGenSubset;
+
+/** HIP-4 outcome id + side (0 = first side, usually Yes). */
+declare function outcomeEncoding(outcome: number, side: number): number;
+declare function outcomeTradeCoin(encoding: number): string;
+declare function outcomeBalanceCoin(encoding: number): string;
+declare function outcomeAssetId(encoding: number): number;
+declare function outcomeSideIndex(side: 'yes' | 'no' | 0 | 1): 0 | 1;
+declare function outcomeSideName(name: string | undefined, fallback: string): string;
+type HyperliquidOutcomeSideSpec = {
+    name?: string;
+};
+type HyperliquidOutcomeMeta = {
+    outcome: number;
+    name: string;
+    description: string;
+    sideSpecs?: HyperliquidOutcomeSideSpec[];
+    quoteToken?: string;
+    venue?: string;
+    deployerFeeScale?: string;
+};
+type HyperliquidOutcomeQuestion = {
+    question: number;
+    name?: string;
+    description?: string;
+    fallbackOutcome?: number;
+    namedOutcomes?: number[];
+    settledNamedOutcomes?: number[];
+};
+declare function parseHyperliquidPipeFields(description: string | undefined): Record<string, string>;
+/** `20261001-0000` → unix seconds UTC. */
+declare function parseHyperliquidStamp(raw: string | undefined): number | null;
+declare function formatHyperliquidStamp(unixSec: number | null): string | null;
+declare function questionForOutcome(outcomeId: number, questions: readonly HyperliquidOutcomeQuestion[]): HyperliquidOutcomeQuestion | undefined;
+declare function formatOutcomeQuestion(outcome: HyperliquidOutcomeMeta, question?: HyperliquidOutcomeQuestion): string;
+type HyperliquidOutcomeTemplate = {
+    id: string;
+    description?: string;
+    role?: string | {
+        questionOutcome?: {
+            parent?: string;
+        };
+    };
+};
+declare function outcomeTemplateId(name: string | undefined): string;
+declare function outcomeFieldMap(outcome: HyperliquidOutcomeMeta, question?: HyperliquidOutcomeQuestion): Record<string, string>;
+declare function fillOutcomeTemplate(text: string, fields: Record<string, string>): string;
+declare function resolveOutcomeSideLabel(specName: string | undefined, fields: Record<string, string>, fallback: string): string;
+/** Official template text with this market's fields filled in. */
+declare function formatOutcomeRules(outcome: HyperliquidOutcomeMeta, question?: HyperliquidOutcomeQuestion, templates?: readonly HyperliquidOutcomeTemplate[]): string;
+declare function outcomeExpiryUnix(outcome: HyperliquidOutcomeMeta, question?: HyperliquidOutcomeQuestion): number;
+
+declare const HYPERLIQUID_OUTCOME_PROTOCOL_ID = "hyperliquidOutcome";
+declare const HYPERLIQUID_OUTCOME_MAINNET_CHAIN_ID = 999;
+type OutcomeBookLevel = {
+    px: string;
+    sz: string;
+    n: number;
+};
+type OutcomeBook = {
+    coin: string;
+    time: number | null;
+    bids: OutcomeBookLevel[];
+    asks: OutcomeBookLevel[];
+};
+type HyperliquidOutcomeMarket = {
+    outcome: number;
+    name: string;
+    description: string;
+    question: string;
+    questionId: number | null;
+    sideNames: [string, string];
+    quoteToken: string;
+    venue: string;
+    categories: string[];
+    yesEncoding: number;
+    noEncoding: number;
+    yesCoin: string;
+    noCoin: string;
+    yesAssetId: number;
+    noAssetId: number;
+    yesBalanceCoin: string;
+    noBalanceCoin: string;
+    yesPrice: number | null;
+    noPrice: number | null;
+    yesPriceLabel: string | null;
+    noPriceLabel: string | null;
+    expiresAt: string | null;
+    endOfTrading: number;
+    status: 'live' | 'closed';
+    tradable: boolean;
+    rules: string;
+};
+declare function clearHyperliquidOutcomeMetaCache(): void;
+declare function hyperliquidOutcomeMatchesQuery(market: HyperliquidOutcomeMarket, query: string): boolean;
+declare function listHyperliquidOutcomeMarkets(args: {
+    chainId?: number;
+    query?: string;
+}): Promise<{
+    markets: HyperliquidOutcomeMarket[];
+    questions: HyperliquidOutcomeQuestion[];
+}>;
+declare function getHyperliquidOutcomeMarket(args: {
+    chainId?: number;
+    outcomeId: number;
+}): Promise<HyperliquidOutcomeMarket>;
+type OutcomeChanceBar = {
+    timestamp: number;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+};
+/** Hourly Yes/No mid history from candleSnapshot. Closes are probabilities in 0–1. */
+declare function fetchHyperliquidOutcomeChanceSeries(args: {
+    chainId?: number;
+    coin: string;
+}): Promise<OutcomeChanceBar[]>;
+declare function fetchHyperliquidOutcomeBook(args: {
+    chainId?: number;
+    coin: string;
+}): Promise<OutcomeBook>;
+type OutcomeBalance = {
+    coin: string;
+    total: string;
+    hold: string;
+    outcome: number | null;
+    side: 'yes' | 'no' | null;
+};
+type OutcomeOpenOrder = {
+    coin: string;
+    side: string;
+    limitPx: string;
+    sz: string;
+    oid: number;
+    timestamp: number;
+    outcome: number | null;
+    outcomeSide: 'yes' | 'no' | null;
+};
+declare function fetchHyperliquidOutcomeAccount(args: {
+    chainId?: number;
+    user: string;
+}): Promise<{
+    quoteBalances: Array<{
+        coin: string;
+        total: string;
+        hold: string;
+    }>;
+    outcomeBalances: OutcomeBalance[];
+    openOrders: OutcomeOpenOrder[];
+}>;
+
+type HyperliquidOutcomePurposeAction = 'order' | 'cancel' | 'split' | 'merge' | 'mergeQuestion' | 'negate';
+declare function buildHyperliquidOutcomePurposePrefill(args: {
+    action: HyperliquidOutcomePurposeAction;
+    question?: string;
+    side?: 'yes' | 'no';
+    isBuy?: boolean;
+    szHuman?: string;
+    limitPxHuman?: string;
+    tif?: string;
+    amountHuman?: string;
+    oid?: number;
+}): string;
+
+type HyperliquidL1Tif = 'Alo' | 'Gtc' | 'Ioc';
+type HyperliquidOrderGrouping = 'na' | 'normalTpsl' | 'positionTpsl';
+type HyperliquidOrderWire = {
+    a: number;
+    b: boolean;
+    p: string;
+    s: string;
+    r: boolean;
+    t: {
+        limit: {
+            tif: HyperliquidL1Tif;
+        };
+    } | {
+        trigger: {
+            isMarket: boolean;
+            triggerPx: string;
+            tpsl: 'tp' | 'sl';
+        };
+    };
+    c?: string;
+};
+type HyperliquidOrderAction = {
+    type: 'order';
+    orders: HyperliquidOrderWire[];
+    grouping: HyperliquidOrderGrouping;
+};
+
+type OutcomeMultisignCommon = {
+    keyGen: KeyGenSubsetForPermit;
+    chainId: number;
+    purposeText: string;
+    nonce?: number;
+    expiryDate?: number;
+};
+type HyperliquidOutcomeOrderArgs = OutcomeMultisignCommon & {
+    outcome: number;
+    side: 'yes' | 'no';
+    isBuy: boolean;
+    limitPxHuman: string;
+    szHuman: string;
+    tif?: string;
+    reduceOnly?: boolean;
+};
+declare function buildHyperliquidOutcomeOrderAction(args: {
+    outcome: number;
+    side: 'yes' | 'no';
+    isBuy: boolean;
+    limitPxHuman: string;
+    szHuman: string;
+    tif?: string;
+    reduceOnly?: boolean;
+}): {
+    encoding: number;
+    coin: string;
+    asset: number;
+    action: HyperliquidOrderAction;
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeOrder(args: HyperliquidOutcomeOrderArgs): Promise<MultisignBuildResult>;
+declare function buildHyperliquidOutcomeCancelAction(args: {
+    outcome: number;
+    side: 'yes' | 'no';
+    oid: number;
+}): {
+    encoding: number;
+    coin: string;
+    asset: number;
+    action: {
+        type: string;
+        cancels: {
+            a: number;
+            o: number;
+        }[];
+    };
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeCancel(args: OutcomeMultisignCommon & {
+    outcome: number;
+    side: 'yes' | 'no';
+    oid: number;
+}): Promise<MultisignBuildResult>;
+declare function buildHyperliquidOutcomeSplitAction(args: {
+    outcome: number;
+    amountHuman: string;
+}): {
+    type: "userOutcome";
+    splitOutcome: {
+        outcome: number;
+        amount: string;
+    };
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeSplit(args: OutcomeMultisignCommon & {
+    outcome: number;
+    amountHuman: string;
+}): Promise<MultisignBuildResult>;
+declare function buildHyperliquidOutcomeMergeAction(args: {
+    outcome: number;
+    amountHuman?: string;
+    amountMax?: boolean;
+}): {
+    type: "userOutcome";
+    mergeOutcome: {
+        outcome: number;
+        amount: string | null;
+    };
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeMerge(args: OutcomeMultisignCommon & {
+    outcome: number;
+    amountHuman?: string;
+    amountMax?: boolean;
+}): Promise<MultisignBuildResult>;
+declare function buildHyperliquidOutcomeMergeQuestionAction(args: {
+    question: number;
+    amountHuman?: string;
+    amountMax?: boolean;
+}): {
+    type: "userOutcome";
+    mergeQuestion: {
+        question: number;
+        amount: string | null;
+    };
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeMergeQuestion(args: OutcomeMultisignCommon & {
+    question: number;
+    amountHuman?: string;
+    amountMax?: boolean;
+}): Promise<MultisignBuildResult>;
+declare function buildHyperliquidOutcomeNegateAction(args: {
+    question: number;
+    outcome: number;
+    amountHuman: string;
+}): {
+    type: "userOutcome";
+    negateOutcome: {
+        question: number;
+        outcome: number;
+        amount: string;
+    };
+};
+declare function buildEvmMultisignBodyHyperliquidOutcomeNegate(args: OutcomeMultisignCommon & {
+    question: number;
+    outcome: number;
+    amountHuman: string;
+}): Promise<MultisignBuildResult>;
+
+declare function hyperliquidOutcomeToPredictionFields(market: HyperliquidOutcomeMarket, chainId: number): {
+    venue: "hyperliquid";
+    venueMarketId: string;
+    question: string;
+    categories: string[];
+    yesPrice: number | null;
+    noPrice: number | null;
+    yesPriceLabel: string | null;
+    noPriceLabel: string | null;
+    volume: string;
+    tvl: null;
+    expiresAt: string | null;
+    expiresAtLabel: string | null;
+    tradingEndsLabel: string;
+    endOfTrading: number;
+    status: "live" | "closed";
+    outcome: number;
+    statusUpdatedAt: null;
+    resolutionLabel: null;
+    chainId: number;
+    paymentSymbol: string;
+    tradable: boolean;
+    rules: string;
+    source: string;
+};
+declare function hyperliquidOutcomeFetchMarketsSummary(input: {
+    chainId?: number;
+    query?: string;
+    limit?: number;
+    offset?: number;
+}): Promise<{
+    markets: HyperliquidOutcomeMarket[];
+    hasMore: boolean;
+    nextOffset: number;
+    notes: string;
+}>;
+declare function hyperliquidOutcomeFetchMarketSummary(input: {
+    chainId?: number;
+    outcome: number;
+}): Promise<{
+    yesBook: OutcomeBook;
+    noBook: OutcomeBook;
+    notes: string;
+    outcome: number;
+    name: string;
+    description: string;
+    question: string;
+    questionId: number | null;
+    sideNames: [string, string];
+    quoteToken: string;
+    venue: string;
+    categories: string[];
+    yesEncoding: number;
+    noEncoding: number;
+    yesCoin: string;
+    noCoin: string;
+    yesAssetId: number;
+    noAssetId: number;
+    yesBalanceCoin: string;
+    noBalanceCoin: string;
+    yesPrice: number | null;
+    noPrice: number | null;
+    yesPriceLabel: string | null;
+    noPriceLabel: string | null;
+    expiresAt: string | null;
+    endOfTrading: number;
+    status: "live" | "closed";
+    tradable: boolean;
+    rules: string;
+}>;
+declare function hyperliquidOutcomeFetchOrderbookSummary(input: {
+    chainId?: number;
+    outcome: number;
+    side?: 'yes' | 'no';
+}): Promise<{
+    outcome: number;
+    side: "yes" | "no";
+    book: OutcomeBook;
+    notes: string;
+}>;
+declare function hyperliquidOutcomeFetchPositionsSummary(input: {
+    chainId?: number;
+    user: string;
+}): Promise<{
+    quoteBalances: {
+        coin: string;
+        total: string;
+        hold: string;
+    }[];
+    outcomeBalances: OutcomeBalance[];
+    notes: string;
+}>;
+declare function hyperliquidOutcomeFetchOpenOrdersSummary(input: {
+    chainId?: number;
+    user: string;
+}): Promise<{
+    openOrders: OutcomeOpenOrder[];
+    notes: string;
+}>;
+
+declare const hyperliquidOutcomeProtocolModule: ProtocolModule;
+
+export { HYPERLIQUID_OUTCOME_MAINNET_CHAIN_ID, HYPERLIQUID_OUTCOME_PROTOCOL_ID, type HyperliquidOutcomeMarket, type HyperliquidOutcomeMeta, type HyperliquidOutcomeOrderArgs, type HyperliquidOutcomePurposeAction, type HyperliquidOutcomeQuestion, type HyperliquidOutcomeSideSpec, type HyperliquidOutcomeTemplate, type OutcomeBalance, type OutcomeBook, type OutcomeBookLevel, type OutcomeChanceBar, type OutcomeOpenOrder, buildEvmMultisignBodyHyperliquidOutcomeCancel, buildEvmMultisignBodyHyperliquidOutcomeMerge, buildEvmMultisignBodyHyperliquidOutcomeMergeQuestion, buildEvmMultisignBodyHyperliquidOutcomeNegate, buildEvmMultisignBodyHyperliquidOutcomeOrder, buildEvmMultisignBodyHyperliquidOutcomeSplit, buildHyperliquidOutcomeCancelAction, buildHyperliquidOutcomeMergeAction, buildHyperliquidOutcomeMergeQuestionAction, buildHyperliquidOutcomeNegateAction, buildHyperliquidOutcomeOrderAction, buildHyperliquidOutcomePurposePrefill, buildHyperliquidOutcomeSplitAction, clearHyperliquidOutcomeMetaCache, fetchHyperliquidOutcomeAccount, fetchHyperliquidOutcomeBook, fetchHyperliquidOutcomeChanceSeries, fillOutcomeTemplate, formatHyperliquidStamp, formatOutcomeQuestion, formatOutcomeRules, getHyperliquidOutcomeMarket, hyperliquidOutcomeFetchMarketSummary, hyperliquidOutcomeFetchMarketsSummary, hyperliquidOutcomeFetchOpenOrdersSummary, hyperliquidOutcomeFetchOrderbookSummary, hyperliquidOutcomeFetchPositionsSummary, hyperliquidOutcomeMatchesQuery, hyperliquidOutcomeProtocolModule, hyperliquidOutcomeToPredictionFields, listHyperliquidOutcomeMarkets, outcomeAssetId, outcomeBalanceCoin, outcomeEncoding, outcomeExpiryUnix, outcomeFieldMap, outcomeSideIndex, outcomeSideName, outcomeTemplateId, outcomeTradeCoin, parseHyperliquidPipeFields, parseHyperliquidStamp, questionForOutcome, resolveOutcomeSideLabel };