@uniswap/client-data-api 0.0.124 → 0.0.126

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 } from "@bufbuild/protobuf";
3
3
  import { ChainTokenProfitLoss, Contract, MultichainToken, MultichainTokenProfitLoss, Pool as Pool$1, PoolRef, Portfolio, PortfolioValueModifier, Token, TokenDetailProfitLoss, TokenProfitLoss, TokenReportEventType, Transaction, TransactionTypeFilter, WalletProfitLoss } from "./types_pb.js";
4
- import { Pair, Pool, Position, PositionStatus, ProtocolVersion } from "./poolTypes_pb.js";
4
+ import { Pair, Pool, Position, PositionStatus, ProtocolVersion, RewardBalance } from "./poolTypes_pb.js";
5
5
  /**
6
6
  * @generated from enum data.v1.Platform
7
7
  */
@@ -1204,6 +1204,19 @@ export declare class GetRewardsResponse extends Message<GetRewardsResponse> {
1204
1204
  * @generated from field: string total_unclaimed_amount_uni = 1;
1205
1205
  */
1206
1206
  totalUnclaimedAmountUni: string;
1207
+ /**
1208
+ * Per-reward-token unclaimed balances (multi-denomination). The
1209
+ * total_unclaimed_amount_uni field above is the legacy UNI-only view.
1210
+ *
1211
+ * @generated from field: repeated pools.v1.RewardBalance reward_balances = 2;
1212
+ */
1213
+ rewardBalances: RewardBalance[];
1214
+ /**
1215
+ * Sum of priced reward_balances in USD. Unset when none could be priced.
1216
+ *
1217
+ * @generated from field: optional double total_unclaimed_usd = 3;
1218
+ */
1219
+ totalUnclaimedUsd?: number;
1207
1220
  constructor(data?: PartialMessage<GetRewardsResponse>);
1208
1221
  static readonly runtime: typeof proto3;
1209
1222
  static readonly typeName = "data.v1.GetRewardsResponse";
@@ -2122,6 +2135,10 @@ export declare class ListRwaTokensRequest extends Message<ListRwaTokensRequest>
2122
2135
  * @generated from field: bool include_sparkline_1d = 3;
2123
2136
  */
2124
2137
  includeSparkline1d: boolean;
2138
+ /**
2139
+ * @generated from field: bool use_substream_data = 4;
2140
+ */
2141
+ useSubstreamData: boolean;
2125
2142
  constructor(data?: PartialMessage<ListRwaTokensRequest>);
2126
2143
  static readonly runtime: typeof proto3;
2127
2144
  static readonly typeName = "data.v1.ListRwaTokensRequest";
@@ -2168,6 +2185,10 @@ export declare class ListRankedRwasRequest extends Message<ListRankedRwasRequest
2168
2185
  * @generated from field: bool include_sparkline_1d = 3;
2169
2186
  */
2170
2187
  includeSparkline1d: boolean;
2188
+ /**
2189
+ * @generated from field: bool use_substream_data = 4;
2190
+ */
2191
+ useSubstreamData: boolean;
2171
2192
  constructor(data?: PartialMessage<ListRankedRwasRequest>);
2172
2193
  static readonly runtime: typeof proto3;
2173
2194
  static readonly typeName = "data.v1.ListRankedRwasRequest";
@@ -4,7 +4,7 @@
4
4
  // @ts-nocheck
5
5
  import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
6
6
  import { ChainTokenProfitLoss, Contract, MultichainToken, MultichainTokenProfitLoss, Pool as Pool$1, PoolRef, Portfolio, PortfolioValueModifier, Token, TokenDetailProfitLoss, TokenProfitLoss, TokenReportEventType, Transaction, TransactionTypeFilter, WalletProfitLoss } from "./types_pb.js";
7
- import { Pair, Pool, Position, PositionStatus, ProtocolVersion } from "./poolTypes_pb.js";
7
+ import { Pair, Pool, Position, PositionStatus, ProtocolVersion, RewardBalance } from "./poolTypes_pb.js";
8
8
  /**
9
9
  * @generated from enum data.v1.Platform
10
10
  */
@@ -1616,6 +1616,13 @@ export class GetRewardsResponse extends Message {
1616
1616
  * @generated from field: string total_unclaimed_amount_uni = 1;
1617
1617
  */
1618
1618
  this.totalUnclaimedAmountUni = "";
1619
+ /**
1620
+ * Per-reward-token unclaimed balances (multi-denomination). The
1621
+ * total_unclaimed_amount_uni field above is the legacy UNI-only view.
1622
+ *
1623
+ * @generated from field: repeated pools.v1.RewardBalance reward_balances = 2;
1624
+ */
1625
+ this.rewardBalances = [];
1619
1626
  proto3.util.initPartial(data, this);
1620
1627
  }
1621
1628
  static fromBinary(bytes, options) {
@@ -1635,6 +1642,8 @@ GetRewardsResponse.runtime = proto3;
1635
1642
  GetRewardsResponse.typeName = "data.v1.GetRewardsResponse";
1636
1643
  GetRewardsResponse.fields = proto3.util.newFieldList(() => [
1637
1644
  { no: 1, name: "total_unclaimed_amount_uni", kind: "scalar", T: 9 /* ScalarType.STRING */ },
1645
+ { no: 2, name: "reward_balances", kind: "message", T: RewardBalance, repeated: true },
1646
+ { no: 3, name: "total_unclaimed_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1638
1647
  ]);
1639
1648
  /**
1640
1649
  * @generated from message data.v1.ListTopPoolsRequest
@@ -2846,6 +2855,10 @@ export class ListRwaTokensRequest extends Message {
2846
2855
  * @generated from field: bool include_sparkline_1d = 3;
2847
2856
  */
2848
2857
  this.includeSparkline1d = false;
2858
+ /**
2859
+ * @generated from field: bool use_substream_data = 4;
2860
+ */
2861
+ this.useSubstreamData = false;
2849
2862
  proto3.util.initPartial(data, this);
2850
2863
  }
2851
2864
  static fromBinary(bytes, options) {
@@ -2867,6 +2880,7 @@ ListRwaTokensRequest.fields = proto3.util.newFieldList(() => [
2867
2880
  { no: 1, name: "category", kind: "enum", T: proto3.getEnumType(RwaCategory) },
2868
2881
  { no: 2, name: "chain_ids", kind: "scalar", T: 13 /* ScalarType.UINT32 */, repeated: true },
2869
2882
  { no: 3, name: "include_sparkline_1d", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
2883
+ { no: 4, name: "use_substream_data", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
2870
2884
  ]);
2871
2885
  /**
2872
2886
  * @generated from message data.v1.ListRwaTokensResponse
@@ -2920,6 +2934,10 @@ export class ListRankedRwasRequest extends Message {
2920
2934
  * @generated from field: bool include_sparkline_1d = 3;
2921
2935
  */
2922
2936
  this.includeSparkline1d = false;
2937
+ /**
2938
+ * @generated from field: bool use_substream_data = 4;
2939
+ */
2940
+ this.useSubstreamData = false;
2923
2941
  proto3.util.initPartial(data, this);
2924
2942
  }
2925
2943
  static fromBinary(bytes, options) {
@@ -2941,6 +2959,7 @@ ListRankedRwasRequest.fields = proto3.util.newFieldList(() => [
2941
2959
  { no: 1, name: "category", kind: "enum", T: proto3.getEnumType(RwaCategory) },
2942
2960
  { no: 2, name: "chain_ids", kind: "scalar", T: 13 /* ScalarType.UINT32 */, repeated: true },
2943
2961
  { no: 3, name: "include_sparkline_1d", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
2962
+ { no: 4, name: "use_substream_data", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
2944
2963
  ]);
2945
2964
  /**
2946
2965
  * @generated from message data.v1.ListRankedRwasResponse
@@ -2,7 +2,8 @@ import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialM
2
2
  import { Message, proto3 } from "@bufbuild/protobuf";
3
3
  import { ProtectionInfo } from "./types_pb.js";
4
4
  /**
5
- * How a graduated LP position is locked (which timelock recipient contract holds it).
5
+ * How a graduated LP position is locked (which timelock recipient contract holds it,
6
+ * or BURN when it was minted directly to the burn address).
6
7
  *
7
8
  * @generated from enum data.v1.LockMode
8
9
  */
@@ -22,7 +23,15 @@ export declare enum LockMode {
22
23
  /**
23
24
  * @generated from enum value: LOCK_MODE_BUYBACK_BURN = 3;
24
25
  */
25
- BUYBACK_BURN = 3
26
+ BUYBACK_BURN = 3,
27
+ /**
28
+ * The LP position was minted directly to the burn address
29
+ * (0x000000000000000000000000000000000000dEaD): no recipient contract exists
30
+ * and the position can never be withdrawn. locked_forever is always true.
31
+ *
32
+ * @generated from enum value: LOCK_MODE_BURN = 4;
33
+ */
34
+ BURN = 4
26
35
  }
27
36
  /**
28
37
  * Request to fetch all bids by a wallet.
@@ -241,13 +250,14 @@ export declare class GetAuctionRequest extends Message<GetAuctionRequest> {
241
250
  }
242
251
  /**
243
252
  * Liquidity-lock metadata for auctions whose graduated LP position is held by a
244
- * timelock recipient contract. Set on Auction only when the position is locked.
253
+ * timelock recipient contract (or by the burn address for LOCK_MODE_BURN). Set on
254
+ * Auction only when the position is locked.
245
255
  *
246
256
  * @generated from message data.v1.LiquidityLockInfo
247
257
  */
248
258
  export declare class LiquidityLockInfo extends Message<LiquidityLockInfo> {
249
259
  /**
250
- * Lock recipient contract address.
260
+ * Lock recipient contract address (the burn address for LOCK_MODE_BURN).
251
261
  *
252
262
  * @generated from field: string lock_recipient = 1;
253
263
  */
@@ -258,13 +268,16 @@ export declare class LiquidityLockInfo extends Message<LiquidityLockInfo> {
258
268
  lockMode: LockMode;
259
269
  /**
260
270
  * Unlock block number only — clients estimate the calendar date from it.
271
+ * 0 for LOCK_MODE_BURN (nothing ever unlocks): check locked_forever before
272
+ * rendering an unlock date.
261
273
  *
262
274
  * @generated from field: uint64 unlock_block = 3;
263
275
  */
264
276
  unlockBlock: bigint;
265
277
  /**
266
278
  * Timelock operator: the address that can claim the position after unlock
267
- * ("LP owner" display while locked).
279
+ * ("LP owner" display while locked). Empty for LOCK_MODE_BURN — no one can
280
+ * ever claim a burned position.
268
281
  *
269
282
  * @generated from field: string lp_operator = 4;
270
283
  */
@@ -288,6 +301,15 @@ export declare class LiquidityLockInfo extends Message<LiquidityLockInfo> {
288
301
  * @generated from field: string total_tokens_burned = 7;
289
302
  */
290
303
  totalTokensBurned: string;
304
+ /**
305
+ * True when the position can never be withdrawn: LOCK_MODE_BURN, or a
306
+ * contract-held lock whose unlock_block is so far in the future it is
307
+ * effectively permanent (the legacy "Permanent" preset encoded ~100,000
308
+ * years as a timelock). Render "locked forever" and ignore unlock_block.
309
+ *
310
+ * @generated from field: bool locked_forever = 8;
311
+ */
312
+ lockedForever: boolean;
291
313
  constructor(data?: PartialMessage<LiquidityLockInfo>);
292
314
  static readonly runtime: typeof proto3;
293
315
  static readonly typeName = "data.v1.LiquidityLockInfo";
@@ -5,7 +5,8 @@
5
5
  import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
6
6
  import { ProtectionInfo } from "./types_pb.js";
7
7
  /**
8
- * How a graduated LP position is locked (which timelock recipient contract holds it).
8
+ * How a graduated LP position is locked (which timelock recipient contract holds it,
9
+ * or BURN when it was minted directly to the burn address).
9
10
  *
10
11
  * @generated from enum data.v1.LockMode
11
12
  */
@@ -27,6 +28,14 @@ export var LockMode;
27
28
  * @generated from enum value: LOCK_MODE_BUYBACK_BURN = 3;
28
29
  */
29
30
  LockMode[LockMode["BUYBACK_BURN"] = 3] = "BUYBACK_BURN";
31
+ /**
32
+ * The LP position was minted directly to the burn address
33
+ * (0x000000000000000000000000000000000000dEaD): no recipient contract exists
34
+ * and the position can never be withdrawn. locked_forever is always true.
35
+ *
36
+ * @generated from enum value: LOCK_MODE_BURN = 4;
37
+ */
38
+ LockMode[LockMode["BURN"] = 4] = "BURN";
30
39
  })(LockMode || (LockMode = {}));
31
40
  // Retrieve enum metadata with: proto3.getEnumType(LockMode)
32
41
  proto3.util.setEnumType(LockMode, "data.v1.LockMode", [
@@ -34,6 +43,7 @@ proto3.util.setEnumType(LockMode, "data.v1.LockMode", [
34
43
  { no: 1, name: "LOCK_MODE_TIMELOCK" },
35
44
  { no: 2, name: "LOCK_MODE_FEES_FORWARDER" },
36
45
  { no: 3, name: "LOCK_MODE_BUYBACK_BURN" },
46
+ { no: 4, name: "LOCK_MODE_BURN" },
37
47
  ]);
38
48
  /**
39
49
  * Request to fetch all bids by a wallet.
@@ -356,7 +366,8 @@ GetAuctionRequest.fields = proto3.util.newFieldList(() => [
356
366
  ]);
357
367
  /**
358
368
  * Liquidity-lock metadata for auctions whose graduated LP position is held by a
359
- * timelock recipient contract. Set on Auction only when the position is locked.
369
+ * timelock recipient contract (or by the burn address for LOCK_MODE_BURN). Set on
370
+ * Auction only when the position is locked.
360
371
  *
361
372
  * @generated from message data.v1.LiquidityLockInfo
362
373
  */
@@ -364,7 +375,7 @@ export class LiquidityLockInfo extends Message {
364
375
  constructor(data) {
365
376
  super();
366
377
  /**
367
- * Lock recipient contract address.
378
+ * Lock recipient contract address (the burn address for LOCK_MODE_BURN).
368
379
  *
369
380
  * @generated from field: string lock_recipient = 1;
370
381
  */
@@ -375,13 +386,16 @@ export class LiquidityLockInfo extends Message {
375
386
  this.lockMode = LockMode.UNSPECIFIED;
376
387
  /**
377
388
  * Unlock block number only — clients estimate the calendar date from it.
389
+ * 0 for LOCK_MODE_BURN (nothing ever unlocks): check locked_forever before
390
+ * rendering an unlock date.
378
391
  *
379
392
  * @generated from field: uint64 unlock_block = 3;
380
393
  */
381
394
  this.unlockBlock = protoInt64.zero;
382
395
  /**
383
396
  * Timelock operator: the address that can claim the position after unlock
384
- * ("LP owner" display while locked).
397
+ * ("LP owner" display while locked). Empty for LOCK_MODE_BURN — no one can
398
+ * ever claim a burned position.
385
399
  *
386
400
  * @generated from field: string lp_operator = 4;
387
401
  */
@@ -393,6 +407,15 @@ export class LiquidityLockInfo extends Message {
393
407
  * @generated from field: string total_tokens_burned = 7;
394
408
  */
395
409
  this.totalTokensBurned = "";
410
+ /**
411
+ * True when the position can never be withdrawn: LOCK_MODE_BURN, or a
412
+ * contract-held lock whose unlock_block is so far in the future it is
413
+ * effectively permanent (the legacy "Permanent" preset encoded ~100,000
414
+ * years as a timelock). Render "locked forever" and ignore unlock_block.
415
+ *
416
+ * @generated from field: bool locked_forever = 8;
417
+ */
418
+ this.lockedForever = false;
396
419
  proto3.util.initPartial(data, this);
397
420
  }
398
421
  static fromBinary(bytes, options) {
@@ -418,6 +441,7 @@ LiquidityLockInfo.fields = proto3.util.newFieldList(() => [
418
441
  { no: 5, name: "fee_recipient", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
419
442
  { no: 6, name: "min_token_burn_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
420
443
  { no: 7, name: "total_tokens_burned", kind: "scalar", T: 9 /* ScalarType.STRING */ },
444
+ { no: 8, name: "locked_forever", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
421
445
  ]);
422
446
  /**
423
447
  * A single auction resource.
@@ -83,6 +83,38 @@ export declare class Token extends Message<Token> {
83
83
  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Token;
84
84
  static equals(a: Token | PlainMessage<Token> | undefined, b: Token | PlainMessage<Token> | undefined): boolean;
85
85
  }
86
+ /**
87
+ * Unclaimed reward balance for a single reward token. Surfaces LP incentive
88
+ * rewards per denomination (e.g. UNI, USDC) rather than a single UNI-only amount.
89
+ *
90
+ * @generated from message pools.v1.RewardBalance
91
+ */
92
+ export declare class RewardBalance extends Message<RewardBalance> {
93
+ /**
94
+ * @generated from field: pools.v1.Token token = 1;
95
+ */
96
+ token?: Token;
97
+ /**
98
+ * Unclaimed amount in the token's smallest unit.
99
+ *
100
+ * @generated from field: string unclaimed_amount = 2;
101
+ */
102
+ unclaimedAmount: string;
103
+ /**
104
+ * Unclaimed amount in USD. Unset when no price is available.
105
+ *
106
+ * @generated from field: optional double unclaimed_amount_usd = 3;
107
+ */
108
+ unclaimedAmountUsd?: number;
109
+ constructor(data?: PartialMessage<RewardBalance>);
110
+ static readonly runtime: typeof proto3;
111
+ static readonly typeName = "pools.v1.RewardBalance";
112
+ static readonly fields: FieldList;
113
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RewardBalance;
114
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RewardBalance;
115
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RewardBalance;
116
+ static equals(a: RewardBalance | PlainMessage<RewardBalance> | undefined, b: RewardBalance | PlainMessage<RewardBalance> | undefined): boolean;
117
+ }
86
118
  /**
87
119
  * @generated from message pools.v1.PoolPosition
88
120
  */
@@ -179,6 +211,13 @@ export declare class PoolPosition extends Message<PoolPosition> {
179
211
  * @generated from field: string unclaimed_rewards_amount_uni = 23;
180
212
  */
181
213
  unclaimedRewardsAmountUni: string;
214
+ /**
215
+ * Per-reward-token unclaimed balances (multi-denomination). The
216
+ * unclaimed_rewards_amount_uni field above is the legacy UNI-only view.
217
+ *
218
+ * @generated from field: repeated pools.v1.RewardBalance reward_balances = 24;
219
+ */
220
+ rewardBalances: RewardBalance[];
182
221
  constructor(data?: PartialMessage<PoolPosition>);
183
222
  static readonly runtime: typeof proto3;
184
223
  static readonly typeName = "pools.v1.PoolPosition";
@@ -117,6 +117,43 @@ Token.fields = proto3.util.newFieldList(() => [
117
117
  { no: 6, name: "logo", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
118
118
  { no: 7, name: "is_native", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
119
119
  ]);
120
+ /**
121
+ * Unclaimed reward balance for a single reward token. Surfaces LP incentive
122
+ * rewards per denomination (e.g. UNI, USDC) rather than a single UNI-only amount.
123
+ *
124
+ * @generated from message pools.v1.RewardBalance
125
+ */
126
+ export class RewardBalance extends Message {
127
+ constructor(data) {
128
+ super();
129
+ /**
130
+ * Unclaimed amount in the token's smallest unit.
131
+ *
132
+ * @generated from field: string unclaimed_amount = 2;
133
+ */
134
+ this.unclaimedAmount = "";
135
+ proto3.util.initPartial(data, this);
136
+ }
137
+ static fromBinary(bytes, options) {
138
+ return new RewardBalance().fromBinary(bytes, options);
139
+ }
140
+ static fromJson(jsonValue, options) {
141
+ return new RewardBalance().fromJson(jsonValue, options);
142
+ }
143
+ static fromJsonString(jsonString, options) {
144
+ return new RewardBalance().fromJsonString(jsonString, options);
145
+ }
146
+ static equals(a, b) {
147
+ return proto3.util.equals(RewardBalance, a, b);
148
+ }
149
+ }
150
+ RewardBalance.runtime = proto3;
151
+ RewardBalance.typeName = "pools.v1.RewardBalance";
152
+ RewardBalance.fields = proto3.util.newFieldList(() => [
153
+ { no: 1, name: "token", kind: "message", T: Token },
154
+ { no: 2, name: "unclaimed_amount", kind: "scalar", T: 9 /* ScalarType.STRING */ },
155
+ { no: 3, name: "unclaimed_amount_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
156
+ ]);
120
157
  /**
121
158
  * @generated from message pools.v1.PoolPosition
122
159
  */
@@ -207,6 +244,13 @@ export class PoolPosition extends Message {
207
244
  * @generated from field: string unclaimed_rewards_amount_uni = 23;
208
245
  */
209
246
  this.unclaimedRewardsAmountUni = "";
247
+ /**
248
+ * Per-reward-token unclaimed balances (multi-denomination). The
249
+ * unclaimed_rewards_amount_uni field above is the legacy UNI-only view.
250
+ *
251
+ * @generated from field: repeated pools.v1.RewardBalance reward_balances = 24;
252
+ */
253
+ this.rewardBalances = [];
210
254
  proto3.util.initPartial(data, this);
211
255
  }
212
256
  static fromBinary(bytes, options) {
@@ -248,6 +292,7 @@ PoolPosition.fields = proto3.util.newFieldList(() => [
248
292
  { no: 21, name: "boosted_apr", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
249
293
  { no: 22, name: "total_apr", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
250
294
  { no: 23, name: "unclaimed_rewards_amount_uni", kind: "scalar", T: 9 /* ScalarType.STRING */ },
295
+ { no: 24, name: "reward_balances", kind: "message", T: RewardBalance, repeated: true },
251
296
  ]);
252
297
  /**
253
298
  * @generated from message pools.v1.PairPosition
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniswap/client-data-api",
3
- "version": "0.0.124",
3
+ "version": "0.0.126",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },