@uniswap/client-data-api 0.0.136 → 0.0.138

package/dist/data/v2/types_pb.d.ts

@@ -1,6 +1,7 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
 import { TimestampedValue, TokenType } from "../v1/types_pb.js";
+import { ProtocolVersion } from "../v1/poolTypes_pb.js";
 /**
  * @generated from enum data.v2.TokensOrderBy
  */
@@ -204,6 +205,87 @@ export declare enum HistoryDuration {
      */
     MAX = 6
 }
+/**
+ * @generated from enum data.v2.PoolsOrderBy
+ */
+export declare enum PoolsOrderBy {
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * default
+     *
+     * @generated from enum value: POOLS_ORDER_BY_TVL = 1;
+     */
+    TVL = 1,
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_1D = 2;
+     */
+    VOLUME_1D = 2,
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_30D = 3;
+     */
+    VOLUME_30D = 3,
+    /**
+     * fee revenue / TVL; excludes reward_apr
+     *
+     * @generated from enum value: POOLS_ORDER_BY_APR = 4;
+     */
+    APR = 4,
+    /**
+     * volume_1d / tvl; capital-efficiency proxy
+     *
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_1D_TVL_RATIO = 5;
+     */
+    VOLUME_1D_TVL_RATIO = 5
+}
+/**
+ * @generated from enum data.v2.PoolTokenLogicalOperator
+ */
+export declare enum PoolTokenLogicalOperator {
+    /**
+     * treated as OR
+     *
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_OR = 1;
+     */
+    OR = 1,
+    /**
+     * invalid with more than 2 tokens
+     *
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_AND = 2;
+     */
+    AND = 2
+}
+/**
+ * @generated from enum data.v2.TransactionEventType
+ */
+export declare enum TransactionEventType {
+    /**
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_SWAP = 1;
+     */
+    SWAP = 1,
+    /**
+     * mint / positive modify_liquidity
+     *
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_ADD = 2;
+     */
+    ADD = 2,
+    /**
+     * burn / negative modify_liquidity
+     *
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_REMOVE = 3;
+     */
+    REMOVE = 3
+}
 /**
  * Sort field for ListLaunches; UNSPECIFIED defaults to LAUNCHED_AT (newest first).
  *
@@ -719,6 +801,369 @@ export declare class MultichainToken extends Message<MultichainToken> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MultichainToken;
     static equals(a: MultichainToken | PlainMessage<MultichainToken> | undefined, b: MultichainToken | PlainMessage<MultichainToken> | undefined): boolean;
 }
+/**
+ * @generated from message data.v2.PoolsSort
+ */
+export declare class PoolsSort extends Message<PoolsSort> {
+    /**
+     * default: POOLS_ORDER_BY_TVL
+     *
+     * @generated from field: optional data.v2.PoolsOrderBy order_by = 1;
+     */
+    orderBy?: PoolsOrderBy;
+    /**
+     * default false (highest first)
+     *
+     * @generated from field: optional bool ascending = 2;
+     */
+    ascending?: boolean;
+    constructor(data?: PartialMessage<PoolsSort>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolsSort";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolsSort;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolsSort;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolsSort;
+    static equals(a: PoolsSort | PlainMessage<PoolsSort> | undefined, b: PoolsSort | PlainMessage<PoolsSort> | undefined): boolean;
+}
+/**
+ * Ranking stats for a pool.
+ * apr = annualised fee revenue / TVL.
+ * reward_apr = Merkl incentive yield (not a valid sort key).
+ * total_apr = apr + reward_apr treating null as 0; only null if both are null.
+ *
+ * @generated from message data.v2.PoolRankStats
+ */
+export declare class PoolRankStats extends Message<PoolRankStats> {
+    /**
+     * @generated from field: optional double tvl = 1;
+     */
+    tvl?: number;
+    /**
+     * @generated from field: optional double volume_1d = 2;
+     */
+    volume1d?: number;
+    /**
+     * @generated from field: optional double volume_30d = 3;
+     */
+    volume30d?: number;
+    /**
+     * @generated from field: optional double apr = 4;
+     */
+    apr?: number;
+    /**
+     * @generated from field: optional double reward_apr = 5;
+     */
+    rewardApr?: number;
+    /**
+     * @generated from field: optional double total_apr = 6;
+     */
+    totalApr?: number;
+    /**
+     * volume_1d / tvl; null if tvl is zero
+     *
+     * @generated from field: optional double volume_1d_tvl_ratio = 7;
+     */
+    volume1dTvlRatio?: number;
+    constructor(data?: PartialMessage<PoolRankStats>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolRankStats";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolRankStats;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolRankStats;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolRankStats;
+    static equals(a: PoolRankStats | PlainMessage<PoolRankStats> | undefined, b: PoolRankStats | PlainMessage<PoolRankStats> | undefined): boolean;
+}
+/**
+ * A pool with its protocol identity and token pair. No stats — stats live on
+ * RankedPool.
+ *
+ * @generated from message data.v2.Pool
+ */
+export declare class Pool extends Message<Pool> {
+    /**
+     * @generated from field: uint32 chain_id = 1;
+     */
+    chainId: number;
+    /**
+     * checksummed pool address (V4: pool id hash)
+     *
+     * @generated from field: string pool_id = 2;
+     */
+    poolId: string;
+    /**
+     * @generated from field: data.v2.Token token0 = 3;
+     */
+    token0?: Token;
+    /**
+     * @generated from field: data.v2.Token token1 = 4;
+     */
+    token1?: Token;
+    /**
+     * @generated from field: pools.v1.ProtocolVersion protocol_version = 5;
+     */
+    protocolVersion: ProtocolVersion;
+    /**
+     * @generated from field: optional int32 tick_spacing = 6;
+     */
+    tickSpacing?: number;
+    /**
+     * pips; absent for V2 (fixed 0.3%) and dynamic-fee pools
+     *
+     * @generated from field: optional uint32 fee_tier = 7;
+     */
+    feeTier?: number;
+    /**
+     * true for V4 pools with dynamic fees
+     *
+     * @generated from field: bool is_dynamic_fee = 8;
+     */
+    isDynamicFee: boolean;
+    /**
+     * V4 only
+     *
+     * @generated from field: optional string hook_address = 9;
+     */
+    hookAddress?: string;
+    constructor(data?: PartialMessage<Pool>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.Pool";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Pool;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Pool;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Pool;
+    static equals(a: Pool | PlainMessage<Pool> | undefined, b: Pool | PlainMessage<Pool> | undefined): boolean;
+}
+/**
+ * @generated from message data.v2.PoolTokenFilter
+ */
+export declare class PoolTokenFilter extends Message<PoolTokenFilter> {
+    /**
+     * checksummed EVM addresses
+     *
+     * @generated from field: repeated string tokens = 1;
+     */
+    tokens: string[];
+    /**
+     * @generated from field: data.v2.PoolTokenLogicalOperator logical_operator = 2;
+     */
+    logicalOperator: PoolTokenLogicalOperator;
+    constructor(data?: PartialMessage<PoolTokenFilter>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolTokenFilter";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolTokenFilter;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolTokenFilter;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolTokenFilter;
+    static equals(a: PoolTokenFilter | PlainMessage<PoolTokenFilter> | undefined, b: PoolTokenFilter | PlainMessage<PoolTokenFilter> | undefined): boolean;
+}
+/**
+ * @generated from message data.v2.PoolStatRangeFilter
+ */
+export declare class PoolStatRangeFilter extends Message<PoolStatRangeFilter> {
+    /**
+     * @generated from field: optional double min = 1;
+     */
+    min?: number;
+    /**
+     * @generated from field: optional double max = 2;
+     */
+    max?: number;
+    constructor(data?: PartialMessage<PoolStatRangeFilter>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolStatRangeFilter";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolStatRangeFilter;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolStatRangeFilter;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolStatRangeFilter;
+    static equals(a: PoolStatRangeFilter | PlainMessage<PoolStatRangeFilter> | undefined, b: PoolStatRangeFilter | PlainMessage<PoolStatRangeFilter> | undefined): boolean;
+}
+/**
+ * @generated from message data.v2.PoolStatsFilter
+ */
+export declare class PoolStatsFilter extends Message<PoolStatsFilter> {
+    /**
+     * @generated from field: optional data.v2.PoolStatRangeFilter tvl = 1;
+     */
+    tvl?: PoolStatRangeFilter;
+    /**
+     * @generated from field: optional data.v2.PoolStatRangeFilter apr = 2;
+     */
+    apr?: PoolStatRangeFilter;
+    /**
+     * @generated from field: optional data.v2.PoolStatRangeFilter volume_1d = 3;
+     */
+    volume1d?: PoolStatRangeFilter;
+    /**
+     * @generated from field: optional data.v2.PoolStatRangeFilter volume_30d = 4;
+     */
+    volume30d?: PoolStatRangeFilter;
+    constructor(data?: PartialMessage<PoolStatsFilter>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolStatsFilter";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolStatsFilter;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolStatsFilter;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolStatsFilter;
+    static equals(a: PoolStatsFilter | PlainMessage<PoolStatsFilter> | undefined, b: PoolStatsFilter | PlainMessage<PoolStatsFilter> | undefined): boolean;
+}
+/**
+ * Server-side filters applied before ranking and pagination.
+ *
+ * @generated from message data.v2.PoolListFilter
+ */
+export declare class PoolListFilter extends Message<PoolListFilter> {
+    /**
+     * if empty, all protocol versions
+     *
+     * @generated from field: repeated pools.v1.ProtocolVersion protocol_versions = 1;
+     */
+    protocolVersions: ProtocolVersion[];
+    /**
+     * default false (spam excluded)
+     *
+     * @generated from field: optional bool include_spam = 2;
+     */
+    includeSpam?: boolean;
+    /**
+     * @generated from field: optional data.v2.PoolTokenFilter token_filter = 3;
+     */
+    tokenFilter?: PoolTokenFilter;
+    /**
+     * @generated from field: optional data.v2.PoolStatsFilter stats_filter = 4;
+     */
+    statsFilter?: PoolStatsFilter;
+    /**
+     * e.g. [500, 3000, 10000]; never matches V2 pools
+     *
+     * @generated from field: repeated uint32 fee_tiers = 5;
+     */
+    feeTiers: number[];
+    constructor(data?: PartialMessage<PoolListFilter>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.PoolListFilter";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolListFilter;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolListFilter;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolListFilter;
+    static equals(a: PoolListFilter | PlainMessage<PoolListFilter> | undefined, b: PoolListFilter | PlainMessage<PoolListFilter> | undefined): boolean;
+}
+/**
+ * Returned by ListPools — wraps a Pool with its ranking stats.
+ *
+ * @generated from message data.v2.RankedPool
+ */
+export declare class RankedPool extends Message<RankedPool> {
+    /**
+     * @generated from field: data.v2.Pool pool = 1;
+     */
+    pool?: Pool;
+    /**
+     * @generated from field: data.v2.PoolRankStats stats = 2;
+     */
+    stats?: PoolRankStats;
+    constructor(data?: PartialMessage<RankedPool>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.RankedPool";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RankedPool;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RankedPool;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RankedPool;
+    static equals(a: RankedPool | PlainMessage<RankedPool> | undefined, b: RankedPool | PlainMessage<RankedPool> | undefined): boolean;
+}
+/**
+ * One token side of a pool event. amount is absolute (always positive).
+ * amount_usd = |amount| * price; 0 when price or decimals are unavailable.
+ *
+ * @generated from message data.v2.TransactionTokenSide
+ */
+export declare class TransactionTokenSide extends Message<TransactionTokenSide> {
+    /**
+     * @generated from field: data.v2.Token token = 1;
+     */
+    token?: Token;
+    /**
+     * decimal-adjusted absolute amount, full precision; absent when decimals unavailable
+     *
+     * @generated from field: optional string amount = 2;
+     */
+    amount?: string;
+    /**
+     * @generated from field: double amount_usd = 3;
+     */
+    amountUsd: number;
+    constructor(data?: PartialMessage<TransactionTokenSide>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.TransactionTokenSide";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionTokenSide;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionTokenSide;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionTokenSide;
+    static equals(a: TransactionTokenSide | PlainMessage<TransactionTokenSide> | undefined, b: TransactionTokenSide | PlainMessage<TransactionTokenSide> | undefined): boolean;
+}
+/**
+ * A single on-chain event from the global protocol feed.
+ *
+ * @generated from message data.v2.UniswapTransaction
+ */
+export declare class UniswapTransaction extends Message<UniswapTransaction> {
+    /**
+     * @generated from field: uint32 chain_id = 1;
+     */
+    chainId: number;
+    /**
+     * @generated from field: string tx_hash = 2;
+     */
+    txHash: string;
+    /**
+     * Unix epoch milliseconds
+     *
+     * @generated from field: int64 timestamp_ms = 3;
+     */
+    timestampMs: bigint;
+    /**
+     * @generated from field: data.v2.TransactionEventType event_type = 4;
+     */
+    eventType: TransactionEventType;
+    /**
+     * @generated from field: pools.v1.ProtocolVersion protocol_version = 5;
+     */
+    protocolVersion: ProtocolVersion;
+    /**
+     * pool address (V2/V3) or pool_id (V4)
+     *
+     * @generated from field: string pool_id = 6;
+     */
+    poolId: string;
+    /**
+     * @generated from field: data.v2.TransactionTokenSide token0 = 7;
+     */
+    token0?: TransactionTokenSide;
+    /**
+     * @generated from field: data.v2.TransactionTokenSide token1 = 8;
+     */
+    token1?: TransactionTokenSide;
+    /**
+     * swap = avg of both sides; add/remove = sum
+     *
+     * @generated from field: double amount_usd = 9;
+     */
+    amountUsd: number;
+    /**
+     * checksummed EVM address (tx_from)
+     *
+     * @generated from field: string wallet_address = 10;
+     */
+    walletAddress: string;
+    constructor(data?: PartialMessage<UniswapTransaction>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "data.v2.UniswapTransaction";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UniswapTransaction;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UniswapTransaction;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UniswapTransaction;
+    static equals(a: UniswapTransaction | PlainMessage<UniswapTransaction> | undefined, b: UniswapTransaction | PlainMessage<UniswapTransaction> | undefined): boolean;
+}
 /**
  * @generated from message data.v2.Token
  */