@uniswap/client-trading 0.5.10 → 0.5.12

package/dist/trading/v1/api_pb.d.ts

@@ -380,6 +380,22 @@ export declare enum PlanStepType {
      */
     VAULT_WITHDRAW = 15
 }
+/**
+ * Set when the output is a fee taken from the swap; unset for the swapper's
+ * core output.
+ *
+ * @generated from enum trading.v1.AggregatedOutputFee
+ */
+export declare enum AggregatedOutputFee {
+    /**
+     * @generated from enum value: AGGREGATED_OUTPUT_FEE_UNSPECIFIED = 0;
+     */
+    AGGREGATED_OUTPUT_FEE_UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: INTEGRATOR = 1;
+     */
+    INTEGRATOR = 1
+}
 /**
  * @generated from enum trading.v1.PoolType
  */
@@ -1737,6 +1753,13 @@ export declare class QuoteRequest extends Message<QuoteRequest> {
      * @generated from field: optional trading.v1.EarnIntent earn_intent = 24;
      */
     earnIntent?: EarnIntent;
+    /**
+     * When true, uniroute-backed classic quotes include routeCandidates —
+     * the top alternative routes with whole-route amounts.
+     *
+     * @generated from field: optional bool include_route_candidates = 25;
+     */
+    includeRouteCandidates?: boolean;
     constructor(data?: PartialMessage<QuoteRequest>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.QuoteRequest";
@@ -2398,9 +2421,9 @@ export declare class AggregatedOutput extends Message<AggregatedOutput> {
      */
     minAmount?: string;
     /**
-     * @generated from field: bool fee = 6;
+     * @generated from field: optional trading.v1.AggregatedOutputFee fee = 6;
      */
-    fee: boolean;
+    fee?: AggregatedOutputFee;
     constructor(data?: PartialMessage<AggregatedOutput>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.AggregatedOutput";
@@ -2531,6 +2554,15 @@ export declare class ClassicQuote extends Message<ClassicQuote> {
      * @generated from field: repeated trading.v1.SwapStep swap_steps = 26;
      */
     swapSteps: SwapStep[];
+    /**
+     * Top quoted route candidates the router considered but did NOT serve
+     * (the served route and candidates proven unviable — simulation or
+     * trade-build failures — are excluded), best-first. Populated only for
+     * uniroute-backed quotes when QuoteRequest.include_route_candidates is set.
+     *
+     * @generated from field: repeated trading.v1.RouteCandidate route_candidates = 27;
+     */
+    routeCandidates: RouteCandidate[];
     constructor(data?: PartialMessage<ClassicQuote>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.ClassicQuote";
@@ -2540,6 +2572,38 @@ export declare class ClassicQuote extends Message<ClassicQuote> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ClassicQuote;
     static equals(a: ClassicQuote | PlainMessage<ClassicQuote> | undefined, b: ClassicQuote | PlainMessage<ClassicQuote> | undefined): boolean;
 }
+/**
+ * A quoted route candidate with its whole-route (not per-hop) amounts.
+ * quote_amount is the output amount for EXACT_INPUT and the required input
+ * amount for EXACT_OUTPUT. Amounts are quoter estimates and do not carry
+ * the simulation/portion corrections applied to the served quote.
+ *
+ * @generated from message trading.v1.RouteCandidate
+ */
+export declare class RouteCandidate extends Message<RouteCandidate> {
+    /**
+     * @generated from field: string route_string = 1;
+     */
+    routeString: string;
+    /**
+     * @generated from field: string quote_amount = 2;
+     */
+    quoteAmount: string;
+    /**
+     * Gas-adjusted whole-route amount; omitted when gas details are unavailable.
+     *
+     * @generated from field: optional string quote_gas_adjusted = 3;
+     */
+    quoteGasAdjusted?: string;
+    constructor(data?: PartialMessage<RouteCandidate>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "trading.v1.RouteCandidate";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RouteCandidate;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RouteCandidate;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RouteCandidate;
+    static equals(a: RouteCandidate | PlainMessage<RouteCandidate> | undefined, b: RouteCandidate | PlainMessage<RouteCandidate> | undefined): boolean;
+}
 /**
  * Universal Router SwapStep representation (mirrors the SDK shape used by
  * SwapRouter.encodeSwaps). Only used in the swapsteps quote/encoding flow.

package/dist/trading/v1/api_pb.js

@@ -511,6 +511,28 @@ proto3.util.setEnumType(PlanStepType, "trading.v1.PlanStepType", [
     { no: 14, name: "PLAN_STEP_TYPE_VAULT_DEPOSIT" },
     { no: 15, name: "PLAN_STEP_TYPE_VAULT_WITHDRAW" },
 ]);
+/**
+ * Set when the output is a fee taken from the swap; unset for the swapper's
+ * core output.
+ *
+ * @generated from enum trading.v1.AggregatedOutputFee
+ */
+export var AggregatedOutputFee;
+(function (AggregatedOutputFee) {
+    /**
+     * @generated from enum value: AGGREGATED_OUTPUT_FEE_UNSPECIFIED = 0;
+     */
+    AggregatedOutputFee[AggregatedOutputFee["AGGREGATED_OUTPUT_FEE_UNSPECIFIED"] = 0] = "AGGREGATED_OUTPUT_FEE_UNSPECIFIED";
+    /**
+     * @generated from enum value: INTEGRATOR = 1;
+     */
+    AggregatedOutputFee[AggregatedOutputFee["INTEGRATOR"] = 1] = "INTEGRATOR";
+})(AggregatedOutputFee || (AggregatedOutputFee = {}));
+// Retrieve enum metadata with: proto3.getEnumType(AggregatedOutputFee)
+proto3.util.setEnumType(AggregatedOutputFee, "trading.v1.AggregatedOutputFee", [
+    { no: 0, name: "AGGREGATED_OUTPUT_FEE_UNSPECIFIED" },
+    { no: 1, name: "INTEGRATOR" },
+]);
 /**
  * @generated from enum trading.v1.PoolType
  */
@@ -2120,6 +2142,7 @@ QuoteRequest.fields = proto3.util.newFieldList(() => [
     { no: 22, name: "recipient", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 23, name: "urgency_overrides", kind: "message", T: UrgencyWithOverrides, opt: true },
     { no: 24, name: "earn_intent", kind: "message", T: EarnIntent, opt: true },
+    { no: 25, name: "include_route_candidates", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
 ]);
 /**
  * @generated from message trading.v1.EarnIntent
@@ -2777,10 +2800,6 @@ export class AggregatedOutput extends Message {
          * @generated from field: double bps = 4;
          */
         this.bps = 0;
-        /**
-         * @generated from field: bool fee = 6;
-         */
-        this.fee = false;
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -2804,7 +2823,7 @@ AggregatedOutput.fields = proto3.util.newFieldList(() => [
     { no: 3, name: "recipient", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 4, name: "bps", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
     { no: 5, name: "min_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
-    { no: 6, name: "fee", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 6, name: "fee", kind: "enum", T: proto3.getEnumType(AggregatedOutputFee), opt: true },
 ]);
 /**
  * @generated from message trading.v1.RouteList
@@ -2878,6 +2897,15 @@ export class ClassicQuote extends Message {
          * @generated from field: repeated trading.v1.SwapStep swap_steps = 26;
          */
         this.swapSteps = [];
+        /**
+         * Top quoted route candidates the router considered but did NOT serve
+         * (the served route and candidates proven unviable — simulation or
+         * trade-build failures — are excluded), best-first. Populated only for
+         * uniroute-backed quotes when QuoteRequest.include_route_candidates is set.
+         *
+         * @generated from field: repeated trading.v1.RouteCandidate route_candidates = 27;
+         */
+        this.routeCandidates = [];
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -2921,6 +2949,48 @@ ClassicQuote.fields = proto3.util.newFieldList(() => [
     { no: 23, name: "portion_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 24, name: "portion_recipient", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 26, name: "swap_steps", kind: "message", T: SwapStep, repeated: true },
+    { no: 27, name: "route_candidates", kind: "message", T: RouteCandidate, repeated: true },
+]);
+/**
+ * A quoted route candidate with its whole-route (not per-hop) amounts.
+ * quote_amount is the output amount for EXACT_INPUT and the required input
+ * amount for EXACT_OUTPUT. Amounts are quoter estimates and do not carry
+ * the simulation/portion corrections applied to the served quote.
+ *
+ * @generated from message trading.v1.RouteCandidate
+ */
+export class RouteCandidate extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: string route_string = 1;
+         */
+        this.routeString = "";
+        /**
+         * @generated from field: string quote_amount = 2;
+         */
+        this.quoteAmount = "";
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new RouteCandidate().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new RouteCandidate().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new RouteCandidate().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(RouteCandidate, a, b);
+    }
+}
+RouteCandidate.runtime = proto3;
+RouteCandidate.typeName = "trading.v1.RouteCandidate";
+RouteCandidate.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "route_string", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "quote_amount", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "quote_gas_adjusted", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
 ]);
 /**
  * Universal Router SwapStep representation (mirrors the SDK shape used by

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uniswap/client-trading",
-    "version": "0.5.10",
+    "version": "0.5.12",
     "publishConfig": {
       "access": "public"
     },