@bropump/sdk 0.2.1 → 0.2.2

package/README.md

@@ -4,53 +4,204 @@ TypeScript SDK for the BroPump API.
 
 ## Install
 
-Install from public npmjs:
-
 ```bash
 npm install @bropump/sdk
 ```
 
-## Example
+## Create a Client
+
+Use the built-in network presets for the normal app environments:
 
 ```ts
 import { BroPumpClient } from '@bropump/sdk'
 
+const mainnet = new BroPumpClient({ network: 'mainnet' })
+const devnet = new BroPumpClient({ network: 'devnet' })
+```
+
+The SDK resolves hosts automatically:
+
+- `mainnet` -> `https://api.bropump.run`
+- `devnet` -> `https://dev.bropump.run`
+
+If you need local or preview infrastructure, keep using `baseUrl` as an override:
+
+```ts
 const client = new BroPumpClient({
-  network: 'mainnet',
+  network: 'devnet',
+  baseUrl: 'http://localhost:3001',
 })
+```
+
+## Config Modes
+
+Launch selection is driven by Cloudflare config binding names, not raw threshold numbers.
+
+Fetch the currently available modes from the API:
+
+```ts
+const launchConfig = await client.launchConfig.get()
+
+console.log(launchConfig.defaultConfigMode)
+console.log(launchConfig.availableConfigModes)
+console.log(launchConfig.configModeOptions)
+```
+
+Each option includes:
+
+- `configMode`, for example `MAINNET_CONFIG_25`
+- `migrationThreshold`, the resolved quote target behind that mode
+- `configAddress`
+- `deploymentMode`
+
+## Launch a Token
+
+```ts
+import { BroPumpClient, BroPumpTokenFailedError } from '@bropump/sdk'
+
+const client = new BroPumpClient({ network: 'devnet' })
 
 const token = await client.tokens.create({
+  mode: 'live',
   name: 'Bro Pump',
   symbol: 'BRO',
   description: 'Simple token flow',
   deployer: 'YOUR_WALLET',
-  migrationThreshold: 35,
+  configMode: 'DEVNET_CONFIG_1',
+  firstBuyAmount: 0.25,
   image: new Blob(['demo'], { type: 'image/png' }),
 })
 
-const ready = await client.tokens.waitForReadyToSign(token.id)
+try {
+  const ready = await client.tokens.waitForReadyToSign(token.id)
+
+  await client.tokens.submitSigned(token.id, {
+    submitId: ready.submit.id,
+    signedTransactions: [
+      /* signed base64 transactions */
+    ],
+  })
+
+  const live = await client.tokens.waitForLive(token.id)
+  console.log(live.pool, live.mint)
+} catch (error) {
+  if (error instanceof BroPumpTokenFailedError) {
+    console.error(error.token.error)
+  }
+  throw error
+}
+```
 
-await client.tokens.submitSigned(token.id, {
-  submitId: ready.submit.id,
-  signedTransactions: ready.submit.transactions.map((tx) => tx),
+## Preview Fees and Curve Data
+
+```ts
+const preview = await client.fees.preview({
+  configMode: 'MAINNET_CONFIG_25',
+  firstBuyAmount: 0.5,
+  deployerWallet: 'YOUR_WALLET',
 })
+
+console.log(preview.selectedConfigMode)
+console.log(preview.curve.migrationThreshold)
+console.log(preview.costQuote.recommendedMinBalanceSol)
 ```
 
-Use `network: 'devnet'` for the dev environment:
+## Polling Helpers
+
+The SDK includes built-in polling helpers for the common launch lifecycle checkpoints:
+
+- `client.tokens.waitForReadyToSign(id, options)`
+- `client.tokens.waitForLive(id, options)`
+- `client.tokens.waitFor(id, predicate, options)`
+
+All wait helpers accept:
+
+- `timeoutMs`
+- `pollIntervalMs`
+- `signal`
+- `stopOnFailed`
+
+## Realtime / WSS
+
+You do not need to manage a separate websocket host manually. The SDK derives `ws://` or `wss://`
+from the API base URL automatically.
+
+### Watch a Token Session
 
 ```ts
-const client = new BroPumpClient({
-  network: 'devnet',
-})
+const stream = await client.tokens.watch(token.id)
+
+for await (const message of stream) {
+  console.log(message.type, message.data)
+
+  if (message.type === 'token_update' && message.data?.status === 'live') {
+    break
+  }
+}
+
+stream.close()
 ```
 
-`baseUrl` remains available as an override for local or preview environments.
+### Wait for a Specific Realtime Event
 
-## Publish
+```ts
+const stream = await client.tokens.watch(token.id)
 
-This package is set up to publish publicly to npmjs under `@bropump/sdk`.
+const readyMessage = await stream.waitFor(
+  (message) =>
+    message.type === 'token_update' &&
+    Boolean(message.data?.submit?.id),
+  30_000
+)
 
-```bash
-cd packages/sdk
-npm publish --access public --registry=https://registry.npmjs.org
+console.log(readyMessage.data?.submit?.id)
+stream.close()
+```
+
+### Watch a Pool Directly
+
+```ts
+const poolStream = await client.tokens.watchPool('POOL_ADDRESS')
+
+for await (const message of poolStream) {
+  console.log(message.type, message.data?.runtime?.phase)
+}
 ```
+
+Common message types:
+
+- `token_snapshot`
+- `token_update`
+- `launch_snapshot`
+- `launch_update`
+- `runtime_snapshot`
+- `runtime_update`
+
+## Manual WSS URL Access
+
+If you need the derived websocket URL for your own socket layer, use `buildWebSocketUrl`:
+
+```ts
+import { buildWebSocketUrl } from '@bropump/sdk'
+
+const wsUrl = buildWebSocketUrl('https://dev.bropump.run', '/tokens/123/ws')
+```
+
+## Errors
+
+Request failures throw `BroPumpApiError`:
+
+```ts
+import { BroPumpApiError } from '@bropump/sdk'
+
+try {
+  await client.health()
+} catch (error) {
+  if (error instanceof BroPumpApiError) {
+    console.error(error.status, error.code, error.body)
+  }
+}
+```
+
+Lifecycle polling helpers throw `BroPumpTokenFailedError` when a token reaches `failed` while
+you are waiting on it.

package/dist/client.js

@@ -198,7 +198,7 @@ function buildCreateTokenFormData(input) {
     appendFormValue(form, 'symbol', input.symbol);
     appendFormValue(form, 'description', input.description);
     appendFormValue(form, 'deployer', input.deployer);
-    appendFormValue(form, 'migrationThreshold', input.migrationThreshold);
+    appendFormValue(form, 'configMode', input.configMode);
     appendFormValue(form, 'firstBuyAmount', input.firstBuyAmount);
     appendFormValue(form, 'x', input.x);
     appendFormValue(form, 'website', input.website);

package/dist/types.d.ts

@@ -38,7 +38,7 @@ export type CreateTokenInput = {
     symbol: string;
     description: string;
     deployer: string;
-    migrationThreshold?: number;
+    configMode?: string;
     firstBuyAmount?: number;
     x?: string;
     website?: string;
@@ -90,19 +90,17 @@ export type LaunchCostQuote = {
     };
     breakdown: LaunchCostBreakdown;
 };
-export type MigrationThresholdOption = {
+export type ConfigModeOption = {
+    configMode: string;
     migrationThreshold: number;
-    presetBinding: string;
     configAddress: string | null;
     deploymentMode: 'predeployed-config' | 'per-launch-config';
 };
 export type LaunchConfigView = {
     network: 'devnet' | 'mainnet';
-    defaultMigrationThreshold: number;
-    allowedMigrationThresholds: number[];
-    availableMigrationThresholds: number[];
-    migrationThresholdOptions: MigrationThresholdOption[];
-    availableMigrationThresholdOptions: MigrationThresholdOption[];
+    defaultConfigMode: string;
+    availableConfigModes: string[];
+    configModeOptions: ConfigModeOption[];
 };
 export type SubmitAction = {
     id: string;
@@ -159,9 +157,8 @@ export type RealtimeMessage<T> = {
     data: T | null;
 };
 export type CurvePreview = {
-    allowedMigrationThresholds: number[];
-    migrationThresholdOptions: MigrationThresholdOption[];
-    selectedMigrationThreshold: number;
+    configModeOptions: ConfigModeOption[];
+    selectedConfigMode: string;
     curve: {
         startingMC: number;
         endingMC: number;
@@ -202,7 +199,7 @@ export type CurvePreview = {
 };
 export type FeePreviewRequest = {
     totalSupply?: string;
-    migrationThreshold?: number;
+    configMode?: string;
     firstBuyAmount?: number;
     deployerWallet?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bropump/sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "TypeScript SDK for the BroPump API",
   "license": "UNLICENSED",
   "type": "module",