@liquid-af/sdk 0.11.1 → 0.11.2

package/src/idl/liquid_state.ts

@@ -16,7 +16,7 @@ export type LiquidState = {
     {
       "name": "acceptAdmin",
       "docs": [
-        "Accept a pending admin transfer, completing the two-step handoff"
+        "Accept a pending admin transfer, completing the two-step handoff."
       ],
       "discriminator": [
         112,
@@ -251,6 +251,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -268,7 +271,7 @@ export type LiquidState = {
     {
       "name": "cancelAdminTransfer",
       "docs": [
-        "Cancel a pending admin transfer (callable by current or pending admin)"
+        "Cancel a pending admin transfer (callable by current or pending admin)."
       ],
       "discriminator": [
         38,
@@ -326,7 +329,7 @@ export type LiquidState = {
     {
       "name": "closeDeal",
       "docs": [
-        "Admin closes/deletes a deal, returning rent to admin"
+        "Admin closes/deletes a deal, returning rent to admin."
       ],
       "discriminator": [
         157,
@@ -443,11 +446,11 @@ export type LiquidState = {
     {
       "name": "createDeal",
       "docs": [
-        "Admin creates an exclusive deal for a pubkey",
+        "Admin creates an exclusive deal for a pubkey.",
         "",
         "# Arguments",
-        "* `owner` - The pubkey this deal belongs to",
-        "* `cashback_multiplier_bps` - Cashback multiplier in basis points (10000 = 1x)"
+        "* `owner` - The pubkey this deal belongs to.",
+        "* `cashback_multiplier_bps` - Cashback multiplier in basis points (10000 = 1x)."
       ],
       "discriminator": [
         198,
@@ -566,6 +569,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -615,6 +621,9 @@ export type LiquidState = {
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to credit cashback to."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -739,11 +748,17 @@ export type LiquidState = {
       "accounts": [
         {
           "name": "payer",
+          "docs": [
+            "The payer for account creation."
+          ],
           "writable": true,
           "signer": true
         },
         {
           "name": "cashbackConfig",
+          "docs": [
+            "Cashback configuration account to initialize."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -772,6 +787,9 @@ export type LiquidState = {
         },
         {
           "name": "globalCurveVolume",
+          "docs": [
+            "Global curve volume accumulator to initialize."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -804,6 +822,9 @@ export type LiquidState = {
         },
         {
           "name": "globalAmmVolume",
+          "docs": [
+            "Global AMM volume accumulator to initialize."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -834,6 +855,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -851,7 +875,7 @@ export type LiquidState = {
     {
       "name": "initializeTokenVolume",
       "docs": [
-        "Initialize a token's volume accumulator with default values"
+        "Initialize a token's volume accumulator with default values."
       ],
       "discriminator": [
         98,
@@ -923,7 +947,7 @@ export type LiquidState = {
     {
       "name": "initializeUser",
       "docs": [
-        "Initialize a user's properties account with default values"
+        "Initialize a user's properties account with default values."
       ],
       "discriminator": [
         111,
@@ -992,7 +1016,7 @@ export type LiquidState = {
     {
       "name": "redeemDeal",
       "docs": [
-        "User redeems their referrer's deal, copying the multiplier"
+        "User redeems their referrer's deal, copying the multiplier."
       ],
       "discriminator": [
         28,
@@ -1113,8 +1137,8 @@ export type LiquidState = {
     {
       "name": "setCashbackMode",
       "docs": [
-        "User-callable instruction to activate cashback spending mode",
-        "Applies volume-based multiplier to credits"
+        "Activates cashback spending mode for the caller.",
+        "Applies the volume-based multiplier to accumulated credits."
       ],
       "discriminator": [
         172,
@@ -1129,10 +1153,16 @@ export type LiquidState = {
       "accounts": [
         {
           "name": "user",
+          "docs": [
+            "The user activating spending mode."
+          ],
           "signer": true
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to toggle spending mode on."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1222,6 +1252,9 @@ export type LiquidState = {
       "accounts": [
         {
           "name": "user",
+          "docs": [
+            "The user setting their referrer."
+          ],
           "signer": true
         },
         {
@@ -1234,6 +1267,9 @@ export type LiquidState = {
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to set the referrer on."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1313,10 +1349,7 @@ export type LiquidState = {
         "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."
+        "* `amount` - Maximum USD credits to spend (6 decimals)."
       ],
       "discriminator": [
         59,
@@ -1345,6 +1378,9 @@ export type LiquidState = {
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to debit cashback from."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1426,7 +1462,7 @@ export type LiquidState = {
     {
       "name": "takeSnapshot",
       "docs": [
-        "Admin takes a snapshot of a user's volume since last snapshot"
+        "Admin takes a snapshot of a user's volume since last snapshot."
       ],
       "discriminator": [
         183,
@@ -1600,6 +1636,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -1693,6 +1732,9 @@ export type LiquidState = {
       "accounts": [
         {
           "name": "payer",
+          "docs": [
+            "The payer for the transaction."
+          ],
           "writable": true,
           "signer": true
         },
@@ -1765,6 +1807,9 @@ export type LiquidState = {
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to update volumes on."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1797,6 +1842,9 @@ export type LiquidState = {
         },
         {
           "name": "globalAmmVolume",
+          "docs": [
+            "Global AMM volume accumulator."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1827,6 +1875,9 @@ export type LiquidState = {
         },
         {
           "name": "tokenVolume",
+          "docs": [
+            "Token-specific volume accumulator."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -1868,6 +1919,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -1974,6 +2028,9 @@ export type LiquidState = {
       "accounts": [
         {
           "name": "payer",
+          "docs": [
+            "The payer for the transaction."
+          ],
           "writable": true,
           "signer": true
         },
@@ -2046,6 +2103,9 @@ export type LiquidState = {
         },
         {
           "name": "userProperties",
+          "docs": [
+            "User properties account to update volumes on."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -2078,6 +2138,9 @@ export type LiquidState = {
         },
         {
           "name": "globalCurveVolume",
+          "docs": [
+            "Global curve volume accumulator."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -2110,6 +2173,9 @@ export type LiquidState = {
         },
         {
           "name": "tokenVolume",
+          "docs": [
+            "Token-specific volume accumulator."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -2151,6 +2217,9 @@ export type LiquidState = {
         },
         {
           "name": "systemProgram",
+          "docs": [
+            "System program."
+          ],
           "address": "11111111111111111111111111111111"
         }
       ],
@@ -2463,6 +2532,9 @@ export type LiquidState = {
   "types": [
     {
       "name": "adminUpdateUserArgs",
+      "docs": [
+        "Arguments for admin-updating a user's referrer or cashback multiplier."
+      ],
       "type": {
         "kind": "struct",
         "fields": [
@@ -2666,15 +2738,24 @@ export type LiquidState = {
     },
     {
       "name": "initializeConfigArgs",
+      "docs": [
+        "Arguments for initializing the global cashback and volume configuration."
+      ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "adminAuthority",
+            "docs": [
+              "The admin authority pubkey for the cashback configuration."
+            ],
             "type": "pubkey"
           },
           {
             "name": "ranges",
+            "docs": [
+              "Balance-based multiplier ranges for progressive cashback tiers."
+            ],
             "type": {
               "vec": {
                 "defined": {
@@ -2685,6 +2766,9 @@ export type LiquidState = {
           },
           {
             "name": "traderCashbackBasisPoints",
+            "docs": [
+              "Base trader cashback rate in basis points (10000 = 100%)."
+            ],
             "type": "u16"
           }
         ]
@@ -2726,11 +2810,17 @@ export type LiquidState = {
     },
     {
       "name": "spendCashbackResult",
+      "docs": [
+        "Result of a cashback spend operation."
+      ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "spent",
+            "docs": [
+              "The amount of credits actually spent (may be less than requested)."
+            ],
             "type": "u64"
           }
         ]
@@ -2786,11 +2876,17 @@ export type LiquidState = {
     },
     {
       "name": "updateConfigArgs",
+      "docs": [
+        "Arguments for updating the cashback configuration."
+      ],
       "type": {
         "kind": "struct",
         "fields": [
           {
             "name": "newRanges",
+            "docs": [
+              "Optional new balance-based multiplier ranges."
+            ],
             "type": {
               "option": {
                 "vec": {
@@ -2803,6 +2899,9 @@ export type LiquidState = {
           },
           {
             "name": "newTraderCashbackBasisPoints",
+            "docs": [
+              "Optional new trader cashback rate in basis points."
+            ],
             "type": {
               "option": "u16"
             }

package/src/idl/liquid_swap.json

@@ -2094,12 +2094,12 @@
     {
       "name": "create",
       "docs": [
-        "Creates a pool for the given token pair and the initial price.",
+        "Creates an AMM pool for the given token pair with an initial deposit.",
         "",
         "# Arguments",
-        "* `init_amount_base` - the initial amount_0 to deposit",
-        "* `init_amount_quote` - the initial amount_1 to deposit",
-        "* `creator` - the creator of the pool"
+        "* `init_amount_base` - Initial base token amount to deposit into the pool.",
+        "* `init_amount_quote` - Initial quote token amount to deposit into the pool.",
+        "* `creator` - Optional creator pubkey (for program-initiated migration pools)."
       ],
       "discriminator": [
         24,
@@ -2826,12 +2826,12 @@
     {
       "name": "deposit",
       "docs": [
-        "Deposit lp token to the pool.",
+        "Deposits liquidity into the pool, minting LP tokens to the owner.",
         "",
         "# Arguments",
-        "* `lp_token_amount` - Increased number of LPs",
-        "* `maximum_base_token_amount` -  Maximum base token amount to deposit, prevents excessive slippage",
-        "* `maximum_quote_token_amount` - Maximum quote token amount to deposit, prevents excessive slippage"
+        "* `lp_token_amount` - Number of LP tokens to mint.",
+        "* `maximum_base_token_amount` - Maximum base tokens willing to deposit (slippage protection).",
+        "* `maximum_quote_token_amount` - Maximum quote tokens willing to deposit (slippage protection)."
       ],
       "discriminator": [
         242,
@@ -2847,12 +2847,15 @@
         {
           "name": "owner",
           "docs": [
-            "Pays to mint the position."
+            "The owner depositing liquidity into the pool."
           ],
           "signer": true
         },
         {
           "name": "pool_state",
+          "docs": [
+            "Pool state account validated against base/quote vaults and LP mint."
+          ],
           "writable": true
         },
         {
@@ -4120,10 +4123,16 @@
       "accounts": [
         {
           "name": "admin",
+          "docs": [
+            "The admin authorized to pause the protocol."
+          ],
           "signer": true
         },
         {
           "name": "global_config",
+          "docs": [
+            "Global configuration account to be updated."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -6343,10 +6352,16 @@
       "accounts": [
         {
           "name": "admin",
+          "docs": [
+            "The admin authorized to unpause the protocol."
+          ],
           "signer": true
         },
         {
           "name": "global_config",
+          "docs": [
+            "Global configuration account to be updated."
+          ],
           "writable": true,
           "pda": {
             "seeds": [
@@ -6500,12 +6515,12 @@
     {
       "name": "withdraw",
       "docs": [
-        "Withdraw lp for base token and quote token.",
+        "Withdraws liquidity from the pool, burning LP tokens and returning base and quote tokens.",
         "",
         "# Arguments",
-        "* `lp_token_amount` - Amount of pool tokens to burn. User receives an output of token a and b based on the percentage of the pool tokens that are returned.",
-        "* `minimum_base_amount` -  Minimum amount of base token to receive, prevents excessive slippage",
-        "* `minimum_quote_amount` -  Minimum amount of quote token to receive, prevents excessive slippage"
+        "* `lp_token_amount` - Number of LP tokens to burn.",
+        "* `minimum_base_amount` - Minimum base tokens expected to receive (slippage protection).",
+        "* `minimum_quote_amount` - Minimum quote tokens expected to receive (slippage protection)."
       ],
       "discriminator": [
         183,
@@ -6521,14 +6536,14 @@
         {
           "name": "owner",
           "docs": [
-            "Pays to mint the position."
+            "The owner withdrawing liquidity from the pool."
           ],
           "signer": true
         },
         {
           "name": "pool_state",
           "docs": [
-            "Pool state account."
+            "Pool state account validated against base/quote vaults and LP mint."
           ],
           "writable": true
         },
@@ -7179,6 +7194,9 @@
     },
     {
       "name": "FeeMode",
+      "docs": [
+        "The fee distribution mode for a token's fee configuration."
+      ],
       "repr": {
         "kind": "rust"
       },
@@ -7196,6 +7214,9 @@
     },
     {
       "name": "FeeRecipient",
+      "docs": [
+        "A fee recipient with their allocation and vault PDA bump."
+      ],
       "repr": {
         "kind": "c"
       },
@@ -7204,18 +7225,30 @@
         "fields": [
           {
             "name": "pubkey",
+            "docs": [
+              "The public key of the fee recipient."
+            ],
             "type": "pubkey"
           },
           {
             "name": "basis_points",
+            "docs": [
+              "The recipient's share of fees in basis points (out of 10,000)."
+            ],
             "type": "u16"
           },
           {
             "name": "vault_bump",
+            "docs": [
+              "The bump seed for the recipient's vault PDA."
+            ],
             "type": "u8"
           },
           {
             "name": "_padding",
+            "docs": [
+              "Padding to align to 8-byte boundary (32 + 2 + 1 + 5 = 40 bytes)."
+            ],
             "type": {
               "array": [
                 "u8",
@@ -7573,6 +7606,11 @@
     },
     {
       "name": "UnifiedFeeConfiguration",
+      "docs": [
+        "Unified fee configuration for a token, supporting both Recipients and Revoked modes.",
+        "",
+        "Stored as a zero-copy account for efficient access in hot paths."
+      ],
       "serialization": "bytemuckunsafe",
       "repr": {
         "kind": "c",