@bropump/sdk 0.2.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BroPump
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,56 +1,210 @@
 # @bropump/sdk
 
-TypeScript SDK for the BroPump API.
+TypeScript SDK for BroPump launches, fee previews, and realtime launch sessions.
 
 ## 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',
 })
+```
+
+## Launch Modes
+
+Launch modes are the current available token fee, liquidity, and bonding setups.
+
+Fetch the currently available launch modes from the API:
+
+```ts
+const launchConfig = await client.launchConfig.get()
+
+console.log(launchConfig.defaultLaunchMode)
+console.log(launchConfig.availableLaunchModes)
+console.log(launchConfig.launchModeOptions)
+```
+
+Each option includes:
+
+- `launchMode`, 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,
+  launchMode: '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({
+  launchMode: 'MAINNET_CONFIG_25',
+  firstBuyAmount: 0.5,
+  deployerWallet: 'YOUR_WALLET',
 })
+
+console.log(preview.selectedLaunchMode)
+console.log(preview.curve.migrationThreshold)
+console.log(preview.costQuote.recommendedMinBalanceSol)
+```
+
+## 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 for both `mainnet` and `devnet`.
+
+### Watch a Token Session
+
+```ts
+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()
 ```
 
-Use `network: 'devnet'` for the dev environment:
+### Wait for a Specific Realtime Event
 
 ```ts
-const client = new BroPumpClient({
-  network: 'devnet',
-})
+const stream = await client.tokens.watch(token.id)
+
+const readyMessage = await stream.waitFor(
+  (message) =>
+    message.type === 'token_update' &&
+    Boolean(message.data?.submit?.id),
+  30_000
+)
+
+console.log(readyMessage.data?.submit?.id)
+stream.close()
 ```
 
-`baseUrl` remains available as an override for local or preview environments.
+### Watch a Pool Directly
 
-## Publish
+```ts
+const poolStream = await client.tokens.watchPool('POOL_ADDRESS')
 
-This package is set up to publish publicly to npmjs under `@bropump/sdk`.
+for await (const message of poolStream) {
+  console.log(message.type, message.data?.runtime?.phase)
+}
+```
 
-```bash
-cd packages/sdk
-npm publish --access public --registry=https://registry.npmjs.org
+Common message types:
+
+- `token_snapshot`
+- `token_update`
+- `launch_snapshot`
+- `launch_update`
+- `runtime_snapshot`
+- `runtime_update`
+
+Use `client.tokens.watch(tokenId)` for a launch session and `client.tokens.watchPool(poolAddress)`
+for a live pool stream.
+
+## 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

@@ -123,19 +123,21 @@ export class BroPumpClient {
         });
     }
     async previewFees(input, options) {
-        return this.request({
+        const preview = await this.request({
             path: '/fees/preview',
             method: 'POST',
-            body: input ?? {},
+            body: buildFeePreviewPayload(input),
             options,
         });
+        return normalizeCurvePreview(preview);
     }
     async getLaunchConfig(options) {
-        return this.request({
+        const launchConfig = await this.request({
             path: '/launch-config',
             method: 'GET',
             options,
         });
+        return normalizeLaunchConfigView(launchConfig);
     }
     async getWalletBalance(address, options) {
         return this.request({
@@ -198,7 +200,8 @@ 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, 'launchMode', input.launchMode);
+    appendFormValue(form, 'configMode', input.launchMode);
     appendFormValue(form, 'firstBuyAmount', input.firstBuyAmount);
     appendFormValue(form, 'x', input.x);
     appendFormValue(form, 'website', input.website);
@@ -212,6 +215,72 @@ function appendFormValue(form, key, value) {
         return;
     form.set(key, String(value));
 }
+function buildFeePreviewPayload(input) {
+    if (!input)
+        return {};
+    return {
+        ...input,
+        ...(input.launchMode ? { configMode: input.launchMode } : {}),
+    };
+}
+function normalizeLaunchModeOption(input) {
+    const launchMode = typeof input.launchMode === 'string'
+        ? input.launchMode
+        : typeof input.configMode === 'string'
+            ? input.configMode
+            : '';
+    return {
+        launchMode,
+        migrationThreshold: Number(input.migrationThreshold ?? 0),
+        configAddress: typeof input.configAddress === 'string' || input.configAddress === null
+            ? input.configAddress
+            : null,
+        deploymentMode: input.deploymentMode === 'per-launch-config' ? 'per-launch-config' : 'predeployed-config',
+    };
+}
+function normalizeLaunchConfigView(input) {
+    const optionRows = Array.isArray(input.launchModeOptions)
+        ? input.launchModeOptions
+        : Array.isArray(input.configModeOptions)
+            ? input.configModeOptions
+            : [];
+    const launchModeOptions = optionRows
+        .filter((value) => Boolean(value) && typeof value === 'object')
+        .map(normalizeLaunchModeOption);
+    return {
+        network: input.network === 'devnet' ? 'devnet' : 'mainnet',
+        defaultLaunchMode: typeof input.defaultLaunchMode === 'string'
+            ? input.defaultLaunchMode
+            : typeof input.defaultConfigMode === 'string'
+                ? input.defaultConfigMode
+                : launchModeOptions[0]?.launchMode || '',
+        availableLaunchModes: Array.isArray(input.availableLaunchModes)
+            ? input.availableLaunchModes.filter((value) => typeof value === 'string')
+            : Array.isArray(input.availableConfigModes)
+                ? input.availableConfigModes.filter((value) => typeof value === 'string')
+                : launchModeOptions.map((option) => option.launchMode),
+        launchModeOptions,
+    };
+}
+function normalizeCurvePreview(input) {
+    const optionRows = Array.isArray(input.launchModeOptions)
+        ? input.launchModeOptions
+        : Array.isArray(input.configModeOptions)
+            ? input.configModeOptions
+            : [];
+    const launchModeOptions = optionRows
+        .filter((value) => Boolean(value) && typeof value === 'object')
+        .map(normalizeLaunchModeOption);
+    return {
+        ...input,
+        launchModeOptions,
+        selectedLaunchMode: typeof input.selectedLaunchMode === 'string'
+            ? input.selectedLaunchMode
+            : typeof input.selectedConfigMode === 'string'
+                ? input.selectedConfigMode
+                : launchModeOptions[0]?.launchMode || '',
+    };
+}
 function toImagePart(image) {
     if (isBlob(image)) {
         return {

package/dist/types.d.ts

@@ -38,7 +38,7 @@ export type CreateTokenInput = {
     symbol: string;
     description: string;
     deployer: string;
-    migrationThreshold?: number;
+    launchMode?: string;
     firstBuyAmount?: number;
     x?: string;
     website?: string;
@@ -90,19 +90,17 @@ export type LaunchCostQuote = {
     };
     breakdown: LaunchCostBreakdown;
 };
-export type MigrationThresholdOption = {
+export type LaunchModeOption = {
+    launchMode: 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[];
+    defaultLaunchMode: string;
+    availableLaunchModes: string[];
+    launchModeOptions: LaunchModeOption[];
 };
 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;
+    launchModeOptions: LaunchModeOption[];
+    selectedLaunchMode: string;
     curve: {
         startingMC: number;
         endingMC: number;
@@ -202,7 +199,7 @@ export type CurvePreview = {
 };
 export type FeePreviewRequest = {
     totalSupply?: string;
-    migrationThreshold?: number;
+    launchMode?: string;
     firstBuyAmount?: number;
     deployerWallet?: string;
 };

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@bropump/sdk",
-  "version": "0.2.1",
-  "description": "TypeScript SDK for the BroPump API",
-  "license": "UNLICENSED",
+  "version": "0.2.3",
+  "description": "TypeScript SDK for BroPump launches, fee previews, and realtime sessions",
+  "license": "MIT",
   "type": "module",
   "sideEffects": false,
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "repository": {
     "type": "git",
@@ -21,7 +22,8 @@
     "sdk",
     "typescript",
     "api",
-    "cloudflare"
+    "launches",
+    "solana"
   ],
   "engines": {
     "node": ">=18"