@liquid-af/sdk 0.10.1 → 0.10.3

package/src/idl/liquid_fees.ts

@@ -16,10 +16,7 @@ export type LiquidFees = {
     {
       "name": "acceptAdmin",
       "docs": [
-        "Accept a pending admin transfer (step 2 of 2).",
-        "",
-        "# Arguments",
-        "* `ctx` - Context containing the pending admin signer."
+        "Accept a pending admin transfer (step 2 of 2)."
       ],
       "discriminator": [
         112,
@@ -75,12 +72,7 @@ export type LiquidFees = {
     {
       "name": "claimFees",
       "docs": [
-        "Claim accumulated SOL fees from a recipient's vault PDA.",
-        "",
-        "# Arguments",
-        "The recipient must sign the transaction. The vault PDA is derived",
-        "from the fee_config and recipient pubkey, ensuring only the rightful",
-        "recipient can claim."
+        "Claim accumulated SOL fees from a recipient's vault PDA."
       ],
       "discriminator": [
         82,
@@ -192,11 +184,7 @@ export type LiquidFees = {
     {
       "name": "claimTokenFees",
       "docs": [
-        "Claim accumulated token fees from a recipient's vault ATA.",
-        "",
-        "# Arguments",
-        "The recipient must sign the transaction. After claiming, the vault",
-        "ATA is closed and rent is returned to the recipient."
+        "Claim accumulated token fees from a recipient's vault ATA."
       ],
       "discriminator": [
         205,
@@ -812,7 +800,10 @@ export type LiquidFees = {
         "",
         "This should be called when creating a new bonding curve.",
         "The fee configuration is keyed by token_mint, so it persists",
-        "across migration from bonding curve to AMM."
+        "across migration from bonding curve to AMM.",
+        "",
+        "# Arguments",
+        "* `args` - Fee recipients, basis points, and update authority."
       ],
       "discriminator": [
         62,
@@ -937,10 +928,7 @@ export type LiquidFees = {
     {
       "name": "initializeGlobalConfig",
       "docs": [
-        "Initialize the global configuration for the liquid-fees program.",
-        "",
-        "# Arguments",
-        "* `ctx` - Context containing the admin signer and global config PDA."
+        "Initialize the global configuration for the liquid-fees program."
       ],
       "discriminator": [
         113,
@@ -1003,7 +991,6 @@ export type LiquidFees = {
         "Override the update authority on a fee configuration.",
         "",
         "# Arguments",
-        "* `ctx` - Context containing the admin, global config, and target fee config.",
         "* `args` - Contains the new update authority public key."
       ],
       "discriminator": [
@@ -1289,7 +1276,6 @@ export type LiquidFees = {
         "Transfer admin authority to a new address (step 1 of 2).",
         "",
         "# Arguments",
-        "* `ctx` - Context containing the current admin signer.",
         "* `new_admin` - The new admin authority public key."
       ],
       "discriminator": [
@@ -1355,7 +1341,10 @@ export type LiquidFees = {
         "",
         "Can update recipients or transfer update authority.",
         "Cannot be used to revoke - use `revoke_fee_config` instead.",
-        "Cannot be called on revoked configurations."
+        "Cannot be called on revoked configurations.",
+        "",
+        "# Arguments",
+        "* `args` - New recipients and/or new update authority."
       ],
       "discriminator": [
         104,

package/src/idl/liquid_state.json

@@ -68,7 +68,10 @@
     {
       "name": "admin_update_user",
       "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,
@@ -574,7 +577,10 @@
     {
       "name": "earn_cashback",
       "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,
@@ -667,6 +673,36 @@
             "Liquid events program for centralized event emission."
           ],
           "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+        },
+        {
+          "name": "cashback_config",
+          "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": [
@@ -679,7 +715,10 @@
     {
       "name": "initialize_config",
       "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,
@@ -1118,33 +1157,6 @@
             ]
           }
         },
-        {
-          "name": "cashback_config",
-          "pda": {
-            "seeds": [
-              {
-                "kind": "const",
-                "value": [
-                  99,
-                  97,
-                  115,
-                  104,
-                  98,
-                  97,
-                  99,
-                  107,
-                  95,
-                  99,
-                  111,
-                  110,
-                  102,
-                  105,
-                  103
-                ]
-              }
-            ]
-          }
-        },
         {
           "name": "cpi_authority",
           "docs": [
@@ -1186,7 +1198,10 @@
     {
       "name": "set_referrer",
       "docs": [
-        "User sets their referrer (one-time only)"
+        "User sets their referrer (one-time only).",
+        "",
+        "# Arguments",
+        "* `referrer` - The referrer's public key."
       ],
       "discriminator": [
         115,
@@ -1289,8 +1304,13 @@
     {
       "name": "spend_cashback",
       "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,
@@ -1582,7 +1602,10 @@
     {
       "name": "transfer_admin",
       "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,
@@ -1645,7 +1668,11 @@
       "name": "update_amm_volumes",
       "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,
@@ -1840,7 +1867,7 @@
       ],
       "args": [
         {
-          "name": "sol_amount",
+          "name": "usd_amount",
           "type": "u64"
         },
         {
@@ -1852,7 +1879,10 @@
     {
       "name": "update_config",
       "docs": [
-        "Admin updates cashback configuration"
+        "Admin updates cashback configuration.",
+        "",
+        "# Arguments",
+        "* `args` - New cashback ranges and/or trader cashback basis points."
       ],
       "discriminator": [
         29,
@@ -1919,7 +1949,11 @@
       "name": "update_curve_volumes",
       "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,
@@ -2116,7 +2150,7 @@
       ],
       "args": [
         {
-          "name": "sol_amount",
+          "name": "usd_amount",
           "type": "u64"
         },
         {
@@ -2128,7 +2162,10 @@
     {
       "name": "update_deal",
       "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,
@@ -2464,7 +2501,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": {
@@ -2496,7 +2535,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",
@@ -2504,14 +2548,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"
           },
@@ -2571,9 +2615,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"
           },
@@ -2598,9 +2642,9 @@
         "kind": "struct",
         "fields": [
           {
-            "name": "total_sol_volume",
+            "name": "total_usd_volume",
             "docs": [
-              "Total SOL volume across all curve trades"
+              "Total USD volume across all curve trades (6 decimals)"
             ],
             "type": "u128"
           },
@@ -2704,9 +2748,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"
           },
@@ -2718,16 +2762,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"
           }
@@ -2784,9 +2828,9 @@
             }
           },
           {
-            "name": "total_sol_volume",
+            "name": "total_usd_volume",
             "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"
           },
@@ -2812,23 +2856,23 @@
             "type": "bool"
           },
           {
-            "name": "curve_sol_volume",
+            "name": "curve_usd_volume",
             "docs": [
-              "SOL volume from curve trades only (for analytics)"
+              "USD volume from curve trades only (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "amm_sol_volume",
+            "name": "amm_usd_volume",
             "docs": [
-              "SOL volume from AMM trades only (for analytics)"
+              "USD volume from AMM trades only (for analytics)"
             ],
             "type": "u128"
           },
           {
-            "name": "snapshot_sol_volume",
+            "name": "snapshot_usd_volume",
             "docs": [
-              "SOL volume accumulated since the last snapshot (resets on snapshot)"
+              "USD volume accumulated since the last snapshot (resets on snapshot)"
             ],
             "type": "u128"
           },
@@ -2893,9 +2937,9 @@
             }
           },
           {
-            "name": "sol_volume",
+            "name": "usd_volume",
             "docs": [
-              "SOL volume accumulated during this snapshot period"
+              "USD volume accumulated during this snapshot period"
             ],
             "type": "u128"
           },