@skip-go/client 1.6.0-alpha.3 → 1.6.0-alpha.4

package/dist/esm/callbacks-DdC6QMlE.d.ts

@@ -0,0 +1,158 @@
+import { TxStatusResponse } from './api/postTransactionStatus.js';
+import { T as TransferState, h as AxelarTransferState, g as CCTPTransferState, H as HyperlaneTransferState, O as OPInitTransferState, G as GoFastTransferState, f as StargateTransferState, L as LayerZeroTransferState, b as TransactionState, bs as RouteResponse, a8 as CosmosMsg, az as PostHandler, aA as Route, aX as TransferAssetRelease, aY as TransferStatus, a5 as Erc20Approval } from './swaggerTypes-CzGbnX_b.js';
+import { A as ApiRequest } from './generateApi-Bv02Xt5y.js';
+import { S as SignerGetters, b as GasOptions, B as BaseSettings, U as UserAddress, T as TxResult } from './client-types-D03Tellv.js';
+
+type OverallStatus = "pending" | "success" | "failed";
+declare function getTransferEventsFromTxStatusResponse(txStatusResponse?: TxStatusResponse[]): {
+    status: TransferEventStatus;
+    fromChainId: string;
+    toChainId: string;
+    state: AxelarTransferState | CCTPTransferState | StargateTransferState | GoFastTransferState | HyperlaneTransferState | TransferState | OPInitTransferState | LayerZeroTransferState;
+    fromExplorerLink?: string | undefined;
+    toExplorerLink?: string | undefined;
+    fromTxHash?: string | undefined;
+    toTxHash?: string | undefined;
+    explorerLink?: string | undefined;
+    transferType?: TransferType | undefined;
+    durationInMs?: number | undefined;
+}[];
+declare function getSimpleOverallStatus(state: TransactionState): OverallStatus;
+declare enum TransferType {
+    ibcTransfer = "ibcTransfer",
+    axelarTransfer = "axelarTransfer",
+    cctpTransfer = "cctpTransfer",
+    hyperlaneTransfer = "hyperlaneTransfer",
+    opInitTransfer = "opInitTransfer",
+    goFastTransfer = "goFastTransfer",
+    stargateTransfer = "stargateTransfer",
+    eurekaTransfer = "eurekaTransfer",
+    layerZeroTransfer = "layerZeroTransfer"
+}
+type TransferEventStatus = "unconfirmed" | "signing" | "pending" | "completed" | "failed" | "approving" | "incomplete";
+type ClientTransferEvent = {
+    fromChainId: string;
+    toChainId: string;
+    state: TransferState | AxelarTransferState | CCTPTransferState | HyperlaneTransferState | OPInitTransferState | GoFastTransferState | StargateTransferState | LayerZeroTransferState;
+    status?: TransferEventStatus;
+    fromExplorerLink?: string;
+    toExplorerLink?: string;
+    fromTxHash?: string;
+    toTxHash?: string;
+    explorerLink?: string;
+    transferType?: TransferType;
+    durationInMs?: number;
+};
+
+/** Execute Route Options */
+type ExecuteRouteOptions = SignerGetters & GasOptions & TransactionCallbacks & BaseSettings & Pick<ApiRequest<"msgs">, "timeoutSeconds"> & {
+    route: RouteResponse;
+    /**
+     * Addresses should be in the same order with the `requiredChainAddresses` in the `route`
+     */
+    userAddresses: UserAddress[];
+    /**
+     * If `appendCosmosMsgs` is provided, it will append the specified Cosmos messages to the transactions.
+     */
+    appendCosmosMsgs?: Record<string, CosmosMsg[]>;
+    /**
+     * Specify actions to perform after the route is completed
+     */
+    postRouteHandler?: PostHandler;
+};
+declare const executeRoute: (options: ExecuteRouteOptions) => Promise<void>;
+
+type RouteStatus = "unconfirmed" | "validating" | "allowance" | "signing" | "pending" | "completed" | "incomplete" | "failed";
+type TransactionStatus = "pending" | "success" | "failed";
+type TransactionDetails = {
+    chainId: string;
+    txHash?: string;
+    status?: TransactionStatus;
+    statusResponse?: TxStatusResponse;
+    explorerLink?: string;
+    routeKeyToStatus?: Record<string, TransactionStatus>;
+    routeKey?: string;
+};
+type SimpleRoute = Partial<Pick<Route, "usdAmountIn" | "usdAmountOut" | "amountIn" | "amountOut" | "sourceAssetDenom" | "sourceAssetChainId" | "destAssetDenom" | "destAssetChainId" | "estimatedRouteDurationSeconds" | "operations">>;
+type RouteDetails = {
+    id: string;
+    timestamp: number;
+    status: RouteStatus;
+    route: SimpleRoute;
+    txsRequired: number;
+    txsSigned: number;
+    transactionDetails: TransactionDetails[];
+    transferEvents: ClientTransferEvent[];
+    transferAssetRelease?: TransferAssetRelease;
+    transferIndexToRouteKey?: Record<number, string>;
+    mainRouteId?: string;
+    relatedRoutes?: Partial<RouteDetails>[];
+    routeKey?: string;
+    userAddresses: UserAddress[];
+};
+declare function getTransactionStatus(state?: TransactionState): TransactionStatus;
+type subscribeToRouteStatusProps = {
+    routeDetails?: RouteDetails | RouteDetails[];
+    onRouteStatusUpdated?: ExecuteRouteOptions["onRouteStatusUpdated"];
+};
+type executeAndSubscribeToRouteStatusProps = {
+    routeDetails?: RouteDetails;
+    transactionDetails?: TransactionDetails[];
+    trackTxPollingOptions?: ExecuteRouteOptions["trackTxPollingOptions"];
+    onRouteStatusUpdated?: ExecuteRouteOptions["onRouteStatusUpdated"];
+    executeTransaction?: (index: number) => Promise<TxResult>;
+    options?: ExecuteRouteOptions;
+    routeId?: string;
+    isCancelled?: () => boolean;
+};
+declare const subscribeToRouteStatus: (props: subscribeToRouteStatusProps) => () => void;
+declare const executeAndSubscribeToRouteStatus: ({ transactionDetails, executeTransaction, trackTxPollingOptions, routeDetails, onRouteStatusUpdated, options, routeId, isCancelled, }: executeAndSubscribeToRouteStatusProps) => Promise<void>;
+type updateRouteDetailsProps = {
+    routeDetails?: RouteDetails;
+    transactionDetails?: TransactionDetails[];
+    options?: Partial<ExecuteRouteOptions>;
+    status?: RouteStatus;
+    routeId?: string;
+    mainRouteId?: string;
+    transferIndexToRouteKey?: Record<number, string>;
+    relatedRoutes?: Partial<RouteDetails>[];
+};
+declare const updateRouteDetails: ({ transactionDetails, routeDetails, options, status, routeId, mainRouteId, transferIndexToRouteKey, relatedRoutes, }: updateRouteDetailsProps) => RouteDetails;
+
+type CallbackStatus = "error" | "pending" | "completed";
+type TransactionCallbacks = {
+    onTransactionSignRequested?: (value: {
+        chainId: string;
+        txIndex: number;
+        signerAddress?: string;
+    }) => Promise<void>;
+    onTransactionSigned?: (txInfo: {
+        chainId: string;
+    }) => Promise<void>;
+    onTransactionBroadcast?: (txInfo: {
+        txHash: string;
+        chainId: string;
+    }) => Promise<void>;
+    onTransactionTracked?: (txInfo: {
+        txHash: string;
+        chainId: string;
+        explorerLink: string;
+    }) => Promise<void>;
+    onTransactionCompleted?: (txInfo: {
+        chainId: string;
+        txHash: string;
+        status?: TransferStatus;
+    }) => Promise<void>;
+    onRouteStatusUpdated?: (routeStatus: RouteDetails) => void;
+    onValidateGasBalance?: (value: {
+        chainId?: string;
+        txIndex?: number;
+        status: CallbackStatus;
+    }) => Promise<void>;
+    onApproveAllowance?: (value: {
+        allowance?: Erc20Approval;
+        status: CallbackStatus;
+    }) => Promise<void>;
+};
+
+export { type ClientTransferEvent as C, type ExecuteRouteOptions as E, type OverallStatus as O, type RouteDetails as R, type TransactionDetails as T, type RouteStatus as a, type TransactionStatus as b, type TransferEventStatus as c, TransferType as d, executeRoute as e, getSimpleOverallStatus as f, getTransferEventsFromTxStatusResponse as g, type TransactionCallbacks as h, getTransactionStatus as i, type subscribeToRouteStatusProps as j, type executeAndSubscribeToRouteStatusProps as k, executeAndSubscribeToRouteStatus as l, subscribeToRouteStatus as s, updateRouteDetails as u };