@uniswap/client-data-api 0.0.258 → 0.0.260

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

@@ -1,6 +1,6 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3, Timestamp } from "@bufbuild/protobuf";
-import { RankedMultichainToken, RankedPool } from "./types_pb.js";
+import { RankedMultichainToken, RankedPool, TokenLaunchProvenance } from "./types_pb.js";
 /**
  * @generated from enum data.v2.SearchType
  */
@@ -26,6 +26,43 @@ export declare enum SearchType {
      */
     CATEGORY = 4
 }
+/**
+ * Where an auction is in its life, decided server-side from the chain head against start_block/end_block and, once ended, from the raise outcome.
+ *
+ * @generated from enum data.v2.AuctionLifecycle
+ */
+export declare enum AuctionLifecycle {
+    /**
+     * The current row, the chain head or the raise figures were unavailable; the block times and raw raise fields, when set, still let a client classify.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * start_block not yet reached.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_UPCOMING = 1;
+     */
+    UPCOMING = 1,
+    /**
+     * start_block reached and end_block not yet reached (the data.v1 AuctionStatusFilter ACTIVE rule).
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_LIVE = 2;
+     */
+    LIVE = 2,
+    /**
+     * Ended with total_bid_volume >= required_currency_raised, or already migrated into its pool; the migration itself may still be pending.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_GRADUATED = 3;
+     */
+    GRADUATED = 3,
+    /**
+     * Ended with total_bid_volume < required_currency_raised.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_FAILED = 4;
+     */
+    FAILED = 4
+}
 /**
  * @generated from message data.v2.SearchRequest
  */
@@ -149,11 +186,51 @@ export declare class SearchAuction extends Message<SearchAuction> {
      */
     fdvUsd?: string;
     /**
-     * Same rules as data.v1.Auction.estimated_end_time; unset when unresolvable or the auction has graduated.
+     * Same rules as data.v1.Auction.estimated_end_time, served for every lifecycle (a graduated auction's end is its "launched x ago" anchor); unset when unresolvable.
      *
      * @generated from field: optional google.protobuf.Timestamp estimated_end_time = 9;
      */
     estimatedEndTime?: Timestamp;
+    /**
+     * Same rules as data.v1.Auction.estimated_start_time; unset when unresolvable.
+     *
+     * @generated from field: optional google.protobuf.Timestamp estimated_start_time = 10;
+     */
+    estimatedStartTime?: Timestamp;
+    /**
+     * @generated from field: data.v2.AuctionLifecycle lifecycle = 11;
+     */
+    lifecycle: AuctionLifecycle;
+    /**
+     * Same shape as Token.launch_provenance: the Uniswap CCA launchpad, with launch_method CROWD/CUSTOM from the quick-launch classification (UNSPECIFIED until classified).
+     *
+     * @generated from field: optional data.v2.TokenLaunchProvenance launch_provenance = 12;
+     */
+    launchProvenance?: TokenLaunchProvenance;
+    /**
+     * Raw bid volume, an integer string in the raise currency's smallest unit; unset when unavailable or not an integer.
+     *
+     * @generated from field: optional string total_bid_volume = 13;
+     */
+    totalBidVolume?: string;
+    /**
+     * Raw raise target that decides GRADUATED vs FAILED, in the units of total_bid_volume; unset when unavailable or not an integer.
+     *
+     * @generated from field: optional string required_currency_raised = 14;
+     */
+    requiredCurrencyRaised?: string;
+    /**
+     * EIP-55 checksummed raise currency, the zero address for the chain's native currency; unset when unavailable or not an address.
+     *
+     * @generated from field: optional string currency_address = 15;
+     */
+    currencyAddress?: string;
+    /**
+     * Raise currency decimals (0-255), for rendering the raw raise fields; unset when unknown.
+     *
+     * @generated from field: optional uint32 currency_decimals = 16;
+     */
+    currencyDecimals?: number;
     constructor(data?: PartialMessage<SearchAuction>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "data.v2.SearchAuction";

package/dist/data/v2/search_pb.js

@@ -3,7 +3,7 @@
 /* eslint-disable */
 // @ts-nocheck
 import { Message, proto3, Timestamp } from "@bufbuild/protobuf";
-import { RankedMultichainToken, RankedPool } from "./types_pb.js";
+import { RankedMultichainToken, RankedPool, TokenLaunchProvenance } from "./types_pb.js";
 /**
  * @generated from enum data.v2.SearchType
  */
@@ -38,6 +38,52 @@ proto3.util.setEnumType(SearchType, "data.v2.SearchType", [
     { no: 3, name: "SEARCH_TYPE_AUCTION" },
     { no: 4, name: "SEARCH_TYPE_CATEGORY" },
 ]);
+/**
+ * Where an auction is in its life, decided server-side from the chain head against start_block/end_block and, once ended, from the raise outcome.
+ *
+ * @generated from enum data.v2.AuctionLifecycle
+ */
+export var AuctionLifecycle;
+(function (AuctionLifecycle) {
+    /**
+     * The current row, the chain head or the raise figures were unavailable; the block times and raw raise fields, when set, still let a client classify.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_UNSPECIFIED = 0;
+     */
+    AuctionLifecycle[AuctionLifecycle["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /**
+     * start_block not yet reached.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_UPCOMING = 1;
+     */
+    AuctionLifecycle[AuctionLifecycle["UPCOMING"] = 1] = "UPCOMING";
+    /**
+     * start_block reached and end_block not yet reached (the data.v1 AuctionStatusFilter ACTIVE rule).
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_LIVE = 2;
+     */
+    AuctionLifecycle[AuctionLifecycle["LIVE"] = 2] = "LIVE";
+    /**
+     * Ended with total_bid_volume >= required_currency_raised, or already migrated into its pool; the migration itself may still be pending.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_GRADUATED = 3;
+     */
+    AuctionLifecycle[AuctionLifecycle["GRADUATED"] = 3] = "GRADUATED";
+    /**
+     * Ended with total_bid_volume < required_currency_raised.
+     *
+     * @generated from enum value: AUCTION_LIFECYCLE_FAILED = 4;
+     */
+    AuctionLifecycle[AuctionLifecycle["FAILED"] = 4] = "FAILED";
+})(AuctionLifecycle || (AuctionLifecycle = {}));
+// Retrieve enum metadata with: proto3.getEnumType(AuctionLifecycle)
+proto3.util.setEnumType(AuctionLifecycle, "data.v2.AuctionLifecycle", [
+    { no: 0, name: "AUCTION_LIFECYCLE_UNSPECIFIED" },
+    { no: 1, name: "AUCTION_LIFECYCLE_UPCOMING" },
+    { no: 2, name: "AUCTION_LIFECYCLE_LIVE" },
+    { no: 3, name: "AUCTION_LIFECYCLE_GRADUATED" },
+    { no: 4, name: "AUCTION_LIFECYCLE_FAILED" },
+]);
 /**
  * @generated from message data.v2.SearchRequest
  */
@@ -183,6 +229,10 @@ export class SearchAuction extends Message {
          * @generated from field: string total_bid_volume_usd = 7;
          */
         this.totalBidVolumeUsd = "";
+        /**
+         * @generated from field: data.v2.AuctionLifecycle lifecycle = 11;
+         */
+        this.lifecycle = AuctionLifecycle.UNSPECIFIED;
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -210,4 +260,11 @@ SearchAuction.fields = proto3.util.newFieldList(() => [
     { no: 7, name: "total_bid_volume_usd", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 8, name: "fdv_usd", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 9, name: "estimated_end_time", kind: "message", T: Timestamp, opt: true },
+    { no: 10, name: "estimated_start_time", kind: "message", T: Timestamp, opt: true },
+    { no: 11, name: "lifecycle", kind: "enum", T: proto3.getEnumType(AuctionLifecycle) },
+    { no: 12, name: "launch_provenance", kind: "message", T: TokenLaunchProvenance, opt: true },
+    { no: 13, name: "total_bid_volume", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 14, name: "required_currency_raised", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 15, name: "currency_address", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 16, name: "currency_decimals", kind: "scalar", T: 13 /* ScalarType.UINT32 */, opt: true },
 ]);

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

@@ -990,6 +990,31 @@ export declare class TokenIssuerInfo extends Message<TokenIssuerInfo> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TokenIssuerInfo;
     static equals(a: TokenIssuerInfo | PlainMessage<TokenIssuerInfo> | undefined, b: TokenIssuerInfo | PlainMessage<TokenIssuerInfo> | undefined): boolean;
 }
+/**
+ * One chain's deployment of a multichain token. Decimals differ across a
+ * group's chains (USDC is 6 on mainnet and 18 on BNB), so amounts on a
+ * chain are scaled by this value, never by MultichainToken.decimals.
+ *
+ * @generated from message data.v2.ChainDeployment
+ */
+export declare class ChainDeployment extends Message<ChainDeployment> {
+    /**
+     * @generated from field: string address = 1;
+     */
+    address: string;
+    /**
+     * @generated from field: uint32 decimals = 2;
+     */
+    decimals: number;
+    constructor(data?: PartialMessage<ChainDeployment>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.ChainDeployment";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ChainDeployment;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ChainDeployment;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ChainDeployment;
+    static equals(a: ChainDeployment | PlainMessage<ChainDeployment> | undefined, b: ChainDeployment | PlainMessage<ChainDeployment> | undefined): boolean;
+}
 /**
  * @generated from message data.v2.MultichainToken
  */
@@ -1003,7 +1028,11 @@ export declare class MultichainToken extends Message<MultichainToken> {
      */
     multichainId: string;
     /**
-     * @generated from field: map<string, string> addresses = 2;
+     * chainId -> address. Same keys as `deployments`, which also carries the
+     * chain's decimals; read that instead.
+     *
+     * @generated from field: map<string, string> addresses = 2 [deprecated = true];
+     * @deprecated
      */
     addresses: {
         [key: string]: string;
@@ -1013,6 +1042,9 @@ export declare class MultichainToken extends Message<MultichainToken> {
      */
     symbol: string;
     /**
+     * The canonical deployment's decimals (`canonical_chain_id`). Per-chain
+     * values are in `deployments`.
+     *
      * @generated from field: uint32 decimals = 4;
      */
     decimals: number;
@@ -1058,11 +1090,19 @@ export declare class MultichainToken extends Message<MultichainToken> {
      */
     issuer?: TokenIssuerInfo;
     /**
-     * key of `addresses` the price, chart and metadata come from
+     * key of `deployments` the price, chart and metadata come from
      *
      * @generated from field: optional uint32 canonical_chain_id = 14;
      */
     canonicalChainId?: number;
+    /**
+     * chainId -> that chain's deployment: one per chain, the full canonical group.
+     *
+     * @generated from field: map<string, data.v2.ChainDeployment> deployments = 15;
+     */
+    deployments: {
+        [key: string]: ChainDeployment;
+    };
     constructor(data?: PartialMessage<MultichainToken>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "data.v2.MultichainToken";

package/dist/data/v2/types_pb.js

@@ -1134,6 +1134,45 @@ TokenIssuerInfo.fields = proto3.util.newFieldList(() => [
     { no: 2, name: "display_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 3, name: "logo_url", kind: "scalar", T: 9 /* ScalarType.STRING */ },
 ]);
+/**
+ * One chain's deployment of a multichain token. Decimals differ across a
+ * group's chains (USDC is 6 on mainnet and 18 on BNB), so amounts on a
+ * chain are scaled by this value, never by MultichainToken.decimals.
+ *
+ * @generated from message data.v2.ChainDeployment
+ */
+export class ChainDeployment extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: string address = 1;
+         */
+        this.address = "";
+        /**
+         * @generated from field: uint32 decimals = 2;
+         */
+        this.decimals = 0;
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new ChainDeployment().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new ChainDeployment().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new ChainDeployment().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(ChainDeployment, a, b);
+    }
+}
+ChainDeployment.runtime = proto3;
+ChainDeployment.typeName = "data.v2.ChainDeployment";
+ChainDeployment.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "address", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "decimals", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+]);
 /**
  * @generated from message data.v2.MultichainToken
  */
@@ -1149,7 +1188,11 @@ export class MultichainToken extends Message {
          */
         this.multichainId = "";
         /**
-         * @generated from field: map<string, string> addresses = 2;
+         * chainId -> address. Same keys as `deployments`, which also carries the
+         * chain's decimals; read that instead.
+         *
+         * @generated from field: map<string, string> addresses = 2 [deprecated = true];
+         * @deprecated
          */
         this.addresses = {};
         /**
@@ -1157,6 +1200,9 @@ export class MultichainToken extends Message {
          */
         this.symbol = "";
         /**
+         * The canonical deployment's decimals (`canonical_chain_id`). Per-chain
+         * values are in `deployments`.
+         *
          * @generated from field: uint32 decimals = 4;
          */
         this.decimals = 0;
@@ -1174,6 +1220,12 @@ export class MultichainToken extends Message {
          * @generated from field: repeated string category_ids = 12;
          */
         this.categoryIds = [];
+        /**
+         * chainId -> that chain's deployment: one per chain, the full canonical group.
+         *
+         * @generated from field: map<string, data.v2.ChainDeployment> deployments = 15;
+         */
+        this.deployments = {};
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -1206,6 +1258,7 @@ MultichainToken.fields = proto3.util.newFieldList(() => [
     { no: 12, name: "category_ids", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
     { no: 13, name: "issuer", kind: "message", T: TokenIssuerInfo, opt: true },
     { no: 14, name: "canonical_chain_id", kind: "scalar", T: 13 /* ScalarType.UINT32 */, opt: true },
+    { no: 15, name: "deployments", kind: "map", K: 9 /* ScalarType.STRING */, V: { kind: "message", T: ChainDeployment } },
 ]);
 /**
  * @generated from message data.v2.PoolsSort

package/package.json

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