@codex-data/sdk 2.4.3 → 2.4.5

package/dist/sdk/generated/graphql.d.ts

@@ -289,6 +289,15 @@ export type Balance = {
     /** The ID of the wallet (`walletAddress:networkId`). */
     walletId: Scalars['String']['output'];
 };
+/** Filters for `balances`. Bounds can't be negative, and a range can't be empty. */
+export type BalanceFilters = {
+    /** Keeps holdings whose `balanceUsd` is in range. Requires `sortBy: USD_VALUE` unless `tokens` is passed. A holding with no `balanceUsd` never matches. */
+    balanceUsd?: InputMaybe<NumberFilter>;
+    /** Keeps holdings that have a `tokenPriceUsd` when true, or that have none when false. */
+    hasPrice?: InputMaybe<Scalars['Boolean']['input']>;
+    /** Keeps holdings whose `liquidityUsd` is in range. A holding with no `liquidityUsd` never matches, except native balances, which always match. */
+    liquidityUsd?: InputMaybe<NumberFilter>;
+};
 export type BalancesInput = {
     /** A cursor for use in pagination. */
     cursor?: InputMaybe<Scalars['String']['input']>;
@@ -297,6 +306,8 @@ export type BalancesInput = {
      * @deprecated Use tokens list instead
      */
     filterToken?: InputMaybe<Scalars['String']['input']>;
+    /** Keeps only holdings that match every filter set. A filtered page reads at most 600 of the wallet's holdings, so it can return fewer than `limit` results, or none, while `cursor` is still set; keep paging until `cursor` is null. Reuse a cursor only with the same `filters`. With `tokens`, name at most 200 token IDs across `networks`. */
+    filters?: InputMaybe<BalanceFilters>;
     /** Whether to include native network balances in the response (ID will be native:&lt;networkId&gt;). Requires a list of `networks`. Does not apply when using `tokens`. On networks where the native asset is also readable through an ERC-20 alias contract, the response counts that holding once: the native view is returned and the alias projection row is suppressed on every page; request the alias contract explicitly in `tokens`, or set `includeNative: false`, for the contract view. */
     includeNative?: InputMaybe<Scalars['Boolean']['input']>;
     /** The maximum number of holdings to return. Does not apply when using `tokens`. */
@@ -3770,7 +3781,7 @@ export type LiquidityMetadataByToken = {
     networkId: Scalars['Int']['output'];
     /** The address of the token. */
     tokenAddress: Scalars['String']['output'];
-    /** The total liquidity in USD. */
+    /** The token's total liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens` (the combined liquidity of its 15 deepest pools) once the token has one; elsewhere, or until then, it is the value of the token's own side across the pairs below at its current price. `lockedLiquidityPercentage` is always measured across the pairs below, not against this figure. */
     totalLiquidityUsd: Scalars['String']['output'];
     /** The total amount of tokens in pairs. */
     totalTokenLiquidity: Scalars['String']['output'];
@@ -11467,7 +11478,7 @@ export type Price = {
      * @deprecated Pricing no longer based on specific pools
      */
     confidence?: Maybe<Scalars['Float']['output']>;
-    /** The token's liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens`: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days, where each pool counts only the real money the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Elsewhere, or until that total is computed for the token, it is the token's route-backed liquidity, summed across its pairs with valid routing liquidity. Null when this stat has not been computed for the token yet. Not available via subscription. */
+    /** The token's liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens`: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days, where each pool counts only the real money the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Elsewhere, or until that total is computed for the token, it is the token's route-backed liquidity, summed across its pairs with valid routing liquidity. Null when this stat has not been computed for the token yet. On subscriptions it is the `totalLiquidityUsd` value only, refreshed at most every 30 seconds, and null on networks where the real-money total is not enabled. */
     liquidityUsd?: Maybe<Scalars['String']['output']>;
     /** The network ID the token is deployed on. */
     networkId: Scalars['Int']['output'];
@@ -14367,11 +14378,11 @@ export type TokenFilterResult = {
     lastTransaction?: Maybe<Scalars['Int']['output']>;
     /** Metadata for the token's most liquid pair */
     liquidPair?: Maybe<Pair>;
-    /** The liquidity of the token's most liquid pair */
+    /** The liquidity of the token's most liquid pair. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` (the combined liquidity of the token's 15 deepest pools) once the token has one. The value is recomputed when the token trades. */
     liquidPairLiquidity?: Maybe<Scalars['String']['output']>;
     /** The liquid pairs price in USD. */
     liquidPairPriceUSD?: Maybe<Scalars['String']['output']>;
-    /** Amount of liquidity in the token's top pair. With `useAggregatedStats`, on networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` once the token has one; on other networks it is the token's aggregated liquidity. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. */
+    /** The token's liquidity in USD. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` (the combined liquidity of its 15 deepest pools) once the token has one. On other networks it is the liquidity of the token's top pair, or with `useAggregatedStats` the token's aggregated liquidity. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. */
     liquidity?: Maybe<Scalars['String']['output']>;
     /** The lowest price in USD in the past hour. */
     low1?: Maybe<Scalars['String']['output']>;
@@ -14459,7 +14470,7 @@ export type TokenFilterResult = {
     totalFees12?: Maybe<Scalars['String']['output']>;
     /** The total trading fees (pool + gas + tips) in USD in the past 24 hours. */
     totalFees24?: Maybe<Scalars['String']['output']>;
-    /** The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Distinct from `liquidity`, which covers the top pair only, except with `useAggregatedStats` on networks where the real-money total is enabled, where the two are the same value. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. Null when this stat has not been computed for the token yet. */
+    /** The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. On networks where the real-money total is enabled, `liquidity` is the same value; elsewhere `liquidity` covers the top pair only (or the aggregated liquidity with `useAggregatedStats`). The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. Null when this stat has not been computed for the token yet. */
     totalLiquidityUsd?: Maybe<Scalars['String']['output']>;
     /** A heuristic based on various factors used to rank tokens based on how trending they are. */
     trendingScore?: Maybe<Scalars['Float']['output']>;
@@ -14654,7 +14665,7 @@ export type TokenFilters = {
     launchpadName?: InputMaybe<Array<Scalars['String']['input']>>;
     /** A list of launchpad protocols. */
     launchpadProtocol?: InputMaybe<Array<Scalars['String']['input']>>;
-    /** The amount of liquidity in the token's top pair. With `useAggregatedStats`, on networks where the real-money total is enabled, this filters on the same value as `totalLiquidityUsd` once the token has one; on other networks it filters on the token's aggregated liquidity. */
+    /** The token's liquidity in USD. On networks where the real-money total is enabled, this filters on the same value as `totalLiquidityUsd` (the combined liquidity of its 15 deepest pools) once the token has one. On other networks it filters on the liquidity of the token's top pair, or with `useAggregatedStats` the token's aggregated liquidity. */
     liquidity?: InputMaybe<NumberFilter>;
     /** The lowest price in USD in the past hour. */
     low1?: InputMaybe<NumberFilter>;
@@ -14740,7 +14751,7 @@ export type TokenFilters = {
     totalFees12?: InputMaybe<NumberFilter>;
     /** Filter by total fees in the past 24 hours. */
     totalFees24?: InputMaybe<NumberFilter>;
-    /** The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Distinct from `liquidity`, which covers the top pair only, except with `useAggregatedStats` on networks where the real-money total is enabled, where the two are the same value. */
+    /** The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. On networks where the real-money total is enabled, `liquidity` is the same value; elsewhere `liquidity` covers the top pair only (or the aggregated liquidity with `useAggregatedStats`). */
     totalLiquidityUsd?: InputMaybe<NumberFilter>;
     /** Whether to ignore pairs/tokens not relevant to trending. This is done checking against a few factors and ignoring uninteresting tokens like stables / network tokens. If you want all tokens regardless of these checks, then don't include this field. (default) If you want only tokens that fail the trending ignore checks, then set it to `true`. (i.e. stablecoins, rugs, network base tokens) If you want only tokens that pass the trending ignore checks, then set it to `false`. */
     trendingIgnored?: InputMaybe<Scalars['Boolean']['input']>;
@@ -15633,7 +15644,7 @@ export type TokenWithMetadata = {
     isScam?: Maybe<Scalars['Boolean']['output']>;
     /** The unix timestamp for the token's last transaction. */
     lastTransaction?: Maybe<Scalars['Int']['output']>;
-    /** The total liquidity of the token's top pair in USD. */
+    /** The token's liquidity in USD. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` from `filterTokens` (the combined liquidity of the token's 15 deepest pools) once the token has one; elsewhere it is the total liquidity of the token's top pair. The value is recomputed when the token trades. */
     liquidity: Scalars['String']['output'];
     /** The fully diluted market cap. */
     marketCap?: Maybe<Scalars['String']['output']>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codex-data/sdk",
-  "version": "2.4.3",
+  "version": "2.4.5",
   "engines": {
     "node": ">=17.5.0"
   },

package/schema.graphql

@@ -9193,7 +9193,7 @@ type Price {
   priceUsd: Float!
   """The pool that emitted the swap generating this price"""
   blockNumber: Int
-  """The token's liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens`: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days, where each pool counts only the real money the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Elsewhere, or until that total is computed for the token, it is the token's route-backed liquidity, summed across its pairs with valid routing liquidity. Null when this stat has not been computed for the token yet. Not available via subscription."""
+  """The token's liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens`: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days, where each pool counts only the real money the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Elsewhere, or until that total is computed for the token, it is the token's route-backed liquidity, summed across its pairs with valid routing liquidity. Null when this stat has not been computed for the token yet. On subscriptions it is the `totalLiquidityUsd` value only, refreshed at most every 30 seconds, and null on networks where the real-money total is not enabled."""
   liquidityUsd: String
   """The percent price change in the past 24 hours. Decimal format. Not available via subscription."""
   priceChange24: Float
@@ -9340,9 +9340,9 @@ type TokenFilterResult {
   high24: String
   """The highest price in USD in the past 4 hours."""
   high4: String
-  """Amount of liquidity in the token's top pair. With `useAggregatedStats`, on networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` once the token has one; on other networks it is the token's aggregated liquidity. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value."""
+  """The token's liquidity in USD. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` (the combined liquidity of its 15 deepest pools) once the token has one. On other networks it is the liquidity of the token's top pair, or with `useAggregatedStats` the token's aggregated liquidity. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value."""
   liquidity: String
-  """The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Distinct from `liquidity`, which covers the top pair only, except with `useAggregatedStats` on networks where the real-money total is enabled, where the two are the same value. The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. Null when this stat has not been computed for the token yet."""
+  """The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. On networks where the real-money total is enabled, `liquidity` is the same value; elsewhere `liquidity` covers the top pair only (or the aggregated liquidity with `useAggregatedStats`). The value is recomputed when the token trades, so a token with no trade since this definition last changed keeps its previous value. Null when this stat has not been computed for the token yet."""
   totalLiquidityUsd: String
   """The token of interest. Can be `token0` or `token1`."""
   quoteToken: String
@@ -9364,7 +9364,7 @@ type TokenFilterResult {
   pair: Pair
   """Metadata for the token's most liquid pair"""
   liquidPair: Pair
-  """The liquidity of the token's most liquid pair"""
+  """The liquidity of the token's most liquid pair. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` (the combined liquidity of the token's 15 deepest pools) once the token has one. The value is recomputed when the token trades."""
   liquidPairLiquidity: String
   """The liquid pairs price in USD."""
   liquidPairPriceUSD: String
@@ -11366,6 +11366,18 @@ input BalancesInput {
   sortDirection: RankingDirection
   """Controls how uiBalance is expressed. SCALED returns the Token-2022 stored RPC UI amount, and multiplies B20 balances by their active multiplier. RAW removes the active Token-2022 UI amount multiplier and returns B20 balances unchanged. Defaults to SCALED."""
   uiAmountMode: UiAmountMode
+  """Keeps only holdings that match every filter set. A filtered page reads at most 600 of the wallet's holdings, so it can return fewer than `limit` results, or none, while `cursor` is still set; keep paging until `cursor` is null. Reuse a cursor only with the same `filters`. With `tokens`, name at most 200 token IDs across `networks`."""
+  filters: BalanceFilters
+}
+
+"""Filters for `balances`. Bounds can't be negative, and a range can't be empty."""
+input BalanceFilters {
+  """Keeps holdings whose `balanceUsd` is in range. Requires `sortBy: USD_VALUE` unless `tokens` is passed. A holding with no `balanceUsd` never matches."""
+  balanceUsd: NumberFilter
+  """Keeps holdings whose `liquidityUsd` is in range. A holding with no `liquidityUsd` never matches, except native balances, which always match."""
+  liquidityUsd: NumberFilter
+  """Keeps holdings that have a `tokenPriceUsd` when true, or that have none when false."""
+  hasPrice: Boolean
 }
 
 """Wallet balance of a token."""
@@ -13016,9 +13028,9 @@ input TokenFilters {
   high24: NumberFilter
   """The highest price in USD in the past 4 hours."""
   high4: NumberFilter
-  """The amount of liquidity in the token's top pair. With `useAggregatedStats`, on networks where the real-money total is enabled, this filters on the same value as `totalLiquidityUsd` once the token has one; on other networks it filters on the token's aggregated liquidity."""
+  """The token's liquidity in USD. On networks where the real-money total is enabled, this filters on the same value as `totalLiquidityUsd` (the combined liquidity of its 15 deepest pools) once the token has one. On other networks it filters on the liquidity of the token's top pair, or with `useAggregatedStats` the token's aggregated liquidity."""
   liquidity: NumberFilter
-  """The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. Distinct from `liquidity`, which covers the top pair only, except with `useAggregatedStats` on networks where the real-money total is enabled, where the two are the same value."""
+  """The token's total liquidity in USD: the combined liquidity of its 15 deepest pools, leaving out pools with no trade in the last 7 days. On networks where the real-money total is enabled, each pool counts only the real money behind it: what the token can reach in one or two trades into the network's pricing reference tokens (such as its main stablecoins), with each route counted once. On networks where the real-money total is enabled, `liquidity` is the same value; elsewhere `liquidity` covers the top pair only (or the aggregated liquidity with `useAggregatedStats`)."""
   totalLiquidityUsd: NumberFilter
   """The lowest price in USD in the past hour."""
   low1: NumberFilter
@@ -13315,7 +13327,7 @@ type TokenWithMetadata {
   exchanges: [Exchange!]!
   """The ID of the token (`address:networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
   id: String!
-  """The total liquidity of the token's top pair in USD."""
+  """The token's liquidity in USD. On networks where the real-money total is enabled, this is the same value as `totalLiquidityUsd` from `filterTokens` (the combined liquidity of the token's 15 deepest pools) once the token has one; elsewhere it is the total liquidity of the token's top pair. The value is recomputed when the token trades."""
   liquidity: String!
   """The name of the token."""
   name: String!
@@ -15722,7 +15734,7 @@ type LiquidityMetadataByToken {
   tokenAddress: String!
   """The network ID the token is deployed on."""
   networkId: Int!
-  """The total liquidity in USD."""
+  """The token's total liquidity in USD. On networks where the real-money total is enabled, this is `totalLiquidityUsd` from `filterTokens` (the combined liquidity of its 15 deepest pools) once the token has one; elsewhere, or until then, it is the value of the token's own side across the pairs below at its current price. `lockedLiquidityPercentage` is always measured across the pairs below, not against this figure."""
   totalLiquidityUsd: String!
   """The locked liquidity in USD."""
   lockedLiquidityUsd: String!