@uniswap/client-data-api 0.0.136 → 0.0.138

package/dist/data/v2/types_pb.js

@@ -4,6 +4,7 @@
 // @ts-nocheck
 import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
 import { TimestampedValue, TokenType } from "../v1/types_pb.js";
+import { ProtocolVersion } from "../v1/poolTypes_pb.js";
 /**
  * @generated from enum data.v2.TokensOrderBy
  */
@@ -264,6 +265,112 @@ proto3.util.setEnumType(HistoryDuration, "data.v2.HistoryDuration", [
     { no: 5, name: "HISTORY_DURATION_YEAR" },
     { no: 6, name: "HISTORY_DURATION_MAX" },
 ]);
+/**
+ * @generated from enum data.v2.PoolsOrderBy
+ */
+export var PoolsOrderBy;
+(function (PoolsOrderBy) {
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_UNSPECIFIED = 0;
+     */
+    PoolsOrderBy[PoolsOrderBy["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /**
+     * default
+     *
+     * @generated from enum value: POOLS_ORDER_BY_TVL = 1;
+     */
+    PoolsOrderBy[PoolsOrderBy["TVL"] = 1] = "TVL";
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_1D = 2;
+     */
+    PoolsOrderBy[PoolsOrderBy["VOLUME_1D"] = 2] = "VOLUME_1D";
+    /**
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_30D = 3;
+     */
+    PoolsOrderBy[PoolsOrderBy["VOLUME_30D"] = 3] = "VOLUME_30D";
+    /**
+     * fee revenue / TVL; excludes reward_apr
+     *
+     * @generated from enum value: POOLS_ORDER_BY_APR = 4;
+     */
+    PoolsOrderBy[PoolsOrderBy["APR"] = 4] = "APR";
+    /**
+     * volume_1d / tvl; capital-efficiency proxy
+     *
+     * @generated from enum value: POOLS_ORDER_BY_VOLUME_1D_TVL_RATIO = 5;
+     */
+    PoolsOrderBy[PoolsOrderBy["VOLUME_1D_TVL_RATIO"] = 5] = "VOLUME_1D_TVL_RATIO";
+})(PoolsOrderBy || (PoolsOrderBy = {}));
+// Retrieve enum metadata with: proto3.getEnumType(PoolsOrderBy)
+proto3.util.setEnumType(PoolsOrderBy, "data.v2.PoolsOrderBy", [
+    { no: 0, name: "POOLS_ORDER_BY_UNSPECIFIED" },
+    { no: 1, name: "POOLS_ORDER_BY_TVL" },
+    { no: 2, name: "POOLS_ORDER_BY_VOLUME_1D" },
+    { no: 3, name: "POOLS_ORDER_BY_VOLUME_30D" },
+    { no: 4, name: "POOLS_ORDER_BY_APR" },
+    { no: 5, name: "POOLS_ORDER_BY_VOLUME_1D_TVL_RATIO" },
+]);
+/**
+ * @generated from enum data.v2.PoolTokenLogicalOperator
+ */
+export var PoolTokenLogicalOperator;
+(function (PoolTokenLogicalOperator) {
+    /**
+     * treated as OR
+     *
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_UNSPECIFIED = 0;
+     */
+    PoolTokenLogicalOperator[PoolTokenLogicalOperator["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /**
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_OR = 1;
+     */
+    PoolTokenLogicalOperator[PoolTokenLogicalOperator["OR"] = 1] = "OR";
+    /**
+     * invalid with more than 2 tokens
+     *
+     * @generated from enum value: POOL_TOKEN_LOGICAL_OPERATOR_AND = 2;
+     */
+    PoolTokenLogicalOperator[PoolTokenLogicalOperator["AND"] = 2] = "AND";
+})(PoolTokenLogicalOperator || (PoolTokenLogicalOperator = {}));
+// Retrieve enum metadata with: proto3.getEnumType(PoolTokenLogicalOperator)
+proto3.util.setEnumType(PoolTokenLogicalOperator, "data.v2.PoolTokenLogicalOperator", [
+    { no: 0, name: "POOL_TOKEN_LOGICAL_OPERATOR_UNSPECIFIED" },
+    { no: 1, name: "POOL_TOKEN_LOGICAL_OPERATOR_OR" },
+    { no: 2, name: "POOL_TOKEN_LOGICAL_OPERATOR_AND" },
+]);
+/**
+ * @generated from enum data.v2.TransactionEventType
+ */
+export var TransactionEventType;
+(function (TransactionEventType) {
+    /**
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0;
+     */
+    TransactionEventType[TransactionEventType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /**
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_SWAP = 1;
+     */
+    TransactionEventType[TransactionEventType["SWAP"] = 1] = "SWAP";
+    /**
+     * mint / positive modify_liquidity
+     *
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_ADD = 2;
+     */
+    TransactionEventType[TransactionEventType["ADD"] = 2] = "ADD";
+    /**
+     * burn / negative modify_liquidity
+     *
+     * @generated from enum value: TRANSACTION_EVENT_TYPE_REMOVE = 3;
+     */
+    TransactionEventType[TransactionEventType["REMOVE"] = 3] = "REMOVE";
+})(TransactionEventType || (TransactionEventType = {}));
+// Retrieve enum metadata with: proto3.getEnumType(TransactionEventType)
+proto3.util.setEnumType(TransactionEventType, "data.v2.TransactionEventType", [
+    { no: 0, name: "TRANSACTION_EVENT_TYPE_UNSPECIFIED" },
+    { no: 1, name: "TRANSACTION_EVENT_TYPE_SWAP" },
+    { no: 2, name: "TRANSACTION_EVENT_TYPE_ADD" },
+    { no: 3, name: "TRANSACTION_EVENT_TYPE_REMOVE" },
+]);
 /**
  * Sort field for ListLaunches; UNSPECIFIED defaults to LAUNCHED_AT (newest first).
  *
@@ -846,6 +953,405 @@ MultichainToken.fields = proto3.util.newFieldList(() => [
     { no: 9, name: "fees", kind: "message", T: TokenFees },
     { no: 10, name: "project", kind: "message", T: TokenProject },
 ]);
+/**
+ * @generated from message data.v2.PoolsSort
+ */
+export class PoolsSort extends Message {
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolsSort().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolsSort().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolsSort().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolsSort, a, b);
+    }
+}
+PoolsSort.runtime = proto3;
+PoolsSort.typeName = "data.v2.PoolsSort";
+PoolsSort.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "order_by", kind: "enum", T: proto3.getEnumType(PoolsOrderBy), opt: true },
+    { no: 2, name: "ascending", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
+]);
+/**
+ * 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 class PoolRankStats extends Message {
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolRankStats().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolRankStats().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolRankStats().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolRankStats, a, b);
+    }
+}
+PoolRankStats.runtime = proto3;
+PoolRankStats.typeName = "data.v2.PoolRankStats";
+PoolRankStats.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "tvl", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 2, name: "volume_1d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 3, name: "volume_30d", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 4, name: "apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 5, name: "reward_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 6, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 7, name: "volume_1d_tvl_ratio", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+]);
+/**
+ * A pool with its protocol identity and token pair. No stats — stats live on
+ * RankedPool.
+ *
+ * @generated from message data.v2.Pool
+ */
+export class Pool extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: uint32 chain_id = 1;
+         */
+        this.chainId = 0;
+        /**
+         * checksummed pool address (V4: pool id hash)
+         *
+         * @generated from field: string pool_id = 2;
+         */
+        this.poolId = "";
+        /**
+         * @generated from field: pools.v1.ProtocolVersion protocol_version = 5;
+         */
+        this.protocolVersion = ProtocolVersion.UNSPECIFIED;
+        /**
+         * true for V4 pools with dynamic fees
+         *
+         * @generated from field: bool is_dynamic_fee = 8;
+         */
+        this.isDynamicFee = false;
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new Pool().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new Pool().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new Pool().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(Pool, a, b);
+    }
+}
+Pool.runtime = proto3;
+Pool.typeName = "data.v2.Pool";
+Pool.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "chain_id", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 2, name: "pool_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "token0", kind: "message", T: Token },
+    { no: 4, name: "token1", kind: "message", T: Token },
+    { no: 5, name: "protocol_version", kind: "enum", T: proto3.getEnumType(ProtocolVersion) },
+    { no: 6, name: "tick_spacing", kind: "scalar", T: 5 /* ScalarType.INT32 */, opt: true },
+    { no: 7, name: "fee_tier", kind: "scalar", T: 13 /* ScalarType.UINT32 */, opt: true },
+    { no: 8, name: "is_dynamic_fee", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 9, name: "hook_address", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+]);
+/**
+ * @generated from message data.v2.PoolTokenFilter
+ */
+export class PoolTokenFilter extends Message {
+    constructor(data) {
+        super();
+        /**
+         * checksummed EVM addresses
+         *
+         * @generated from field: repeated string tokens = 1;
+         */
+        this.tokens = [];
+        /**
+         * @generated from field: data.v2.PoolTokenLogicalOperator logical_operator = 2;
+         */
+        this.logicalOperator = PoolTokenLogicalOperator.UNSPECIFIED;
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolTokenFilter().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolTokenFilter().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolTokenFilter().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolTokenFilter, a, b);
+    }
+}
+PoolTokenFilter.runtime = proto3;
+PoolTokenFilter.typeName = "data.v2.PoolTokenFilter";
+PoolTokenFilter.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "tokens", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
+    { no: 2, name: "logical_operator", kind: "enum", T: proto3.getEnumType(PoolTokenLogicalOperator) },
+]);
+/**
+ * @generated from message data.v2.PoolStatRangeFilter
+ */
+export class PoolStatRangeFilter extends Message {
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolStatRangeFilter().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolStatRangeFilter().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolStatRangeFilter().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolStatRangeFilter, a, b);
+    }
+}
+PoolStatRangeFilter.runtime = proto3;
+PoolStatRangeFilter.typeName = "data.v2.PoolStatRangeFilter";
+PoolStatRangeFilter.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "min", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+    { no: 2, name: "max", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
+]);
+/**
+ * @generated from message data.v2.PoolStatsFilter
+ */
+export class PoolStatsFilter extends Message {
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolStatsFilter().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolStatsFilter().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolStatsFilter().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolStatsFilter, a, b);
+    }
+}
+PoolStatsFilter.runtime = proto3;
+PoolStatsFilter.typeName = "data.v2.PoolStatsFilter";
+PoolStatsFilter.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "tvl", kind: "message", T: PoolStatRangeFilter, opt: true },
+    { no: 2, name: "apr", kind: "message", T: PoolStatRangeFilter, opt: true },
+    { no: 3, name: "volume_1d", kind: "message", T: PoolStatRangeFilter, opt: true },
+    { no: 4, name: "volume_30d", kind: "message", T: PoolStatRangeFilter, opt: true },
+]);
+/**
+ * Server-side filters applied before ranking and pagination.
+ *
+ * @generated from message data.v2.PoolListFilter
+ */
+export class PoolListFilter extends Message {
+    constructor(data) {
+        super();
+        /**
+         * if empty, all protocol versions
+         *
+         * @generated from field: repeated pools.v1.ProtocolVersion protocol_versions = 1;
+         */
+        this.protocolVersions = [];
+        /**
+         * e.g. [500, 3000, 10000]; never matches V2 pools
+         *
+         * @generated from field: repeated uint32 fee_tiers = 5;
+         */
+        this.feeTiers = [];
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new PoolListFilter().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new PoolListFilter().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new PoolListFilter().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(PoolListFilter, a, b);
+    }
+}
+PoolListFilter.runtime = proto3;
+PoolListFilter.typeName = "data.v2.PoolListFilter";
+PoolListFilter.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "protocol_versions", kind: "enum", T: proto3.getEnumType(ProtocolVersion), repeated: true },
+    { no: 2, name: "include_spam", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
+    { no: 3, name: "token_filter", kind: "message", T: PoolTokenFilter, opt: true },
+    { no: 4, name: "stats_filter", kind: "message", T: PoolStatsFilter, opt: true },
+    { no: 5, name: "fee_tiers", kind: "scalar", T: 13 /* ScalarType.UINT32 */, repeated: true },
+]);
+/**
+ * Returned by ListPools — wraps a Pool with its ranking stats.
+ *
+ * @generated from message data.v2.RankedPool
+ */
+export class RankedPool extends Message {
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new RankedPool().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new RankedPool().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new RankedPool().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(RankedPool, a, b);
+    }
+}
+RankedPool.runtime = proto3;
+RankedPool.typeName = "data.v2.RankedPool";
+RankedPool.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "pool", kind: "message", T: Pool },
+    { no: 2, name: "stats", kind: "message", T: PoolRankStats },
+]);
+/**
+ * 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 class TransactionTokenSide extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: double amount_usd = 3;
+         */
+        this.amountUsd = 0;
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new TransactionTokenSide().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new TransactionTokenSide().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new TransactionTokenSide().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(TransactionTokenSide, a, b);
+    }
+}
+TransactionTokenSide.runtime = proto3;
+TransactionTokenSide.typeName = "data.v2.TransactionTokenSide";
+TransactionTokenSide.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "token", kind: "message", T: Token },
+    { no: 2, name: "amount", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 3, name: "amount_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+]);
+/**
+ * A single on-chain event from the global protocol feed.
+ *
+ * @generated from message data.v2.UniswapTransaction
+ */
+export class UniswapTransaction extends Message {
+    constructor(data) {
+        super();
+        /**
+         * @generated from field: uint32 chain_id = 1;
+         */
+        this.chainId = 0;
+        /**
+         * @generated from field: string tx_hash = 2;
+         */
+        this.txHash = "";
+        /**
+         * Unix epoch milliseconds
+         *
+         * @generated from field: int64 timestamp_ms = 3;
+         */
+        this.timestampMs = protoInt64.zero;
+        /**
+         * @generated from field: data.v2.TransactionEventType event_type = 4;
+         */
+        this.eventType = TransactionEventType.UNSPECIFIED;
+        /**
+         * @generated from field: pools.v1.ProtocolVersion protocol_version = 5;
+         */
+        this.protocolVersion = ProtocolVersion.UNSPECIFIED;
+        /**
+         * pool address (V2/V3) or pool_id (V4)
+         *
+         * @generated from field: string pool_id = 6;
+         */
+        this.poolId = "";
+        /**
+         * swap = avg of both sides; add/remove = sum
+         *
+         * @generated from field: double amount_usd = 9;
+         */
+        this.amountUsd = 0;
+        /**
+         * checksummed EVM address (tx_from)
+         *
+         * @generated from field: string wallet_address = 10;
+         */
+        this.walletAddress = "";
+        proto3.util.initPartial(data, this);
+    }
+    static fromBinary(bytes, options) {
+        return new UniswapTransaction().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new UniswapTransaction().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new UniswapTransaction().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(UniswapTransaction, a, b);
+    }
+}
+UniswapTransaction.runtime = proto3;
+UniswapTransaction.typeName = "data.v2.UniswapTransaction";
+UniswapTransaction.fields = proto3.util.newFieldList(() => [
+    { no: 1, name: "chain_id", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 2, name: "tx_hash", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "timestamp_ms", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 4, name: "event_type", kind: "enum", T: proto3.getEnumType(TransactionEventType) },
+    { no: 5, name: "protocol_version", kind: "enum", T: proto3.getEnumType(ProtocolVersion) },
+    { no: 6, name: "pool_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 7, name: "token0", kind: "message", T: TransactionTokenSide },
+    { no: 8, name: "token1", kind: "message", T: TransactionTokenSide },
+    { no: 9, name: "amount_usd", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+    { no: 10, name: "wallet_address", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+]);
 /**
  * @generated from message data.v2.Token
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uniswap/client-data-api",
-    "version": "0.0.136",
+    "version": "0.0.138",
     "publishConfig": {
       "access": "public"
     },