@liquid-af/sdk 0.10.1 → 0.10.3

package/src/idl/liquid_state.ts

@@ -74,7 +74,10 @@ export type LiquidState = {
     {
       "name": "adminUpdateUser",
       "docs": [
-        "Admin updates a user's referrer/multiplier and always takes a snapshot"
+        "Admin updates a user's referrer/multiplier and always takes a snapshot.",
+        "",
+        "# Arguments",
+        "* `args` - Optional new referrer and cashback multiplier override."
       ],
       "discriminator": [
         161,
@@ -580,7 +583,10 @@ export type LiquidState = {
     {
       "name": "earnCashback",
       "docs": [
-        "Earn cashback credits (called via CPI during trades)"
+        "Earn cashback credits (called via CPI during trades).",
+        "",
+        "# Arguments",
+        "* `cashback_amount` - Base cashback amount in USD (6 decimals) before multiplier adjustment."
       ],
       "discriminator": [
         123,
@@ -673,6 +679,36 @@ export type LiquidState = {
             "Liquid events program for centralized event emission."
           ],
           "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+        },
+        {
+          "name": "cashbackConfig",
+          "docs": [
+            "Cashback configuration for balance-based multiplier tiers."
+          ],
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  99,
+                  97,
+                  115,
+                  104,
+                  98,
+                  97,
+                  99,
+                  107,
+                  95,
+                  99,
+                  111,
+                  110,
+                  102,
+                  105,
+                  103
+                ]
+              }
+            ]
+          }
         }
       ],
       "args": [
@@ -685,7 +721,10 @@ export type LiquidState = {
     {
       "name": "initializeConfig",
       "docs": [
-        "Initialize global configuration (cashback config and volume accumulators)"
+        "Initialize global configuration (cashback config and volume accumulators).",
+        "",
+        "# Arguments",
+        "* `args` - Admin authority, cashback ranges, and trader cashback basis points."
       ],
       "discriminator": [
         208,
@@ -1124,33 +1163,6 @@ export type LiquidState = {
             ]
           }
         },
-        {
-          "name": "cashbackConfig",
-          "pda": {
-            "seeds": [
-              {
-                "kind": "const",
-                "value": [
-                  99,
-                  97,
-                  115,
-                  104,
-                  98,
-                  97,
-                  99,
-                  107,
-                  95,
-                  99,
-                  111,
-                  110,
-                  102,
-                  105,
-                  103
-                ]
-              }
-            ]
-          }
-        },
         {
           "name": "cpiAuthority",
           "docs": [
@@ -1192,7 +1204,10 @@ export type LiquidState = {
     {
       "name": "setReferrer",
       "docs": [
-        "User sets their referrer (one-time only)"
+        "User sets their referrer (one-time only).",
+        "",
+        "# Arguments",
+        "* `referrer` - The referrer's public key."
       ],
       "discriminator": [
         115,
@@ -1295,8 +1310,13 @@ export type LiquidState = {
     {
       "name": "spendCashback",
       "docs": [
-        "Spend cashback credits to offset protocol fees (called via CPI)",
-        "Returns the amount actually spent"
+        "Spend cashback credits to offset protocol fees (called via CPI).",
+        "",
+        "# Arguments",
+        "* `amount` - Maximum USD credits to spend (6 decimals).",
+        "",
+        "# Returns",
+        "* `SpendCashbackResult` - The amount of credits actually spent."
       ],
       "discriminator": [
         59,
@@ -1588,7 +1608,10 @@ export type LiquidState = {
     {
       "name": "transferAdmin",
       "docs": [
-        "Propose transfer of admin authority to a new pubkey (two-step)"
+        "Propose transfer of admin authority to a new pubkey (two-step).",
+        "",
+        "# Arguments",
+        "* `new_admin` - The proposed new admin authority public key."
       ],
       "discriminator": [
         42,
@@ -1651,7 +1674,11 @@ export type LiquidState = {
       "name": "updateAmmVolumes",
       "docs": [
         "Update volume accumulators for AMM trades.",
-        "Called via CPI from the liquid-swap program."
+        "Called via CPI from the liquid-swap program.",
+        "",
+        "# Arguments",
+        "* `usd_amount` - Trade volume in USD (6 decimals).",
+        "* `token_amount` - Trade volume in base token units."
       ],
       "discriminator": [
         155,
@@ -1846,7 +1873,7 @@ export type LiquidState = {
       ],
       "args": [
         {
-          "name": "solAmount",
+          "name": "usdAmount",
           "type": "u64"
         },
         {
@@ -1858,7 +1885,10 @@ export type LiquidState = {
     {
       "name": "updateConfig",
       "docs": [
-        "Admin updates cashback configuration"
+        "Admin updates cashback configuration.",
+        "",
+        "# Arguments",
+        "* `args` - New cashback ranges and/or trader cashback basis points."
       ],
       "discriminator": [
         29,
@@ -1925,7 +1955,11 @@ export type LiquidState = {
       "name": "updateCurveVolumes",
       "docs": [
         "Update volume accumulators for bonding curve trades.",
-        "Called via CPI from the liquid program."
+        "Called via CPI from the liquid program.",
+        "",
+        "# Arguments",
+        "* `usd_amount` - Trade volume in USD (6 decimals).",
+        "* `token_amount` - Trade volume in base token units."
       ],
       "discriminator": [
         119,
@@ -2122,7 +2156,7 @@ export type LiquidState = {
       ],
       "args": [
         {
-          "name": "solAmount",
+          "name": "usdAmount",
           "type": "u64"
         },
         {
@@ -2134,7 +2168,10 @@ export type LiquidState = {
     {
       "name": "updateDeal",
       "docs": [
-        "Admin updates a deal's cashback multiplier"
+        "Admin updates a deal's cashback multiplier.",
+        "",
+        "# Arguments",
+        "* `new_cashback_multiplier_bps` - New cashback multiplier in basis points (10000 = 1x)."
       ],
       "discriminator": [
         244,
@@ -2470,7 +2507,9 @@ export type LiquidState = {
           {
             "name": "ranges",
             "docs": [
-              "Volume-based multiplier ranges (use len() for active count)"
+              "Balance-based multiplier ranges (use len() for active count).",
+              "Thresholds refer to the user's cashback credit balance. Multiplier is",
+              "applied progressively as credits are earned, not at mode-switch."
             ],
             "type": {
               "vec": {
@@ -2502,7 +2541,12 @@ export type LiquidState = {
     {
       "name": "cashbackRange",
       "docs": [
-        "Cashback range defining volume-based multiplier tiers"
+        "Cashback range defining balance-based multiplier tiers.",
+        "",
+        "Each range maps a cashback balance interval to a multiplier. When a user earns",
+        "cashback, the earned amount is multiplied by the tier corresponding to their",
+        "current balance. If earning crosses a tier boundary, the amount is split so",
+        "each portion receives its respective tier's multiplier."
       ],
       "type": {
         "kind": "struct",
@@ -2510,14 +2554,14 @@ export type LiquidState = {
           {
             "name": "rangeStartInclusive",
             "docs": [
-              "Lower bound of volume range (inclusive)"
+              "Lower bound of balance range (inclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
           {
             "name": "rangeEndExclusive",
             "docs": [
-              "Upper bound of volume range (exclusive)"
+              "Upper bound of balance range (exclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
@@ -2577,9 +2621,9 @@ export type LiquidState = {
         "kind": "struct",
         "fields": [
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume across all AMM trades"
+              "Total USD volume across all AMM trades (6 decimals)"
             ],
             "type": "u128"
           },
@@ -2604,9 +2648,9 @@ export type LiquidState = {
         "kind": "struct",
         "fields": [
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume across all curve trades"
+              "Total USD volume across all curve trades (6 decimals)"
             ],
             "type": "u128"
           },
@@ -2710,9 +2754,9 @@ export type LiquidState = {
             "type": "pubkey"
           },
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume for this token (curve + AMM)"
+              "Total USD volume for this token (curve + AMM, 6 decimals)"
             ],
             "type": "u128"
           },
@@ -2724,16 +2768,16 @@ export type LiquidState = {
             "type": "u128"
           },
           {
-            "name": "curveSolVolume",
+            "name": "curveUsdVolume",
             "docs": [
-              "SOL volume from curve trades (for analytics)"
+              "USD volume from curve trades (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "ammSolVolume",
+            "name": "ammUsdVolume",
             "docs": [
-              "SOL volume from AMM trades (for analytics)"
+              "USD volume from AMM trades (for analytics)"
             ],
             "type": "u128"
           }
@@ -2790,9 +2834,9 @@ export type LiquidState = {
             }
           },
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume traded across both curve and AMM (used for cashback multiplier)"
+              "Total USD volume traded across both curve and AMM"
             ],
             "type": "u128"
           },
@@ -2818,23 +2862,23 @@ export type LiquidState = {
             "type": "bool"
           },
           {
-            "name": "curveSolVolume",
+            "name": "curveUsdVolume",
             "docs": [
-              "SOL volume from curve trades only (for analytics)"
+              "USD volume from curve trades only (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "ammSolVolume",
+            "name": "ammUsdVolume",
             "docs": [
-              "SOL volume from AMM trades only (for analytics)"
+              "USD volume from AMM trades only (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "snapshotSolVolume",
+            "name": "snapshotUsdVolume",
             "docs": [
-              "SOL volume accumulated since the last snapshot (resets on snapshot)"
+              "USD volume accumulated since the last snapshot (resets on snapshot)"
             ],
             "type": "u128"
           },
@@ -2899,9 +2943,9 @@ export type LiquidState = {
             }
           },
           {
-            "name": "solVolume",
+            "name": "usdVolume",
             "docs": [
-              "SOL volume accumulated during this snapshot period"
+              "USD volume accumulated during this snapshot period"
             ],
             "type": "u128"
           },

package/src/idl/liquid_swap.json

@@ -7109,7 +7109,9 @@
           {
             "name": "ranges",
             "docs": [
-              "Volume-based multiplier ranges (use len() for active count)"
+              "Balance-based multiplier ranges (use len() for active count).",
+              "Thresholds refer to the user's cashback credit balance. Multiplier is",
+              "applied progressively as credits are earned, not at mode-switch."
             ],
             "type": {
               "vec": {
@@ -7141,7 +7143,12 @@
     {
       "name": "CashbackRange",
       "docs": [
-        "Cashback range defining volume-based multiplier tiers"
+        "Cashback range defining balance-based multiplier tiers.",
+        "",
+        "Each range maps a cashback balance interval to a multiplier. When a user earns",
+        "cashback, the earned amount is multiplied by the tier corresponding to their",
+        "current balance. If earning crosses a tier boundary, the amount is split so",
+        "each portion receives its respective tier's multiplier."
       ],
       "type": {
         "kind": "struct",
@@ -7149,14 +7156,14 @@
           {
             "name": "range_start_inclusive",
             "docs": [
-              "Lower bound of volume range (inclusive)"
+              "Lower bound of balance range (inclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
           {
             "name": "range_end_exclusive",
             "docs": [
-              "Upper bound of volume range (exclusive)"
+              "Upper bound of balance range (exclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
@@ -7279,9 +7286,9 @@
         "kind": "struct",
         "fields": [
           {
-            "name": "total_sol_volume",
+            "name": "total_usd_volume",
             "docs": [
-              "Total SOL volume across all AMM trades"
+              "Total USD volume across all AMM trades (6 decimals)"
             ],
             "type": "u128"
           },
@@ -7534,9 +7541,9 @@
             "type": "pubkey"
           },
           {
-            "name": "total_sol_volume",
+            "name": "total_usd_volume",
             "docs": [
-              "Total SOL volume for this token (curve + AMM)"
+              "Total USD volume for this token (curve + AMM, 6 decimals)"
             ],
             "type": "u128"
           },
@@ -7548,16 +7555,16 @@
             "type": "u128"
           },
           {
-            "name": "curve_sol_volume",
+            "name": "curve_usd_volume",
             "docs": [
-              "SOL volume from curve trades (for analytics)"
+              "USD volume from curve trades (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "amm_sol_volume",
+            "name": "amm_usd_volume",
             "docs": [
-              "SOL volume from AMM trades (for analytics)"
+              "USD volume from AMM trades (for analytics)"
             ],
             "type": "u128"
           }

package/src/idl/liquid_swap.ts

@@ -7115,7 +7115,9 @@ export type LiquidSwap = {
           {
             "name": "ranges",
             "docs": [
-              "Volume-based multiplier ranges (use len() for active count)"
+              "Balance-based multiplier ranges (use len() for active count).",
+              "Thresholds refer to the user's cashback credit balance. Multiplier is",
+              "applied progressively as credits are earned, not at mode-switch."
             ],
             "type": {
               "vec": {
@@ -7147,7 +7149,12 @@ export type LiquidSwap = {
     {
       "name": "cashbackRange",
       "docs": [
-        "Cashback range defining volume-based multiplier tiers"
+        "Cashback range defining balance-based multiplier tiers.",
+        "",
+        "Each range maps a cashback balance interval to a multiplier. When a user earns",
+        "cashback, the earned amount is multiplied by the tier corresponding to their",
+        "current balance. If earning crosses a tier boundary, the amount is split so",
+        "each portion receives its respective tier's multiplier."
       ],
       "type": {
         "kind": "struct",
@@ -7155,14 +7162,14 @@ export type LiquidSwap = {
           {
             "name": "rangeStartInclusive",
             "docs": [
-              "Lower bound of volume range (inclusive)"
+              "Lower bound of balance range (inclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
           {
             "name": "rangeEndExclusive",
             "docs": [
-              "Upper bound of volume range (exclusive)"
+              "Upper bound of balance range (exclusive), in USD with 6 decimals"
             ],
             "type": "u64"
           },
@@ -7285,9 +7292,9 @@ export type LiquidSwap = {
         "kind": "struct",
         "fields": [
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume across all AMM trades"
+              "Total USD volume across all AMM trades (6 decimals)"
             ],
             "type": "u128"
           },
@@ -7540,9 +7547,9 @@ export type LiquidSwap = {
             "type": "pubkey"
           },
           {
-            "name": "totalSolVolume",
+            "name": "totalUsdVolume",
             "docs": [
-              "Total SOL volume for this token (curve + AMM)"
+              "Total USD volume for this token (curve + AMM, 6 decimals)"
             ],
             "type": "u128"
           },
@@ -7554,16 +7561,16 @@ export type LiquidSwap = {
             "type": "u128"
           },
           {
-            "name": "curveSolVolume",
+            "name": "curveUsdVolume",
             "docs": [
-              "SOL volume from curve trades (for analytics)"
+              "USD volume from curve trades (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "ammSolVolume",
+            "name": "ammUsdVolume",
             "docs": [
-              "SOL volume from AMM trades (for analytics)"
+              "USD volume from AMM trades (for analytics)"
             ],
             "type": "u128"
           }

package/src/types.ts

@@ -188,7 +188,7 @@ export interface ReferrerInfo {
 /** User properties account */
 export interface UserProperties {
 	referrer: ReferrerInfo | null;
-	totalSolVolume: BN;
+	totalUsdVolume: BN;
 	totalTokenVolume: BN;
 	cashbackCredits: BN;
 	isSpending: boolean;
@@ -205,7 +205,7 @@ export interface UserSnapshot {
 	user: PublicKey;
 	index: number;
 	prevSnapshot: PublicKey | null;
-	solVolume: BN;
+	usdVolume: BN;
 	tokenVolume: BN;
 	createdAt: BN;
 }
@@ -226,7 +226,7 @@ export interface AdminUpdateUserArgs {
 /** Per-token volume accumulator */
 export interface TokenVolumeAccumulator {
 	mint: PublicKey;
-	totalSolVolume: BN;
+	totalUsdVolume: BN;
 	totalTokenVolume: BN;
 	curveSolVolume: BN;
 	ammSolVolume: BN;
@@ -234,13 +234,13 @@ export interface TokenVolumeAccumulator {
 
 /** Global curve volume accumulator */
 export interface GlobalCurveVolume {
-	totalSolVolume: BN;
+	totalUsdVolume: BN;
 	totalTokenVolume: BN;
 }
 
 /** Global AMM volume accumulator */
 export interface GlobalAmmVolume {
-	totalSolVolume: BN;
+	totalUsdVolume: BN;
 	totalTokenVolume: BN;
 }