@uniswap/client-data-api 0.0.281 → 0.0.283

package/dist/data/v1/plan_pb.d.ts

@@ -92,6 +92,76 @@ export declare enum EarnPlanAction {
      */
     WITHDRAW = 2
 }
+/**
+ * @generated from enum data.v1.MarginPlanAction
+ */
+export declare enum MarginPlanAction {
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_UNKNOWN = 0;
+     */
+    UNKNOWN = 0,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_OPEN = 1;
+     */
+    OPEN = 1,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_CLOSE = 2;
+     */
+    CLOSE = 2,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_INCREASE_LEVERAGE = 3;
+     */
+    INCREASE_LEVERAGE = 3,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_DECREASE_LEVERAGE = 4;
+     */
+    DECREASE_LEVERAGE = 4,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY = 5;
+     */
+    ADD_EQUITY = 5,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY = 6;
+     */
+    WITHDRAW_EQUITY = 6,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY_AND_INCREASE_LEVERAGE = 7;
+     */
+    ADD_EQUITY_AND_INCREASE_LEVERAGE = 7,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY_AND_DECREASE_LEVERAGE = 8;
+     */
+    ADD_EQUITY_AND_DECREASE_LEVERAGE = 8,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE = 9;
+     */
+    WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE = 9,
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE = 10;
+     */
+    WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE = 10
+}
+/**
+ * @generated from enum data.v1.MarginPlanVenue
+ */
+export declare enum MarginPlanVenue {
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_UNKNOWN = 0;
+     */
+    UNKNOWN = 0,
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_MORPHO = 1;
+     */
+    MORPHO = 1,
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_AAVE_V3 = 2;
+     */
+    AAVE_V3 = 2,
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_AAVE_V4 = 3;
+     */
+    AAVE_V4 = 3
+}
 /**
  * @generated from enum data.v1.PlanStepStatus
  */

package/dist/data/v1/plan_pb.js

@@ -126,6 +126,99 @@ proto3.util.setEnumType(EarnPlanAction, "data.v1.EarnPlanAction", [
     { no: 1, name: "EARN_PLAN_ACTION_DEPOSIT" },
     { no: 2, name: "EARN_PLAN_ACTION_WITHDRAW" },
 ]);
+/**
+ * @generated from enum data.v1.MarginPlanAction
+ */
+export var MarginPlanAction;
+(function (MarginPlanAction) {
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_UNKNOWN = 0;
+     */
+    MarginPlanAction[MarginPlanAction["UNKNOWN"] = 0] = "UNKNOWN";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_OPEN = 1;
+     */
+    MarginPlanAction[MarginPlanAction["OPEN"] = 1] = "OPEN";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_CLOSE = 2;
+     */
+    MarginPlanAction[MarginPlanAction["CLOSE"] = 2] = "CLOSE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_INCREASE_LEVERAGE = 3;
+     */
+    MarginPlanAction[MarginPlanAction["INCREASE_LEVERAGE"] = 3] = "INCREASE_LEVERAGE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_DECREASE_LEVERAGE = 4;
+     */
+    MarginPlanAction[MarginPlanAction["DECREASE_LEVERAGE"] = 4] = "DECREASE_LEVERAGE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY = 5;
+     */
+    MarginPlanAction[MarginPlanAction["ADD_EQUITY"] = 5] = "ADD_EQUITY";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY = 6;
+     */
+    MarginPlanAction[MarginPlanAction["WITHDRAW_EQUITY"] = 6] = "WITHDRAW_EQUITY";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY_AND_INCREASE_LEVERAGE = 7;
+     */
+    MarginPlanAction[MarginPlanAction["ADD_EQUITY_AND_INCREASE_LEVERAGE"] = 7] = "ADD_EQUITY_AND_INCREASE_LEVERAGE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_ADD_EQUITY_AND_DECREASE_LEVERAGE = 8;
+     */
+    MarginPlanAction[MarginPlanAction["ADD_EQUITY_AND_DECREASE_LEVERAGE"] = 8] = "ADD_EQUITY_AND_DECREASE_LEVERAGE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE = 9;
+     */
+    MarginPlanAction[MarginPlanAction["WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE"] = 9] = "WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE";
+    /**
+     * @generated from enum value: MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE = 10;
+     */
+    MarginPlanAction[MarginPlanAction["WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE"] = 10] = "WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE";
+})(MarginPlanAction || (MarginPlanAction = {}));
+// Retrieve enum metadata with: proto3.getEnumType(MarginPlanAction)
+proto3.util.setEnumType(MarginPlanAction, "data.v1.MarginPlanAction", [
+    { no: 0, name: "MARGIN_PLAN_ACTION_UNKNOWN" },
+    { no: 1, name: "MARGIN_PLAN_ACTION_OPEN" },
+    { no: 2, name: "MARGIN_PLAN_ACTION_CLOSE" },
+    { no: 3, name: "MARGIN_PLAN_ACTION_INCREASE_LEVERAGE" },
+    { no: 4, name: "MARGIN_PLAN_ACTION_DECREASE_LEVERAGE" },
+    { no: 5, name: "MARGIN_PLAN_ACTION_ADD_EQUITY" },
+    { no: 6, name: "MARGIN_PLAN_ACTION_WITHDRAW_EQUITY" },
+    { no: 7, name: "MARGIN_PLAN_ACTION_ADD_EQUITY_AND_INCREASE_LEVERAGE" },
+    { no: 8, name: "MARGIN_PLAN_ACTION_ADD_EQUITY_AND_DECREASE_LEVERAGE" },
+    { no: 9, name: "MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_INCREASE_LEVERAGE" },
+    { no: 10, name: "MARGIN_PLAN_ACTION_WITHDRAW_EQUITY_AND_DECREASE_LEVERAGE" },
+]);
+/**
+ * @generated from enum data.v1.MarginPlanVenue
+ */
+export var MarginPlanVenue;
+(function (MarginPlanVenue) {
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_UNKNOWN = 0;
+     */
+    MarginPlanVenue[MarginPlanVenue["UNKNOWN"] = 0] = "UNKNOWN";
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_MORPHO = 1;
+     */
+    MarginPlanVenue[MarginPlanVenue["MORPHO"] = 1] = "MORPHO";
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_AAVE_V3 = 2;
+     */
+    MarginPlanVenue[MarginPlanVenue["AAVE_V3"] = 2] = "AAVE_V3";
+    /**
+     * @generated from enum value: MARGIN_PLAN_VENUE_AAVE_V4 = 3;
+     */
+    MarginPlanVenue[MarginPlanVenue["AAVE_V4"] = 3] = "AAVE_V4";
+})(MarginPlanVenue || (MarginPlanVenue = {}));
+// Retrieve enum metadata with: proto3.getEnumType(MarginPlanVenue)
+proto3.util.setEnumType(MarginPlanVenue, "data.v1.MarginPlanVenue", [
+    { no: 0, name: "MARGIN_PLAN_VENUE_UNKNOWN" },
+    { no: 1, name: "MARGIN_PLAN_VENUE_MORPHO" },
+    { no: 2, name: "MARGIN_PLAN_VENUE_AAVE_V3" },
+    { no: 3, name: "MARGIN_PLAN_VENUE_AAVE_V4" },
+]);
 /**
  * @generated from enum data.v1.PlanStepStatus
  */

package/dist/data/v1/types_pb.d.ts

@@ -1,6 +1,6 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
-import { EarnPlanAction, PlanStatus, PlanStepStatus, SwapType } from "./plan_pb.js";
+import { EarnPlanAction, MarginPlanAction, MarginPlanVenue, PlanStatus, PlanStepStatus, SwapType } from "./plan_pb.js";
 /**
  * @generated from enum data.v1.TokenType
  */
@@ -1541,6 +1541,13 @@ export declare class PlanTransaction extends Message<PlanTransaction> {
      * @generated from field: optional data.v1.EarnPlanMetadata earn_metadata = 16;
      */
     earnMetadata?: EarnPlanMetadata;
+    /**
+     * Set when the plan is a margin position action. Lets clients label the
+     * plan with the margin action instead of generic swap language.
+     *
+     * @generated from field: optional data.v1.MarginPlanMetadata margin_metadata = 17;
+     */
+    marginMetadata?: MarginPlanMetadata;
     constructor(data?: PartialMessage<PlanTransaction>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "data.v1.PlanTransaction";
@@ -1550,6 +1557,43 @@ export declare class PlanTransaction extends Message<PlanTransaction> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PlanTransaction;
     static equals(a: PlanTransaction | PlainMessage<PlanTransaction> | undefined, b: PlanTransaction | PlainMessage<PlanTransaction> | undefined): boolean;
 }
+/**
+ * Plan-level margin action metadata for margin position flows.
+ *
+ * @generated from message data.v1.MarginPlanMetadata
+ */
+export declare class MarginPlanMetadata extends Message<MarginPlanMetadata> {
+    /**
+     * @generated from field: data.v1.MarginPlanAction action = 1;
+     */
+    action: MarginPlanAction;
+    /**
+     * `<collateral>-<debt>-<venue>`; a display key, not a parse target.
+     *
+     * @generated from field: string market_key = 2;
+     */
+    marketKey: string;
+    /**
+     * @generated from field: data.v1.MarginPlanVenue venue = 3;
+     */
+    venue: MarginPlanVenue;
+    /**
+     * @generated from field: string collateral_token = 4;
+     */
+    collateralToken: string;
+    /**
+     * @generated from field: string debt_token = 5;
+     */
+    debtToken: string;
+    constructor(data?: PartialMessage<MarginPlanMetadata>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v1.MarginPlanMetadata";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MarginPlanMetadata;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MarginPlanMetadata;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MarginPlanMetadata;
+    static equals(a: MarginPlanMetadata | PlainMessage<MarginPlanMetadata> | undefined, b: MarginPlanMetadata | PlainMessage<MarginPlanMetadata> | undefined): boolean;
+}
 /**
  * Plan-level Earn intent metadata for chained Earn vault flows.
  *

package/dist/data/v1/types_pb.js

@@ -3,7 +3,7 @@
 /* eslint-disable */
 // @ts-nocheck
 import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
-import { EarnPlanAction, PlanStatus, PlanStepStatus, SwapType } from "./plan_pb.js";
+import { EarnPlanAction, MarginPlanAction, MarginPlanVenue, PlanStatus, PlanStepStatus, SwapType } from "./plan_pb.js";
 /**
  * @generated from enum data.v1.TokenType
  */
@@ -1963,6 +1963,61 @@ PlanTransaction.fields = proto3.util.newFieldList(() => [
     { no: 14, name: "gas_fee", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 15, name: "last_user_action_at_millis", kind: "scalar", T: 4 /* ScalarType.UINT64 */, opt: true },
     { no: 16, name: "earn_metadata", kind: "message", T: EarnPlanMetadata, opt: true },
+    { no: 17, name: "margin_metadata", kind: "message", T: MarginPlanMetadata, opt: true },
+]);
+/**
+ * Plan-level margin action metadata for margin position flows.
+ *
+ * @generated from message data.v1.MarginPlanMetadata
+ */
+export class MarginPlanMetadata extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: data.v1.MarginPlanAction action = 1;
+         */
+        this.action = MarginPlanAction.UNKNOWN;
+        /**
+         * `<collateral>-<debt>-<venue>`; a display key, not a parse target.
+         *
+         * @generated from field: string market_key = 2;
+         */
+        this.marketKey = "";
+        /**
+         * @generated from field: data.v1.MarginPlanVenue venue = 3;
+         */
+        this.venue = MarginPlanVenue.UNKNOWN;
+        /**
+         * @generated from field: string collateral_token = 4;
+         */
+        this.collateralToken = "";
+        /**
+         * @generated from field: string debt_token = 5;
+         */
+        this.debtToken = "";
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new MarginPlanMetadata().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new MarginPlanMetadata().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new MarginPlanMetadata().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(MarginPlanMetadata, a, b);
+    }
+}
+MarginPlanMetadata.runtime = proto3;
+MarginPlanMetadata.typeName = "data.v1.MarginPlanMetadata";
+MarginPlanMetadata.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "action", kind: "enum", T: proto3.getEnumType(MarginPlanAction) },
+    { no: 2, name: "market_key", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "venue", kind: "enum", T: proto3.getEnumType(MarginPlanVenue) },
+    { no: 4, name: "collateral_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "debt_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
 ]);
 /**
  * Plan-level Earn intent metadata for chained Earn vault flows.

package/dist/data/v2/search_pb.d.ts

@@ -123,7 +123,8 @@ export declare class SearchResponse extends Message<SearchResponse> {
     /**
      * Ranker-ordered, same row shape as ListTokens; hidden results (malicious,
      * blocklisted, URL in name) are dropped server-side, except the token a
-     * pasted address names, which is returned here with its safety fields set.
+     * pasted address names, which is returned here with its safety fields set
+     * unless its auction replaces it (see auctions).
      * A single-chain (ungrouped) row carries its own multichain_id here and in
      * suppressed_tokens, as a row key; GetTokenMultiChain does not resolve it.
      *
@@ -143,7 +144,7 @@ export declare class SearchResponse extends Message<SearchResponse> {
      */
     pools: RankedPool[];
     /**
-     * Ordered by total bid volume. Without TOKEN, every match is served. With both TOKEN and AUCTION requested, one primary result per Custom CCA token, matched on chain + token address. An auction whose token is unsafe (Blockaid Spam or Malicious verdict, blocklisted, URL in name, or an unverified impersonator) is dropped on every query, a pasted address included; the token's row stays, with its safety fields. Otherwise an UPCOMING or LIVE auction whose token is not tradeable yet (is_tradeable false) replaces its token's rows in tokens and suppressed_tokens; for any other auction a matching token row wins. An auction with no matching token row gives way to its token, appended after the ranked rows while tokens has room, when it is GRADUATED or FAILED or its token is tradeable; a GRADUATED or FAILED auction whose token is not appended is dropped, and so is an open one whose token cannot be checked. An UNSPECIFIED auction is dropped. At most 15 tokens are looked up per request, open auctions first; an auction left unchecked beyond them is dropped. Kept rows keep their order. Auctions are capped before any token is replaced, so a replaced token's auction is always served.
+     * LIVE first, then UPCOMING, then GRADUATED or FAILED, then UNSPECIFIED; each group ordered by total bid volume. On a name query an auction whose token is unsafe (Blockaid Spam or Malicious verdict, blocklisted, URL in name, or an unverified impersonator) is dropped; a pasted address serves it. Without TOKEN, a name query looks each auction's token up by address and serves the auction only when that token is servable or not found; a pasted address serves every match. With both TOKEN and AUCTION requested, one primary result per Custom CCA token, matched on chain + token address: an UPCOMING or LIVE auction whose token is not tradeable yet (is_tradeable false) replaces its token's rows in tokens and suppressed_tokens; for any other auction a matching token row wins. An auction with no matching token row gives way to its token, appended after the ranked rows while tokens has room, when it is GRADUATED or FAILED or its token is tradeable; a GRADUATED or FAILED auction whose token is not appended is dropped, and so is an open one whose token cannot be checked, except that a pasted address keeps an auction whose token lookup finds no servable token. With TOKEN, an UNSPECIFIED auction is dropped. At most 30 tokens are looked up per request, open auctions first; on a name query an auction left unchecked beyond them is dropped. Kept rows keep their order. Auctions are capped before any token is replaced, so a replaced token's auction is always served.
      *
      * @generated from field: repeated data.v2.SearchAuction auctions = 4;
      */

package/dist/data/v2/search_pb.js

@@ -158,7 +158,8 @@ export class SearchResponse extends Message {
         /**
          * Ranker-ordered, same row shape as ListTokens; hidden results (malicious,
          * blocklisted, URL in name) are dropped server-side, except the token a
-         * pasted address names, which is returned here with its safety fields set.
+         * pasted address names, which is returned here with its safety fields set
+         * unless its auction replaces it (see auctions).
          * A single-chain (ungrouped) row carries its own multichain_id here and in
          * suppressed_tokens, as a row key; GetTokenMultiChain does not resolve it.
          *
@@ -178,7 +179,7 @@ export class SearchResponse extends Message {
          */
         this.pools = [];
         /**
-         * Ordered by total bid volume. Without TOKEN, every match is served. With both TOKEN and AUCTION requested, one primary result per Custom CCA token, matched on chain + token address. An auction whose token is unsafe (Blockaid Spam or Malicious verdict, blocklisted, URL in name, or an unverified impersonator) is dropped on every query, a pasted address included; the token's row stays, with its safety fields. Otherwise an UPCOMING or LIVE auction whose token is not tradeable yet (is_tradeable false) replaces its token's rows in tokens and suppressed_tokens; for any other auction a matching token row wins. An auction with no matching token row gives way to its token, appended after the ranked rows while tokens has room, when it is GRADUATED or FAILED or its token is tradeable; a GRADUATED or FAILED auction whose token is not appended is dropped, and so is an open one whose token cannot be checked. An UNSPECIFIED auction is dropped. At most 15 tokens are looked up per request, open auctions first; an auction left unchecked beyond them is dropped. Kept rows keep their order. Auctions are capped before any token is replaced, so a replaced token's auction is always served.
+         * LIVE first, then UPCOMING, then GRADUATED or FAILED, then UNSPECIFIED; each group ordered by total bid volume. On a name query an auction whose token is unsafe (Blockaid Spam or Malicious verdict, blocklisted, URL in name, or an unverified impersonator) is dropped; a pasted address serves it. Without TOKEN, a name query looks each auction's token up by address and serves the auction only when that token is servable or not found; a pasted address serves every match. With both TOKEN and AUCTION requested, one primary result per Custom CCA token, matched on chain + token address: an UPCOMING or LIVE auction whose token is not tradeable yet (is_tradeable false) replaces its token's rows in tokens and suppressed_tokens; for any other auction a matching token row wins. An auction with no matching token row gives way to its token, appended after the ranked rows while tokens has room, when it is GRADUATED or FAILED or its token is tradeable; a GRADUATED or FAILED auction whose token is not appended is dropped, and so is an open one whose token cannot be checked, except that a pasted address keeps an auction whose token lookup finds no servable token. With TOKEN, an UNSPECIFIED auction is dropped. At most 30 tokens are looked up per request, open auctions first; on a name query an auction left unchecked beyond them is dropped. Kept rows keep their order. Auctions are capped before any token is replaced, so a replaced token's auction is always served.
          *
          * @generated from field: repeated data.v2.SearchAuction auctions = 4;
          */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uniswap/client-data-api",
-    "version": "0.0.281",
+    "version": "0.0.283",
     "publishConfig": {
       "access": "public"
     },