@liquid-af/sdk 0.10.1 → 0.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +2 -2
  2. package/dist/accounts/liquid-state.d.ts +10 -10
  3. package/dist/client.d.ts +10 -10
  4. package/dist/events/types.d.ts +1 -2
  5. package/dist/events/types.d.ts.map +1 -1
  6. package/dist/helpers/preview.d.ts.map +1 -1
  7. package/dist/helpers/preview.js +21 -48
  8. package/dist/helpers/preview.js.map +1 -1
  9. package/dist/idl/liquid.d.ts +67 -60
  10. package/dist/idl/liquid.d.ts.map +1 -1
  11. package/dist/idl/liquid.json +67 -60
  12. package/dist/idl/liquid_events.d.ts +3 -10
  13. package/dist/idl/liquid_events.d.ts.map +1 -1
  14. package/dist/idl/liquid_events.json +3 -10
  15. package/dist/idl/liquid_fees.d.ts +12 -23
  16. package/dist/idl/liquid_fees.d.ts.map +1 -1
  17. package/dist/idl/liquid_fees.json +12 -23
  18. package/dist/idl/liquid_state.d.ts +108 -64
  19. package/dist/idl/liquid_state.d.ts.map +1 -1
  20. package/dist/idl/liquid_state.json +108 -64
  21. package/dist/idl/liquid_swap.d.ts +19 -12
  22. package/dist/idl/liquid_swap.d.ts.map +1 -1
  23. package/dist/idl/liquid_swap.json +19 -12
  24. package/dist/types.d.ts +5 -5
  25. package/package.json +1 -1
  26. package/src/events/types.ts +1 -2
  27. package/src/helpers/preview.ts +46 -48
  28. package/src/idl/liquid.json +67 -60
  29. package/src/idl/liquid.ts +67 -60
  30. package/src/idl/liquid_events.json +3 -10
  31. package/src/idl/liquid_events.ts +3 -10
  32. package/src/idl/liquid_fees.json +12 -23
  33. package/src/idl/liquid_fees.ts +12 -23
  34. package/src/idl/liquid_state.json +108 -64
  35. package/src/idl/liquid_state.ts +108 -64
  36. package/src/idl/liquid_swap.json +19 -12
  37. package/src/idl/liquid_swap.ts +19 -12
  38. package/src/types.ts +5 -5
@@ -214,7 +214,7 @@
214
214
  {
215
215
  "name": "user",
216
216
  "docs": [
217
- "The user buying tokens."
217
+ "The user executing the trade."
218
218
  ],
219
219
  "writable": true,
220
220
  "signer": true
@@ -365,14 +365,14 @@
365
365
  {
366
366
  "name": "user_token_account",
367
367
  "docs": [
368
- "User's token account to receive bought tokens."
368
+ "User's token account for the traded token."
369
369
  ],
370
370
  "writable": true
371
371
  },
372
372
  {
373
373
  "name": "fee_vault",
374
374
  "docs": [
375
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
375
+ "The fee vault (for Recipients mode, from liquid-fees)."
376
376
  ],
377
377
  "writable": true,
378
378
  "pda": {
@@ -515,7 +515,7 @@
515
515
  {
516
516
  "name": "mint",
517
517
  "docs": [
518
- "The mint of the token being bought."
518
+ "The mint of the traded token."
519
519
  ]
520
520
  },
521
521
  {
@@ -528,7 +528,7 @@
528
528
  {
529
529
  "name": "fee_config",
530
530
  "docs": [
531
- "The fee configuration for this token."
531
+ "The fee configuration for this token (from liquid-fees program)."
532
532
  ],
533
533
  "pda": {
534
534
  "seeds": [
@@ -1140,7 +1140,7 @@
1140
1140
  {
1141
1141
  "name": "user",
1142
1142
  "docs": [
1143
- "The user buying tokens."
1143
+ "The user executing the trade."
1144
1144
  ],
1145
1145
  "writable": true,
1146
1146
  "signer": true
@@ -1307,21 +1307,21 @@
1307
1307
  {
1308
1308
  "name": "user_token_account",
1309
1309
  "docs": [
1310
- "User's base token account to receive bought tokens."
1310
+ "User's base token account for the traded token."
1311
1311
  ],
1312
1312
  "writable": true
1313
1313
  },
1314
1314
  {
1315
1315
  "name": "user_quote_account",
1316
1316
  "docs": [
1317
- "User's quote token account (e.g., USDC) to pay from."
1317
+ "User's quote token account (e.g., USDC)."
1318
1318
  ],
1319
1319
  "writable": true
1320
1320
  },
1321
1321
  {
1322
1322
  "name": "fee_vault",
1323
1323
  "docs": [
1324
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
1324
+ "The fee vault (for Recipients mode, from liquid-fees)."
1325
1325
  ],
1326
1326
  "writable": true,
1327
1327
  "pda": {
@@ -1533,7 +1533,7 @@
1533
1533
  {
1534
1534
  "name": "mint",
1535
1535
  "docs": [
1536
- "The base token mint being bought."
1536
+ "The base token mint being traded."
1537
1537
  ]
1538
1538
  },
1539
1539
  {
@@ -2158,7 +2158,7 @@
2158
2158
  {
2159
2159
  "name": "user",
2160
2160
  "docs": [
2161
- "The user buying tokens."
2161
+ "The user executing the trade."
2162
2162
  ],
2163
2163
  "writable": true,
2164
2164
  "signer": true
@@ -2309,14 +2309,14 @@
2309
2309
  {
2310
2310
  "name": "user_token_account",
2311
2311
  "docs": [
2312
- "User's token account to receive bought tokens."
2312
+ "User's token account for the traded token."
2313
2313
  ],
2314
2314
  "writable": true
2315
2315
  },
2316
2316
  {
2317
2317
  "name": "fee_vault",
2318
2318
  "docs": [
2319
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
2319
+ "The fee vault (for Recipients mode, from liquid-fees)."
2320
2320
  ],
2321
2321
  "writable": true,
2322
2322
  "pda": {
@@ -2459,7 +2459,7 @@
2459
2459
  {
2460
2460
  "name": "mint",
2461
2461
  "docs": [
2462
- "The mint of the token being bought."
2462
+ "The mint of the traded token."
2463
2463
  ]
2464
2464
  },
2465
2465
  {
@@ -2472,7 +2472,7 @@
2472
2472
  {
2473
2473
  "name": "fee_config",
2474
2474
  "docs": [
2475
- "The fee configuration for this token."
2475
+ "The fee configuration for this token (from liquid-fees program)."
2476
2476
  ],
2477
2477
  "pda": {
2478
2478
  "seeds": [
@@ -3084,7 +3084,7 @@
3084
3084
  {
3085
3085
  "name": "user",
3086
3086
  "docs": [
3087
- "The user buying tokens."
3087
+ "The user executing the trade."
3088
3088
  ],
3089
3089
  "writable": true,
3090
3090
  "signer": true
@@ -3251,21 +3251,21 @@
3251
3251
  {
3252
3252
  "name": "user_token_account",
3253
3253
  "docs": [
3254
- "User's base token account to receive bought tokens."
3254
+ "User's base token account for the traded token."
3255
3255
  ],
3256
3256
  "writable": true
3257
3257
  },
3258
3258
  {
3259
3259
  "name": "user_quote_account",
3260
3260
  "docs": [
3261
- "User's quote token account (e.g., USDC) to pay from."
3261
+ "User's quote token account (e.g., USDC)."
3262
3262
  ],
3263
3263
  "writable": true
3264
3264
  },
3265
3265
  {
3266
3266
  "name": "fee_vault",
3267
3267
  "docs": [
3268
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
3268
+ "The fee vault (for Recipients mode, from liquid-fees)."
3269
3269
  ],
3270
3270
  "writable": true,
3271
3271
  "pda": {
@@ -3477,7 +3477,7 @@
3477
3477
  {
3478
3478
  "name": "mint",
3479
3479
  "docs": [
3480
- "The base token mint being bought."
3480
+ "The base token mint being traded."
3481
3481
  ]
3482
3482
  },
3483
3483
  {
@@ -8389,7 +8389,7 @@
8389
8389
  {
8390
8390
  "name": "user",
8391
8391
  "docs": [
8392
- "The user selling tokens."
8392
+ "The user executing the trade."
8393
8393
  ],
8394
8394
  "writable": true,
8395
8395
  "signer": true
@@ -8540,14 +8540,14 @@
8540
8540
  {
8541
8541
  "name": "user_token_account",
8542
8542
  "docs": [
8543
- "User's token account to send sold tokens from."
8543
+ "User's token account for the traded token."
8544
8544
  ],
8545
8545
  "writable": true
8546
8546
  },
8547
8547
  {
8548
8548
  "name": "fee_vault",
8549
8549
  "docs": [
8550
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
8550
+ "The fee vault (for Recipients mode, from liquid-fees)."
8551
8551
  ],
8552
8552
  "writable": true,
8553
8553
  "pda": {
@@ -8690,7 +8690,7 @@
8690
8690
  {
8691
8691
  "name": "mint",
8692
8692
  "docs": [
8693
- "The mint of the token being sold."
8693
+ "The mint of the traded token."
8694
8694
  ]
8695
8695
  },
8696
8696
  {
@@ -8773,7 +8773,7 @@
8773
8773
  {
8774
8774
  "name": "creator_user_properties",
8775
8775
  "docs": [
8776
- "Creator's user properties from liquid-state"
8776
+ "Creator's user properties from liquid-state."
8777
8777
  ],
8778
8778
  "pda": {
8779
8779
  "seeds": [
@@ -9315,7 +9315,7 @@
9315
9315
  {
9316
9316
  "name": "user",
9317
9317
  "docs": [
9318
- "The user selling tokens."
9318
+ "The user executing the trade."
9319
9319
  ],
9320
9320
  "writable": true,
9321
9321
  "signer": true
@@ -9482,21 +9482,21 @@
9482
9482
  {
9483
9483
  "name": "user_token_account",
9484
9484
  "docs": [
9485
- "User's base token account to send sold tokens from."
9485
+ "User's base token account for the traded token."
9486
9486
  ],
9487
9487
  "writable": true
9488
9488
  },
9489
9489
  {
9490
9490
  "name": "user_quote_account",
9491
9491
  "docs": [
9492
- "User's quote token account (e.g., USDC) to receive payment."
9492
+ "User's quote token account (e.g., USDC)."
9493
9493
  ],
9494
9494
  "writable": true
9495
9495
  },
9496
9496
  {
9497
9497
  "name": "fee_vault",
9498
9498
  "docs": [
9499
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
9499
+ "The fee vault (for Recipients mode, from liquid-fees)."
9500
9500
  ],
9501
9501
  "writable": true,
9502
9502
  "pda": {
@@ -9708,7 +9708,7 @@
9708
9708
  {
9709
9709
  "name": "mint",
9710
9710
  "docs": [
9711
- "The base token mint being sold."
9711
+ "The base token mint being traded."
9712
9712
  ]
9713
9713
  },
9714
9714
  {
@@ -10333,7 +10333,7 @@
10333
10333
  {
10334
10334
  "name": "user",
10335
10335
  "docs": [
10336
- "The user selling tokens."
10336
+ "The user executing the trade."
10337
10337
  ],
10338
10338
  "writable": true,
10339
10339
  "signer": true
@@ -10484,14 +10484,14 @@
10484
10484
  {
10485
10485
  "name": "user_token_account",
10486
10486
  "docs": [
10487
- "User's token account to send sold tokens from."
10487
+ "User's token account for the traded token."
10488
10488
  ],
10489
10489
  "writable": true
10490
10490
  },
10491
10491
  {
10492
10492
  "name": "fee_vault",
10493
10493
  "docs": [
10494
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
10494
+ "The fee vault (for Recipients mode, from liquid-fees)."
10495
10495
  ],
10496
10496
  "writable": true,
10497
10497
  "pda": {
@@ -10634,7 +10634,7 @@
10634
10634
  {
10635
10635
  "name": "mint",
10636
10636
  "docs": [
10637
- "The mint of the token being sold."
10637
+ "The mint of the traded token."
10638
10638
  ]
10639
10639
  },
10640
10640
  {
@@ -10717,7 +10717,7 @@
10717
10717
  {
10718
10718
  "name": "creator_user_properties",
10719
10719
  "docs": [
10720
- "Creator's user properties from liquid-state"
10720
+ "Creator's user properties from liquid-state."
10721
10721
  ],
10722
10722
  "pda": {
10723
10723
  "seeds": [
@@ -11259,7 +11259,7 @@
11259
11259
  {
11260
11260
  "name": "user",
11261
11261
  "docs": [
11262
- "The user selling tokens."
11262
+ "The user executing the trade."
11263
11263
  ],
11264
11264
  "writable": true,
11265
11265
  "signer": true
@@ -11426,21 +11426,21 @@
11426
11426
  {
11427
11427
  "name": "user_token_account",
11428
11428
  "docs": [
11429
- "User's base token account to send sold tokens from."
11429
+ "User's base token account for the traded token."
11430
11430
  ],
11431
11431
  "writable": true
11432
11432
  },
11433
11433
  {
11434
11434
  "name": "user_quote_account",
11435
11435
  "docs": [
11436
- "User's quote token account (e.g., USDC) to receive payment."
11436
+ "User's quote token account (e.g., USDC)."
11437
11437
  ],
11438
11438
  "writable": true
11439
11439
  },
11440
11440
  {
11441
11441
  "name": "fee_vault",
11442
11442
  "docs": [
11443
- "The fee vault (for Direct/Recipients mode, from liquid-fees)."
11443
+ "The fee vault (for Recipients mode, from liquid-fees)."
11444
11444
  ],
11445
11445
  "writable": true,
11446
11446
  "pda": {
@@ -11652,7 +11652,7 @@
11652
11652
  {
11653
11653
  "name": "mint",
11654
11654
  "docs": [
11655
- "The base token mint being sold."
11655
+ "The base token mint being traded."
11656
11656
  ]
11657
11657
  },
11658
11658
  {
@@ -13219,7 +13219,9 @@
13219
13219
  {
13220
13220
  "name": "ranges",
13221
13221
  "docs": [
13222
- "Volume-based multiplier ranges (use len() for active count)"
13222
+ "Balance-based multiplier ranges (use len() for active count).",
13223
+ "Thresholds refer to the user's cashback credit balance. Multiplier is",
13224
+ "applied progressively as credits are earned, not at mode-switch."
13223
13225
  ],
13224
13226
  "type": {
13225
13227
  "vec": {
@@ -13251,7 +13253,12 @@
13251
13253
  {
13252
13254
  "name": "CashbackRange",
13253
13255
  "docs": [
13254
- "Cashback range defining volume-based multiplier tiers"
13256
+ "Cashback range defining balance-based multiplier tiers.",
13257
+ "",
13258
+ "Each range maps a cashback balance interval to a multiplier. When a user earns",
13259
+ "cashback, the earned amount is multiplied by the tier corresponding to their",
13260
+ "current balance. If earning crosses a tier boundary, the amount is split so",
13261
+ "each portion receives its respective tier's multiplier."
13255
13262
  ],
13256
13263
  "type": {
13257
13264
  "kind": "struct",
@@ -13259,14 +13266,14 @@
13259
13266
  {
13260
13267
  "name": "range_start_inclusive",
13261
13268
  "docs": [
13262
- "Lower bound of volume range (inclusive)"
13269
+ "Lower bound of balance range (inclusive), in USD with 6 decimals"
13263
13270
  ],
13264
13271
  "type": "u64"
13265
13272
  },
13266
13273
  {
13267
13274
  "name": "range_end_exclusive",
13268
13275
  "docs": [
13269
- "Upper bound of volume range (exclusive)"
13276
+ "Upper bound of balance range (exclusive), in USD with 6 decimals"
13270
13277
  ],
13271
13278
  "type": "u64"
13272
13279
  },
@@ -13563,9 +13570,9 @@
13563
13570
  "kind": "struct",
13564
13571
  "fields": [
13565
13572
  {
13566
- "name": "total_sol_volume",
13573
+ "name": "total_usd_volume",
13567
13574
  "docs": [
13568
- "Total SOL volume across all curve trades"
13575
+ "Total USD volume across all curve trades (6 decimals)"
13569
13576
  ],
13570
13577
  "type": "u128"
13571
13578
  },
@@ -13795,9 +13802,9 @@
13795
13802
  "type": "pubkey"
13796
13803
  },
13797
13804
  {
13798
- "name": "total_sol_volume",
13805
+ "name": "total_usd_volume",
13799
13806
  "docs": [
13800
- "Total SOL volume for this token (curve + AMM)"
13807
+ "Total USD volume for this token (curve + AMM, 6 decimals)"
13801
13808
  ],
13802
13809
  "type": "u128"
13803
13810
  },
@@ -13809,16 +13816,16 @@
13809
13816
  "type": "u128"
13810
13817
  },
13811
13818
  {
13812
- "name": "curve_sol_volume",
13819
+ "name": "curve_usd_volume",
13813
13820
  "docs": [
13814
- "SOL volume from curve trades (for analytics)"
13821
+ "USD volume from curve trades (for analytics)"
13815
13822
  ],
13816
13823
  "type": "u128"
13817
13824
  },
13818
13825
  {
13819
- "name": "amm_sol_volume",
13826
+ "name": "amm_usd_volume",
13820
13827
  "docs": [
13821
- "SOL volume from AMM trades (for analytics)"
13828
+ "USD volume from AMM trades (for analytics)"
13822
13829
  ],
13823
13830
  "type": "u128"
13824
13831
  }
@@ -13933,9 +13940,9 @@
13933
13940
  }
13934
13941
  },
13935
13942
  {
13936
- "name": "total_sol_volume",
13943
+ "name": "total_usd_volume",
13937
13944
  "docs": [
13938
- "Total SOL volume traded across both curve and AMM (used for cashback multiplier)"
13945
+ "Total USD volume traded across both curve and AMM"
13939
13946
  ],
13940
13947
  "type": "u128"
13941
13948
  },
@@ -13961,23 +13968,23 @@
13961
13968
  "type": "bool"
13962
13969
  },
13963
13970
  {
13964
- "name": "curve_sol_volume",
13971
+ "name": "curve_usd_volume",
13965
13972
  "docs": [
13966
- "SOL volume from curve trades only (for analytics)"
13973
+ "USD volume from curve trades only (for analytics)"
13967
13974
  ],
13968
13975
  "type": "u128"
13969
13976
  },
13970
13977
  {
13971
- "name": "amm_sol_volume",
13978
+ "name": "amm_usd_volume",
13972
13979
  "docs": [
13973
- "SOL volume from AMM trades only (for analytics)"
13980
+ "USD volume from AMM trades only (for analytics)"
13974
13981
  ],
13975
13982
  "type": "u128"
13976
13983
  },
13977
13984
  {
13978
- "name": "snapshot_sol_volume",
13985
+ "name": "snapshot_usd_volume",
13979
13986
  "docs": [
13980
- "SOL volume accumulated since the last snapshot (resets on snapshot)"
13987
+ "USD volume accumulated since the last snapshot (resets on snapshot)"
13981
13988
  ],
13982
13989
  "type": "u128"
13983
13990
  },
@@ -1165,13 +1165,6 @@ export type LiquidEvents = {
1165
1165
  ];
1166
1166
  "type": "pubkey";
1167
1167
  },
1168
- {
1169
- "name": "multiplierBps";
1170
- "docs": [
1171
- "Cashback multiplier in basis points."
1172
- ];
1173
- "type": "u16";
1174
- },
1175
1168
  {
1176
1169
  "name": "timestamp";
1177
1170
  "docs": [
@@ -2272,9 +2265,9 @@ export type LiquidEvents = {
2272
2265
  "type": "u32";
2273
2266
  },
2274
2267
  {
2275
- "name": "solVolume";
2268
+ "name": "usdVolume";
2276
2269
  "docs": [
2277
- "SOL volume at snapshot time."
2270
+ "USD volume at snapshot time."
2278
2271
  ];
2279
2272
  "type": "u128";
2280
2273
  },
@@ -2628,7 +2621,7 @@ export type LiquidEvents = {
2628
2621
  {
2629
2622
  "name": "tradeAmounts";
2630
2623
  "docs": [
2631
- "Trade amount variants for bonding curve trades."
2624
+ "Trade amount variants for bonding curve and AMM trades."
2632
2625
  ];
2633
2626
  "type": {
2634
2627
  "kind": "enum";