@uniswap/client-data-api 0.0.123 → 0.0.125

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";
@@ -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
@@ -1,6 +1,29 @@
1
1
  import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
2
2
  import { Message, proto3 } from "@bufbuild/protobuf";
3
3
  import { ProtectionInfo } from "./types_pb.js";
4
+ /**
5
+ * How a graduated LP position is locked (which timelock recipient contract holds it).
6
+ *
7
+ * @generated from enum data.v1.LockMode
8
+ */
9
+ export declare enum LockMode {
10
+ /**
11
+ * @generated from enum value: LOCK_MODE_UNSPECIFIED = 0;
12
+ */
13
+ UNSPECIFIED = 0,
14
+ /**
15
+ * @generated from enum value: LOCK_MODE_TIMELOCK = 1;
16
+ */
17
+ TIMELOCK = 1,
18
+ /**
19
+ * @generated from enum value: LOCK_MODE_FEES_FORWARDER = 2;
20
+ */
21
+ FEES_FORWARDER = 2,
22
+ /**
23
+ * @generated from enum value: LOCK_MODE_BUYBACK_BURN = 3;
24
+ */
25
+ BUYBACK_BURN = 3
26
+ }
4
27
  /**
5
28
  * Request to fetch all bids by a wallet.
6
29
  *
@@ -216,6 +239,64 @@ export declare class GetAuctionRequest extends Message<GetAuctionRequest> {
216
239
  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetAuctionRequest;
217
240
  static equals(a: GetAuctionRequest | PlainMessage<GetAuctionRequest> | undefined, b: GetAuctionRequest | PlainMessage<GetAuctionRequest> | undefined): boolean;
218
241
  }
242
+ /**
243
+ * 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.
245
+ *
246
+ * @generated from message data.v1.LiquidityLockInfo
247
+ */
248
+ export declare class LiquidityLockInfo extends Message<LiquidityLockInfo> {
249
+ /**
250
+ * Lock recipient contract address.
251
+ *
252
+ * @generated from field: string lock_recipient = 1;
253
+ */
254
+ lockRecipient: string;
255
+ /**
256
+ * @generated from field: data.v1.LockMode lock_mode = 2;
257
+ */
258
+ lockMode: LockMode;
259
+ /**
260
+ * Unlock block number only — clients estimate the calendar date from it.
261
+ *
262
+ * @generated from field: uint64 unlock_block = 3;
263
+ */
264
+ unlockBlock: bigint;
265
+ /**
266
+ * Timelock operator: the address that can claim the position after unlock
267
+ * ("LP owner" display while locked).
268
+ *
269
+ * @generated from field: string lp_operator = 4;
270
+ */
271
+ lpOperator: string;
272
+ /**
273
+ * Fees-forwarder mode only.
274
+ *
275
+ * @generated from field: optional string fee_recipient = 5;
276
+ */
277
+ feeRecipient?: string;
278
+ /**
279
+ * Buyback-burn per-burn floor, raw base units.
280
+ *
281
+ * @generated from field: optional string min_token_burn_amount = 6;
282
+ */
283
+ minTokenBurnAmount?: string;
284
+ /**
285
+ * Cumulative tokens bought back & burned, raw base units. USD valuation is
286
+ * client-side at the current token price.
287
+ *
288
+ * @generated from field: string total_tokens_burned = 7;
289
+ */
290
+ totalTokensBurned: string;
291
+ constructor(data?: PartialMessage<LiquidityLockInfo>);
292
+ static readonly runtime: typeof proto3;
293
+ static readonly typeName = "data.v1.LiquidityLockInfo";
294
+ static readonly fields: FieldList;
295
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): LiquidityLockInfo;
296
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): LiquidityLockInfo;
297
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): LiquidityLockInfo;
298
+ static equals(a: LiquidityLockInfo | PlainMessage<LiquidityLockInfo> | undefined, b: LiquidityLockInfo | PlainMessage<LiquidityLockInfo> | undefined): boolean;
299
+ }
219
300
  /**
220
301
  * A single auction resource.
221
302
  *
@@ -421,6 +502,21 @@ export declare class Auction extends Message<Auction> {
421
502
  * @generated from field: optional string lbp_migration_block = 43;
422
503
  */
423
504
  lbpMigrationBlock?: string;
505
+ /**
506
+ * Liquidity-lock metadata; set only when the graduated LP position is locked
507
+ * in a timelock recipient contract.
508
+ *
509
+ * @generated from field: optional data.v1.LiquidityLockInfo liquidity_lock = 44;
510
+ */
511
+ liquidityLock?: LiquidityLockInfo;
512
+ /**
513
+ * Pool owner (the migration's positionRecipient) when the LP position is NOT
514
+ * locked — the unlocked "LP owner" display. Null until migration params are
515
+ * indexed or when the position is locked (use liquidity_lock.lp_operator).
516
+ *
517
+ * @generated from field: optional string pool_owner = 45;
518
+ */
519
+ poolOwner?: string;
424
520
  constructor(data?: PartialMessage<Auction>);
425
521
  static readonly runtime: typeof proto3;
426
522
  static readonly typeName = "data.v1.Auction";
@@ -2,8 +2,39 @@
2
2
  // @generated from file data/v1/auction.proto (package data.v1, syntax proto3)
3
3
  /* eslint-disable */
4
4
  // @ts-nocheck
5
- import { Message, proto3 } from "@bufbuild/protobuf";
5
+ import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
6
6
  import { ProtectionInfo } from "./types_pb.js";
7
+ /**
8
+ * How a graduated LP position is locked (which timelock recipient contract holds it).
9
+ *
10
+ * @generated from enum data.v1.LockMode
11
+ */
12
+ export var LockMode;
13
+ (function (LockMode) {
14
+ /**
15
+ * @generated from enum value: LOCK_MODE_UNSPECIFIED = 0;
16
+ */
17
+ LockMode[LockMode["UNSPECIFIED"] = 0] = "UNSPECIFIED";
18
+ /**
19
+ * @generated from enum value: LOCK_MODE_TIMELOCK = 1;
20
+ */
21
+ LockMode[LockMode["TIMELOCK"] = 1] = "TIMELOCK";
22
+ /**
23
+ * @generated from enum value: LOCK_MODE_FEES_FORWARDER = 2;
24
+ */
25
+ LockMode[LockMode["FEES_FORWARDER"] = 2] = "FEES_FORWARDER";
26
+ /**
27
+ * @generated from enum value: LOCK_MODE_BUYBACK_BURN = 3;
28
+ */
29
+ LockMode[LockMode["BUYBACK_BURN"] = 3] = "BUYBACK_BURN";
30
+ })(LockMode || (LockMode = {}));
31
+ // Retrieve enum metadata with: proto3.getEnumType(LockMode)
32
+ proto3.util.setEnumType(LockMode, "data.v1.LockMode", [
33
+ { no: 0, name: "LOCK_MODE_UNSPECIFIED" },
34
+ { no: 1, name: "LOCK_MODE_TIMELOCK" },
35
+ { no: 2, name: "LOCK_MODE_FEES_FORWARDER" },
36
+ { no: 3, name: "LOCK_MODE_BUYBACK_BURN" },
37
+ ]);
7
38
  /**
8
39
  * Request to fetch all bids by a wallet.
9
40
  *
@@ -323,6 +354,71 @@ GetAuctionRequest.fields = proto3.util.newFieldList(() => [
323
354
  { no: 1, name: "chain_id", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
324
355
  { no: 2, name: "address", kind: "scalar", T: 9 /* ScalarType.STRING */ },
325
356
  ]);
357
+ /**
358
+ * 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.
360
+ *
361
+ * @generated from message data.v1.LiquidityLockInfo
362
+ */
363
+ export class LiquidityLockInfo extends Message {
364
+ constructor(data) {
365
+ super();
366
+ /**
367
+ * Lock recipient contract address.
368
+ *
369
+ * @generated from field: string lock_recipient = 1;
370
+ */
371
+ this.lockRecipient = "";
372
+ /**
373
+ * @generated from field: data.v1.LockMode lock_mode = 2;
374
+ */
375
+ this.lockMode = LockMode.UNSPECIFIED;
376
+ /**
377
+ * Unlock block number only — clients estimate the calendar date from it.
378
+ *
379
+ * @generated from field: uint64 unlock_block = 3;
380
+ */
381
+ this.unlockBlock = protoInt64.zero;
382
+ /**
383
+ * Timelock operator: the address that can claim the position after unlock
384
+ * ("LP owner" display while locked).
385
+ *
386
+ * @generated from field: string lp_operator = 4;
387
+ */
388
+ this.lpOperator = "";
389
+ /**
390
+ * Cumulative tokens bought back & burned, raw base units. USD valuation is
391
+ * client-side at the current token price.
392
+ *
393
+ * @generated from field: string total_tokens_burned = 7;
394
+ */
395
+ this.totalTokensBurned = "";
396
+ proto3.util.initPartial(data, this);
397
+ }
398
+ static fromBinary(bytes, options) {
399
+ return new LiquidityLockInfo().fromBinary(bytes, options);
400
+ }
401
+ static fromJson(jsonValue, options) {
402
+ return new LiquidityLockInfo().fromJson(jsonValue, options);
403
+ }
404
+ static fromJsonString(jsonString, options) {
405
+ return new LiquidityLockInfo().fromJsonString(jsonString, options);
406
+ }
407
+ static equals(a, b) {
408
+ return proto3.util.equals(LiquidityLockInfo, a, b);
409
+ }
410
+ }
411
+ LiquidityLockInfo.runtime = proto3;
412
+ LiquidityLockInfo.typeName = "data.v1.LiquidityLockInfo";
413
+ LiquidityLockInfo.fields = proto3.util.newFieldList(() => [
414
+ { no: 1, name: "lock_recipient", kind: "scalar", T: 9 /* ScalarType.STRING */ },
415
+ { no: 2, name: "lock_mode", kind: "enum", T: proto3.getEnumType(LockMode) },
416
+ { no: 3, name: "unlock_block", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
417
+ { no: 4, name: "lp_operator", kind: "scalar", T: 9 /* ScalarType.STRING */ },
418
+ { no: 5, name: "fee_recipient", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
419
+ { no: 6, name: "min_token_burn_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
420
+ { no: 7, name: "total_tokens_burned", kind: "scalar", T: 9 /* ScalarType.STRING */ },
421
+ ]);
326
422
  /**
327
423
  * A single auction resource.
328
424
  *
@@ -490,6 +586,8 @@ Auction.fields = proto3.util.newFieldList(() => [
490
586
  { no: 41, name: "token_description", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
491
587
  { no: 42, name: "x_handle", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
492
588
  { no: 43, name: "lbp_migration_block", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
589
+ { no: 44, name: "liquidity_lock", kind: "message", T: LiquidityLockInfo, opt: true },
590
+ { no: 45, name: "pool_owner", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
493
591
  ]);
494
592
  /**
495
593
  * Response containing auctions.
@@ -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.123",
3
+ "version": "0.0.125",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },