@uniswap/client-data-api 0.0.229 → 0.0.231

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
2
2
  import { Message, proto3, Timestamp } from "@bufbuild/protobuf";
3
3
  import { TimestampedValue, TokenType } from "../v1/types_pb.js";
4
- import { ProtocolVersion } from "../v1/poolTypes_pb.js";
4
+ import { ProtocolVersion, Token as Token$1 } from "../v1/poolTypes_pb.js";
5
5
  /**
6
6
  * @generated from enum data.v2.TokensOrderBy
7
7
  */
@@ -364,7 +364,18 @@ export declare enum LaunchesOrderBy {
364
364
  *
365
365
  * @generated from enum value: LAUNCHES_ORDER_BY_TRENDING = 6;
366
366
  */
367
- TRENDING = 6
367
+ TRENDING = 6,
368
+ /**
369
+ * Fully-diluted valuation, descending by default. Served from the RANKED
370
+ * launch_tokens read (the live attribution scan has no FDV engine), which
371
+ * every non-LAUNCHED_AT sort already routes to. Unlike TRENDING, a
372
+ * LaunchListFilter.window IS applied under this sort: the launch-age floor
373
+ * reaches both arms, so FDV + LAST_24H ranks by FDV among launches inside
374
+ * that window rather than across all launches.
375
+ *
376
+ * @generated from enum value: LAUNCHES_ORDER_BY_FDV = 7;
377
+ */
378
+ FDV = 7
368
379
  }
369
380
  /**
370
381
  * Launch-recency window for ListLaunches. UNSPECIFIED applies no window (all
@@ -1026,6 +1037,36 @@ export declare class PoolsSort extends Message<PoolsSort> {
1026
1037
  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolsSort;
1027
1038
  static equals(a: PoolsSort | PlainMessage<PoolsSort> | undefined, b: PoolsSort | PlainMessage<PoolsSort> | undefined): boolean;
1028
1039
  }
1040
+ /**
1041
+ * A pool's boosted APR in one reward token: the sum of that token's live
1042
+ * campaign APRs on the pool, in percent, on top of the pool's fee APR. Ended
1043
+ * campaigns are excluded — they accrue no yield.
1044
+ *
1045
+ * Deliberately carries no campaign detail (windows, allocations, distributed
1046
+ * amounts): only the pool details page renders that, and it reads
1047
+ * GetPoolRewards. Keeping it off this message keeps the per-row payload small
1048
+ * enough to repeat across a page of pools.
1049
+ *
1050
+ * @generated from message data.v2.PoolTokenBoost
1051
+ */
1052
+ export declare class PoolTokenBoost extends Message<PoolTokenBoost> {
1053
+ /**
1054
+ * @generated from field: pools.v1.Token token = 1;
1055
+ */
1056
+ token?: Token$1;
1057
+ /**
1058
+ * @generated from field: double apr = 2;
1059
+ */
1060
+ apr: number;
1061
+ constructor(data?: PartialMessage<PoolTokenBoost>);
1062
+ static readonly runtime: typeof proto3;
1063
+ static readonly typeName = "data.v2.PoolTokenBoost";
1064
+ static readonly fields: FieldList;
1065
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolTokenBoost;
1066
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolTokenBoost;
1067
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolTokenBoost;
1068
+ static equals(a: PoolTokenBoost | PlainMessage<PoolTokenBoost> | undefined, b: PoolTokenBoost | PlainMessage<PoolTokenBoost> | undefined): boolean;
1069
+ }
1029
1070
  /**
1030
1071
  * Ranking stats for a pool.
1031
1072
  * apr = annualised fee revenue / TVL.
@@ -1065,6 +1106,19 @@ export declare class PoolRankStats extends Message<PoolRankStats> {
1065
1106
  * @generated from field: optional double volume_1d_tvl_ratio = 7;
1066
1107
  */
1067
1108
  volume1dTvlRatio?: number;
1109
+ /**
1110
+ * What reward_apr is paid in, per reward token — so a client can denominate
1111
+ * a boost ("+2.1% in UNI") instead of rendering a bare number under a
1112
+ * guessed symbol. reward_apr stays the cross-token sum and is derived from
1113
+ * these, so reward_apr == sum(token_boosts[].apr) always holds.
1114
+ *
1115
+ * Empty when the pool runs no live campaign, and empty when the incentive
1116
+ * lookup degraded — in which case reward_apr is unset too. Never one
1117
+ * without the other: a boost nobody can denominate is worse than no boost.
1118
+ *
1119
+ * @generated from field: repeated data.v2.PoolTokenBoost token_boosts = 8;
1120
+ */
1121
+ tokenBoosts: PoolTokenBoost[];
1068
1122
  constructor(data?: PartialMessage<PoolRankStats>);
1069
1123
  static readonly runtime: typeof proto3;
1070
1124
  static readonly typeName = "data.v2.PoolRankStats";
@@ -4,7 +4,7 @@
4
4
  // @ts-nocheck
5
5
  import { Message, proto3, protoInt64, Timestamp } from "@bufbuild/protobuf";
6
6
  import { TimestampedValue, TokenType } from "../v1/types_pb.js";
7
- import { ProtocolVersion } from "../v1/poolTypes_pb.js";
7
+ import { ProtocolVersion, Token as Token$1 } from "../v1/poolTypes_pb.js";
8
8
  /**
9
9
  * @generated from enum data.v2.TokensOrderBy
10
10
  */
@@ -462,6 +462,17 @@ export var LaunchesOrderBy;
462
462
  * @generated from enum value: LAUNCHES_ORDER_BY_TRENDING = 6;
463
463
  */
464
464
  LaunchesOrderBy[LaunchesOrderBy["TRENDING"] = 6] = "TRENDING";
465
+ /**
466
+ * Fully-diluted valuation, descending by default. Served from the RANKED
467
+ * launch_tokens read (the live attribution scan has no FDV engine), which
468
+ * every non-LAUNCHED_AT sort already routes to. Unlike TRENDING, a
469
+ * LaunchListFilter.window IS applied under this sort: the launch-age floor
470
+ * reaches both arms, so FDV + LAST_24H ranks by FDV among launches inside
471
+ * that window rather than across all launches.
472
+ *
473
+ * @generated from enum value: LAUNCHES_ORDER_BY_FDV = 7;
474
+ */
475
+ LaunchesOrderBy[LaunchesOrderBy["FDV"] = 7] = "FDV";
465
476
  })(LaunchesOrderBy || (LaunchesOrderBy = {}));
466
477
  // Retrieve enum metadata with: proto3.getEnumType(LaunchesOrderBy)
467
478
  proto3.util.setEnumType(LaunchesOrderBy, "data.v2.LaunchesOrderBy", [
@@ -472,6 +483,7 @@ proto3.util.setEnumType(LaunchesOrderBy, "data.v2.LaunchesOrderBy", [
472
483
  { no: 4, name: "LAUNCHES_ORDER_BY_PRICE_CHANGE_1H" },
473
484
  { no: 5, name: "LAUNCHES_ORDER_BY_PRICE_CHANGE_1D" },
474
485
  { no: 6, name: "LAUNCHES_ORDER_BY_TRENDING" },
486
+ { no: 7, name: "LAUNCHES_ORDER_BY_FDV" },
475
487
  ]);
476
488
  /**
477
489
  * Launch-recency window for ListLaunches. UNSPECIFIED applies no window (all
@@ -1174,6 +1186,46 @@ PoolsSort.fields = proto3.util.newFieldList(() => [
1174
1186
  { no: 1, name: "order_by", kind: "enum", T: proto3.getEnumType(PoolsOrderBy), opt: true },
1175
1187
  { no: 2, name: "ascending", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
1176
1188
  ]);
1189
+ /**
1190
+ * A pool's boosted APR in one reward token: the sum of that token's live
1191
+ * campaign APRs on the pool, in percent, on top of the pool's fee APR. Ended
1192
+ * campaigns are excluded — they accrue no yield.
1193
+ *
1194
+ * Deliberately carries no campaign detail (windows, allocations, distributed
1195
+ * amounts): only the pool details page renders that, and it reads
1196
+ * GetPoolRewards. Keeping it off this message keeps the per-row payload small
1197
+ * enough to repeat across a page of pools.
1198
+ *
1199
+ * @generated from message data.v2.PoolTokenBoost
1200
+ */
1201
+ export class PoolTokenBoost extends Message {
1202
+ constructor(data) {
1203
+ super();
1204
+ /**
1205
+ * @generated from field: double apr = 2;
1206
+ */
1207
+ this.apr = 0;
1208
+ proto3.util.initPartial(data, this);
1209
+ }
1210
+ static fromBinary(bytes, options) {
1211
+ return new PoolTokenBoost().fromBinary(bytes, options);
1212
+ }
1213
+ static fromJson(jsonValue, options) {
1214
+ return new PoolTokenBoost().fromJson(jsonValue, options);
1215
+ }
1216
+ static fromJsonString(jsonString, options) {
1217
+ return new PoolTokenBoost().fromJsonString(jsonString, options);
1218
+ }
1219
+ static equals(a, b) {
1220
+ return proto3.util.equals(PoolTokenBoost, a, b);
1221
+ }
1222
+ }
1223
+ PoolTokenBoost.runtime = proto3;
1224
+ PoolTokenBoost.typeName = "data.v2.PoolTokenBoost";
1225
+ PoolTokenBoost.fields = proto3.util.newFieldList(() => [
1226
+ { no: 1, name: "token", kind: "message", T: Token$1 },
1227
+ { no: 2, name: "apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
1228
+ ]);
1177
1229
  /**
1178
1230
  * Ranking stats for a pool.
1179
1231
  * apr = annualised fee revenue / TVL.
@@ -1185,6 +1237,19 @@ PoolsSort.fields = proto3.util.newFieldList(() => [
1185
1237
  export class PoolRankStats extends Message {
1186
1238
  constructor(data) {
1187
1239
  super();
1240
+ /**
1241
+ * What reward_apr is paid in, per reward token — so a client can denominate
1242
+ * a boost ("+2.1% in UNI") instead of rendering a bare number under a
1243
+ * guessed symbol. reward_apr stays the cross-token sum and is derived from
1244
+ * these, so reward_apr == sum(token_boosts[].apr) always holds.
1245
+ *
1246
+ * Empty when the pool runs no live campaign, and empty when the incentive
1247
+ * lookup degraded — in which case reward_apr is unset too. Never one
1248
+ * without the other: a boost nobody can denominate is worse than no boost.
1249
+ *
1250
+ * @generated from field: repeated data.v2.PoolTokenBoost token_boosts = 8;
1251
+ */
1252
+ this.tokenBoosts = [];
1188
1253
  proto3.util.initPartial(data, this);
1189
1254
  }
1190
1255
  static fromBinary(bytes, options) {
@@ -1210,6 +1275,7 @@ PoolRankStats.fields = proto3.util.newFieldList(() => [
1210
1275
  { no: 5, name: "reward_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1211
1276
  { no: 6, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1212
1277
  { no: 7, name: "volume_1d_tvl_ratio", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1278
+ { no: 8, name: "token_boosts", kind: "message", T: PoolTokenBoost, repeated: true },
1213
1279
  ]);
1214
1280
  /**
1215
1281
  * A pool's protocol identity, token pair, and current on-chain state (state
@@ -41,7 +41,18 @@ export declare enum LaunchesOrderBy {
41
41
  *
42
42
  * @generated from enum value: LAUNCHES_ORDER_BY_TRENDING = 6;
43
43
  */
44
- TRENDING = 6
44
+ TRENDING = 6,
45
+ /**
46
+ * Fully-diluted valuation, descending by default. Served from the RANKED
47
+ * launch_tokens read (the live attribution scan has no FDV engine), which
48
+ * every non-LAUNCHED_AT sort already routes to. Unlike TRENDING, a
49
+ * LaunchListFilter.window IS applied under this sort: the launch-age floor
50
+ * reaches both arms, so FDV + LAST_24H ranks by FDV among launches inside
51
+ * that window rather than across all launches.
52
+ *
53
+ * @generated from enum value: LAUNCHES_ORDER_BY_FDV = 7;
54
+ */
55
+ FDV = 7
45
56
  }
46
57
  /**
47
58
  * Launch-recency window for ListLaunches. UNSPECIFIED applies no window (all
@@ -46,6 +46,17 @@ export var LaunchesOrderBy;
46
46
  * @generated from enum value: LAUNCHES_ORDER_BY_TRENDING = 6;
47
47
  */
48
48
  LaunchesOrderBy[LaunchesOrderBy["TRENDING"] = 6] = "TRENDING";
49
+ /**
50
+ * Fully-diluted valuation, descending by default. Served from the RANKED
51
+ * launch_tokens read (the live attribution scan has no FDV engine), which
52
+ * every non-LAUNCHED_AT sort already routes to. Unlike TRENDING, a
53
+ * LaunchListFilter.window IS applied under this sort: the launch-age floor
54
+ * reaches both arms, so FDV + LAST_24H ranks by FDV among launches inside
55
+ * that window rather than across all launches.
56
+ *
57
+ * @generated from enum value: LAUNCHES_ORDER_BY_FDV = 7;
58
+ */
59
+ LaunchesOrderBy[LaunchesOrderBy["FDV"] = 7] = "FDV";
49
60
  })(LaunchesOrderBy || (LaunchesOrderBy = {}));
50
61
  // Retrieve enum metadata with: proto3.getEnumType(LaunchesOrderBy)
51
62
  proto3.util.setEnumType(LaunchesOrderBy, "launches.v1.LaunchesOrderBy", [
@@ -56,6 +67,7 @@ proto3.util.setEnumType(LaunchesOrderBy, "launches.v1.LaunchesOrderBy", [
56
67
  { no: 4, name: "LAUNCHES_ORDER_BY_PRICE_CHANGE_1H" },
57
68
  { no: 5, name: "LAUNCHES_ORDER_BY_PRICE_CHANGE_1D" },
58
69
  { no: 6, name: "LAUNCHES_ORDER_BY_TRENDING" },
70
+ { no: 7, name: "LAUNCHES_ORDER_BY_FDV" },
59
71
  ]);
60
72
  /**
61
73
  * Launch-recency window for ListLaunches. UNSPECIFIED applies no window (all
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniswap/client-data-api",
3
- "version": "0.0.229",
3
+ "version": "0.0.231",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },