@codex-data/sdk 2.3.30 → 2.3.32

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

@@ -248,7 +248,7 @@ export type Balance = {
     address: Scalars['String']['output'];
     /** The balance held by the wallet. */
     balance: Scalars['String']['output'];
-    /** The balance held by the wallet in USD. */
+    /** The balance held by the wallet in USD. Computed from `shiftedBalance`, NOT from `uiBalance` — for a B20 asset token those differ by the token's multiplier, so do not recompute this as `uiBalance * tokenPriceUsd`. */
     balanceUsd?: Maybe<Scalars['String']['output']>;
     /** The time that this address first held a token. */
     firstHeldTimestamp?: Maybe<Scalars['Int']['output']>;
@@ -266,9 +266,9 @@ export type Balance = {
     tokenId: Scalars['String']['output'];
     /** Unix timestamp (seconds) of the token's most recent trade/market event across all pools we track. Token-level (not specific to this wallet). Useful for filtering out dead/worthless tokens, e.g. no activity in months. */
     tokenLastTradedTimestamp?: Maybe<Scalars['Int']['output']>;
-    /** The token price in USD. */
+    /** The token price in USD, per raw token — the same units as `shiftedBalance`. For a B20 asset token this does NOT pair with `uiBalance`, which is multiplier-adjusted; multiplying the two over-counts by the multiplier. Use `balanceUsd` for position value. */
     tokenPriceUsd?: Maybe<Scalars['String']['output']>;
-    /** The wallet balance expressed for UI display. Defaults to shiftedBalance. When uiAmountMode is RAW, Token-2022 balances are divided by the active UI amount multiplier when available. */
+    /** The wallet balance expressed for UI display. Defaults to shiftedBalance. For Token-2022 tokens, RAW divides out the active UI amount multiplier. For B20 asset tokens, SCALED multiplies by the active multiplier so the value reflects redeemable units rather than raw token count. IMPORTANT: that B20 adjustment is applied ONLY by the `balances` query, which is the one place a `uiAmountMode` is resolved. Every other source of a Balance — `holders`, `refreshBalances`, `primeBalance`, and the subscriptions — returns the raw `shiftedBalance` here, so the same holding can read differently across them. Display only: it does not share units with `tokenPriceUsd`, so do not multiply the two. */
     uiBalance?: Maybe<Scalars['Float']['output']>;
     /** The block number at which this balance was last updated. Null when the block is unknown (e.g. native balances) or the underlying balance record cannot be found. */
     updatedAtBlock?: Maybe<Scalars['Int']['output']>;
@@ -291,7 +291,7 @@ export type BalancesInput = {
     limit?: InputMaybe<Scalars['Int']['input']>;
     /** The network IDs to filter by. */
     networks?: InputMaybe<Array<Scalars['Int']['input']>>;
-    /** Whether to remove scam tokens from the response. */
+    /** Whether to remove scam tokens from the response. Removes tokens labelled as scams, plus unlabelled tokens whose trading data identifies them as dead dust: no trade in the last 24 hours, or $1,000 or less of pool liquidity. Tokens with no trading history anywhere are kept: filtering is deliberately conservative, and clients wanting aggressive spam removal (e.g. by token symbol) should filter client-side. */
     removeScams?: InputMaybe<Scalars['Boolean']['input']>;
     /** The attribute to sort the list on. Defaults to BALANCE (raw token amount). */
     sortBy?: InputMaybe<BalancesSortAttribute>;
@@ -299,7 +299,7 @@ export type BalancesInput = {
     sortDirection?: InputMaybe<RankingDirection>;
     /** The token IDs (`address:networkId`) or addresses to request the balance for. Requires a list of `networks` if only passing addresses. Include native network balances using `native` as the token address. Only applied when using `walletAddress` (not `walletId`). Max 200 tokens. */
     tokens?: InputMaybe<Array<Scalars['String']['input']>>;
-    /** Controls how uiBalance is expressed. SCALED returns the stored RPC UI amount. RAW removes the active Token-2022 UI amount multiplier when available. Defaults to SCALED. */
+    /** 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?: InputMaybe<UiAmountMode>;
     /** The wallet address to filter by. */
     walletAddress?: InputMaybe<Scalars['String']['input']>;
@@ -318,7 +318,7 @@ export type BalancesResponse = {
 };
 /** The attribute to sort balances by. */
 export declare enum BalancesSortAttribute {
-    /** Sort by raw token balance amount (default). */
+    /** Sort by raw token balance amount (default). Note this orders on `shiftedBalance`, not `uiBalance` — a list rendering `uiBalance` for B20 asset tokens can therefore look mis-ordered, since each token's multiplier differs. Sort by USD_VALUE if the displayed order must match the displayed column. */
     Balance = "BALANCE",
     /** Sort by USD value (descending). */
     UsdValue = "USD_VALUE"
@@ -2888,6 +2888,7 @@ export declare enum LiquidityLockProtocol {
     Doppler = "DOPPLER",
     MeteoraDammV2 = "METEORA_DAMM_V2",
     O1Exchange = "O1_EXCHANGE",
+    PonsV2 = "PONS_V2",
     UncxV2 = "UNCX_V2",
     UncxV3 = "UNCX_V3"
 }
@@ -14097,11 +14098,11 @@ export declare enum TradingPeriod {
     Week = "WEEK",
     Year = "YEAR"
 }
-/** Controls whether uiBalance returns the stored RPC UI balance or removes Token-2022 UI amount multipliers. */
+/** Controls whether uiBalance is expressed in multiplier-adjusted or raw units. The two supported standards store opposite things, so the mode applies in opposite directions. */
 export declare enum UiAmountMode {
-    /** Return raw token amounts by removing Token-2022 UI amount multipliers where available. */
+    /** Return raw token amounts: Token-2022 balances have their UI amount multiplier removed; B20 balances are already raw and pass through unchanged. */
     Raw = "RAW",
-    /** Return the stored RPC UI balance. This is the default. */
+    /** Return multiplier-adjusted amounts: Token-2022 balances are the stored RPC UI amount; B20 balances are multiplied by the token's active multiplier. This is the default. */
     Scaled = "SCALED"
 }
 /** An unconfirmed token transaction. */

package/dist/sdk/generated/graphql.js

@@ -14,7 +14,7 @@ var AlertRecurrence;
 /** The attribute to sort balances by. */
 var BalancesSortAttribute;
 (function (BalancesSortAttribute) {
-    /** Sort by raw token balance amount (default). */
+    /** Sort by raw token balance amount (default). Note this orders on `shiftedBalance`, not `uiBalance` — a list rendering `uiBalance` for B20 asset tokens can therefore look mis-ordered, since each token's multiplier differs. Sort by USD_VALUE if the displayed order must match the displayed column. */
     BalancesSortAttribute["Balance"] = "BALANCE";
     /** Sort by USD value (descending). */
     BalancesSortAttribute["UsdValue"] = "USD_VALUE";
@@ -293,6 +293,7 @@ var LiquidityLockProtocol;
     LiquidityLockProtocol["Doppler"] = "DOPPLER";
     LiquidityLockProtocol["MeteoraDammV2"] = "METEORA_DAMM_V2";
     LiquidityLockProtocol["O1Exchange"] = "O1_EXCHANGE";
+    LiquidityLockProtocol["PonsV2"] = "PONS_V2";
     LiquidityLockProtocol["UncxV2"] = "UNCX_V2";
     LiquidityLockProtocol["UncxV3"] = "UNCX_V3";
 })(LiquidityLockProtocol || (exports.LiquidityLockProtocol = LiquidityLockProtocol = {}));
@@ -2204,12 +2205,12 @@ var TradingPeriod;
     TradingPeriod["Week"] = "WEEK";
     TradingPeriod["Year"] = "YEAR";
 })(TradingPeriod || (exports.TradingPeriod = TradingPeriod = {}));
-/** Controls whether uiBalance returns the stored RPC UI balance or removes Token-2022 UI amount multipliers. */
+/** Controls whether uiBalance is expressed in multiplier-adjusted or raw units. The two supported standards store opposite things, so the mode applies in opposite directions. */
 var UiAmountMode;
 (function (UiAmountMode) {
-    /** Return raw token amounts by removing Token-2022 UI amount multipliers where available. */
+    /** Return raw token amounts: Token-2022 balances have their UI amount multiplier removed; B20 balances are already raw and pass through unchanged. */
     UiAmountMode["Raw"] = "RAW";
-    /** Return the stored RPC UI balance. This is the default. */
+    /** Return multiplier-adjusted amounts: Token-2022 balances are the stored RPC UI amount; B20 balances are multiplied by the token's active multiplier. This is the default. */
     UiAmountMode["Scaled"] = "SCALED";
 })(UiAmountMode || (exports.UiAmountMode = UiAmountMode = {}));
 /** The state of the wallet backfill. */

package/dist/sdk/generated/graphql.mjs

@@ -7,7 +7,7 @@ export var AlertRecurrence;
 /** The attribute to sort balances by. */
 export var BalancesSortAttribute;
 (function (BalancesSortAttribute) {
-    /** Sort by raw token balance amount (default). */
+    /** Sort by raw token balance amount (default). Note this orders on `shiftedBalance`, not `uiBalance` — a list rendering `uiBalance` for B20 asset tokens can therefore look mis-ordered, since each token's multiplier differs. Sort by USD_VALUE if the displayed order must match the displayed column. */
     BalancesSortAttribute["Balance"] = "BALANCE";
     /** Sort by USD value (descending). */
     BalancesSortAttribute["UsdValue"] = "USD_VALUE";
@@ -286,6 +286,7 @@ export var LiquidityLockProtocol;
     LiquidityLockProtocol["Doppler"] = "DOPPLER";
     LiquidityLockProtocol["MeteoraDammV2"] = "METEORA_DAMM_V2";
     LiquidityLockProtocol["O1Exchange"] = "O1_EXCHANGE";
+    LiquidityLockProtocol["PonsV2"] = "PONS_V2";
     LiquidityLockProtocol["UncxV2"] = "UNCX_V2";
     LiquidityLockProtocol["UncxV3"] = "UNCX_V3";
 })(LiquidityLockProtocol || (LiquidityLockProtocol = {}));
@@ -2197,12 +2198,12 @@ export var TradingPeriod;
     TradingPeriod["Week"] = "WEEK";
     TradingPeriod["Year"] = "YEAR";
 })(TradingPeriod || (TradingPeriod = {}));
-/** Controls whether uiBalance returns the stored RPC UI balance or removes Token-2022 UI amount multipliers. */
+/** Controls whether uiBalance is expressed in multiplier-adjusted or raw units. The two supported standards store opposite things, so the mode applies in opposite directions. */
 export var UiAmountMode;
 (function (UiAmountMode) {
-    /** Return raw token amounts by removing Token-2022 UI amount multipliers where available. */
+    /** Return raw token amounts: Token-2022 balances have their UI amount multiplier removed; B20 balances are already raw and pass through unchanged. */
     UiAmountMode["Raw"] = "RAW";
-    /** Return the stored RPC UI balance. This is the default. */
+    /** Return multiplier-adjusted amounts: Token-2022 balances are the stored RPC UI amount; B20 balances are multiplied by the token's active multiplier. This is the default. */
     UiAmountMode["Scaled"] = "SCALED";
 })(UiAmountMode || (UiAmountMode = {}));
 /** The state of the wallet backfill. */

package/package.json

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