@hodlmarkets/sdk 0.1.0

package/README.md

@@ -0,0 +1,121 @@
+# @hodlmarkets/sdk
+
+TypeScript SDK for the HODL vAMM program on Solana.
+
+Full documentation at [docs.hodl.markets](https://docs.hodl.markets)
+
+## Install
+
+```bash
+npm install @hodlmarkets/sdk
+```
+
+Peer dependencies:
+
+```bash
+npm install @coral-xyz/anchor @solana/web3.js @solana/spl-token bn.js
+```
+
+## Buy
+
+```ts
+import { Connection } from '@solana/web3.js'
+import BN from 'bn.js'
+import { HodlClient, calculateBuyAmount, applySlippage } from '@hodlmarkets/sdk'
+
+const connection = new Connection('https://api.mainnet-beta.solana.com')
+const client = new HodlClient({ connection })
+
+const pool = await client.fetchPool(mint)
+
+const solAmount = new BN('100000000') // 0.1 SOL
+const expectedTokens = calculateBuyAmount(solAmount, pool.vammRealSol, pool.vammTokens, pool.vammK)
+const minTokensOut = applySlippage(expectedTokens, 100) // 1% slippage
+
+const tx = await client.buy({ buyer: wallet.publicKey, mint, solAmount, minTokensOut })
+tx.sign([wallet])
+const signature = await client.send(tx)
+```
+
+## Sell
+
+```ts
+import { HodlClient, calculateSellAmount, applySlippage, getPoolStatePDA, PROGRAM_ID } from '@hodlmarkets/sdk'
+
+const pool = await client.fetchPool(mint)
+const [poolState] = getPoolStatePDA(mint, PROGRAM_ID)
+const position = await client.fetchPosition(poolState, wallet.publicKey)
+
+const expectedSol = calculateSellAmount(position.tradableTokens, pool.vammRealSol, pool.vammTokens, pool.vammK)
+
+const tx = await client.sell({
+  seller: wallet.publicKey,
+  mint,
+  tokenAmount: position.tradableTokens,
+  minSolOut: applySlippage(expectedSol, 100),
+})
+tx.sign([wallet])
+await client.send(tx)
+```
+
+## Create Token
+
+```ts
+import { Keypair } from '@solana/web3.js'
+import BN from 'bn.js'
+
+const mint = Keypair.generate()
+
+const tx = await client.createToken({
+  creator: wallet.publicKey,
+  mint: mint.publicKey,
+  name: 'My Token',
+  symbol: 'MTK',
+  uri: 'https://arweave.net/metadata.json',
+  poolDescription: 'A community token',
+  vestDuration: new BN(60), // 1 minute (only 60 or 600 allowed)
+})
+tx.sign([wallet, mint]) // both creator and mint must sign
+await client.send(tx)
+```
+
+## Claim Accrued Tokens
+
+```ts
+const [poolState] = getPoolStatePDA(mint, PROGRAM_ID)
+const tx = await client.claimAccrued({ owner: wallet.publicKey, poolState })
+tx.sign([wallet])
+await client.send(tx)
+```
+
+## Events
+
+```ts
+// Real-time
+const subId = client.subscribeToEvents((event, slot, signature) => {
+  if (event.name === 'tokenPurchased') {
+    console.log('Buy:', event.data.tokensReceived.toString())
+  }
+})
+await client.unsubscribe(subId)
+
+// Historical
+const events = await client.fetchAndParseTransaction(signature)
+```
+
+## Error Handling
+
+```ts
+import { parseHodlError } from '@hodlmarkets/sdk'
+
+try {
+  await client.send(tx)
+} catch (err) {
+  const hodlErr = parseHodlError(err)
+  if (hodlErr) console.error(`HODL error ${hodlErr.code}: ${hodlErr.message}`)
+}
+```
+
+## License
+
+MIT