@0xsquid/squid-types 0.1.26 → 0.1.27

package/dist/fees/index.d.ts

@@ -1,4 +1,4 @@
-import { Token } from "tokens";
+import { Token } from "../tokens";
 export declare enum FeeType {
     AXELAR_FEE = "Axelar Fee",
     GAS_RECEIVER_FEE = "Gas Receiver Fee",

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export * from "./routes";
 export * from "./squid";
 export * from "./status";
 export * from "./wrappers";
+export * from "./path";

package/dist/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./routes"), exports);
 __exportStar(require("./squid"), exports);
 __exportStar(require("./status"), exports);
 __exportStar(require("./wrappers"), exports);
+__exportStar(require("./path"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB;AACzB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB;AACzB,6CAA2B;AAC3B,yCAAuB"}

package/dist/path/index.d.ts

@@ -0,0 +1,61 @@
+import { Dex, DexName } from "../dexes";
+import { ChainData, ChainType } from "../chains";
+import { ActionType } from "../routes";
+import { Token } from "../tokens";
+import { WrapperType } from "wrappers";
+export interface PathInternal {
+    fromChain: string;
+    fromToken: string;
+    toChain: string;
+    toToken: string;
+    actions: PathActionInternal[];
+}
+export interface Path {
+    fromChain: ChainData;
+    fromToken: Token;
+    toChain: ChainData;
+    toToken: Token;
+    actions: PathAction[];
+}
+export interface PathActionInternal {
+    type: ActionType;
+    chainType: ChainType;
+    fromChainId: string;
+    toChainId: string;
+    fromToken: string;
+    toToken: string;
+    data: Record<string, any>;
+}
+export interface ActionBaseData {
+    dex: DexName | Dex;
+    chainId: string;
+    slippage: number;
+    path: string[];
+    custom: Record<string, any>;
+    poolFees: number[][];
+    pools: string[];
+    poolId: string;
+    isStable: boolean[];
+    exchangeId?: string;
+    exchangeProvider?: string;
+    address: string;
+    wrapper: string;
+    type: WrapperType;
+    coinAddresses: string[];
+}
+export interface PathAction {
+    type: ActionType;
+    chainType: ChainType;
+    fromChain: ChainData;
+    toChain: ChainData;
+    fromToken: Token;
+    toToken: Token;
+    data: ActionBaseData;
+}
+export interface PathParams {
+    fromChainId: string;
+    toChainId: string;
+    fromToken: Pick<Token, "type" | "chainId" | "name" | "symbol" | "decimals" | "address">;
+    toToken: Pick<Token, "type" | "chainId" | "name" | "symbol" | "decimals" | "address">;
+    maxResults?: number;
+}

package/dist/path/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/path/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/path/index.ts"],"names":[],"mappings":""}

package/dist/quote/index.d.ts

@@ -1,4 +1,4 @@
-import { ActionStage, ActionType, BridgeDetails, ChainType, CustomCallDetails, SwapDetails, IbcTransferDetails, Token } from "../index";
+import { ActionStage, BridgeDetails, CustomCallDetails, SwapDetails, PathAction, WrapDetails } from "../index";
 export interface Quote {
     actions: QuoteAction[];
     fromAmount: string;
@@ -12,13 +12,12 @@ export interface Quote {
     toAmountUsd?: string;
     aggregateSlippage?: number;
 }
-export interface QuoteAction {
-    type: ActionType;
-    chainType: ChainType;
-    fromChainId: string;
-    toChainId: string;
-    fromToken: Token;
-    toToken: Token;
+export interface QuoteAction extends Omit<PathAction, "data"> {
+    fromAmount: string;
+    toAmount: string;
+    toAmountMin: string;
+    exchangeRate: string;
+    priceImpact: string;
     stage?: ActionStage;
-    details: SwapDetails | BridgeDetails | CustomCallDetails | IbcTransferDetails;
+    data: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails;
 }

package/dist/routes/index.d.ts

@@ -1,25 +1,16 @@
-import { ChainData, ChainType } from "chains";
-import { Dex, DexName } from "dexes";
-import { FeeCost, GasCost } from "fees";
-import { ChainCall, EvmContractCall, SlippageMode, SquidData } from "squid";
-import { Token } from "tokens";
-import { WrapDirection, WrapperType } from "wrappers";
-export declare enum ActionType {
-    SWAP = "swap",
-    WRAP = "wrap",
-    BRIDGE = "bridge",
-    IBC_TRANSFER = "ibc-transfer",
-    CUSTOM = "custom"
-}
-export declare enum ActionStage {
-    EVM_SOURCE = 0,
-    EVM_DESTINATION = 1,
-    EVM_TRANSIENT = 2,
-    EVM_ONLY = 3,
-    COSMOS_SOURCE = 4,
-    COSMOS_DESTINATION = 5,
-    COSMOS_TRANSIENT = 6,
-    COSMOS_ONLY = 7
+import { ChainData, ChainType } from "../chains";
+import { Dex, DexName } from "../dexes";
+import { FeeCost, GasCost } from "../fees";
+import { QuoteAction } from "../quote";
+import { ChainCall, EvmContractCall, SlippageMode, SquidData } from "../squid";
+import { Token } from "../tokens";
+import { WrapDirection, WrapperType } from "../wrappers";
+export interface RouteResponse {
+    route: {
+        estimate: Estimate;
+        transactionRequest: SquidData;
+        params: RouteRequest;
+    };
 }
 export interface RouteRequest {
     fromChain: string;
@@ -40,39 +31,6 @@ export interface RouteRequest {
     prefer?: DexName[];
     receiveGasOnDestination?: boolean;
 }
-export interface Route {
-    actions: RouteAction[];
-    fromToken: Token;
-    toToken: Token;
-    fromAmount: string;
-    toAmount: string;
-    toAmountMin: string;
-    sendAmount: string;
-    exchangeRate: string;
-    aggregatePriceImpact: string;
-    estimatedRouteDuration: number;
-    fromAmountUSD?: string;
-    toAmountUSD?: string;
-    isBoostSupported: boolean;
-    gasCosts: GasCost[];
-    feeCosts: FeeCost[];
-}
-export interface StageContext {
-    stage: ActionStage;
-    isSourceNative: boolean;
-    isDestinationNative: boolean;
-    isEvm: boolean;
-    isCosmos: boolean;
-    toAddress: string;
-    receiver: string;
-    isFirstAction?: boolean;
-    isLastAction?: boolean;
-    hasDestinationCalls?: boolean;
-    hasSourceCalls?: boolean;
-    multicall?: string;
-    preHook: boolean;
-    postHook: boolean;
-}
 export interface RouteRequestPopulated {
     fromChain: ChainData;
     toChain: ChainData;
@@ -92,83 +50,99 @@ export interface RouteRequestPopulated {
     prefer?: DexName[];
     receiveGasOnDestination?: boolean;
 }
-export interface RouteResponse {
-    route: {
-        estimate: Estimate;
-        transactionRequest: SquidData;
-        params: RouteRequest;
-    };
-}
 export interface Estimate extends Route {
-    actions: SimpleRouteAction[];
+    actions: RouteAction[];
 }
-export interface RouteAction {
-    type: ActionType;
-    chainType: ChainType;
-    fromChainId: string;
-    toChainId: string;
+export interface Route {
+    actions: RouteAction[];
     fromToken: Token;
     toToken: Token;
+    fromAmount: string;
+    toAmount: string;
+    toAmountMin: string;
+    sendAmount: string;
+    exchangeRate: string;
+    aggregatePriceImpact: string;
+    estimatedRouteDuration: number;
+    fromAmountUSD?: string;
+    toAmountUSD?: string;
+    isBoostSupported: boolean;
+    gasCosts: GasCost[];
+    feeCosts: FeeCost[];
+}
+export interface RouteAction extends QuoteAction {
     provider?: string;
     description?: string;
-    stage?: ActionStage;
-    details: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails | IbcTransferDetails;
+    data: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails;
 }
-export interface SimpleRouteAction extends RouteAction {
-    details: SimpleSwapDetails | SimpleWrapDetails | BridgeDetails | CustomCallDetails | IbcTransferDetails;
+export declare enum ActionType {
+    SWAP = "swap",
+    WRAP = "wrap",
+    BRIDGE = "bridge",
+    IBC_TRANSFER = "ibc-transfer",
+    CUSTOM = "custom"
 }
-export interface BaseSwapDetails {
+export interface WrapDetails {
     target: string;
     path: string[];
-    swapType: string;
-    fromAmount: string;
-    toAmount: string;
-    toAmountMin: string;
-    exchangeRate: string;
-    priceImpact: string;
-    isWrappedNative?: boolean;
-    dynamicSlippage?: number;
-}
-export interface WrapDetails extends SimpleWrapDetails {
+    type: WrapperType;
+    address: string;
+    wrapper: string;
+    coinAddresses: string[];
+    direction: WrapDirection;
     calls: ChainCall[];
     custom?: Record<string, any>;
 }
-export interface SimpleWrapDetails {
+export interface SwapDetails {
     target: string;
     path: string[];
-    wrapType: WrapperType;
-    direction: WrapDirection;
-    fromAmount: string;
-    toAmount: string;
-    exchangeRate: string;
-    priceImpact: string;
-}
-export interface SwapDetails extends BaseSwapDetails {
     dex: Dex;
     calls: ChainCall[];
+    pools: string[];
+    poolFees: string[];
+    coinAddresses: string[];
+    exchangeId?: string;
+    exchangeProvider?: string;
     custom?: Record<string, any>;
-    pools?: string[];
-}
-export interface SimpleSwapDetails extends BaseSwapDetails {
-    dexName: DexName;
 }
 export interface BridgeDetails {
     target: string;
     provider: string;
     name: string;
-    sendAmount: string;
-    receiveAmount: string;
-    exchangeRate: string;
 }
 export interface CustomCallDetails {
     name: string;
     calls: EvmContractCall[];
 }
-export interface IbcTransferDetails {
-}
 export interface Hook {
     chainType: ChainType;
     fundAmount: string;
     fundToken: string;
     calls: ChainCall[];
 }
+export declare enum ActionStage {
+    EVM_SOURCE = 0,
+    EVM_DESTINATION = 1,
+    EVM_TRANSIENT = 2,
+    EVM_ONLY = 3,
+    COSMOS_SOURCE = 4,
+    COSMOS_DESTINATION = 5,
+    COSMOS_TRANSIENT = 6,
+    COSMOS_ONLY = 7
+}
+export interface StageContext {
+    stage: ActionStage;
+    isSourceNative: boolean;
+    isDestinationNative: boolean;
+    isEvm: boolean;
+    isCosmos: boolean;
+    toAddress: string;
+    receiver: string;
+    isFirstAction?: boolean;
+    isLastAction?: boolean;
+    hasDestinationCalls?: boolean;
+    hasSourceCalls?: boolean;
+    multicall?: string;
+    preHook: boolean;
+    postHook: boolean;
+}

package/dist/routes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/routes/index.ts"],"names":[],"mappings":";;;AAOA,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,WASX;AATD,WAAY,WAAW;IACrB,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,+DAAa,CAAA;IACb,qDAAQ,CAAA;IACR,+DAAa,CAAA;IACb,yEAAkB,CAAA;IAClB,qEAAgB,CAAA;IAChB,2DAAW,CAAA;AACb,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/routes/index.ts"],"names":[],"mappings":";;;AAoFA,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AA6CD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,+DAAa,CAAA;IACb,qDAAQ,CAAA;IACR,+DAAa,CAAA;IACb,yEAAkB,CAAA;IAClB,qEAAgB,CAAA;IAChB,2DAAW,CAAA;AACb,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB"}

package/dist/squid/index.d.ts

@@ -1,4 +1,4 @@
-import { ChainType } from "chains";
+import { ChainType } from "../chains";
 export declare enum SquidRouteType {
     CALL_BRIDGE_CALL = "CALL_BRIDGE_CALL",
     CALL_BRIDGE = "CALL_BRIDGE",

package/dist/status/index.d.ts

@@ -1,6 +1,6 @@
 import { BlockTag } from "@ethersproject/providers";
 import { GMPError } from "@axelar-network/axelarjs-sdk";
-import { ChainData } from "chains";
+import { ChainData } from "../chains";
 export type StatusRequest = {
     transactionId: string;
     routeType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsquid/squid-types",
-  "version": "0.1.26",
+  "version": "0.1.27",
   "description": "JS and TS types relating to 0xsquid related projects.",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",