@uniswap/client-liquidity 1.4.1 → 1.4.3

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

@@ -43,6 +43,30 @@ export declare enum GasUrgency {
      */
     URGENT = 3
 }
+/**
+ * Pool protocol for read endpoints. Unlike v1.Protocols (V2=0), this follows
+ * the UNSPECIFIED-at-0 standard so an unset value can't silently mean V2.
+ *
+ * @generated from enum uniswap.liquidity.v2.PoolProtocol
+ */
+export declare enum PoolProtocol {
+    /**
+     * @generated from enum value: POOL_PROTOCOL_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: POOL_PROTOCOL_V2 = 1;
+     */
+    V2 = 1,
+    /**
+     * @generated from enum value: POOL_PROTOCOL_V3 = 2;
+     */
+    V3 = 2,
+    /**
+     * @generated from enum value: POOL_PROTOCOL_V4 = 3;
+     */
+    V4 = 3
+}
 /**
  * @generated from enum uniswap.liquidity.v2.PoolSortBy
  */
@@ -60,6 +84,67 @@ export declare enum PoolSortBy {
      */
     APR = 2
 }
+/**
+ * Chart time window. Mirrors data.v2's HistoryDuration (shared data.v2 protos
+ * are not importable from this package; duplication is the accepted approach
+ * until cross-service proto reuse lands post-stage-4).
+ *
+ * @generated from enum uniswap.liquidity.v2.HistoryDuration
+ */
+export declare enum HistoryDuration {
+    /**
+     * server defaults to DAY
+     *
+     * @generated from enum value: HISTORY_DURATION_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: HISTORY_DURATION_HOUR = 1;
+     */
+    HOUR = 1,
+    /**
+     * @generated from enum value: HISTORY_DURATION_DAY = 2;
+     */
+    DAY = 2,
+    /**
+     * @generated from enum value: HISTORY_DURATION_WEEK = 3;
+     */
+    WEEK = 3,
+    /**
+     * @generated from enum value: HISTORY_DURATION_MONTH = 4;
+     */
+    MONTH = 4,
+    /**
+     * @generated from enum value: HISTORY_DURATION_YEAR = 5;
+     */
+    YEAR = 5,
+    /**
+     * @generated from enum value: HISTORY_DURATION_MAX = 6;
+     */
+    MAX = 6
+}
+/**
+ * Open/closed state of an LP position. CLOSED = fully withdrawn (V3/V4
+ * liquidity or the V2 LP-token balance is zero) — the indexer keeps such rows
+ * as tombstones. In/out-of-range needs the pool's current tick and is left to
+ * read-time derivation.
+ *
+ * @generated from enum uniswap.liquidity.v2.PositionStatus
+ */
+export declare enum PositionStatus {
+    /**
+     * @generated from enum value: POSITION_STATUS_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: POSITION_STATUS_OPEN = 1;
+     */
+    OPEN = 1,
+    /**
+     * @generated from enum value: POSITION_STATUS_CLOSED = 2;
+     */
+    CLOSED = 2
+}
 /**
  * @generated from message uniswap.liquidity.v2.LPToken
  */
@@ -537,6 +622,22 @@ export declare class PoolSummary extends Message<PoolSummary> {
      * @generated from field: optional int32 tick_spacing = 16;
      */
     tickSpacing?: number;
+    /**
+     * V2 pools only: raw pair reserves and LP token total supply (uint256 as
+     * decimal strings), so clients can derive a wallet's underlying token
+     * amounts from its lp_shares. Unset for V3/V4.
+     *
+     * @generated from field: optional string reserve0 = 17;
+     */
+    reserve0?: string;
+    /**
+     * @generated from field: optional string reserve1 = 18;
+     */
+    reserve1?: string;
+    /**
+     * @generated from field: optional string total_supply = 19;
+     */
+    totalSupply?: string;
     constructor(data?: PartialMessage<PoolSummary>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "uniswap.liquidity.v2.PoolSummary";
@@ -571,3 +672,317 @@ export declare class PoolListCursor extends Message<PoolListCursor> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolListCursor;
     static equals(a: PoolListCursor | PlainMessage<PoolListCursor> | undefined, b: PoolListCursor | PlainMessage<PoolListCursor> | undefined): boolean;
 }
+/**
+ * Identifies one pool. address_or_id is the pair/pool address for V2/V3
+ * (0x + 40 hex chars) or the pool id for V4 (0x + 64 hex chars).
+ *
+ * @generated from message uniswap.liquidity.v2.PoolReference
+ */
+export declare class PoolReference extends Message<PoolReference> {
+    /**
+     * @generated from field: uniswap.liquidity.v1.ChainId chain_id = 1;
+     */
+    chainId: ChainId;
+    /**
+     * @generated from field: string address_or_id = 2;
+     */
+    addressOrId: string;
+    /**
+     * POOL_PROTOCOL_UNSPECIFIED rejected as invalid_argument
+     *
+     * @generated from field: uniswap.liquidity.v2.PoolProtocol version = 3;
+     */
+    version: PoolProtocol;
+    constructor(data?: PartialMessage<PoolReference>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolReference";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolReference;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolReference;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolReference;
+    static equals(a: PoolReference | PlainMessage<PoolReference> | undefined, b: PoolReference | PlainMessage<PoolReference> | undefined): boolean;
+}
+/**
+ * One point of a pool's relative-price history, in raw pool-token
+ * denomination (token1 per token0 and its inverse), not USD.
+ * TODO(CONS-2536): whether V2/V3 WETH legs should be presented as ETH (and
+ * stats combined with V4 native pools) is pending; prices stay in raw pool
+ * token terms until that lands.
+ *
+ * @generated from message uniswap.liquidity.v2.PoolPricePoint
+ */
+export declare class PoolPricePoint extends Message<PoolPricePoint> {
+    /**
+     * unix seconds, bucket start (inclusive)
+     *
+     * @generated from field: int64 timestamp = 1;
+     */
+    timestamp: bigint;
+    /**
+     * @generated from field: double price_token0_in_token1 = 2;
+     */
+    priceToken0InToken1: number;
+    /**
+     * @generated from field: double price_token1_in_token0 = 3;
+     */
+    priceToken1InToken0: number;
+    constructor(data?: PartialMessage<PoolPricePoint>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolPricePoint";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolPricePoint;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolPricePoint;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolPricePoint;
+    static equals(a: PoolPricePoint | PlainMessage<PoolPricePoint> | undefined, b: PoolPricePoint | PlainMessage<PoolPricePoint> | undefined): boolean;
+}
+/**
+ * One bucket of a pool's swap-volume history, USD-denominated.
+ *
+ * @generated from message uniswap.liquidity.v2.PoolVolumeBucket
+ */
+export declare class PoolVolumeBucket extends Message<PoolVolumeBucket> {
+    /**
+     * unix seconds, bucket start (inclusive)
+     *
+     * @generated from field: int64 timestamp = 1;
+     */
+    timestamp: bigint;
+    /**
+     * @generated from field: double volume_usd = 2;
+     */
+    volumeUsd: number;
+    /**
+     * @generated from field: double fee_usd = 3;
+     */
+    feeUsd: number;
+    constructor(data?: PartialMessage<PoolVolumeBucket>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolVolumeBucket";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolVolumeBucket;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolVolumeBucket;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolVolumeBucket;
+    static equals(a: PoolVolumeBucket | PlainMessage<PoolVolumeBucket> | undefined, b: PoolVolumeBucket | PlainMessage<PoolVolumeBucket> | undefined): boolean;
+}
+/**
+ * One LP position, as indexed from chain events (raw position state).
+ * Token amounts, uncollected fees, in-range and USD valuation land with the
+ * positions pricing pipeline (data-ingestion position math) as additive
+ * optional fields.
+ * TODO(CONS-2536): position balances are returned untranslated (V2/V3 pools
+ * report WETH as its own ERC-20); whether to present WETH legs as ETH is an
+ * open LP/CE decision.
+ *
+ * @generated from message uniswap.liquidity.v2.Position
+ */
+export declare class Position extends Message<Position> {
+    /**
+     * @generated from field: uniswap.liquidity.v1.Protocols version = 1;
+     */
+    version: Protocols;
+    /**
+     * @generated from field: int32 chain_id = 2;
+     */
+    chainId: number;
+    /**
+     * @generated from field: string owner = 3;
+     */
+    owner: string;
+    /**
+     * V3/V4 position NFT token id; unset for V2 (pair-share positions).
+     *
+     * @generated from field: optional string token_id = 4;
+     */
+    tokenId?: string;
+    /**
+     * V2/V3: pair/pool address. V4: pool id (0x + 64 hex).
+     *
+     * @generated from field: string pool_address_or_id = 5;
+     */
+    poolAddressOrId: string;
+    /**
+     * Fee in pips; unset for V2 (fixed 0.3%).
+     *
+     * @generated from field: optional int32 fee_tier = 6;
+     */
+    feeTier?: number;
+    /**
+     * @generated from field: optional sint32 tick_lower = 7;
+     */
+    tickLower?: number;
+    /**
+     * @generated from field: optional sint32 tick_upper = 8;
+     */
+    tickUpper?: number;
+    /**
+     * V3/V4 raw position liquidity (uint128 as decimal string).
+     *
+     * @generated from field: optional string liquidity = 9;
+     */
+    liquidity?: string;
+    /**
+     * V2 LP-token balance (raw, decimal string).
+     *
+     * @generated from field: optional string lp_shares = 10;
+     */
+    lpShares?: string;
+    /**
+     * V4 only: the PositionManager the token id belongs to.
+     *
+     * @generated from field: optional string position_manager_address = 11;
+     */
+    positionManagerAddress?: string;
+    /**
+     * Unix seconds of the last indexed event applied to this position.
+     *
+     * @generated from field: int64 updated_at = 12;
+     */
+    updatedAt: bigint;
+    /**
+     * Unix seconds of the first indexed event that created this position.
+     *
+     * @generated from field: int64 created_at = 13;
+     */
+    createdAt: bigint;
+    /**
+     * Derived from the raw balance: OPEN while liquidity / lp_shares > 0.
+     *
+     * @generated from field: uniswap.liquidity.v2.PositionStatus status = 14;
+     */
+    status: PositionStatus;
+    /**
+     * Pool token identity, joined from pool metadata (no valuation). Mirrors the
+     * PoolSummary token fields. Raw pool tokens (WETH stays WETH); ETH-display
+     * translation is a separate presentation decision. Unset when the position's
+     * pool metadata could not be resolved.
+     *
+     * @generated from field: optional string token0_address = 15;
+     */
+    token0Address?: string;
+    /**
+     * @generated from field: optional string token1_address = 16;
+     */
+    token1Address?: string;
+    /**
+     * @generated from field: optional uniswap.liquidity.v2.TokenMetadata token0_metadata = 17;
+     */
+    token0Metadata?: TokenMetadata;
+    /**
+     * @generated from field: optional uniswap.liquidity.v2.TokenMetadata token1_metadata = 18;
+     */
+    token1Metadata?: TokenMetadata;
+    /**
+     * V4 pool hooks contract; unset for V2/V3.
+     *
+     * @generated from field: optional string hook_address = 19;
+     */
+    hookAddress?: string;
+    /**
+     * @generated from field: optional int32 tick_spacing = 20;
+     */
+    tickSpacing?: number;
+    /**
+     * Current pool state (no USD valuation), so clients can derive the position's
+     * price range, in/out-of-range, and current price. V3/V4 only; unset for V2
+     * and when the pool has no current-state row.
+     *
+     * @generated from field: optional sint32 current_tick = 21;
+     */
+    currentTick?: number;
+    /**
+     * @generated from field: optional string sqrt_price_x96 = 22;
+     */
+    sqrtPriceX96?: string;
+    /**
+     * @generated from field: optional string pool_liquidity = 23;
+     */
+    poolLiquidity?: string;
+    /**
+     * Latest USD price per token (raw pool tokens; no position valuation computed
+     * server-side). Clients derive the position's USD value from these + the
+     * token amounts. Unset when no price row exists for the token.
+     *
+     * @generated from field: optional string token0_price_usd = 24;
+     */
+    token0PriceUsd?: string;
+    /**
+     * @generated from field: optional string token1_price_usd = 25;
+     */
+    token1PriceUsd?: string;
+    constructor(data?: PartialMessage<Position>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.Position";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Position;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Position;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Position;
+    static equals(a: Position | PlainMessage<Position> | undefined, b: Position | PlainMessage<Position> | undefined): boolean;
+}
+/**
+ * Keyset cursor for GetWalletPositions. position_key is the last returned
+ * position's key within (chain_id, version): V2 pair address, V3 token id,
+ * V4 "<position_manager>:<token_id>".
+ *
+ * @generated from message uniswap.liquidity.v2.PositionListCursor
+ */
+export declare class PositionListCursor extends Message<PositionListCursor> {
+    /**
+     * @generated from field: int32 chain_id = 1;
+     */
+    chainId: number;
+    /**
+     * @generated from field: uniswap.liquidity.v1.Protocols version = 2;
+     */
+    version: Protocols;
+    /**
+     * @generated from field: string position_key = 3;
+     */
+    positionKey: string;
+    constructor(data?: PartialMessage<PositionListCursor>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PositionListCursor";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PositionListCursor;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PositionListCursor;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PositionListCursor;
+    static equals(a: PositionListCursor | PlainMessage<PositionListCursor> | undefined, b: PositionListCursor | PlainMessage<PositionListCursor> | undefined): boolean;
+}
+/**
+ * One initialized tick of a V3/V4 pool's liquidity distribution.
+ * liquidity_gross/net are raw uint128-scale values serialized as decimal
+ * strings (they overflow doubles).
+ *
+ * @generated from message uniswap.liquidity.v2.PoolTick
+ */
+export declare class PoolTick extends Message<PoolTick> {
+    /**
+     * @generated from field: int32 tick_idx = 1;
+     */
+    tickIdx: number;
+    /**
+     * @generated from field: string liquidity_gross = 2;
+     */
+    liquidityGross: string;
+    /**
+     * @generated from field: string liquidity_net = 3;
+     */
+    liquidityNet: string;
+    /**
+     * Price of token0 in token1 at this tick (1.0001^tick_idx) and its inverse.
+     *
+     * @generated from field: double price_token0_in_token1 = 4;
+     */
+    priceToken0InToken1: number;
+    /**
+     * @generated from field: double price_token1_in_token0 = 5;
+     */
+    priceToken1InToken0: number;
+    constructor(data?: PartialMessage<PoolTick>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "uniswap.liquidity.v2.PoolTick";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolTick;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolTick;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolTick;
+    static equals(a: PoolTick | PlainMessage<PoolTick> | undefined, b: PoolTick | PlainMessage<PoolTick> | undefined): boolean;
+}