@gabox-labs/sdk 0.7.0 → 0.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gabox-labs/sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "description": "The Solana Kit SDK for gabox: generated instruction builders, PDAs, Raydium LaunchLab and CPMM venue accounts, and the pack flow.",
   "license": "MIT",

package/skills/gabox-sdk/SKILL.md

@@ -27,7 +27,9 @@ the WSOL account afterwards, so the wallet spends and receives plain SOL; that c
 WSOL the wallet already held. On any other pool a route provider swaps SOL into the quote token **in
 the same transaction** as the Gabox instruction, and back after a sale. `createClient` gives mainnet
 `jupiterRoute()`; devnet has no router, so pass `route: raydiumCpmmRoute(pool)` with a CPMM pool for
-the SOL pair. `payWith: 'quote'` and `receive: 'quote'` skip the swap.
+the SOL pair. `payWith: 'quote'` and `receive: 'quote'` skip the swap. Only packs and sales swap: a
+machine's seed is always paid by its creator, in the machine's own quote token, so `createMachine`
+has no `payWith` and the creator must hold `maxSeedQuoteIn` of that token first.
 
 ```ts
 import { buyPack, createClient, getOffer } from '@gabox-labs/sdk';
@@ -53,7 +55,7 @@ For creation use `createMachine` with `name`, `symbol`, `uri`, `maxSeedQuoteIn`
 `maxSeedNativeDebit`. Metaplex limits the three strings to 32, 10 and 200 UTF-8 bytes. Add
 `quote: { mint }` and `raise` for a machine priced in another token: `raise` is
 `total_quote_fund_raising` in that token's base units, and a WSOL pool uses the raise the program
-pins instead. Everything else about the launch is pinned. It buys a mandatory seed: enough for a 3x
+pins instead. `seedCostEstimate` says what the seed costs in that token. Everything else about the launch is pinned. It buys a mandatory seed: enough for a 3x
 top prize on the first pack, or the table's full top prize when that pays less than 3x. A table's
 top tier can be at most 20x. Pass `extraSeedTokens` to buy more seed in the same trade, and read
 `seedCostEstimate` for the mandatory, extra and total amounts plus the exact cost.

package/skills/gabox-sdk/references/api.md

@@ -31,22 +31,27 @@ Each returns a kit transaction message. Nothing here signs or sends.
 
 | Function | Input highlights |
 | --- | --- |
-| `createMachine` | `name`, `symbol`, `uri`, `tiers?`, `quote?`, `raise?`, `payWith?`, `maxSeedQuoteIn`, `maxSeedNativeDebit`, `extraSeedTokens?` |
+| `createMachine` | `name`, `symbol`, `uri`, `tiers?`, `quote?`, `raise?`, `maxSeedQuoteIn`, `maxSeedNativeDebit`, `extraSeedTokens?` |
 | `buyPack` | `maxQuoteIn`, `minMaximum`, `maxNativeDebit`, `payWith?`, `venue?`, `seq?` |
 | `fundPrizes` | donate coins the funder already holds into the prize vault |
 | `sellTokens` | `amount`, `minQuoteOutput`, `maxNativeDebit`, `receive?`, `venue?` |
 | `retryDraw` / `expireDraw` | permissionless recovery |
 | `raydium.claimCreatorFee` | `creator`, `quoteMint?`; sweeps every coin that wallet launched against that quote |
 | `raydium.collectCreatorFee` | `mint`, `creator`; one graduated coin's CPMM creator fee |
+| `raydium.claimPlatformFee` | `feeWallet`, `quoteMint?`; the platform's curve share on that quote, signed by the platform fee wallet |
+| `raydium.harvestLockedFees` | `owner`, `position`, `feeLp?`; one graduated coin's locked-LP fees, signed by the fee NFT holder |
 
 On a WSOL pool every builder wraps the SOL its trade needs into the wallet's WSOL account and closes
 that account afterwards, so the wallet spends and receives plain SOL. Closing unwraps any WSOL the
 wallet already held.
 
-On any other pool the wallet's quote account is created if missing, and `payWith: 'sol'` (the
-default) prepends a swap that turns SOL into the quote token. `receive: 'sol'` appends the reverse
-after a sale. `payWith: 'quote'` and `receive: 'quote'` skip the swap. The swap and the Gabox
-instruction always share one transaction.
+On any other pool the wallet's quote account is created if missing, and `buyPack`'s `payWith: 'sol'`
+(the default) prepends a swap that turns SOL into the quote token. `receive: 'sol'` appends the
+reverse after a sale. `payWith: 'quote'` and `receive: 'quote'` skip the swap. The swap and the
+Gabox instruction always share one transaction.
+
+`createMachine` never swaps. The seed is the creator's own money, in the machine's quote token, so
+the creator must hold at least `maxSeedQuoteIn` of it before the transaction runs.
 
 `createMachine` builds one transaction with LaunchLab's `initialize_v2` first and `initialize_pool`
 second. The mint keypair and the creator both sign. It buys a mandatory seed,
@@ -68,8 +73,9 @@ the VRF request on a pack buy.
 `createMachine` takes `quote: { mint }` and `raise`. The quote defaults to wrapped SOL, whose raise
 the program pins per cluster; any other quote needs a `raise` in its own base units, at or above
 `min_quote_fund_raising` in its config. `seedCostEstimate(client, tiers?, { extraSeedTokens?,
-quote?, raise? })` reports the seed cost in the quote token, its decimals and symbol, the raise, and
-`solAmount` through the route provider.
+quote?, raise? })` reports the seed cost in the quote token, which is what the creator pays, plus
+its decimals and symbol, the raise, and `solAmount`: what that cost is worth in SOL through the
+route provider, for a display.
 
 ## The venue
 
@@ -82,6 +88,9 @@ quote?, raise? })` reports the seed cost in the quote token, its decimals and sy
 | `raydium.findCpmmPool(client, { mint, creator, cpswapConfig, quoteMint? })` | the migrated CPMM pool, proved from its own data |
 | `raydium.fetchCurveSettings(client, quoteConfig)` | the fee rates, the migrate fee and the CPMM fee tier, read from chain |
 | `raydium.fetchCreatorFees(client, { creator, mint?, quoteMint? })` | `{ quoteMint, curveQuote, cpmmQuote, cpmmTokens }` |
+| `raydium.fetchPlatformFees(client, { quoteMint? })` | `{ quoteMint, curveQuote }`, the platform's LaunchLab vault for that quote |
+| `raydium.fetchLockedPositions(client, owner)` | `LockedPosition[]`: one per fee NFT the wallet holds, with `poolAddress`, `pool`, `claimableLp`, `claimableToken0`, `claimableToken1` |
+| `raydium.lockedFeeLp(lock, pool)` | the LP a locked position may withdraw now, from `lastK`, `lastLp`, the vaults and the LP supply |
 | `raydium.fetchQuoteConfig(client, mint)` | LaunchLab's global config for a quote, or `null` |
 | `raydium.isQuoteSupported(client, mint)` | can a machine be priced in this mint? |
 | `raydium.fetchQuoteAsset(client, mint)` | the config, token program, decimals, symbol and minimum raise |