@uniswap/client-liquidity 1.4.29 → 1.4.31

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.
@@ -824,6 +824,18 @@ export declare class PoolSummary extends Message<PoolSummary> {
824
824
  * @generated from field: repeated uniswap.liquidity.v2.PoolTokenRewards token_rewards = 28;
825
825
  */
826
826
  tokenRewards: PoolTokenRewards[];
827
+ /**
828
+ * What an LP earns on this pool all-in: the fee APR above plus every reward
829
+ * token's boost — `apr` + the sum of token_rewards[].boosted_apr. Percent.
830
+ *
831
+ * A missing side counts as 0, so a pool with no live campaign reports its fee
832
+ * APR alone. Unset only when neither side is known: no `apr` and no
833
+ * token_rewards. A boost that sums to 0 with token_rewards present is a known
834
+ * zero, not missing.
835
+ *
836
+ * @generated from field: optional double total_apr = 29;
837
+ */
838
+ totalApr?: number;
827
839
  constructor(data?: PartialMessage<PoolSummary>);
828
840
  static readonly runtime: typeof proto3;
829
841
  static readonly typeName = "uniswap.liquidity.v2.PoolSummary";
@@ -968,18 +980,18 @@ export declare class PoolCampaign extends Message<PoolCampaign> {
968
980
  */
969
981
  totalRewardAllocation: string;
970
982
  /**
971
- * Emission rate in USD. Derived upstream from the reward token's price at fetch
972
- * time, so it drifts with price; daily_rewards below is price-independent.
983
+ * Share of total_reward_allocation emitted so far, same units for a
984
+ * distributed-vs-total progress figure.
973
985
  *
974
- * @generated from field: optional double daily_rewards_usd = 6;
975
- */
976
- dailyRewardsUsd?: number;
977
- /**
978
- * Emission rate in the reward token's smallest unit (uint256 decimal string).
986
+ * ESTIMATE, not an upstream fact: Merkl reports no distributed or claimed
987
+ * amount per campaign, so data-api derives this as total_reward_allocation
988
+ * scaled by the fraction of the campaign window elapsed. It assumes uniform
989
+ * emission, so a campaign that pauses, fails, or pays on a curve still reads
990
+ * as exactly on schedule. Don't reconcile it against on-chain claims.
979
991
  *
980
- * @generated from field: optional string daily_rewards = 7;
992
+ * @generated from field: string distributed_rewards = 8;
981
993
  */
982
- dailyRewards?: string;
994
+ distributedRewards: string;
983
995
  constructor(data?: PartialMessage<PoolCampaign>);
984
996
  static readonly runtime: typeof proto3;
985
997
  static readonly typeName = "uniswap.liquidity.v2.PoolCampaign";
@@ -1486,12 +1498,28 @@ export declare class Position extends Message<Position> {
1486
1498
  * reports for the same wallet.
1487
1499
  *
1488
1500
  * Empty for V2 (no campaigns), and empty when the lookup degrades — rewards
1489
- * never fail a positions read. Populated by GetWalletPositions; GetPosition
1490
- * leaves it empty for now.
1501
+ * never fail a positions read. Populated by both GetWalletPositions and
1502
+ * GetPosition.
1491
1503
  *
1492
1504
  * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
1493
1505
  */
1494
1506
  rewards: PositionReward[];
1507
+ /**
1508
+ * What this position earns all-in: the pool's 24h fee APR plus every reward
1509
+ * token's boost — `apr_1d` + the sum of rewards[].boosted_pool_apr. Percent.
1510
+ *
1511
+ * apr_1d is the window used because it's the one data-api's own total_apr sums
1512
+ * (the pool_stats `apr` column); clients showing the 7d/30d window should add
1513
+ * the boost to that window themselves.
1514
+ *
1515
+ * A missing side counts as 0, so an uncampaigned position reports its fee APR
1516
+ * alone and a position whose pool stats haven't published reports its boost
1517
+ * alone. Unset only when neither side is known: no apr_1d and no rewards. A
1518
+ * boost that sums to 0 with rewards present is a known zero, not missing.
1519
+ *
1520
+ * @generated from field: optional double total_apr = 39;
1521
+ */
1522
+ totalApr?: number;
1495
1523
  constructor(data?: PartialMessage<Position>);
1496
1524
  static readonly runtime: typeof proto3;
1497
1525
  static readonly typeName = "uniswap.liquidity.v2.Position";
@@ -1035,6 +1035,7 @@ PoolSummary.fields = proto3.util.newFieldList(() => [
1035
1035
  { no: 26, name: "tvl_usd_change_1d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1036
1036
  { no: 27, name: "volume_usd_1d_change", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1037
1037
  { no: 28, name: "token_rewards", kind: "message", T: PoolTokenRewards, repeated: true },
1038
+ { no: 29, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1038
1039
  ]);
1039
1040
  /**
1040
1041
  * A reward token's on-chain identity, so a client can interpret and format a
@@ -1191,6 +1192,19 @@ export class PoolCampaign extends Message {
1191
1192
  * @generated from field: string total_reward_allocation = 5;
1192
1193
  */
1193
1194
  this.totalRewardAllocation = "";
1195
+ /**
1196
+ * Share of total_reward_allocation emitted so far, same units — for a
1197
+ * distributed-vs-total progress figure.
1198
+ *
1199
+ * ESTIMATE, not an upstream fact: Merkl reports no distributed or claimed
1200
+ * amount per campaign, so data-api derives this as total_reward_allocation
1201
+ * scaled by the fraction of the campaign window elapsed. It assumes uniform
1202
+ * emission, so a campaign that pauses, fails, or pays on a curve still reads
1203
+ * as exactly on schedule. Don't reconcile it against on-chain claims.
1204
+ *
1205
+ * @generated from field: string distributed_rewards = 8;
1206
+ */
1207
+ this.distributedRewards = "";
1194
1208
  proto3.util.initPartial(data, this);
1195
1209
  }
1196
1210
  static fromBinary(bytes, options) {
@@ -1214,8 +1228,7 @@ PoolCampaign.fields = proto3.util.newFieldList(() => [
1214
1228
  { no: 3, name: "start_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
1215
1229
  { no: 4, name: "end_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
1216
1230
  { no: 5, name: "total_reward_allocation", kind: "scalar", T: 9 /* ScalarType.STRING */ },
1217
- { no: 6, name: "daily_rewards_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1218
- { no: 7, name: "daily_rewards", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
1231
+ { no: 8, name: "distributed_rewards", kind: "scalar", T: 9 /* ScalarType.STRING */ },
1219
1232
  ]);
1220
1233
  /**
1221
1234
  * A pool's live rewards in one reward token: the summed boost plus the campaigns
@@ -1645,8 +1658,8 @@ export class Position extends Message {
1645
1658
  * reports for the same wallet.
1646
1659
  *
1647
1660
  * Empty for V2 (no campaigns), and empty when the lookup degrades — rewards
1648
- * never fail a positions read. Populated by GetWalletPositions; GetPosition
1649
- * leaves it empty for now.
1661
+ * never fail a positions read. Populated by both GetWalletPositions and
1662
+ * GetPosition.
1650
1663
  *
1651
1664
  * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
1652
1665
  */
@@ -1707,6 +1720,7 @@ Position.fields = proto3.util.newFieldList(() => [
1707
1720
  { no: 36, name: "reserve1", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
1708
1721
  { no: 37, name: "total_supply", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
1709
1722
  { no: 38, name: "rewards", kind: "message", T: PositionReward, repeated: true },
1723
+ { no: 39, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
1710
1724
  ]);
1711
1725
  /**
1712
1726
  * Keyset cursor for GetWalletPositions. position_key is the last returned
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniswap/client-liquidity",
3
- "version": "1.4.29",
3
+ "version": "1.4.31",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },