@uniswap/client-liquidity 1.4.25 → 1.4.28

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

@@ -791,7 +791,14 @@ export declare class PoolSummary extends Message<PoolSummary> {
     /**
      * 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.
+     * campaign or the lookup degrades. One entry per campaign — not aggregated,
+     * so two concurrent UNI campaigns are two entries.
+     *
+     * 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;
      */
@@ -917,6 +924,61 @@ 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;
 }
+/**
+ * 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
+ * concurrent campaigns paying different tokens.
+ *
+ * Either half can stand alone. An ended campaign leaves a claimable balance with
+ * no boost (apr 0), and a live campaign can have a boost with nothing accrued —
+ * or, on V3, no per-position attribution at all.
+ *
+ * @generated from message uniswap.liquidity.v2.PositionReward
+ */
+export declare class PositionReward extends Message<PositionReward> {
+    /**
+     * The token both values below refer to, on its own distribution chain (which
+     * can differ from the position's chain).
+     *
+     * @generated from field: uniswap.liquidity.v2.RewardToken token = 1;
+     */
+    token?: RewardToken;
+    /**
+     * The POOL's boosted APR from campaigns paying this token — the sum of that
+     * 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.
+     *
+     * @generated from field: double boosted_pool_apr = 2;
+     */
+    boostedPoolApr: number;
+    /**
+     * Unclaimed amount in token's smallest unit (uint256 decimal string). Unset
+     * when there is no per-position attribution upstream (V3) — distinct from a
+     * known zero.
+     *
+     * @generated from field: optional string unclaimed_amount = 3;
+     */
+    unclaimedAmount?: string;
+    /**
+     * Unclaimed amount in USD. Unset when the token could not be priced.
+     *
+     * @generated from field: optional double unclaimed_amount_usd = 4;
+     */
+    unclaimedAmountUsd?: number;
+    constructor(data?: PartialMessage<PositionReward>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PositionReward";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PositionReward;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PositionReward;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PositionReward;
+    static equals(a: PositionReward | PlainMessage<PositionReward> | undefined, b: PositionReward | PlainMessage<PositionReward> | undefined): boolean;
+}
 /**
  * @generated from message uniswap.liquidity.v2.PoolListCursor
  */
@@ -1267,6 +1329,72 @@ export declare class Position extends Message<Position> {
      * @generated from field: optional string token1_price_usd = 25;
      */
     token1PriceUsd?: string;
+    /**
+     * @generated from field: optional string amount0 = 26;
+     */
+    amount0?: string;
+    /**
+     * @generated from field: optional string amount1 = 27;
+     */
+    amount1?: string;
+    /**
+     * @generated from field: optional double value_usd = 28;
+     */
+    valueUsd?: number;
+    /**
+     * @generated from field: optional string token0_uncollected_fees = 29;
+     */
+    token0UncollectedFees?: string;
+    /**
+     * @generated from field: optional string token1_uncollected_fees = 30;
+     */
+    token1UncollectedFees?: string;
+    /**
+     * @generated from field: optional double uncollected_fees_usd = 31;
+     */
+    uncollectedFeesUsd?: number;
+    /**
+     * @generated from field: optional double apr_1d = 32;
+     */
+    apr1d?: number;
+    /**
+     * @generated from field: optional double apr_7d = 33;
+     */
+    apr7d?: number;
+    /**
+     * @generated from field: optional double apr_30d = 34;
+     */
+    apr30d?: number;
+    /**
+     * V2 only: raw pair reserves and LP token total supply (uint256 as decimal
+     * strings), so clients can derive the wallet's underlying token amounts (and
+     * USD value) from lp_shares. Unset for V3/V4, which derive amounts from
+     * liquidity + tick range + current_tick/sqrt_price_x96 instead.
+     *
+     * @generated from field: optional string reserve0 = 35;
+     */
+    reserve0?: string;
+    /**
+     * @generated from field: optional string reserve1 = 36;
+     */
+    reserve1?: string;
+    /**
+     * @generated from field: optional string total_supply = 37;
+     */
+    totalSupply?: string;
+    /**
+     * LP-incentive rewards for this position, one entry per reward token (see
+     * PositionReward). Sourced from data-api, which owns campaign scoping and the
+     * reward-token/creator allowlists, so these agree with what its GetRewards
+     * 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.
+     *
+     * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
+     */
+    rewards: PositionReward[];
     constructor(data?: PartialMessage<Position>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "uniswap.liquidity.v2.Position";

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

@@ -970,7 +970,14 @@ export class PoolSummary extends Message {
         /**
          * 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.
+         * campaign or the lookup degrades. One entry per campaign — not aggregated,
+         * so two concurrent UNI campaigns are two entries.
+         *
+         * 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;
          */
@@ -1138,6 +1145,56 @@ 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 },
 ]);
+/**
+ * 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
+ * concurrent campaigns paying different tokens.
+ *
+ * Either half can stand alone. An ended campaign leaves a claimable balance with
+ * no boost (apr 0), and a live campaign can have a boost with nothing accrued —
+ * or, on V3, no per-position attribution at all.
+ *
+ * @generated from message uniswap.liquidity.v2.PositionReward
+ */
+export class PositionReward extends Message {
+    constructor(data) {
+        super();
+        /**
+         * The POOL's boosted APR from campaigns paying this token — the sum of that
+         * 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.
+         *
+         * @generated from field: double boosted_pool_apr = 2;
+         */
+        this.boostedPoolApr = 0;
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PositionReward().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PositionReward().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PositionReward().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PositionReward, a, b);
+    }
+}
+PositionReward.runtime = proto3;
+PositionReward.typeName = "uniswap.liquidity.v2.PositionReward";
+PositionReward.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "token", kind: "message", T: RewardToken },
+    { no: 2, name: "boosted_pool_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+    { no: 3, name: "unclaimed_amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 4, name: "unclaimed_amount_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+]);
 /**
  * @generated from message uniswap.liquidity.v2.PoolListCursor
  */
@@ -1466,6 +1523,19 @@ export class Position extends Message {
          * @generated from field: uniswap.liquidity.v2.PositionStatus status = 14;
          */
         this.status = PositionStatus.UNSPECIFIED;
+        /**
+         * LP-incentive rewards for this position, one entry per reward token (see
+         * PositionReward). Sourced from data-api, which owns campaign scoping and the
+         * reward-token/creator allowlists, so these agree with what its GetRewards
+         * 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.
+         *
+         * @generated from field: repeated uniswap.liquidity.v2.PositionReward rewards = 38;
+         */
+        this.rewards = [];
         proto3.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -1509,6 +1579,19 @@ Position.fields = proto3.util.newFieldList(() => [
     { no: 23, name: "pool_liquidity", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 24, name: "token0_price_usd", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 25, name: "token1_price_usd", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 26, name: "amount0", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 27, name: "amount1", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 28, name: "value_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 29, name: "token0_uncollected_fees", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 30, name: "token1_uncollected_fees", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 31, name: "uncollected_fees_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 32, name: "apr_1d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 33, name: "apr_7d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 34, name: "apr_30d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 35, name: "reserve0", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { 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 },
 ]);
 /**
  * Keyset cursor for GetWalletPositions. position_key is the last returned

package/package.json

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