@uniswap/client-trading 0.11.7 → 0.11.8

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

@@ -827,18 +827,28 @@ export declare enum MarginOperationType {
  */
 export declare enum MarginPositionStatus {
     /**
+     * Still open on chain, including a position that survived a partial
+     * liquidation.
+     *
      * @generated from enum value: ACTIVE = 0;
      */
     ACTIVE = 0,
     /**
+     * The owner closed it, and it was never liquidated in that epoch.
+     *
      * @generated from enum value: COMPLETED = 1;
      */
     COMPLETED = 1,
     /**
+     * A liquidation cleared its debt. Any collateral it left on the account is
+     * counted as returned, in `size` and `realized_pnl`.
+     *
      * @generated from enum value: LIQUIDATED = 2;
      */
     LIQUIDATED = 2,
     /**
+     * The owner closed it after a partial liquidation earlier in the same epoch.
+     *
      * @generated from enum value: PARTIALLY_LIQUIDATED = 3;
      */
     PARTIALLY_LIQUIDATED = 3
@@ -8972,54 +8982,9 @@ export declare class MarginQuoteResponse extends Message<MarginQuoteResponse> {
     static equals(a: MarginQuoteResponse | PlainMessage<MarginQuoteResponse> | undefined, b: MarginQuoteResponse | PlainMessage<MarginQuoteResponse> | undefined): boolean;
 }
 /**
- * One venue's share of a position. Legs are the unit of truth: a logical
- * position is an aggregation performed at read time, and legs liquidate
- * independently, so the row's risk numbers are the NEAREST leg's.
- *
- * @generated from message trading.v1.MarginPositionLeg
- */
-export declare class MarginPositionLeg extends Message<MarginPositionLeg> {
-    /**
-     * @generated from field: trading.v1.MarginVenue venue = 1;
-     */
-    venue: MarginVenue;
-    /**
-     * The `positionId` handle every action key echoes back. Returned whether or
-     * not a screen renders it.
-     *
-     * @generated from field: string sub_id = 2;
-     */
-    subId: string;
-    /**
-     * The MarginAccount this leg lives at, derived offchain from (owner, subId).
-     *
-     * @generated from field: string account = 3;
-     */
-    account: string;
-    /**
-     * @generated from field: string debt = 4;
-     */
-    debt: string;
-    /**
-     * Best effort, like the markets feed: absent when the venue's rate read did
-     * not return, never zero, because an unread rate and a zero rate differ.
-     *
-     * @generated from field: optional string borrow_rate = 5;
-     */
-    borrowRate?: string;
-    constructor(data?: PartialMessage<MarginPositionLeg>);
-    static readonly runtime: typeof proto3;
-    static readonly typeName = "trading.v1.MarginPositionLeg";
-    static readonly fields: FieldList;
-    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MarginPositionLeg;
-    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MarginPositionLeg;
-    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MarginPositionLeg;
-    static equals(a: MarginPositionLeg | PlainMessage<MarginPositionLeg> | undefined, b: MarginPositionLeg | PlainMessage<MarginPositionLeg> | undefined): boolean;
-}
-/**
- * One logical position, keyed (exposure_token, counter_token, direction) — the
- * same key the markets cursor orders on, which is why both endpoints page
- * through `marginMarketCursor`.
+ * One position: a margin account (owner, sub_id) on one venue and market. Each
+ * open allocates its own sub_id, so a wallet's positions in the same pair are
+ * separate rows, each with its own risk and its own actions.
  *
  * @generated from message trading.v1.MarginPositionRow
  */
@@ -9045,12 +9010,38 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
      */
     size: string;
     /**
-     * @generated from field: repeated trading.v1.MarginPositionLeg legs = 6;
+     * The account index every quote action key addresses.
+     *
+     * @generated from field: string sub_id = 32;
+     */
+    subId: string;
+    /**
+     * @generated from field: trading.v1.MarginVenue venue = 33;
      */
-    legs: MarginPositionLeg[];
+    venue: MarginVenue;
     /**
-     * COST BASIS, from the position store. Absent rather than zero for a leg the
-     * store has not indexed.
+     * The MarginAccount, derived offchain from (owner, sub_id).
+     *
+     * @generated from field: string account = 34;
+     */
+    account: string;
+    /**
+     * ACTIVE only. Raw debt-token units owed now.
+     *
+     * @generated from field: optional string debt_amount = 35;
+     */
+    debtAmount?: string;
+    /**
+     * Raw collateral-token units deposited over the position's life. Absent when
+     * the store has not indexed the position or its flows went untracked.
+     *
+     * @generated from field: optional string deposited_equity = 36;
+     */
+    depositedEquity?: string;
+    /**
+     * COST BASIS, from the position store. Absent rather than zero for a
+     * position the store has not indexed. In the same terms as `oracle_price`:
+     * counter per exposure, 1e18-scaled, reciprocated on a SHORT.
      *
      * @generated from field: optional string entry_price = 7;
      */
@@ -9074,6 +9065,8 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
      */
     unrealizedPnl?: string;
     /**
+     * ACTIVE only. `unrealized_pnl` / `deposited_equity`, 1e18-scaled, signed.
+     *
      * @generated from field: optional string roe = 11;
      */
     roe?: string;
@@ -9093,8 +9086,8 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
      */
     oraclePrice?: string;
     /**
-     * Nearest leg. In TRADER terms, so a short's mark and liquidation price are
-     * both reciprocated; see `displayRiskPrices`.
+     * In TRADER terms, so a short's mark and liquidation price are both
+     * reciprocated; see `displayRiskPrices`.
      *
      * @generated from field: optional string liquidation_price = 15;
      */
@@ -9108,6 +9101,9 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
      */
     healthFactor?: string;
     /**
+     * Annual, 1e18-scaled. Best effort, like the markets feed: absent when the
+     * venue's rate read did not return, never zero.
+     *
      * @generated from field: optional string borrow_rate = 18;
      */
     borrowRate?: string;
@@ -9121,11 +9117,14 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
     /**
      * TERMINAL only, and likewise cost-basis derived. `realized_pnl` is raw
      * collateral-token units: collateral returned minus collateral deposited.
+     * On a terminal row `size` is what the position held when it closed.
      *
      * @generated from field: optional int64 closed_at = 20;
      */
     closedAt?: bigint;
     /**
+     * In the same terms as `entry_price`.
+     *
      * @generated from field: optional string exit_price = 21;
      */
     exitPrice?: string;
@@ -9168,13 +9167,13 @@ export declare class MarginPositionRow extends Message<MarginPositionRow> {
      */
     lastLiquidationTxHash?: string;
     /**
-     * Raw collateral-token units held right after the open, summed over legs.
+     * Raw collateral-token units held right after the open.
      *
      * @generated from field: optional string collateral_at_open = 28;
      */
     collateralAtOpen?: string;
     /**
-     * Partial decreases, oldest first, the newest 50 per leg.
+     * Partial decreases, oldest first, the newest 50.
      *
      * @generated from field: repeated trading.v1.MarginDecreaseActivity decreases = 29;
      */
@@ -9231,8 +9230,7 @@ export declare class MarginDecreaseActivity extends Message<MarginDecreaseActivi
      */
     collateralSold: string;
     /**
-     * Raw debt per raw collateral, 1e18-scaled, like `entry_price`. Absent when
-     * nothing was sold.
+     * In the same terms as the row's `entry_price`. Absent when nothing was sold.
      *
      * @generated from field: optional string exit_price = 5;
      */
@@ -9320,12 +9318,13 @@ export declare class MarginPositionsRequest extends Message<MarginPositionsReque
      */
     chainId: number;
     /**
-     * Selects the tab. Unset is ACTIVE; explicit presence so the server can tell
-     * "not asked" from "asked for ACTIVE".
+     * Selects the tab. Empty means [ACTIVE]. ACTIVE is read on chain and the
+     * finished statuses from the position store, so ACTIVE is requested alone;
+     * any set of finished statuses is served in one page. No duplicates.
      *
-     * @generated from field: optional trading.v1.MarginPositionStatus status = 3;
+     * @generated from field: repeated trading.v1.MarginPositionStatus statuses = 6;
      */
-    status?: MarginPositionStatus;
+    statuses: MarginPositionStatus[];
     /**
      * Opaque; echo `next_cursor` back verbatim. Keyset over the row order, the
      * same contract `GET /margin/markets` uses.

package/dist/trading/v1/api_pb.js

@@ -1115,18 +1115,28 @@ proto3.util.setEnumType(MarginOperationType, "trading.v1.MarginOperationType", [
 export var MarginPositionStatus;
 (function (MarginPositionStatus) {
     /**
+     * Still open on chain, including a position that survived a partial
+     * liquidation.
+     *
      * @generated from enum value: ACTIVE = 0;
      */
     MarginPositionStatus[MarginPositionStatus["ACTIVE"] = 0] = "ACTIVE";
     /**
+     * The owner closed it, and it was never liquidated in that epoch.
+     *
      * @generated from enum value: COMPLETED = 1;
      */
     MarginPositionStatus[MarginPositionStatus["COMPLETED"] = 1] = "COMPLETED";
     /**
+     * A liquidation cleared its debt. Any collateral it left on the account is
+     * counted as returned, in `size` and `realized_pnl`.
+     *
      * @generated from enum value: LIQUIDATED = 2;
      */
     MarginPositionStatus[MarginPositionStatus["LIQUIDATED"] = 2] = "LIQUIDATED";
     /**
+     * The owner closed it after a partial liquidation earlier in the same epoch.
+     *
      * @generated from enum value: PARTIALLY_LIQUIDATED = 3;
      */
     MarginPositionStatus[MarginPositionStatus["PARTIALLY_LIQUIDATED"] = 3] = "PARTIALLY_LIQUIDATED";
@@ -10275,64 +10285,9 @@ MarginQuoteResponse.fields = proto3.util.newFieldList(() => [
     { no: 4, name: "gas_estimate", kind: "message", T: GasEstimate, opt: true },
 ]);
 /**
- * One venue's share of a position. Legs are the unit of truth: a logical
- * position is an aggregation performed at read time, and legs liquidate
- * independently, so the row's risk numbers are the NEAREST leg's.
- *
- * @generated from message trading.v1.MarginPositionLeg
- */
-export class MarginPositionLeg extends Message {
-    constructor(data) {
-        super();
-        /**
-         * @generated from field: trading.v1.MarginVenue venue = 1;
-         */
-        this.venue = MarginVenue.MORPHO;
-        /**
-         * The `positionId` handle every action key echoes back. Returned whether or
-         * not a screen renders it.
-         *
-         * @generated from field: string sub_id = 2;
-         */
-        this.subId = "";
-        /**
-         * The MarginAccount this leg lives at, derived offchain from (owner, subId).
-         *
-         * @generated from field: string account = 3;
-         */
-        this.account = "";
-        /**
-         * @generated from field: string debt = 4;
-         */
-        this.debt = "";
-        proto3.util.initPartial(data, this);
-    }
-    static fromBinary(bytes, options) {
-        return new MarginPositionLeg().fromBinary(bytes, options);
-    }
-    static fromJson(jsonValue, options) {
-        return new MarginPositionLeg().fromJson(jsonValue, options);
-    }
-    static fromJsonString(jsonString, options) {
-        return new MarginPositionLeg().fromJsonString(jsonString, options);
-    }
-    static equals(a, b) {
-        return proto3.util.equals(MarginPositionLeg, a, b);
-    }
-}
-MarginPositionLeg.runtime = proto3;
-MarginPositionLeg.typeName = "trading.v1.MarginPositionLeg";
-MarginPositionLeg.fields = proto3.util.newFieldList(() => [
-    { no: 1, name: "venue", kind: "enum", T: proto3.getEnumType(MarginVenue) },
-    { no: 2, name: "sub_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 3, name: "account", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 4, name: "debt", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 5, name: "borrow_rate", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
-]);
-/**
- * One logical position, keyed (exposure_token, counter_token, direction) — the
- * same key the markets cursor orders on, which is why both endpoints page
- * through `marginMarketCursor`.
+ * One position: a margin account (owner, sub_id) on one venue and market. Each
+ * open allocates its own sub_id, so a wallet's positions in the same pair are
+ * separate rows, each with its own risk and its own actions.
  *
  * @generated from message trading.v1.MarginPositionRow
  */
@@ -10352,11 +10307,23 @@ export class MarginPositionRow extends Message {
          */
         this.size = "";
         /**
-         * @generated from field: repeated trading.v1.MarginPositionLeg legs = 6;
+         * The account index every quote action key addresses.
+         *
+         * @generated from field: string sub_id = 32;
+         */
+        this.subId = "";
+        /**
+         * @generated from field: trading.v1.MarginVenue venue = 33;
          */
-        this.legs = [];
+        this.venue = MarginVenue.MORPHO;
+        /**
+         * The MarginAccount, derived offchain from (owner, sub_id).
+         *
+         * @generated from field: string account = 34;
+         */
+        this.account = "";
         /**
-         * Partial decreases, oldest first, the newest 50 per leg.
+         * Partial decreases, oldest first, the newest 50.
          *
          * @generated from field: repeated trading.v1.MarginDecreaseActivity decreases = 29;
          */
@@ -10384,7 +10351,11 @@ MarginPositionRow.fields = proto3.util.newFieldList(() => [
     { no: 3, name: "exposure_token", kind: "message", T: MarginTokenMetadata },
     { no: 4, name: "counter_token", kind: "message", T: MarginTokenMetadata },
     { no: 5, name: "size", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 6, name: "legs", kind: "message", T: MarginPositionLeg, repeated: true },
+    { no: 32, name: "sub_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 33, name: "venue", kind: "enum", T: proto3.getEnumType(MarginVenue) },
+    { no: 34, name: "account", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 35, name: "debt_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 36, name: "deposited_equity", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 7, name: "entry_price", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 8, name: "opened_at", kind: "scalar", T: 3 /* ScalarType.INT64 */, opt: true },
     { no: 9, name: "accrued_interest", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
@@ -10559,6 +10530,14 @@ export class MarginPositionsRequest extends Message {
          * @generated from field: int32 chain_id = 2;
          */
         this.chainId = 0;
+        /**
+         * Selects the tab. Empty means [ACTIVE]. ACTIVE is read on chain and the
+         * finished statuses from the position store, so ACTIVE is requested alone;
+         * any set of finished statuses is served in one page. No duplicates.
+         *
+         * @generated from field: repeated trading.v1.MarginPositionStatus statuses = 6;
+         */
+        this.statuses = [];
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -10579,7 +10558,7 @@ MarginPositionsRequest.typeName = "trading.v1.MarginPositionsRequest";
 MarginPositionsRequest.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "swapper", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "chain_id", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 3, name: "status", kind: "enum", T: proto3.getEnumType(MarginPositionStatus), opt: true },
+    { no: 6, name: "statuses", kind: "enum", T: proto3.getEnumType(MarginPositionStatus), repeated: true },
     { no: 4, name: "cursor", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 5, name: "limit", kind: "scalar", T: 5 /* ScalarType.INT32 */, opt: true },
 ]);

package/package.json

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