@craftec/flowcraft-sdk 0.1.0

package/README.md

@@ -0,0 +1,100 @@
+# @craftec/flowcraft-sdk
+
+SDK for Flowcraft subscription streaming protocol on Solana.
+
+## Installation
+
+```bash
+npm install @craftec/flowcraft-sdk
+```
+
+## Usage
+
+```typescript
+import { Connection, Keypair, PublicKey } from "@solana/web3.js";
+import { Wallet } from "@coral-xyz/anchor";
+import { FlowcraftClient } from "@craftec/flowcraft-sdk";
+
+// Initialize client
+const connection = new Connection("https://api.devnet.solana.com");
+const wallet = new Wallet(yourKeypair);
+const client = new FlowcraftClient(connection, wallet);
+
+// Create a pool
+const { signature, pool, vault } = await client.createPool(payer, owner, {
+  name: "premium",
+  mint: mintPubkey,
+});
+
+// Subscribe to a pool
+const { signature, stream } = await client.subscribe(subscriber, {
+  pool: poolPubkey,
+  tier: "monthly",
+  amount: 100_000_000, // in smallest units
+  durationSeconds: 30 * 24 * 60 * 60, // 30 days
+  subscriberTokenAccount,
+  treasuryTokenAccount,
+});
+
+// Calculate vested amount (off-chain)
+const stats = await client.getPoolAggregateStats(poolPubkey);
+console.log("Total Vested:", stats.totalVested.toString());
+console.log("Claimable:", stats.totalClaimable.toString());
+
+// Batch claim from multiple streams
+const { transactions, totalStreams } = await client.buildClaimAllTransactions(
+  owner.publicKey,
+  poolPubkey,
+  ownerTokenAccount,
+  20 // batch size
+);
+
+// Sign all transactions at once
+const signed = await wallet.signAllTransactions(transactions);
+
+// Send in parallel
+await Promise.all(signed.map(tx => connection.sendTransaction(tx)));
+```
+
+## API Reference
+
+### FlowcraftClient
+
+Main client class for interacting with the Flowcraft protocol.
+
+#### Pool Operations
+- `createPool(payer, owner, params)` - Create a new subscription pool
+- `fetchPool(pool)` - Fetch pool data
+- `getPoolInfo(pool)` - Get pool with computed info
+- `getPoolAggregateStats(pool)` - Get aggregate vesting stats for all streams
+
+#### Subscription Operations
+- `subscribe(subscriber, params)` - Subscribe to a pool
+- `addSegment(payer, params)` - Add a new segment to existing subscription
+- `upgradeSegment(subscriber, params)` - Upgrade/downgrade a segment
+- `cancelSegment(subscriber, params)` - Cancel a segment
+
+#### Claiming
+- `claim(owner, params)` - Claim from single stream
+- `claimBatch(owner, params)` - Claim from multiple streams in one tx
+- `buildClaimAllTransactions(...)` - Build batch claim txs for all streams
+
+#### Utilities
+- `getStreamInfoRealTime(stream)` - Get stream with real-time vesting calculation
+- `getRealTimeClaimable(stream)` - Get current claimable amount
+
+## Constants
+
+```typescript
+import { PROGRAM_ID, RATE_DECIMALS } from "@craftec/flowcraft-sdk";
+
+// Program ID (devnet/mainnet)
+console.log(PROGRAM_ID.toBase58());
+
+// Rate decimals for vesting calculation (10^9)
+console.log(RATE_DECIMALS); // 1000000000
+```
+
+## License
+
+MIT

package/dist/client.d.ts

@@ -0,0 +1,148 @@
+import { Connection, PublicKey, Keypair } from "@solana/web3.js";
+import { Program, AnchorProvider, Wallet, BN, Idl } from "@coral-xyz/anchor";
+import { Config, Pool, Stream, PoolInfo, StreamInfo, PoolAggregateStats, StreamWithAddress, CreatePoolParams, SubscribeParams, AddSegmentParams, ClaimParams, CancelSegmentParams, UpgradeSegmentParams } from "./types";
+export declare const IDL: Idl;
+export declare class FlowcraftClient {
+    readonly program: Program;
+    readonly provider: AnchorProvider;
+    readonly programId: PublicKey;
+    constructor(connection: Connection, wallet: Wallet, programId?: PublicKey, idl?: Idl);
+    /**
+     * Get the config PDA
+     */
+    getConfigPda(): [PublicKey, number];
+    /**
+     * Get the pool PDA for an owner and name
+     */
+    getPoolPda(owner: PublicKey, name: string): [PublicKey, number];
+    /**
+     * Get the stream PDA for a pool and subscriber
+     */
+    getStreamPda(pool: PublicKey, subscriber: PublicKey): [PublicKey, number];
+    /**
+     * Get the vault PDA for a pool
+     */
+    getVaultPda(pool: PublicKey): [PublicKey, number];
+    /**
+     * Fetch the global config
+     */
+    fetchConfig(): Promise<Config | null>;
+    /**
+     * Fetch a pool by address
+     */
+    fetchPool(pool: PublicKey): Promise<Pool | null>;
+    /**
+     * Fetch a pool by owner and name
+     */
+    fetchPoolByOwner(owner: PublicKey, name: string): Promise<Pool | null>;
+    /**
+     * Fetch a stream by address
+     */
+    fetchStream(stream: PublicKey): Promise<Stream | null>;
+    /**
+     * Fetch a stream by pool and subscriber
+     */
+    fetchStreamBySubscriber(pool: PublicKey, subscriber: PublicKey): Promise<Stream | null>;
+    /**
+     * Fetch pool with computed info
+     */
+    getPoolInfo(pool: PublicKey): Promise<PoolInfo | null>;
+    /**
+     * Fetch stream with computed info
+     */
+    getStreamInfo(stream: PublicKey): Promise<StreamInfo | null>;
+    /**
+     * Initialize the protocol config (one-time setup)
+     */
+    initializeConfig(admin: Keypair, treasury: PublicKey, feeBps: number): Promise<string>;
+    /**
+     * Update protocol config (admin only)
+     */
+    updateConfig(admin: Keypair, newTreasury?: PublicKey, newFeeBps?: number, newAdmin?: PublicKey): Promise<string>;
+    /**
+     * Create a new subscription pool
+     * @param payer - Keypair that pays for rent (signs the transaction)
+     * @param owner - PublicKey of pool owner (can be any account, including PDA)
+     * @param params - Pool creation parameters
+     */
+    createPool(payer: Keypair, owner: PublicKey, params: CreatePoolParams): Promise<{
+        signature: string;
+        pool: PublicKey;
+        vault: PublicKey;
+    }>;
+    /**
+     * Subscribe to a pool (creates stream with first segment)
+     */
+    subscribe(subscriber: Keypair, params: SubscribeParams): Promise<{
+        signature: string;
+        stream: PublicKey;
+    }>;
+    /**
+     * Add a new segment to an existing subscription
+     */
+    addSegment(payer: Keypair, params: AddSegmentParams): Promise<string>;
+    /**
+     * Claim vested tokens (pool owner only)
+     */
+    claim(owner: Keypair, params: ClaimParams): Promise<string>;
+    /**
+     * Claim vested tokens from multiple streams in a single transaction
+     */
+    claimBatch(owner: Keypair, params: {
+        pool: PublicKey;
+        streams: PublicKey[];
+        ownerTokenAccount: PublicKey;
+    }): Promise<string>;
+    /**
+     * Build batch claim transactions for all streams in a pool
+     * Returns transactions ready to be signed with signAllTransactions
+     */
+    buildClaimAllTransactions(owner: PublicKey, pool: PublicKey, ownerTokenAccount: PublicKey, batchSize?: number): Promise<{
+        transactions: any[];
+        totalStreams: number;
+    }>;
+    /**
+     * Cancel a segment (subscriber only)
+     */
+    cancelSegment(subscriber: Keypair, params: CancelSegmentParams): Promise<string>;
+    /**
+     * Upgrade or downgrade a segment
+     */
+    upgradeSegment(caller: Keypair, params: UpgradeSegmentParams): Promise<string>;
+    /**
+     * Check if a pool exists
+     */
+    poolExists(owner: PublicKey, name: string): Promise<boolean>;
+    /**
+     * Check if a subscription stream exists
+     */
+    subscriptionExists(pool: PublicKey, subscriber: PublicKey): Promise<boolean>;
+    /**
+     * Get claimable amount for a stream
+     */
+    getClaimable(stream: PublicKey): Promise<BN>;
+    /**
+     * Check if subscription is expired
+     */
+    isSubscriptionExpired(stream: PublicKey): Promise<boolean>;
+    /**
+     * Fetch all streams for a pool using getProgramAccounts
+     * Stream account layout: [8 discriminator][32 pool][32 subscriber]...
+     * Filter by pool pubkey at offset 8
+     */
+    fetchStreamsByPool(pool: PublicKey): Promise<StreamWithAddress[]>;
+    /**
+     * Calculate real-time aggregate statistics for a pool
+     * Fetches all streams and calculates vesting off-chain
+     */
+    getPoolAggregateStats(pool: PublicKey): Promise<PoolAggregateStats>;
+    /**
+     * Get real-time claimable amount for a stream (calculated off-chain)
+     */
+    getRealTimeClaimable(streamAddress: PublicKey): Promise<BN>;
+    /**
+     * Get detailed stream info with real-time vesting calculation
+     */
+    getStreamInfoRealTime(streamAddress: PublicKey): Promise<StreamInfo | null>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,OAAO,EAER,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,OAAO,EACP,cAAc,EACd,MAAM,EACN,EAAE,EACF,GAAG,EACJ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,MAAM,EACN,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,UAAU,EAEV,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,SAAS,CAAC;AAYjB,eAAO,MAAM,GAAG,EAAE,GAAqB,CAAC;AAExC,qBAAa,eAAe;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;gBAG5B,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAsB,EACjC,GAAG,GAAE,GAAS;IAahB;;OAEG;IACH,YAAY,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;IAInC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;IAI/D;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;IAIzE;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;IAQjD;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAU3C;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAStD;;OAEG;IACG,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAK5E;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAS5D;;OAEG;IACG,uBAAuB,CAC3B,IAAI,EAAE,SAAS,EACf,UAAU,EAAE,SAAS,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAKzB;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAiB5D;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAyDlE;;OAEG;IACG,gBAAgB,CACpB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC;IAclB;;OAEG;IACG,YAAY,CAChB,KAAK,EAAE,OAAO,EACd,WAAW,CAAC,EAAE,SAAS,EACvB,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,SAAS,GACnB,OAAO,CAAC,MAAM,CAAC;IAqBlB;;;;;OAKG;IACG,UAAU,CACd,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;IAyBpE;;OAEG;IACG,SAAS,CACb,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IAwBpD;;OAEG;IACG,UAAU,CACd,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,MAAM,CAAC;IAoBlB;;OAEG;IACG,KAAK,CACT,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;OAEG;IACG,UAAU,CACd,KAAK,EAAE,OAAO,EACd,MAAM,EAAE;QACN,IAAI,EAAE,SAAS,CAAC;QAChB,OAAO,EAAE,SAAS,EAAE,CAAC;QACrB,iBAAiB,EAAE,SAAS,CAAC;KAC9B,GACA,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;OAGG;IACG,yBAAyB,CAC7B,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,SAAS,EACf,iBAAiB,EAAE,SAAS,EAC5B,SAAS,GAAE,MAAW,GACrB,OAAO,CAAC;QAAE,YAAY,EAAE,GAAG,EAAE,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAoCzD;;OAEG;IACG,aAAa,CACjB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,CAAC;IAiBlB;;OAEG;IACG,cAAc,CAClB,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,MAAM,CAAC;IA2BlB;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKlE;;OAEG;IACG,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAKlF;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;IAKlD;;OAEG;IACG,qBAAqB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAShE;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAyCvE;;;OAGG;IACG,qBAAqB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAyCzE;;OAEG;IACG,oBAAoB,CAAC,aAAa,EAAE,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;IAQjE;;OAEG;IACG,qBAAqB,CAAC,aAAa,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAqClF"}