@swapkit/helpers 6.3.0 → 6.4.0

package/dist/types/api/swapkitApi/endpoints.d.ts

@@ -1,7 +1,7 @@
 import { type Chain } from "@swapkit/types";
 import { AssetValue } from "../../modules/assetValue";
 import type { ProviderName } from "../../types/quotes";
-import { type BrokerDepositChannelParams, type NearDepositChannelParams, type PriceRequest, type QuoteRequest, type SearchTokensResponse, type SwapRouteV2Response, type SwapToRequest, type SwapToResponse, type TokenListProvidersResponse, type TokensResponseV2, type TrackingRequest } from "./types";
+import { type BrokerDepositChannelParams, type LimitOrderBuildRequest, type LimitOrderCancelSubmitRequest, type LimitOrderListQuery, type LimitOrderQuoteRequest, type LimitOrderSubmitRequest, type NearDepositChannelParams, type PriceRequest, type QuoteRequest, type SearchTokensResponse, type SwapRouteV2Response, type SwapToRequest, type SwapToResponse, type TokenListProvidersResponse, type TokensResponseV2, type TrackingRequest } from "./types";
 export declare const SKRequestClient: {
     extend: (newOptions: RequestInit & {
         json?: unknown;
@@ -372,4 +372,261 @@ export declare function getNearDepositChannel(body: NearDepositChannelParams): P
     tx: unknown;
     deadline?: string | undefined;
 }>;
+export declare function getLimitOrderTokens(): Promise<{
+    crossChain: {
+        assets: string[];
+        chainIds: (import("@swapkit/types").ChainId | (string & {}))[];
+        provider: (string & {}) | ProviderName;
+    }[];
+    singleChain: {
+        assets: string[];
+        chainId: import("@swapkit/types").ChainId | (string & {});
+        provider: (string & {}) | ProviderName;
+    }[];
+}>;
+export declare function getLimitOrderQuote(json: LimitOrderQuoteRequest): Promise<{
+    quoteId: string;
+    routes: {
+        buyAmount: string;
+        buyAsset: string;
+        effectiveFillPrice: string;
+        integratorFeeBps: number;
+        limitPrice: string;
+        maxExpirationSeconds: number;
+        minExpirationSeconds: number;
+        provider: (string & {}) | ProviderName;
+        routeId: string;
+        sellAmount: string;
+        sellAsset: string;
+        spotPrice: string;
+        spotPriceDeviationBps: number;
+        takerFeeBps: number;
+        fees?: {
+            amount: string;
+            asset: string;
+            chain: string;
+            protocol: (string & {}) | ProviderName;
+            type: (string & {}) | import("../..").FeeTypeEnum;
+            amountBps?: number | undefined;
+        }[] | undefined;
+        nextActions?: {
+            method: string;
+            url: string;
+            payload?: unknown;
+        }[] | undefined;
+        warnings?: {
+            code: string;
+            display: string;
+            tooltip?: string | undefined;
+        }[] | undefined;
+    }[];
+    error?: string | undefined;
+    providerErrors?: {
+        errorCode?: string | undefined;
+        message?: string | undefined;
+        provider?: (string & {}) | ProviderName | undefined;
+    }[] | undefined;
+}>;
+export declare function buildLimitOrder(json: LimitOrderBuildRequest): Promise<{
+    nextActions: {
+        method: string;
+        url: string;
+        payload?: unknown;
+    }[];
+    orderHash: string;
+    orderId: string;
+    tx: string | Record<string, unknown> | unknown[] | {
+        data: string;
+        to: string;
+        value: string;
+        from?: string | undefined;
+        gas?: string | undefined;
+        gasPrice?: string | undefined;
+        maxFeePerGas?: string | undefined;
+        maxPriorityFeePerGas?: string | undefined;
+        type?: string | undefined;
+    } | null;
+    txMeta: {
+        txType: "evm" | "cardano" | "near" | "psbt" | "ripple" | "solana" | "starknet" | "stellar" | "sui" | "ton" | "tron";
+        chainId?: number | undefined;
+        memo?: string | undefined;
+    } | null;
+    typedData: {
+        domain: {
+            [x: string]: unknown;
+            chainId: number;
+            name: string;
+            verifyingContract: string;
+            version: string;
+        };
+        message: Record<string, unknown>;
+        primaryType: string;
+        types: Record<string, {
+            name: string;
+            type: string;
+        }[]>;
+    } | null;
+    approvalTx?: {
+        data: string;
+        from: string;
+        to: string;
+        value: string;
+        gasLimit?: string | undefined;
+        gasPrice?: string | undefined;
+    } | undefined;
+    depositAddress?: string | undefined;
+    depositAmount?: string | undefined;
+    depositMemo?: string | undefined;
+    isApproved?: boolean | undefined;
+    warnings?: {
+        code: string;
+        display: string;
+        tooltip?: string | undefined;
+    }[] | undefined;
+}>;
+export declare function submitLimitOrder(json: LimitOrderSubmitRequest): Promise<{
+    createdAt: string;
+    orderHash: string;
+    orderId: string;
+    status: (string & {}) | "CANCELLED" | "EXPIRED" | "FAILED" | "FILLED" | "OPEN" | "PARTIAL" | "PENDING" | "SUBMITTED";
+}>;
+export declare function getLimitOrders(query?: LimitOrderListQuery): Promise<{
+    orders: {
+        buyAmount: string;
+        buyAsset: string;
+        chainId: import("@swapkit/types").ChainId | (string & {});
+        createdAt: string;
+        expiresAt: string;
+        fees: {
+            amount: string;
+            asset: string;
+            chain: string;
+            protocol: (string & {}) | ProviderName;
+            type: (string & {}) | import("../..").FeeTypeEnum;
+            amountBps?: number | undefined;
+        }[];
+        filledBuyAmount: string;
+        filledSellAmount: string;
+        limitPrice: string;
+        maker: string;
+        orderHash: string;
+        orderId: string;
+        provider: (string & {}) | ProviderName;
+        receiver: string | null;
+        sellAmount: string;
+        sellAsset: string;
+        status: (string & {}) | "CANCELLED" | "EXPIRED" | "FAILED" | "FILLED" | "OPEN" | "PARTIAL" | "PENDING" | "SUBMITTED";
+        updatedAt: string;
+        cancelRequestedAt?: string | undefined;
+        depositHash?: string | undefined;
+        txHashes?: {
+            chainId: import("@swapkit/types").ChainId | (string & {});
+            txHash: string;
+            type: "fill" | (string & {}) | "cancel" | "deposit" | "withdraw" | "refund";
+            blockNumber?: number | undefined;
+        }[] | undefined;
+        usdValueClose?: string | null | undefined;
+        usdValueOpen?: string | null | undefined;
+        withdrawHash?: string | undefined;
+    }[];
+    nextCursor?: string | undefined;
+}>;
+export declare function getLimitOrder(orderId: string): Promise<{
+    buyAmount: string;
+    buyAsset: string;
+    chainId: import("@swapkit/types").ChainId | (string & {});
+    createdAt: string;
+    expiresAt: string;
+    fees: {
+        amount: string;
+        asset: string;
+        chain: string;
+        protocol: (string & {}) | ProviderName;
+        type: (string & {}) | import("../..").FeeTypeEnum;
+        amountBps?: number | undefined;
+    }[];
+    filledBuyAmount: string;
+    filledSellAmount: string;
+    limitPrice: string;
+    maker: string;
+    orderHash: string;
+    orderId: string;
+    provider: (string & {}) | ProviderName;
+    receiver: string | null;
+    sellAmount: string;
+    sellAsset: string;
+    status: (string & {}) | "CANCELLED" | "EXPIRED" | "FAILED" | "FILLED" | "OPEN" | "PARTIAL" | "PENDING" | "SUBMITTED";
+    updatedAt: string;
+    cancelRequestedAt?: string | undefined;
+    depositHash?: string | undefined;
+    txHashes?: {
+        chainId: import("@swapkit/types").ChainId | (string & {});
+        txHash: string;
+        type: "fill" | (string & {}) | "cancel" | "deposit" | "withdraw" | "refund";
+        blockNumber?: number | undefined;
+    }[] | undefined;
+    usdValueClose?: string | null | undefined;
+    usdValueOpen?: string | null | undefined;
+    withdrawHash?: string | undefined;
+}>;
+export declare function buildLimitOrderCancel(json: {
+    orderId: string;
+}): Promise<{
+    btcSignaturePreimage: string | null;
+    cancelTx: {
+        chainId: number;
+        data: string;
+        from: string;
+        to: string;
+        value: string;
+    } | null;
+    nextActions: {
+        method: string;
+        url: string;
+        payload?: unknown;
+    }[];
+    orderId: string;
+    typedData: {
+        domain: {
+            [x: string]: unknown;
+            name: string;
+            version: string;
+        };
+        message: {
+            [x: string]: unknown;
+            action: "cancel_and_withdraw";
+            chain: string;
+            expiry: number;
+            l1Address: string;
+            nonce: number;
+            payload: {
+                [x: string]: unknown;
+                orderId: string;
+            };
+        };
+        primaryType: "CancelAndWithdraw";
+        types: {
+            [x: string]: unknown;
+            CancelAndWithdraw: {
+                name: string;
+                type: string;
+            }[];
+            CancelAndWithdrawPayload: {
+                name: string;
+                type: string;
+            }[];
+            EIP712Domain: {
+                name: string;
+                type: string;
+            }[];
+        };
+    } | null;
+}>;
+export declare function submitLimitOrderCancel(json: LimitOrderCancelSubmitRequest): Promise<{
+    orderId: string;
+    status: (string & {}) | "CANCELLED" | "EXPIRED" | "FAILED" | "FILLED" | "OPEN" | "PARTIAL" | "PENDING" | "SUBMITTED";
+    cancelRequestedAt?: string | undefined;
+    txHash?: string | undefined;
+    withdrawId?: string | undefined;
+}>;
 export declare function getSwapTo(params: SwapToRequest): Promise<SwapToResponse>;