@uniswap/client-trading 0.8.1 → 0.9.0

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

@@ -7249,7 +7249,7 @@ export declare class CreatePlanRequest extends Message<CreatePlanRequest> {
      */
     routing: SwapType;
     /**
-     * @generated from field: trading.v1.ChainedQuote quote = 2;
+     * @generated from field: optional trading.v1.ChainedQuote quote = 2;
      */
     quote?: ChainedQuote;
     /**
@@ -7264,6 +7264,15 @@ export declare class CreatePlanRequest extends Message<CreatePlanRequest> {
      * @generated from field: optional trading.v1.EarnIntent earn_intent = 5;
      */
     earnIntent?: EarnIntent;
+    /**
+     * The margin quote, echoed back. Exactly one of `quote` and `margin_quote`
+     * is accepted. Every bound and the pool are re-derived from the venue here
+     * rather than trusted, so this names the shape of the position -- market,
+     * venue, sub-account, operation -- and never the numbers it executes on.
+     *
+     * @generated from field: optional trading.v1.MarginQuoteResponse margin_quote = 6;
+     */
+    marginQuote?: MarginQuoteResponse;
     constructor(data?: PartialMessage<CreatePlanRequest>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.CreatePlanRequest";
@@ -7294,6 +7303,50 @@ export declare class GetPlanRequest extends Message<GetPlanRequest> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetPlanRequest;
     static equals(a: GetPlanRequest | PlainMessage<GetPlanRequest> | undefined, b: GetPlanRequest | PlainMessage<GetPlanRequest> | undefined): boolean;
 }
+/**
+ * What the plan is doing to which position. The step type stays
+ * MARGIN_EXECUTE for every action key, so `intent` is where a client reads
+ * which of the ten it is.
+ *
+ * @generated from message trading.v1.MarginPlanIntent
+ */
+export declare class MarginPlanIntent extends Message<MarginPlanIntent> {
+    /**
+     * @generated from field: trading.v1.MarginIntent intent = 1;
+     */
+    intent: MarginIntent;
+    /**
+     * `<collateral>-<debt>-<venue>`. A display key: resolve a market by tokens
+     * and venue, never by parsing this.
+     *
+     * @generated from field: string market_key = 2;
+     */
+    marketKey: string;
+    /**
+     * @generated from field: trading.v1.MarginVenue venue = 3;
+     */
+    venue: MarginVenue;
+    /**
+     * @generated from field: string collateral_token = 4;
+     */
+    collateralToken: string;
+    /**
+     * @generated from field: string debt_token = 5;
+     */
+    debtToken: string;
+    /**
+     * @generated from field: string sub_id = 6;
+     */
+    subId: string;
+    constructor(data?: PartialMessage<MarginPlanIntent>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "trading.v1.MarginPlanIntent";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MarginPlanIntent;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MarginPlanIntent;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MarginPlanIntent;
+    static equals(a: MarginPlanIntent | PlainMessage<MarginPlanIntent> | undefined, b: MarginPlanIntent | PlainMessage<MarginPlanIntent> | undefined): boolean;
+}
 /**
  * @generated from message trading.v1.PlanResponse
  */
@@ -7386,6 +7439,13 @@ export declare class PlanResponse extends Message<PlanResponse> {
      * @generated from field: optional trading.v1.EarnQuoteIntent earn_intent = 22;
      */
     earnIntent?: EarnQuoteIntent;
+    /**
+     * Present iff this plan carries a margin action. Its absence is how a client
+     * tells a margin plan from any other, so it is the whole block or nothing.
+     *
+     * @generated from field: optional trading.v1.MarginPlanIntent margin_intent = 23;
+     */
+    marginIntent?: MarginPlanIntent;
     constructor(data?: PartialMessage<PlanResponse>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.PlanResponse";
@@ -8856,46 +8916,6 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MarginPositionRow;
     static equals(a: MarginPositionRow | PlainMessage<MarginPositionRow> | undefined, b: MarginPositionRow | PlainMessage<MarginPositionRow> | undefined): boolean;
 }
-/**
- * Collateral parked at a MarginAccount whose open never completed. Derived from
- * the chain rather than the plan store, so it survives plan-row expiry and is
- * visible from any device.
- *
- * @generated from message trading.v1.MarginIncompleteOpen
- */
-export declare class MarginIncompleteOpen extends Message<MarginIncompleteOpen> {
-    /**
-     * @generated from field: string account = 1;
-     */
-    account: string;
-    /**
-     * @generated from field: string sub_id = 2;
-     */
-    subId: string;
-    /**
-     * False when the account holds a balance but was never deployed, which is the
-     * window this surface exists for: pre-swap delivered, position not opened.
-     *
-     * @generated from field: bool deployed = 3;
-     */
-    deployed: boolean;
-    /**
-     * @generated from field: trading.v1.MarginTokenMetadata token = 4;
-     */
-    token?: MarginTokenMetadata;
-    /**
-     * @generated from field: string amount = 5;
-     */
-    amount: string;
-    constructor(data?: PartialMessage<MarginIncompleteOpen>);
-    static readonly runtime: typeof proto3;
-    static readonly typeName = "trading.v1.MarginIncompleteOpen";
-    static readonly fields: FieldList;
-    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MarginIncompleteOpen;
-    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MarginIncompleteOpen;
-    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MarginIncompleteOpen;
-    static equals(a: MarginIncompleteOpen | PlainMessage<MarginIncompleteOpen> | undefined, b: MarginIncompleteOpen | PlainMessage<MarginIncompleteOpen> | undefined): boolean;
-}
 /**
  * The one plan-store read, and a deliberately weaker guarantee than the rest of
  * this response: session-scoped and TTL-bound, so absent rather than wrong once
@@ -8909,17 +8929,45 @@ export declare class MarginPendingPlan extends Message<MarginPendingPlan> {
      */
     planId: string;
     /**
+     * Epoch milliseconds. proto3 JSON renders an int64 as a string, which is what
+     * the client reads it as; it does not sort on the value.
+     *
      * @generated from field: int64 created_at = 2;
      */
     createdAt: bigint;
     /**
+     * 0-based index of the first step that is not COMPLETE.
+     *
      * @generated from field: int32 current_step = 3;
      */
     currentStep: number;
     /**
+     * False once an in-progress step carries a proof: that transaction may have
+     * landed, so cancelling could strand a position the plan no longer tracks.
+     *
      * @generated from field: bool cancellable = 4;
      */
     cancellable: boolean;
+    /**
+     * @generated from field: string market_key = 5;
+     */
+    marketKey: string;
+    /**
+     * @generated from field: trading.v1.MarginVenue venue = 6;
+     */
+    venue: MarginVenue;
+    /**
+     * @generated from field: string collateral_token = 7;
+     */
+    collateralToken: string;
+    /**
+     * @generated from field: string debt_token = 8;
+     */
+    debtToken: string;
+    /**
+     * @generated from field: int32 step_count = 9;
+     */
+    stepCount: number;
     constructor(data?: PartialMessage<MarginPendingPlan>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "trading.v1.MarginPendingPlan";
@@ -8988,14 +9036,11 @@ export declare class MarginPositionsResponse extends Message<MarginPositionsResp
      */
     nextCursor?: string;
     /**
-     * Both recovery surfaces serialize as [] when the read ran and found nothing.
-     * They cannot express "not read": a degraded read logs a warning and reports
-     * empty, matching how the markets feed degrades a failed venue.
+     * 4 was incomplete_opens, deleted unpopulated before launch (#13445).
+     * Serializes as [] when the read ran and found nothing. It cannot express
+     * "not read": a degraded read logs a warning and reports empty, matching how
+     * the markets feed degrades a failed venue.
      *
-     * @generated from field: repeated trading.v1.MarginIncompleteOpen incomplete_opens = 4;
-     */
-    incompleteOpens: MarginIncompleteOpen[];
-    /**
      * @generated from field: repeated trading.v1.MarginPendingPlan pending_plans = 5;
      */
     pendingPlans: MarginPendingPlan[];

package/dist/trading/v1/api_pb.js

@@ -8546,10 +8546,11 @@ CreatePlanRequest.runtime = proto3;
 CreatePlanRequest.typeName = "trading.v1.CreatePlanRequest";
 CreatePlanRequest.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "routing", kind: "enum", T: proto3.getEnumType(SwapType) },
-    { no: 2, name: "quote", kind: "message", T: ChainedQuote },
+    { no: 2, name: "quote", kind: "message", T: ChainedQuote, opt: true },
     { no: 3, name: "wallet_execution_context", kind: "message", T: WalletExecutionContext, opt: true },
     { no: 4, name: "urgency_overrides", kind: "message", T: UrgencyWithOverrides, opt: true },
     { no: 5, name: "earn_intent", kind: "message", T: EarnIntent, opt: true },
+    { no: 6, name: "margin_quote", kind: "message", T: MarginQuoteResponse, opt: true },
 ]);
 /**
  * @generated from message trading.v1.GetPlanRequest
@@ -8586,6 +8587,68 @@ GetPlanRequest.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "plan_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "force_refresh", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
 ]);
+/**
+ * What the plan is doing to which position. The step type stays
+ * MARGIN_EXECUTE for every action key, so `intent` is where a client reads
+ * which of the ten it is.
+ *
+ * @generated from message trading.v1.MarginPlanIntent
+ */
+export class MarginPlanIntent extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: trading.v1.MarginIntent intent = 1;
+         */
+        this.intent = MarginIntent.OPEN;
+        /**
+         * `<collateral>-<debt>-<venue>`. A display key: resolve a market by tokens
+         * and venue, never by parsing this.
+         *
+         * @generated from field: string market_key = 2;
+         */
+        this.marketKey = "";
+        /**
+         * @generated from field: trading.v1.MarginVenue venue = 3;
+         */
+        this.venue = MarginVenue.MORPHO;
+        /**
+         * @generated from field: string collateral_token = 4;
+         */
+        this.collateralToken = "";
+        /**
+         * @generated from field: string debt_token = 5;
+         */
+        this.debtToken = "";
+        /**
+         * @generated from field: string sub_id = 6;
+         */
+        this.subId = "";
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new MarginPlanIntent().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new MarginPlanIntent().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new MarginPlanIntent().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(MarginPlanIntent, a, b);
+    }
+}
+MarginPlanIntent.runtime = proto3;
+MarginPlanIntent.typeName = "trading.v1.MarginPlanIntent";
+MarginPlanIntent.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "intent", kind: "enum", T: proto3.getEnumType(MarginIntent) },
+    { no: 2, name: "market_key", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "venue", kind: "enum", T: proto3.getEnumType(MarginVenue) },
+    { no: 4, name: "collateral_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "debt_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 6, name: "sub_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+]);
 /**
  * @generated from message trading.v1.PlanResponse
  */
@@ -8676,6 +8739,7 @@ PlanResponse.fields = proto3.util.newFieldList(() => [
     { no: 20, name: "auto_slippage", kind: "enum", T: proto3.getEnumType(AutoSlippage), opt: true },
     { no: 21, name: "last_user_action_at", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 22, name: "earn_intent", kind: "message", T: EarnQuoteIntent, opt: true },
+    { no: 23, name: "margin_intent", kind: "message", T: MarginPlanIntent, opt: true },
 ]);
 /**
  * @generated from enum trading.v1.PlanResponse.PlanStatus
@@ -10171,59 +10235,6 @@ MarginPositionRow.fields = proto3.util.newFieldList(() => [
     { no: 21, name: "exit_price", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 22, name: "realized_pnl", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
 ]);
-/**
- * Collateral parked at a MarginAccount whose open never completed. Derived from
- * the chain rather than the plan store, so it survives plan-row expiry and is
- * visible from any device.
- *
- * @generated from message trading.v1.MarginIncompleteOpen
- */
-export class MarginIncompleteOpen extends Message {
-    constructor(data) {
-        super();
-        /**
-         * @generated from field: string account = 1;
-         */
-        this.account = "";
-        /**
-         * @generated from field: string sub_id = 2;
-         */
-        this.subId = "";
-        /**
-         * False when the account holds a balance but was never deployed, which is the
-         * window this surface exists for: pre-swap delivered, position not opened.
-         *
-         * @generated from field: bool deployed = 3;
-         */
-        this.deployed = false;
-        /**
-         * @generated from field: string amount = 5;
-         */
-        this.amount = "";
-        proto3.util.initPartial(data, this);
-    }
-    static fromBinary(bytes, options) {
-        return new MarginIncompleteOpen().fromBinary(bytes, options);
-    }
-    static fromJson(jsonValue, options) {
-        return new MarginIncompleteOpen().fromJson(jsonValue, options);
-    }
-    static fromJsonString(jsonString, options) {
-        return new MarginIncompleteOpen().fromJsonString(jsonString, options);
-    }
-    static equals(a, b) {
-        return proto3.util.equals(MarginIncompleteOpen, a, b);
-    }
-}
-MarginIncompleteOpen.runtime = proto3;
-MarginIncompleteOpen.typeName = "trading.v1.MarginIncompleteOpen";
-MarginIncompleteOpen.fields = proto3.util.newFieldList(() => [
-    { no: 1, name: "account", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 2, name: "sub_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 3, name: "deployed", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
-    { no: 4, name: "token", kind: "message", T: MarginTokenMetadata },
-    { no: 5, name: "amount", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-]);
 /**
  * The one plan-store read, and a deliberately weaker guarantee than the rest of
  * this response: session-scoped and TTL-bound, so absent rather than wrong once
@@ -10239,17 +10250,45 @@ export class MarginPendingPlan extends Message {
          */
         this.planId = "";
         /**
+         * Epoch milliseconds. proto3 JSON renders an int64 as a string, which is what
+         * the client reads it as; it does not sort on the value.
+         *
          * @generated from field: int64 created_at = 2;
          */
         this.createdAt = protoInt64.zero;
         /**
+         * 0-based index of the first step that is not COMPLETE.
+         *
          * @generated from field: int32 current_step = 3;
          */
         this.currentStep = 0;
         /**
+         * False once an in-progress step carries a proof: that transaction may have
+         * landed, so cancelling could strand a position the plan no longer tracks.
+         *
          * @generated from field: bool cancellable = 4;
          */
         this.cancellable = false;
+        /**
+         * @generated from field: string market_key = 5;
+         */
+        this.marketKey = "";
+        /**
+         * @generated from field: trading.v1.MarginVenue venue = 6;
+         */
+        this.venue = MarginVenue.MORPHO;
+        /**
+         * @generated from field: string collateral_token = 7;
+         */
+        this.collateralToken = "";
+        /**
+         * @generated from field: string debt_token = 8;
+         */
+        this.debtToken = "";
+        /**
+         * @generated from field: int32 step_count = 9;
+         */
+        this.stepCount = 0;
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -10272,6 +10311,11 @@ MarginPendingPlan.fields = proto3.util.newFieldList(() => [
     { no: 2, name: "created_at", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
     { no: 3, name: "current_step", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
     { no: 4, name: "cancellable", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 5, name: "market_key", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 6, name: "venue", kind: "enum", T: proto3.getEnumType(MarginVenue) },
+    { no: 7, name: "collateral_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 8, name: "debt_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 9, name: "step_count", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
 ]);
 /**
  * @generated from message trading.v1.MarginPositionsRequest
@@ -10326,14 +10370,11 @@ export class MarginPositionsResponse extends Message {
          */
         this.positions = [];
         /**
-         * Both recovery surfaces serialize as [] when the read ran and found nothing.
-         * They cannot express "not read": a degraded read logs a warning and reports
-         * empty, matching how the markets feed degrades a failed venue.
+         * 4 was incomplete_opens, deleted unpopulated before launch (#13445).
+         * Serializes as [] when the read ran and found nothing. It cannot express
+         * "not read": a degraded read logs a warning and reports empty, matching how
+         * the markets feed degrades a failed venue.
          *
-         * @generated from field: repeated trading.v1.MarginIncompleteOpen incomplete_opens = 4;
-         */
-        this.incompleteOpens = [];
-        /**
          * @generated from field: repeated trading.v1.MarginPendingPlan pending_plans = 5;
          */
         this.pendingPlans = [];
@@ -10358,6 +10399,5 @@ MarginPositionsResponse.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "request_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "positions", kind: "message", T: MarginPositionRow, repeated: true },
     { no: 3, name: "next_cursor", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
-    { no: 4, name: "incomplete_opens", kind: "message", T: MarginIncompleteOpen, repeated: true },
     { no: 5, name: "pending_plans", kind: "message", T: MarginPendingPlan, repeated: true },
 ]);

package/package.json

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