@liquid-af/sdk 0.11.1 → 0.11.2

package/dist/idl/liquid_state.json

@@ -10,7 +10,7 @@
         {
             "name": "accept_admin",
             "docs": [
-                "Accept a pending admin transfer, completing the two-step handoff"
+                "Accept a pending admin transfer, completing the two-step handoff."
             ],
             "discriminator": [
                 112,
@@ -245,6 +245,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -262,7 +265,7 @@
         {
             "name": "cancel_admin_transfer",
             "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,
@@ -320,7 +323,7 @@
         {
             "name": "close_deal",
             "docs": [
-                "Admin closes/deletes a deal, returning rent to admin"
+                "Admin closes/deletes a deal, returning rent to admin."
             ],
             "discriminator": [
                 157,
@@ -437,11 +440,11 @@
         {
             "name": "create_deal",
             "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,
@@ -560,6 +563,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -609,6 +615,9 @@
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to credit cashback to."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -733,11 +742,17 @@
             "accounts": [
                 {
                     "name": "payer",
+                    "docs": [
+                        "The payer for account creation."
+                    ],
                     "writable": true,
                     "signer": true
                 },
                 {
                     "name": "cashback_config",
+                    "docs": [
+                        "Cashback configuration account to initialize."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -766,6 +781,9 @@
                 },
                 {
                     "name": "global_curve_volume",
+                    "docs": [
+                        "Global curve volume accumulator to initialize."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -798,6 +816,9 @@
                 },
                 {
                     "name": "global_amm_volume",
+                    "docs": [
+                        "Global AMM volume accumulator to initialize."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -828,6 +849,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -845,7 +869,7 @@
         {
             "name": "initialize_token_volume",
             "docs": [
-                "Initialize a token's volume accumulator with default values"
+                "Initialize a token's volume accumulator with default values."
             ],
             "discriminator": [
                 98,
@@ -917,7 +941,7 @@
         {
             "name": "initialize_user",
             "docs": [
-                "Initialize a user's properties account with default values"
+                "Initialize a user's properties account with default values."
             ],
             "discriminator": [
                 111,
@@ -986,7 +1010,7 @@
         {
             "name": "redeem_deal",
             "docs": [
-                "User redeems their referrer's deal, copying the multiplier"
+                "User redeems their referrer's deal, copying the multiplier."
             ],
             "discriminator": [
                 28,
@@ -1107,8 +1131,8 @@
         {
             "name": "set_cashback_mode",
             "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,
@@ -1123,10 +1147,16 @@
             "accounts": [
                 {
                     "name": "user",
+                    "docs": [
+                        "The user activating spending mode."
+                    ],
                     "signer": true
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to toggle spending mode on."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1216,6 +1246,9 @@
             "accounts": [
                 {
                     "name": "user",
+                    "docs": [
+                        "The user setting their referrer."
+                    ],
                     "signer": true
                 },
                 {
@@ -1228,6 +1261,9 @@
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to set the referrer on."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1307,10 +1343,7 @@
                 "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,
@@ -1339,6 +1372,9 @@
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to debit cashback from."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1420,7 +1456,7 @@
         {
             "name": "take_snapshot",
             "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,
@@ -1594,6 +1630,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -1687,6 +1726,9 @@
             "accounts": [
                 {
                     "name": "payer",
+                    "docs": [
+                        "The payer for the transaction."
+                    ],
                     "writable": true,
                     "signer": true
                 },
@@ -1759,6 +1801,9 @@
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to update volumes on."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1791,6 +1836,9 @@
                 },
                 {
                     "name": "global_amm_volume",
+                    "docs": [
+                        "Global AMM volume accumulator."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1821,6 +1869,9 @@
                 },
                 {
                     "name": "token_volume",
+                    "docs": [
+                        "Token-specific volume accumulator."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -1862,6 +1913,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -1968,6 +2022,9 @@
             "accounts": [
                 {
                     "name": "payer",
+                    "docs": [
+                        "The payer for the transaction."
+                    ],
                     "writable": true,
                     "signer": true
                 },
@@ -2040,6 +2097,9 @@
                 },
                 {
                     "name": "user_properties",
+                    "docs": [
+                        "User properties account to update volumes on."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -2072,6 +2132,9 @@
                 },
                 {
                     "name": "global_curve_volume",
+                    "docs": [
+                        "Global curve volume accumulator."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -2104,6 +2167,9 @@
                 },
                 {
                     "name": "token_volume",
+                    "docs": [
+                        "Token-specific volume accumulator."
+                    ],
                     "writable": true,
                     "pda": {
                         "seeds": [
@@ -2145,6 +2211,9 @@
                 },
                 {
                     "name": "system_program",
+                    "docs": [
+                        "System program."
+                    ],
                     "address": "11111111111111111111111111111111"
                 }
             ],
@@ -2457,6 +2526,9 @@
     "types": [
         {
             "name": "AdminUpdateUserArgs",
+            "docs": [
+                "Arguments for admin-updating a user's referrer or cashback multiplier."
+            ],
             "type": {
                 "kind": "struct",
                 "fields": [
@@ -2660,15 +2732,24 @@
         },
         {
             "name": "InitializeConfigArgs",
+            "docs": [
+                "Arguments for initializing the global cashback and volume configuration."
+            ],
             "type": {
                 "kind": "struct",
                 "fields": [
                     {
                         "name": "admin_authority",
+                        "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": {
@@ -2679,6 +2760,9 @@
                     },
                     {
                         "name": "trader_cashback_basis_points",
+                        "docs": [
+                            "Base trader cashback rate in basis points (10000 = 100%)."
+                        ],
                         "type": "u16"
                     }
                 ]
@@ -2720,11 +2804,17 @@
         },
         {
             "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"
                     }
                 ]
@@ -2780,11 +2870,17 @@
         },
         {
             "name": "UpdateConfigArgs",
+            "docs": [
+                "Arguments for updating the cashback configuration."
+            ],
             "type": {
                 "kind": "struct",
                 "fields": [
                     {
                         "name": "new_ranges",
+                        "docs": [
+                            "Optional new balance-based multiplier ranges."
+                        ],
                         "type": {
                             "option": {
                                 "vec": {
@@ -2797,6 +2893,9 @@
                     },
                     {
                         "name": "new_trader_cashback_basis_points",
+                        "docs": [
+                            "Optional new trader cashback rate in basis points."
+                        ],
                         "type": {
                             "option": "u16"
                         }

package/dist/idl/liquid_swap.d.ts

@@ -2100,12 +2100,12 @@ export type LiquidSwap = {
         {
             "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,
@@ -2832,12 +2832,12 @@ export type LiquidSwap = {
         {
             "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,
@@ -2853,12 +2853,15 @@ export type LiquidSwap = {
                 {
                     "name": "owner";
                     "docs": [
-                        "Pays to mint the position."
+                        "The owner depositing liquidity into the pool."
                     ];
                     "signer": true;
                 },
                 {
                     "name": "poolState";
+                    "docs": [
+                        "Pool state account validated against base/quote vaults and LP mint."
+                    ];
                     "writable": true;
                 },
                 {
@@ -4126,10 +4129,16 @@ export type LiquidSwap = {
             "accounts": [
                 {
                     "name": "admin";
+                    "docs": [
+                        "The admin authorized to pause the protocol."
+                    ];
                     "signer": true;
                 },
                 {
                     "name": "globalConfig";
+                    "docs": [
+                        "Global configuration account to be updated."
+                    ];
                     "writable": true;
                     "pda": {
                         "seeds": [
@@ -6349,10 +6358,16 @@ export type LiquidSwap = {
             "accounts": [
                 {
                     "name": "admin";
+                    "docs": [
+                        "The admin authorized to unpause the protocol."
+                    ];
                     "signer": true;
                 },
                 {
                     "name": "globalConfig";
+                    "docs": [
+                        "Global configuration account to be updated."
+                    ];
                     "writable": true;
                     "pda": {
                         "seeds": [
@@ -6506,12 +6521,12 @@ export type LiquidSwap = {
         {
             "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,
@@ -6527,14 +6542,14 @@ export type LiquidSwap = {
                 {
                     "name": "owner";
                     "docs": [
-                        "Pays to mint the position."
+                        "The owner withdrawing liquidity from the pool."
                     ];
                     "signer": true;
                 },
                 {
                     "name": "poolState";
                     "docs": [
-                        "Pool state account."
+                        "Pool state account validated against base/quote vaults and LP mint."
                     ];
                     "writable": true;
                 },
@@ -7185,6 +7200,9 @@ export type LiquidSwap = {
         },
         {
             "name": "feeMode";
+            "docs": [
+                "The fee distribution mode for a token's fee configuration."
+            ];
             "repr": {
                 "kind": "rust";
             };
@@ -7202,6 +7220,9 @@ export type LiquidSwap = {
         },
         {
             "name": "feeRecipient";
+            "docs": [
+                "A fee recipient with their allocation and vault PDA bump."
+            ];
             "repr": {
                 "kind": "c";
             };
@@ -7210,18 +7231,30 @@ export type LiquidSwap = {
                 "fields": [
                     {
                         "name": "pubkey";
+                        "docs": [
+                            "The public key of the fee recipient."
+                        ];
                         "type": "pubkey";
                     },
                     {
                         "name": "basisPoints";
+                        "docs": [
+                            "The recipient's share of fees in basis points (out of 10,000)."
+                        ];
                         "type": "u16";
                     },
                     {
                         "name": "vaultBump";
+                        "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",
@@ -7579,6 +7612,11 @@ export type LiquidSwap = {
         },
         {
             "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";