@liquid-af/sdk 0.10.2 → 0.10.4

package/src/idl/liquid_state.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/liquid_state.json`.
  */
 export type LiquidState = {
-  "address": "State3HtEfi7cXdsTpAtRoBvrij8zSFCiGTAVWmYH2d",
+  "address": "9ZcKPa3HAEVEKxwFX8fYD56ZJCKPEQgqjgr9rfUvtwKJ",
   "metadata": {
     "name": "liquidState",
     "version": "0.1.0",
@@ -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,
@@ -244,7 +247,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         },
         {
           "name": "systemProgram",
@@ -432,7 +435,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": []
@@ -559,7 +562,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         },
         {
           "name": "systemProgram",
@@ -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,
@@ -672,7 +678,37 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
+        },
+        {
+          "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,
@@ -1066,7 +1105,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": []
@@ -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": [
@@ -1184,7 +1196,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": []
@@ -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,
@@ -1282,7 +1297,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": [
@@ -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,
@@ -1388,7 +1408,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": [
@@ -1576,7 +1596,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         },
         {
           "name": "systemProgram",
@@ -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,
@@ -1700,38 +1727,38 @@ export type LiquidState = {
             "program": {
               "kind": "const",
               "value": [
-                6,
-                165,
-                60,
-                202,
-                204,
-                17,
-                4,
-                104,
-                249,
-                125,
-                214,
-                143,
+                190,
+                32,
+                180,
+                44,
+                45,
+                199,
+                191,
+                169,
+                16,
+                36,
+                248,
+                54,
+                24,
+                28,
+                56,
+                136,
+                88,
                 2,
-                99,
-                165,
-                89,
-                177,
-                218,
-                121,
-                12,
-                23,
-                196,
-                207,
-                105,
-                96,
-                207,
+                74,
+                47,
+                84,
+                229,
+                29,
+                26,
+                30,
+                90,
+                41,
+                109,
                 2,
-                136,
-                202,
-                45,
-                209,
-                225
+                14,
+                50,
+                160
               ]
             }
           }
@@ -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,
@@ -1974,38 +2008,38 @@ export type LiquidState = {
             "program": {
               "kind": "const",
               "value": [
-                5,
-                13,
-                89,
-                2,
-                127,
-                227,
-                146,
-                196,
-                34,
-                13,
-                249,
-                181,
+                90,
                 167,
-                33,
-                126,
-                56,
-                182,
-                105,
-                148,
-                219,
-                33,
-                200,
-                131,
-                117,
-                84,
-                120,
-                212,
-                68,
-                166,
-                219,
-                24,
-                119
+                50,
+                46,
+                85,
+                64,
+                55,
+                53,
+                224,
+                209,
+                144,
+                181,
+                201,
+                225,
+                70,
+                30,
+                252,
+                64,
+                238,
+                96,
+                113,
+                137,
+                55,
+                211,
+                9,
+                69,
+                233,
+                207,
+                149,
+                20,
+                99,
+                193
               ]
             }
           }
@@ -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,
@@ -2242,7 +2279,7 @@ export type LiquidState = {
           "docs": [
             "Liquid events program for centralized event emission."
           ],
-          "address": "EventsQeXA43nLKR69DhHwNsJ6aM512AweMCgG3wG8zG"
+          "address": "Bast7hBDiqSsxiwEmqazwvPvXC3N4z8UQR5ZmkqXnCiY"
         }
       ],
       "args": [
@@ -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"
           },