@uniswap/client-liquidity 1.4.28 → 1.4.30

package/dist/uniswap/liquidity/v2/types_pb.d.ts

@@ -789,18 +789,14 @@ export declare class PoolSummary extends Message<PoolSummary> {
      */
     isDynamicFee?: boolean;
     /**
-     * Live Merkl LP-incentive campaigns for this pool (V3/V4). Composed at read
-     * time from Merkl (not Aurora); empty when the pool has no live allowlisted
-     * campaign or the lookup degrades. One entry per campaign — not aggregated,
-     * so two concurrent UNI campaigns are two entries.
+     * DEPRECATED — superseded by token_rewards below, which groups campaigns under
+     * the token they pay and carries that token's summed boost. This field has never
+     * been populated and stays permanently empty; it exists only so consumers that
+     * already read it keep compiling. Removal is tracked in LP-1585 (reserve tag 25
+     * when it goes — a reused tag with a different type is wire-incompatible).
      *
-     * A per-token aggregate (one entry per reward token, APRs summed) is planned
-     * alongside this as an additive field, fed by the same source Position.rewards
-     * uses — data-api's RewardsBL.getPoolAprsByToken, which is pool-keyed and needs
-     * no wallet. Reuse Position.rewards' per-token semantics for it rather than
-     * inventing a third granularity.
-     *
-     * @generated from field: repeated uniswap.liquidity.v2.RewardsCampaign rewards_campaigns = 25;
+     * @generated from field: repeated uniswap.liquidity.v2.RewardsCampaign rewards_campaigns = 25 [deprecated = true];
+     * @deprecated
      */
     rewardsCampaigns: RewardsCampaign[];
     /**
@@ -817,6 +813,29 @@ export declare class PoolSummary extends Message<PoolSummary> {
      * @generated from field: optional double volume_usd_1d_change = 27;
      */
     volumeUsd1dChange?: number;
+    /**
+     * Live LP-incentive rewards, grouped by the token they pay (see
+     * PoolTokenRewards). Sourced from data-api, which owns campaign scoping, so this
+     * agrees with the boost Position.rewards reports for the same pool.
+     *
+     * Empty for V2 (no campaigns), when the pool has no live campaign, and when the
+     * lookup degrades — rewards never fail a pool read.
+     *
+     * @generated from field: repeated uniswap.liquidity.v2.PoolTokenRewards token_rewards = 28;
+     */
+    tokenRewards: PoolTokenRewards[];
+    /**
+     * What an LP earns on this pool all-in: the fee APR above plus every reward
+     * token's boost — `apr` + the sum of token_rewards[].boosted_apr. Percent.
+     *
+     * A missing side counts as 0, so a pool with no live campaign reports its fee
+     * APR alone. Unset only when neither side is known: no `apr` and no
+     * token_rewards. A boost that sums to 0 with token_rewards present is a known
+     * zero, not missing.
+     *
+     * @generated from field: optional double total_apr = 29;
+     */
+    totalApr?: number;
     constructor(data?: PartialMessage<PoolSummary>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "uniswap.liquidity.v2.PoolSummary";
@@ -924,6 +943,97 @@ export declare class RewardsCampaign extends Message<RewardsCampaign> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RewardsCampaign;
     static equals(a: RewardsCampaign | PlainMessage<RewardsCampaign> | undefined, b: RewardsCampaign | PlainMessage<RewardsCampaign> | undefined): boolean;
 }
+/**
+ * One live campaign behind a pool's per-token boost. It carries no reward token —
+ * campaigns are always grouped under one (see PoolTokenRewards).
+ *
+ * @generated from message uniswap.liquidity.v2.PoolCampaign
+ */
+export declare class PoolCampaign extends Message<PoolCampaign> {
+    /**
+     * Merkl campaign id.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * This campaign's APR alone, in percent. Already included in the parent's
+     * boosted_apr — don't sum these and add them to it.
+     *
+     * @generated from field: double apr = 2;
+     */
+    apr: number;
+    /**
+     * Campaign window, unix seconds.
+     *
+     * @generated from field: int64 start_timestamp = 3;
+     */
+    startTimestamp: bigint;
+    /**
+     * @generated from field: int64 end_timestamp = 4;
+     */
+    endTimestamp: bigint;
+    /**
+     * Total allocation, uint256 decimal string in the reward token's smallest unit.
+     *
+     * @generated from field: string total_reward_allocation = 5;
+     */
+    totalRewardAllocation: string;
+    /**
+     * Emission rate in USD. Derived upstream from the reward token's price at fetch
+     * time, so it drifts with price; daily_rewards below is price-independent.
+     *
+     * @generated from field: optional double daily_rewards_usd = 6;
+     */
+    dailyRewardsUsd?: number;
+    /**
+     * Emission rate in the reward token's smallest unit (uint256 decimal string).
+     *
+     * @generated from field: optional string daily_rewards = 7;
+     */
+    dailyRewards?: string;
+    constructor(data?: PartialMessage<PoolCampaign>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolCampaign";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolCampaign;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolCampaign;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolCampaign;
+    static equals(a: PoolCampaign | PlainMessage<PoolCampaign> | undefined, b: PoolCampaign | PlainMessage<PoolCampaign> | undefined): boolean;
+}
+/**
+ * A pool's live rewards in one reward token: the summed boost plus the campaigns
+ * it came from. A pool running concurrent campaigns in different tokens yields one
+ * entry per token.
+ *
+ * @generated from message uniswap.liquidity.v2.PoolTokenRewards
+ */
+export declare class PoolTokenRewards extends Message<PoolTokenRewards> {
+    /**
+     * @generated from field: uniswap.liquidity.v2.RewardToken token = 1;
+     */
+    token?: RewardToken;
+    /**
+     * Sum of this token's live campaign APRs on the pool, in percent, on top of the
+     * pool's fee APR (PoolSummary.apr). Same number Position.rewards reports as
+     * boosted_pool_apr for this pool and token.
+     *
+     * @generated from field: double boosted_apr = 2;
+     */
+    boostedApr: number;
+    /**
+     * @generated from field: repeated uniswap.liquidity.v2.PoolCampaign campaigns = 3;
+     */
+    campaigns: PoolCampaign[];
+    constructor(data?: PartialMessage<PoolTokenRewards>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolTokenRewards";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolTokenRewards;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolTokenRewards;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolTokenRewards;
+    static equals(a: PoolTokenRewards | PlainMessage<PoolTokenRewards> | undefined, b: PoolTokenRewards | PlainMessage<PoolTokenRewards> | undefined): boolean;
+}
 /**
  * What a position earns in one LP-incentive reward token: the pool's boosted APR
  * and the position's unclaimed balance. One entry per token, since a pool can run
@@ -948,10 +1058,9 @@ export declare class PositionReward extends Message<PositionReward> {
      * token's live campaign APRs, in percent, on top of the pool's fee APR. Shared
      * by every position in the pool, not specific to this one. 0 = no live campaign.
      *
-     * The same number a pool-level per-token APR on PoolSummary will report for
-     * this (pool, token) — see the note on PoolSummary.rewards_campaigns. Distinct
-     * from RewardsCampaign.boosted_apr, which is ONE campaign's APR; this sums
-     * every live campaign paying this token, so don't add the two together.
+     * The same number PoolSummary.token_rewards reports as boosted_apr for this
+     * (pool, token). Distinct from PoolCampaign.apr, which is ONE campaign's APR;
+     * this sums every live campaign paying the token, so don't add the two.
      *
      * @generated from field: double boosted_pool_apr = 2;
      */
@@ -1389,12 +1498,28 @@ export declare class Position extends Message<Position> {
      * reports for the same wallet.
      *
      * Empty for V2 (no campaigns), and empty when the lookup degrades — rewards
-     * never fail a positions read. Populated by GetWalletPositions; GetPosition
-     * leaves it empty for now.
+     * never fail a positions read. Populated by both GetWalletPositions and
+     * GetPosition.
      *
      * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
      */
     rewards: PositionReward[];
+    /**
+     * What this position earns all-in: the pool's 24h fee APR plus every reward
+     * token's boost — `apr_1d` + the sum of rewards[].boosted_pool_apr. Percent.
+     *
+     * apr_1d is the window used because it's the one data-api's own total_apr sums
+     * (the pool_stats `apr` column); clients showing the 7d/30d window should add
+     * the boost to that window themselves.
+     *
+     * A missing side counts as 0, so an uncampaigned position reports its fee APR
+     * alone and a position whose pool stats haven't published reports its boost
+     * alone. Unset only when neither side is known: no apr_1d and no rewards. A
+     * boost that sums to 0 with rewards present is a known zero, not missing.
+     *
+     * @generated from field: optional double total_apr = 39;
+     */
+    totalApr?: number;
     constructor(data?: PartialMessage<Position>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "uniswap.liquidity.v2.Position";

package/dist/uniswap/liquidity/v2/types_pb.js

@@ -968,20 +968,27 @@ export class PoolSummary extends Message {
          */
         this.volumeUsd1d = 0;
         /**
-         * Live Merkl LP-incentive campaigns for this pool (V3/V4). Composed at read
-         * time from Merkl (not Aurora); empty when the pool has no live allowlisted
-         * campaign or the lookup degrades. One entry per campaign — not aggregated,
-         * so two concurrent UNI campaigns are two entries.
+         * DEPRECATED — superseded by token_rewards below, which groups campaigns under
+         * the token they pay and carries that token's summed boost. This field has never
+         * been populated and stays permanently empty; it exists only so consumers that
+         * already read it keep compiling. Removal is tracked in LP-1585 (reserve tag 25
+         * when it goes — a reused tag with a different type is wire-incompatible).
          *
-         * A per-token aggregate (one entry per reward token, APRs summed) is planned
-         * alongside this as an additive field, fed by the same source Position.rewards
-         * uses — data-api's RewardsBL.getPoolAprsByToken, which is pool-keyed and needs
-         * no wallet. Reuse Position.rewards' per-token semantics for it rather than
-         * inventing a third granularity.
-         *
-         * @generated from field: repeated uniswap.liquidity.v2.RewardsCampaign rewards_campaigns = 25;
+         * @generated from field: repeated uniswap.liquidity.v2.RewardsCampaign rewards_campaigns = 25 [deprecated = true];
+         * @deprecated
          */
         this.rewardsCampaigns = [];
+        /**
+         * Live LP-incentive rewards, grouped by the token they pay (see
+         * PoolTokenRewards). Sourced from data-api, which owns campaign scoping, so this
+         * agrees with the boost Position.rewards reports for the same pool.
+         *
+         * Empty for V2 (no campaigns), when the pool has no live campaign, and when the
+         * lookup degrades — rewards never fail a pool read.
+         *
+         * @generated from field: repeated uniswap.liquidity.v2.PoolTokenRewards token_rewards = 28;
+         */
+        this.tokenRewards = [];
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -1027,6 +1034,8 @@ PoolSummary.fields = proto3.util.newFieldList(() => [
     { no: 25, name: "rewards_campaigns", kind: "message", T: RewardsCampaign, repeated: true },
     { no: 26, name: "tvl_usd_change_1d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
     { no: 27, name: "volume_usd_1d_change", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 28, name: "token_rewards", kind: "message", T: PoolTokenRewards, repeated: true },
+    { no: 29, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
 ]);
 /**
  * A reward token's on-chain identity, so a client can interpret and format a
@@ -1145,6 +1154,114 @@ RewardsCampaign.fields = proto3.util.newFieldList(() => [
     { no: 6, name: "distributed_rewards", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 7, name: "reward_token", kind: "message", T: RewardToken },
 ]);
+/**
+ * One live campaign behind a pool's per-token boost. It carries no reward token —
+ * campaigns are always grouped under one (see PoolTokenRewards).
+ *
+ * @generated from message uniswap.liquidity.v2.PoolCampaign
+ */
+export class PoolCampaign extends Message {
+    constructor(data) {
+        super();
+        /**
+         * Merkl campaign id.
+         *
+         * @generated from field: string id = 1;
+         */
+        this.id = "";
+        /**
+         * This campaign's APR alone, in percent. Already included in the parent's
+         * boosted_apr — don't sum these and add them to it.
+         *
+         * @generated from field: double apr = 2;
+         */
+        this.apr = 0;
+        /**
+         * Campaign window, unix seconds.
+         *
+         * @generated from field: int64 start_timestamp = 3;
+         */
+        this.startTimestamp = protoInt64.zero;
+        /**
+         * @generated from field: int64 end_timestamp = 4;
+         */
+        this.endTimestamp = protoInt64.zero;
+        /**
+         * Total allocation, uint256 decimal string in the reward token's smallest unit.
+         *
+         * @generated from field: string total_reward_allocation = 5;
+         */
+        this.totalRewardAllocation = "";
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolCampaign().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolCampaign().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolCampaign().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolCampaign, a, b);
+    }
+}
+PoolCampaign.runtime = proto3;
+PoolCampaign.typeName = "uniswap.liquidity.v2.PoolCampaign";
+PoolCampaign.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+    { no: 3, name: "start_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 4, name: "end_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 5, name: "total_reward_allocation", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 6, name: "daily_rewards_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 7, name: "daily_rewards", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+]);
+/**
+ * A pool's live rewards in one reward token: the summed boost plus the campaigns
+ * it came from. A pool running concurrent campaigns in different tokens yields one
+ * entry per token.
+ *
+ * @generated from message uniswap.liquidity.v2.PoolTokenRewards
+ */
+export class PoolTokenRewards extends Message {
+    constructor(data) {
+        super();
+        /**
+         * Sum of this token's live campaign APRs on the pool, in percent, on top of the
+         * pool's fee APR (PoolSummary.apr). Same number Position.rewards reports as
+         * boosted_pool_apr for this pool and token.
+         *
+         * @generated from field: double boosted_apr = 2;
+         */
+        this.boostedApr = 0;
+        /**
+         * @generated from field: repeated uniswap.liquidity.v2.PoolCampaign campaigns = 3;
+         */
+        this.campaigns = [];
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolTokenRewards().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolTokenRewards().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolTokenRewards().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolTokenRewards, a, b);
+    }
+}
+PoolTokenRewards.runtime = proto3;
+PoolTokenRewards.typeName = "uniswap.liquidity.v2.PoolTokenRewards";
+PoolTokenRewards.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "token", kind: "message", T: RewardToken },
+    { no: 2, name: "boosted_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+    { no: 3, name: "campaigns", kind: "message", T: PoolCampaign, repeated: true },
+]);
 /**
  * What a position earns in one LP-incentive reward token: the pool's boosted APR
  * and the position's unclaimed balance. One entry per token, since a pool can run
@@ -1164,10 +1281,9 @@ export class PositionReward extends Message {
          * token's live campaign APRs, in percent, on top of the pool's fee APR. Shared
          * by every position in the pool, not specific to this one. 0 = no live campaign.
          *
-         * The same number a pool-level per-token APR on PoolSummary will report for
-         * this (pool, token) — see the note on PoolSummary.rewards_campaigns. Distinct
-         * from RewardsCampaign.boosted_apr, which is ONE campaign's APR; this sums
-         * every live campaign paying this token, so don't add the two together.
+         * The same number PoolSummary.token_rewards reports as boosted_apr for this
+         * (pool, token). Distinct from PoolCampaign.apr, which is ONE campaign's APR;
+         * this sums every live campaign paying the token, so don't add the two.
          *
          * @generated from field: double boosted_pool_apr = 2;
          */
@@ -1530,8 +1646,8 @@ export class Position extends Message {
          * reports for the same wallet.
          *
          * Empty for V2 (no campaigns), and empty when the lookup degrades — rewards
-         * never fail a positions read. Populated by GetWalletPositions; GetPosition
-         * leaves it empty for now.
+         * never fail a positions read. Populated by both GetWalletPositions and
+         * GetPosition.
          *
          * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
          */
@@ -1592,6 +1708,7 @@ Position.fields = proto3.util.newFieldList(() => [
     { no: 36, name: "reserve1", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 37, name: "total_supply", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 38, name: "rewards", kind: "message", T: PositionReward, repeated: true },
+    { no: 39, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
 ]);
 /**
  * Keyset cursor for GetWalletPositions. position_key is the last returned

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uniswap/client-liquidity",
-    "version": "1.4.28",
+    "version": "1.4.30",
     "publishConfig": {
       "access": "public"
     },