@pegaroute/sdk 0.1.0 → 0.2.0

package/README.md

@@ -20,7 +20,7 @@ frontend read it.
 ## Quote and swap (backend)
 
 ```ts
-import { type CreateSwapParams, Pegaroute } from "@pegaroute/sdk";
+import { type CreateSwapParams, hasQuoteRouteFees, Pegaroute } from "@pegaroute/sdk";
 
 const pr = new Pegaroute({ apiKey: process.env.PEGAROUTE_API_KEY!, baseUrl: process.env.PEGAROUTE_BASE_URL! });
 
@@ -39,12 +39,22 @@ const quote = await pr.quotes.get(params);
 const best = quote.routes[0];
 
 if (best) {
+  // Show the user what the route costs. `{}` means no fee data, not a zero fee.
+  if (hasQuoteRouteFees(best.fees)) showCost(`$${best.fees.totalUsd} (${best.fees.totalBps} bps)`);
+
+  // Some routes add a fee in the source chain's native coin, which the wallet pays on top of `amount`.
+  if (best.additionalFee) showExtraFee(`${best.additionalFee.amount} ${best.additionalFee.token}`);
+
   const swap = await pr.swaps.create({ ...params, quoteId: quote.quoteId, routeProvider: best.provider });
 
   // Send `swap.transactionId` and `swap.execution` to the frontend for signing.
 }
 ```
 
+`fees.totalUsd` is never negative. If the output is worth more than the input at reference prices, every fee is `0`,
+so two routes showing `0` can still pay out different amounts: compare routes by `expectedOutput`. Only
+`fees.breakdown.route` can be negative, when the provider's rate beats the reference price.
+
 ## Sign (frontend, EVM with viem)
 
 `swap.execution` says what the user's wallet must sign. For an EVM router call (e.g. THORChain):

package/dist/{index-CeY_5Z4u.d.ts → index-ClDOR6-k.d.ts}

@@ -171,28 +171,83 @@ interface TokenAmount {
   baseUnits: string;
 }
 /**
- * Fees for a route, as human-readable decimal strings.
+ * A fee, in two forms: USD, and basis points of the swap's input USD value (100 bps = 1%).
  *
- * Amounts are in destination-asset units (THORChain/Maya), or in USD when `unit` is `"USD"` (Instaswap/Squid).
- * Read `total` for the full fee the user pays.
+ * @example
+ * { usd: "2.5", bps: 10 } // $2.50 on a $2,500 swap
+ */
+interface FeeAmount {
+  /** Amount in USD, as a decimal string, e.g. `"2.7178"`. */
+  usd: string;
+  /** The same amount in basis points of the input USD value. */
+  bps: number;
+}
+/**
+ * What a route costs the user, in USD and in basis points of the input USD value.
+ *
+ * Pegaroute prices the input and output tokens once per quote request, so all routes of a quote use the same
+ * reference prices and compare directly. Source-chain gas that the wallet pays and the route's `additionalFee` are not
+ * included.
+ *
+ * Never negative. If `expectedOutput` is worth more than the input (the user gains on the swap), `totalUsd`, `totalBps`
+ * and every part of `breakdown` are `0` instead of negative. A `0` fee therefore doesn't say how much the user gains:
+ * if two routes both show `0`, one can still pay out more. Compare them by `expectedOutput`, not by fee.
+ */
+interface QuoteRouteFees {
+  /** `totalUsd` in basis points of the input USD value. Never negative. */
+  totalBps: number;
+  /** Cost of the swap in USD: input USD − `expectedOutput` USD. Never negative. */
+  totalUsd: string;
+  /** The total split in three parts: `affiliate` + `route` + `gas` = total, in USD and in bps. */
+  breakdown: {
+    /** The fee that Pegaroute and the integrator receive. */
+    affiliate: FeeAmount;
+    /**
+     * All other costs: provider fees, price impact, spread, and the difference between the provider's price and the
+     * reference price.
+     *
+     * Can be negative. That happens when the provider offers a better rate than the reference price: the extra the
+     * user gets cancels out part of the affiliate and gas fees, so the total ends up below `affiliate` + `gas`. The
+     * three parts still add up to the total.
+     *
+     * @example
+     * // $1,000 in, $999.50 out: total $0.50, affiliate $1, gas $0 → route $0.50 − $1 − $0.
+     * // The provider's rate is $0.50 better than the reference price.
+     * { usd: "-0.5", bps: -5 }
+     */
+    route: FeeAmount;
+    /**
+     * Gas the provider takes from the output (`expectedOutput` is already after it). On Instaswap private routes it
+     * also includes the zkproof protocol fee.
+     */
+    gas: FeeAmount;
+  };
+}
+/**
+ * A route's `fees` when Pegaroute has no fee data for it, sent as `{}`: there is no reference price for the input or
+ * output token, or the provider's quote doesn't show the fee it applies. This is not a zero fee: don't show it as one.
+ */
+type NoQuoteRouteFees = { [K in keyof QuoteRouteFees]?: never; };
+/**
+ * Whether Pegaroute sent fee data for a route. `false` means `{}`: no fee data, not a zero fee.
+ *
+ * @example
+ * if (hasQuoteRouteFees(route.fees)) {
+ *   show(`$${route.fees.totalUsd} (${route.fees.totalBps} bps)`);
+ * }
  */
-interface QuoteFees {
-  /** Pegaroute's affiliate fee. For Instaswap and Squid this excludes the integrator's share (see `subAffiliate`). */
-  affiliate: string;
-  /** Liquidity and other route fees. On Squid this includes Squid's own platform share. */
-  liquidity: string;
-  /** Outbound gas fee on the destination chain (`"0"` when not applicable). */
-  outbound: string;
-  /** Sum of `affiliate`, `liquidity`, `outbound` and `subAffiliate` (when present). */
-  total: string;
-  /** Present when all fee amounts are in USD instead of asset units. */
-  unit?: "USD";
-  /** The integrator's USD share, excluded from `affiliate` (Instaswap/Squid only). */
-  subAffiliate?: string;
-  /** Total provider-facing fee in basis points, when the provider reports it. */
-  totalBps?: number;
-  /** Slippage in basis points, when the provider reports it. */
-  slippageBps?: number;
+declare function hasQuoteRouteFees(fees: QuoteRouteFees | NoQuoteRouteFees): fees is QuoteRouteFees;
+/**
+ * A fee the wallet pays in the source chain's native coin, on top of the quoted amount and the source network gas.
+ *
+ * @example
+ * { token: "ETH", amount: "0.0004" } // a 0.1 ETH swap needs to send 0.1004 ETH
+ */
+interface AdditionalFee {
+  /** Token ID of the source chain's native coin, as in `tokens.list(fromChain)`, e.g. `"ETH"`. */
+  token: string;
+  /** Fee amount, as a human-readable decimal, e.g. `"0.0004"`. */
+  amount: string;
 }
 /** How the affiliate fee on a swap was split between Pegaroute and the integrator, in basis points. */
 interface AffiliateFeeBreakdown {
@@ -239,8 +294,6 @@ interface RouteInfo {
   private?: PrivateSwapMode;
   /** Expected output amount in the destination token, as a human-readable decimal. */
   expectedOutput: string;
-  /** Fees for this route. */
-  fees: QuoteFees;
   /** Estimated time to complete, in seconds. */
   estimatedTimeSeconds: number;
   /** OpenOcean aggregator behind the route (Solana/Sui only). */
@@ -345,12 +398,31 @@ interface QuoteRoute {
   private?: PrivateSwapMode;
   /** The provider's integration type. */
   providerType: ProviderType;
-  /** Expected output in the destination token, as a human-readable decimal, after fees. */
+  /**
+   * Expected output in the destination token, as a human-readable decimal: after all fees, including
+   * `fees.breakdown.gas`. `additionalFee` is not taken from it, since the wallet pays that fee on top.
+   */
   expectedOutput: string;
   /** Estimated time to complete, in seconds. */
   estimatedTimeSeconds: number;
-  /** Fees for this route. */
-  fees: QuoteFees;
+  /**
+   * What this route costs, or `{}` when Pegaroute has no fee data for it (not a zero fee). Tell them apart with
+   * `hasQuoteRouteFees`.
+   *
+   * @example
+   * if (hasQuoteRouteFees(route.fees)) {
+   *   show(`$${route.fees.totalUsd} (${route.fees.totalBps} bps)`);
+   * }
+   */
+  fees: QuoteRouteFees | NoQuoteRouteFees;
+  /**
+   * A fee the wallet pays in the source chain's native coin, on top of the quoted amount and the source network gas, or
+   * `null` when there is none. Show it to the user next to the route's cost.
+   *
+   * On Squid routes this is the Axelar gas receiver fee; on an EVM chain the transaction `value` from `swaps.create`
+   * already includes it. Neither `expectedOutput` nor `fees` include it, but the route order does.
+   */
+  additionalFee: AdditionalFee | null;
   /** The provider's own quote expiry (ISO 8601 or Unix seconds), if it has one. Use the quote's `expiresAt` instead. */
   expiry: string | null;
   /** Transaction memo (THORChain/Maya), if any. */
@@ -363,11 +435,6 @@ interface QuoteRoute {
   gasRate: string | null;
   /** Minimum swap amount in the source token, as a human-readable decimal, if the provider has one. */
   minAmount: string | null;
-  /** The fee applied to this route after provider caps. */
-  resolvedFee: {
-    /** Effective fee in basis points. */
-    feeBps: number;
-  };
   /** OpenOcean aggregator behind the route (Solana/Sui only). */
   openOceanRoute?: OpenOceanRouteMeta;
 }
@@ -392,7 +459,11 @@ interface QuoteResponse {
   quoteId: string;
   /** When the quote expires (ISO 8601). After that, `swaps.create` throws `QuoteExpiredError`. */
   expiresAt: string;
-  /** Available routes, best first: highest output, then fastest, then lowest slippage. */
+  /**
+   * Available routes, best first. Routes are ranked by `expectedOutput` minus `additionalFee`, then by speed. To
+   * subtract the fee, Pegaroute converts it to the output token at reference prices. If it has no reference price for
+   * either token, it ranks that route by `expectedOutput` alone.
+   */
   routes: QuoteRoute[];
   /** One entry per provider that was tried but didn't return a route. */
   warnings: RouteWarning[];
@@ -828,8 +899,6 @@ interface GetSwapResponse {
   input: SwapInput;
   /** The destination side of the swap. */
   output: SwapOutput;
-  /** Fees for the swap. */
-  fees: QuoteFees;
   /** How the affiliate fee was split, when recorded. */
   affiliateFeeBreakdown?: AffiliateFeeBreakdown;
   /** When the swap reached each stage. */
@@ -925,8 +994,6 @@ interface Transaction {
   destination: SwapOutput;
   /** The route the swap executes on. */
   route: RouteInfo;
-  /** Fees for the swap. */
-  fees: QuoteFees;
   /** How the affiliate fee was split, when recorded. */
   affiliateFeeBreakdown?: AffiliateFeeBreakdown;
   /** Why the swap failed, if it did. */
@@ -1015,8 +1082,6 @@ interface TransactionWebhookData {
   input: Pick<SwapInput, "chain" | "token" | "amount" | "address" | "refundAddress" | "txHash">;
   /** The destination side of the swap. */
   output: SwapOutput;
-  /** Fees for the swap. */
-  fees: QuoteFees;
   /** When the swap reached each stage. */
   timestamps: SwapTimestamps;
   /** Why the swap failed, or `null`. */
@@ -1067,4 +1132,4 @@ interface TestWebhookEvent {
  */
 type WebhookEvent = TransactionWebhookEvent | TestWebhookEvent;
 //#endregion
-export { KnownErrorCode as $, toExternalStatus as A, JsonSwapExecution as B, SwapInput as C, Token as Ct, InternalSwapStatus as D, SwapTimestamps as E, EvmSwapExecution as F, UtxoSwapExecution as G, OtherDepositSwapExecution as H, ExecutionFamily as I, GetQuoteParams as J, isExecutionFamily as K, ExecutionMode as L, CosmosMsgDepositSwapExecution as M, CosmosMsgExecuteSwapExecution as N, SwapStatus as O, EvmApproval as P, ErrorCode as Q, ExecutionOfFamily as R, SwapFailure as S, ProvidersResponse as St, SwapProviderInfo as T, SerializedSwapExecution as U, NamedDepositSwapExecution as V, SwapExecution as W, QuoteRoute as X, QuoteResponse as Y, RouteWarning as Z, ProviderStatusInfo as _, ProviderFeeStructure as _t, WebhookEvent as a, QuoteFees as at, SwapEvent as b, ProviderTakeStructure as bt, ExpectedAffiliateEntry as c, StreamingProgress as ct, TransactionsResponse as d, ChainsResponse as dt, AffiliateFeeBreakdown as et, CreateSwapParams as f, HealthResponse as ft, InstaswapSwapLiteSnapshot as g, ProviderAffiliateFeeStructure as gt, InstaswapFeeLine as h, PingResponse as ht, TransactionWebhookEventType as i, Provider as it, CosmosBankSendSwapExecution as j, isTerminalStatus as k, ListTransactionsParams as l, TokenAmount as lt, GetSwapResponse as m, ListProvidersParams as mt, TransactionWebhookData as n, OpenOceanRouteMeta as nt, WebhookStreamingProgress as o, RefundInfo as ot, CreateSwapResponse as p, KnownProviderType as pt, isExecutionMode as q, TransactionWebhookEvent as r, PrivateSwapMode as rt, CursorPagination as s, RouteInfo as st, TestWebhookEvent as t, KnownProvider as tt, Transaction as u, Chain as ut, SubmitTxHashParams as v, ProviderHealth as vt, SwapOutput as w, TokensResponse as wt, SwapEventsResponse as x, ProviderType as xt, SubmitTxHashResponse as y, ProviderInfo as yt, ExecutionOfMode as z };
+export { KnownErrorCode as $, toExternalStatus as A, JsonSwapExecution as B, SwapInput as C, ProviderInfo as Ct, InternalSwapStatus as D, Token as Dt, SwapTimestamps as E, ProvidersResponse as Et, EvmSwapExecution as F, UtxoSwapExecution as G, OtherDepositSwapExecution as H, ExecutionFamily as I, GetQuoteParams as J, isExecutionFamily as K, ExecutionMode as L, CosmosMsgDepositSwapExecution as M, CosmosMsgExecuteSwapExecution as N, SwapStatus as O, TokensResponse as Ot, EvmApproval as P, ErrorCode as Q, ExecutionOfFamily as R, SwapFailure as S, ProviderHealth as St, SwapProviderInfo as T, ProviderType as Tt, SerializedSwapExecution as U, NamedDepositSwapExecution as V, SwapExecution as W, QuoteRoute as X, QuoteResponse as Y, RouteWarning as Z, ProviderStatusInfo as _, KnownProviderType as _t, WebhookEvent as a, OpenOceanRouteMeta as at, SwapEvent as b, ProviderAffiliateFeeStructure as bt, ExpectedAffiliateEntry as c, QuoteRouteFees as ct, TransactionsResponse as d, StreamingProgress as dt, AdditionalFee as et, CreateSwapParams as f, TokenAmount as ft, InstaswapSwapLiteSnapshot as g, HealthResponse as gt, InstaswapFeeLine as h, ChainsResponse as ht, TransactionWebhookEventType as i, NoQuoteRouteFees as it, CosmosBankSendSwapExecution as j, isTerminalStatus as k, ListTransactionsParams as l, RefundInfo as lt, GetSwapResponse as m, Chain as mt, TransactionWebhookData as n, FeeAmount as nt, WebhookStreamingProgress as o, PrivateSwapMode as ot, CreateSwapResponse as p, hasQuoteRouteFees as pt, isExecutionMode as q, TransactionWebhookEvent as r, KnownProvider as rt, CursorPagination as s, Provider as st, TestWebhookEvent as t, AffiliateFeeBreakdown as tt, Transaction as u, RouteInfo as ut, SubmitTxHashParams as v, ListProvidersParams as vt, SwapOutput as w, ProviderTakeStructure as wt, SwapEventsResponse as x, ProviderFeeStructure as xt, SubmitTxHashResponse as y, PingResponse as yt, ExecutionOfMode as z };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { $ as KnownErrorCode, A as toExternalStatus, B as JsonSwapExecution, C as SwapInput, Ct as Token, D as InternalSwapStatus, E as SwapTimestamps, F as EvmSwapExecution, G as UtxoSwapExecution, H as OtherDepositSwapExecution, I as ExecutionFamily, J as GetQuoteParams, K as isExecutionFamily, L as ExecutionMode, M as CosmosMsgDepositSwapExecution, N as CosmosMsgExecuteSwapExecution, O as SwapStatus, P as EvmApproval, Q as ErrorCode, R as ExecutionOfFamily, S as SwapFailure, St as ProvidersResponse, T as SwapProviderInfo, U as SerializedSwapExecution, V as NamedDepositSwapExecution, W as SwapExecution, X as QuoteRoute, Y as QuoteResponse, Z as RouteWarning, _ as ProviderStatusInfo, _t as ProviderFeeStructure, a as WebhookEvent, at as QuoteFees, b as SwapEvent, bt as ProviderTakeStructure, c as ExpectedAffiliateEntry, ct as StreamingProgress, d as TransactionsResponse, dt as ChainsResponse, et as AffiliateFeeBreakdown, f as CreateSwapParams, ft as HealthResponse, g as InstaswapSwapLiteSnapshot, gt as ProviderAffiliateFeeStructure, h as InstaswapFeeLine, ht as PingResponse, i as TransactionWebhookEventType, it as Provider, j as CosmosBankSendSwapExecution, k as isTerminalStatus, l as ListTransactionsParams, lt as TokenAmount, m as GetSwapResponse, mt as ListProvidersParams, n as TransactionWebhookData, nt as OpenOceanRouteMeta, o as WebhookStreamingProgress, ot as RefundInfo, p as CreateSwapResponse, pt as KnownProviderType, q as isExecutionMode, r as TransactionWebhookEvent, rt as PrivateSwapMode, s as CursorPagination, st as RouteInfo, t as TestWebhookEvent, tt as KnownProvider, u as Transaction, ut as Chain, v as SubmitTxHashParams, vt as ProviderHealth, w as SwapOutput, wt as TokensResponse, x as SwapEventsResponse, xt as ProviderType, y as SubmitTxHashResponse, yt as ProviderInfo, z as ExecutionOfMode } from "./index-CeY_5Z4u.js";
+import { $ as KnownErrorCode, A as toExternalStatus, B as JsonSwapExecution, C as SwapInput, Ct as ProviderInfo, D as InternalSwapStatus, Dt as Token, E as SwapTimestamps, Et as ProvidersResponse, F as EvmSwapExecution, G as UtxoSwapExecution, H as OtherDepositSwapExecution, I as ExecutionFamily, J as GetQuoteParams, K as isExecutionFamily, L as ExecutionMode, M as CosmosMsgDepositSwapExecution, N as CosmosMsgExecuteSwapExecution, O as SwapStatus, Ot as TokensResponse, P as EvmApproval, Q as ErrorCode, R as ExecutionOfFamily, S as SwapFailure, St as ProviderHealth, T as SwapProviderInfo, Tt as ProviderType, U as SerializedSwapExecution, V as NamedDepositSwapExecution, W as SwapExecution, X as QuoteRoute, Y as QuoteResponse, Z as RouteWarning, _ as ProviderStatusInfo, _t as KnownProviderType, a as WebhookEvent, at as OpenOceanRouteMeta, b as SwapEvent, bt as ProviderAffiliateFeeStructure, c as ExpectedAffiliateEntry, ct as QuoteRouteFees, d as TransactionsResponse, dt as StreamingProgress, et as AdditionalFee, f as CreateSwapParams, ft as TokenAmount, g as InstaswapSwapLiteSnapshot, gt as HealthResponse, h as InstaswapFeeLine, ht as ChainsResponse, i as TransactionWebhookEventType, it as NoQuoteRouteFees, j as CosmosBankSendSwapExecution, k as isTerminalStatus, l as ListTransactionsParams, lt as RefundInfo, m as GetSwapResponse, mt as Chain, n as TransactionWebhookData, nt as FeeAmount, o as WebhookStreamingProgress, ot as PrivateSwapMode, p as CreateSwapResponse, pt as hasQuoteRouteFees, q as isExecutionMode, r as TransactionWebhookEvent, rt as KnownProvider, s as CursorPagination, st as Provider, t as TestWebhookEvent, tt as AffiliateFeeBreakdown, u as Transaction, ut as RouteInfo, v as SubmitTxHashParams, vt as ListProvidersParams, w as SwapOutput, wt as ProviderTakeStructure, x as SwapEventsResponse, xt as ProviderFeeStructure, y as SubmitTxHashResponse, yt as PingResponse, z as ExecutionOfMode } from "./index-ClDOR6-k.js";
 //#region src/core/http.d.ts
 /** Per-call options accepted by every SDK method. */
 interface RequestOptions {
@@ -496,4 +496,4 @@ interface VerifyWebhookParams {
  */
 export declare function verifyWebhook(params: VerifyWebhookParams): Promise<WebhookEvent>;
 //#endregion
-export { type AffiliateFeeBreakdown, type Chain, type ChainsResponse, type CosmosBankSendSwapExecution, type CosmosMsgDepositSwapExecution, type CosmosMsgExecuteSwapExecution, type CreateSwapParams, type CreateSwapResponse, type CursorPagination, type ErrorCode, type EvmApproval, type EvmSwapExecution, type ExecutionFamily, type ExecutionMode, type ExecutionOfFamily, type ExecutionOfMode, type ExpectedAffiliateEntry, type Fetch, type GetQuoteParams, type GetSwapResponse, type HealthResponse, type InstaswapFeeLine, type InstaswapSwapLiteSnapshot, type InternalSwapStatus, type JsonSwapExecution, type KnownErrorCode, type KnownProvider, type KnownProviderType, type ListProvidersParams, type ListTransactionsParams, type NamedDepositSwapExecution, type OpenOceanRouteMeta, type OtherDepositSwapExecution, type PagePromise, type PegarouteOptions, type PingResponse, type PrivateSwapMode, type Provider, type ProviderAffiliateFeeStructure, type ProviderFeeStructure, type ProviderHealth, type ProviderInfo, type ProviderStatusInfo, type ProviderTakeStructure, type ProviderType, type ProvidersResponse, type QuoteFees, type QuoteResponse, type QuoteRoute, type RefundInfo, type RequestOptions, type RouteInfo, type RouteWarning, type SerializedSwapExecution, type StreamingProgress, type SubmitTxHashParams, type SubmitTxHashResponse, type SwapEvent, type SwapEventsResponse, type SwapExecution, type SwapFailure, type SwapInput, type SwapOutput, type SwapProviderInfo, type SwapStatus, type SwapTimestamps, type TestWebhookEvent, type Token, type TokenAmount, type TokensResponse, type Transaction, type TransactionWebhookData, type TransactionWebhookEvent, type TransactionWebhookEventType, type TransactionsResponse, type UtxoSwapExecution, type VerifyWebhookParams, type WaitForCompletionOptions, type WebhookEvent, type WebhookStreamingProgress, type WebhookVerificationFailure, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };
+export { type AdditionalFee, type AffiliateFeeBreakdown, type Chain, type ChainsResponse, type CosmosBankSendSwapExecution, type CosmosMsgDepositSwapExecution, type CosmosMsgExecuteSwapExecution, type CreateSwapParams, type CreateSwapResponse, type CursorPagination, type ErrorCode, type EvmApproval, type EvmSwapExecution, type ExecutionFamily, type ExecutionMode, type ExecutionOfFamily, type ExecutionOfMode, type ExpectedAffiliateEntry, type FeeAmount, type Fetch, type GetQuoteParams, type GetSwapResponse, type HealthResponse, type InstaswapFeeLine, type InstaswapSwapLiteSnapshot, type InternalSwapStatus, type JsonSwapExecution, type KnownErrorCode, type KnownProvider, type KnownProviderType, type ListProvidersParams, type ListTransactionsParams, type NamedDepositSwapExecution, type NoQuoteRouteFees, type OpenOceanRouteMeta, type OtherDepositSwapExecution, type PagePromise, type PegarouteOptions, type PingResponse, type PrivateSwapMode, type Provider, type ProviderAffiliateFeeStructure, type ProviderFeeStructure, type ProviderHealth, type ProviderInfo, type ProviderStatusInfo, type ProviderTakeStructure, type ProviderType, type ProvidersResponse, type QuoteResponse, type QuoteRoute, type QuoteRouteFees, type RefundInfo, type RequestOptions, type RouteInfo, type RouteWarning, type SerializedSwapExecution, type StreamingProgress, type SubmitTxHashParams, type SubmitTxHashResponse, type SwapEvent, type SwapEventsResponse, type SwapExecution, type SwapFailure, type SwapInput, type SwapOutput, type SwapProviderInfo, type SwapStatus, type SwapTimestamps, type TestWebhookEvent, type Token, type TokenAmount, type TokensResponse, type Transaction, type TransactionWebhookData, type TransactionWebhookEvent, type TransactionWebhookEventType, type TransactionsResponse, type UtxoSwapExecution, type VerifyWebhookParams, type WaitForCompletionOptions, type WebhookEvent, type WebhookStreamingProgress, type WebhookVerificationFailure, hasQuoteRouteFees, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { i as toExternalStatus, n as isExecutionMode, r as isTerminalStatus, t as isExecutionFamily } from "./types-Cz8gDMIR.js";
+import { a as toExternalStatus, i as isTerminalStatus, n as isExecutionMode, r as hasQuoteRouteFees, t as isExecutionFamily } from "./types-Dt7OyLsD.js";
 //#region src/core/errors.ts
 /** Base class for every error the SDK throws after a request is made. */
 var PegarouteError = class extends Error {
@@ -898,4 +898,4 @@ function hexToBytes(hex) {
 	return bytes;
 }
 //#endregion
-export { AuthenticationError, BadRequestError, ConflictError, ConnectionError, InternalServerError, NotFoundError, Pegaroute, PegarouteError, PermissionDeniedError, ProviderChangedError, QuoteExpiredError, RateLimitError, ServiceUnavailableError, TimeoutError, UnprocessableEntityError, WaitTimeoutError, WebhookVerificationError, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus, verifyWebhook };
+export { AuthenticationError, BadRequestError, ConflictError, ConnectionError, InternalServerError, NotFoundError, Pegaroute, PegarouteError, PermissionDeniedError, ProviderChangedError, QuoteExpiredError, RateLimitError, ServiceUnavailableError, TimeoutError, UnprocessableEntityError, WaitTimeoutError, WebhookVerificationError, hasQuoteRouteFees, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus, verifyWebhook };

package/dist/{types-Cz8gDMIR.js → types-Dt7OyLsD.js}

@@ -36,6 +36,19 @@ function isTerminalStatus(status) {
 	return TERMINAL_STATUSES.has(status);
 }
 //#endregion
+//#region src/types/common.ts
+/**
+* Whether Pegaroute sent fee data for a route. `false` means `{}`: no fee data, not a zero fee.
+*
+* @example
+* if (hasQuoteRouteFees(route.fees)) {
+*   show(`$${route.fees.totalUsd} (${route.fees.totalBps} bps)`);
+* }
+*/
+function hasQuoteRouteFees(fees) {
+	return fees.totalUsd !== void 0;
+}
+//#endregion
 //#region src/types/execution.ts
 /**
 * Narrows an execution to the variants of one mode, whatever the family.
@@ -61,4 +74,4 @@ function isExecutionFamily(execution, family) {
 	return execution.family === family;
 }
 //#endregion
-export { toExternalStatus as i, isExecutionMode as n, isTerminalStatus as r, isExecutionFamily as t };
+export { toExternalStatus as a, isTerminalStatus as i, isExecutionMode as n, hasQuoteRouteFees as r, isExecutionFamily as t };

package/dist/types.d.ts

@@ -1,2 +1,2 @@
-import { $ as KnownErrorCode, A as toExternalStatus, B as JsonSwapExecution, C as SwapInput, Ct as Token, D as InternalSwapStatus, E as SwapTimestamps, F as EvmSwapExecution, G as UtxoSwapExecution, H as OtherDepositSwapExecution, I as ExecutionFamily, J as GetQuoteParams, K as isExecutionFamily, L as ExecutionMode, M as CosmosMsgDepositSwapExecution, N as CosmosMsgExecuteSwapExecution, O as SwapStatus, P as EvmApproval, Q as ErrorCode, R as ExecutionOfFamily, S as SwapFailure, St as ProvidersResponse, T as SwapProviderInfo, U as SerializedSwapExecution, V as NamedDepositSwapExecution, W as SwapExecution, X as QuoteRoute, Y as QuoteResponse, Z as RouteWarning, _ as ProviderStatusInfo, _t as ProviderFeeStructure, a as WebhookEvent, at as QuoteFees, b as SwapEvent, bt as ProviderTakeStructure, c as ExpectedAffiliateEntry, ct as StreamingProgress, d as TransactionsResponse, dt as ChainsResponse, et as AffiliateFeeBreakdown, f as CreateSwapParams, ft as HealthResponse, g as InstaswapSwapLiteSnapshot, gt as ProviderAffiliateFeeStructure, h as InstaswapFeeLine, ht as PingResponse, i as TransactionWebhookEventType, it as Provider, j as CosmosBankSendSwapExecution, k as isTerminalStatus, l as ListTransactionsParams, lt as TokenAmount, m as GetSwapResponse, mt as ListProvidersParams, n as TransactionWebhookData, nt as OpenOceanRouteMeta, o as WebhookStreamingProgress, ot as RefundInfo, p as CreateSwapResponse, pt as KnownProviderType, q as isExecutionMode, r as TransactionWebhookEvent, rt as PrivateSwapMode, s as CursorPagination, st as RouteInfo, t as TestWebhookEvent, tt as KnownProvider, u as Transaction, ut as Chain, v as SubmitTxHashParams, vt as ProviderHealth, w as SwapOutput, wt as TokensResponse, x as SwapEventsResponse, xt as ProviderType, y as SubmitTxHashResponse, yt as ProviderInfo, z as ExecutionOfMode } from "./index-CeY_5Z4u.js";
-export { type AffiliateFeeBreakdown, type Chain, type ChainsResponse, type CosmosBankSendSwapExecution, type CosmosMsgDepositSwapExecution, type CosmosMsgExecuteSwapExecution, type CreateSwapParams, type CreateSwapResponse, type CursorPagination, type ErrorCode, type EvmApproval, type EvmSwapExecution, type ExecutionFamily, type ExecutionMode, type ExecutionOfFamily, type ExecutionOfMode, type ExpectedAffiliateEntry, type GetQuoteParams, type GetSwapResponse, type HealthResponse, type InstaswapFeeLine, type InstaswapSwapLiteSnapshot, type InternalSwapStatus, type JsonSwapExecution, type KnownErrorCode, type KnownProvider, type KnownProviderType, type ListProvidersParams, type ListTransactionsParams, type NamedDepositSwapExecution, type OpenOceanRouteMeta, type OtherDepositSwapExecution, type PingResponse, type PrivateSwapMode, type Provider, type ProviderAffiliateFeeStructure, type ProviderFeeStructure, type ProviderHealth, type ProviderInfo, type ProviderStatusInfo, type ProviderTakeStructure, type ProviderType, type ProvidersResponse, type QuoteFees, type QuoteResponse, type QuoteRoute, type RefundInfo, type RouteInfo, type RouteWarning, type SerializedSwapExecution, type StreamingProgress, type SubmitTxHashParams, type SubmitTxHashResponse, type SwapEvent, type SwapEventsResponse, type SwapExecution, type SwapFailure, type SwapInput, type SwapOutput, type SwapProviderInfo, type SwapStatus, type SwapTimestamps, type TestWebhookEvent, type Token, type TokenAmount, type TokensResponse, type Transaction, type TransactionWebhookData, type TransactionWebhookEvent, type TransactionWebhookEventType, type TransactionsResponse, type UtxoSwapExecution, type WebhookEvent, type WebhookStreamingProgress, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };
+import { $ as KnownErrorCode, A as toExternalStatus, B as JsonSwapExecution, C as SwapInput, Ct as ProviderInfo, D as InternalSwapStatus, Dt as Token, E as SwapTimestamps, Et as ProvidersResponse, F as EvmSwapExecution, G as UtxoSwapExecution, H as OtherDepositSwapExecution, I as ExecutionFamily, J as GetQuoteParams, K as isExecutionFamily, L as ExecutionMode, M as CosmosMsgDepositSwapExecution, N as CosmosMsgExecuteSwapExecution, O as SwapStatus, Ot as TokensResponse, P as EvmApproval, Q as ErrorCode, R as ExecutionOfFamily, S as SwapFailure, St as ProviderHealth, T as SwapProviderInfo, Tt as ProviderType, U as SerializedSwapExecution, V as NamedDepositSwapExecution, W as SwapExecution, X as QuoteRoute, Y as QuoteResponse, Z as RouteWarning, _ as ProviderStatusInfo, _t as KnownProviderType, a as WebhookEvent, at as OpenOceanRouteMeta, b as SwapEvent, bt as ProviderAffiliateFeeStructure, c as ExpectedAffiliateEntry, ct as QuoteRouteFees, d as TransactionsResponse, dt as StreamingProgress, et as AdditionalFee, f as CreateSwapParams, ft as TokenAmount, g as InstaswapSwapLiteSnapshot, gt as HealthResponse, h as InstaswapFeeLine, ht as ChainsResponse, i as TransactionWebhookEventType, it as NoQuoteRouteFees, j as CosmosBankSendSwapExecution, k as isTerminalStatus, l as ListTransactionsParams, lt as RefundInfo, m as GetSwapResponse, mt as Chain, n as TransactionWebhookData, nt as FeeAmount, o as WebhookStreamingProgress, ot as PrivateSwapMode, p as CreateSwapResponse, pt as hasQuoteRouteFees, q as isExecutionMode, r as TransactionWebhookEvent, rt as KnownProvider, s as CursorPagination, st as Provider, t as TestWebhookEvent, tt as AffiliateFeeBreakdown, u as Transaction, ut as RouteInfo, v as SubmitTxHashParams, vt as ListProvidersParams, w as SwapOutput, wt as ProviderTakeStructure, x as SwapEventsResponse, xt as ProviderFeeStructure, y as SubmitTxHashResponse, yt as PingResponse, z as ExecutionOfMode } from "./index-ClDOR6-k.js";
+export { type AdditionalFee, type AffiliateFeeBreakdown, type Chain, type ChainsResponse, type CosmosBankSendSwapExecution, type CosmosMsgDepositSwapExecution, type CosmosMsgExecuteSwapExecution, type CreateSwapParams, type CreateSwapResponse, type CursorPagination, type ErrorCode, type EvmApproval, type EvmSwapExecution, type ExecutionFamily, type ExecutionMode, type ExecutionOfFamily, type ExecutionOfMode, type ExpectedAffiliateEntry, type FeeAmount, type GetQuoteParams, type GetSwapResponse, type HealthResponse, type InstaswapFeeLine, type InstaswapSwapLiteSnapshot, type InternalSwapStatus, type JsonSwapExecution, type KnownErrorCode, type KnownProvider, type KnownProviderType, type ListProvidersParams, type ListTransactionsParams, type NamedDepositSwapExecution, type NoQuoteRouteFees, type OpenOceanRouteMeta, type OtherDepositSwapExecution, type PingResponse, type PrivateSwapMode, type Provider, type ProviderAffiliateFeeStructure, type ProviderFeeStructure, type ProviderHealth, type ProviderInfo, type ProviderStatusInfo, type ProviderTakeStructure, type ProviderType, type ProvidersResponse, type QuoteResponse, type QuoteRoute, type QuoteRouteFees, type RefundInfo, type RouteInfo, type RouteWarning, type SerializedSwapExecution, type StreamingProgress, type SubmitTxHashParams, type SubmitTxHashResponse, type SwapEvent, type SwapEventsResponse, type SwapExecution, type SwapFailure, type SwapInput, type SwapOutput, type SwapProviderInfo, type SwapStatus, type SwapTimestamps, type TestWebhookEvent, type Token, type TokenAmount, type TokensResponse, type Transaction, type TransactionWebhookData, type TransactionWebhookEvent, type TransactionWebhookEventType, type TransactionsResponse, type UtxoSwapExecution, type WebhookEvent, type WebhookStreamingProgress, hasQuoteRouteFees, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };

package/dist/types.js

@@ -1,2 +1,2 @@
-import { i as toExternalStatus, n as isExecutionMode, r as isTerminalStatus, t as isExecutionFamily } from "./types-Cz8gDMIR.js";
-export { isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };
+import { a as toExternalStatus, i as isTerminalStatus, n as isExecutionMode, r as hasQuoteRouteFees, t as isExecutionFamily } from "./types-Dt7OyLsD.js";
+export { hasQuoteRouteFees, isExecutionFamily, isExecutionMode, isTerminalStatus, toExternalStatus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pegaroute/sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for the Pegaroute cross-chain swap API",
   "license": "MIT",
   "type": "module",