@usepiper/sdk 0.1.0

package/dist/piper.js

@@ -0,0 +1,253 @@
+/**
+ * Piper SDK — Core Class
+ *
+ * Static methods that append Move calls to a Sui `Transaction`.
+ * Each method maps directly to a public function in the piper::stream Move module.
+ *
+ * Move function signatures (from piper-move/sources/stream.move):
+ *
+ *   create_stream<T>(coin: Coin<T>, flow_rate: u64, recipient: address, clock: &Clock, ctx: &mut TxContext): Stream<T>
+ *   create_on_demand_stream<T>(coin: Coin<T>, recipient: address, authorized_spender: address, clock: &Clock, ctx: &mut TxContext): Stream<T>
+ *   tick<T>(stream: &mut Stream<T>, clock: &Clock, ctx: &mut TxContext)
+ *   pay<T>(stream: &mut Stream<T>, amount: u64, clock: &Clock, ctx: &mut TxContext)
+ *   revoke<T>(stream: &mut Stream<T>, ctx: &mut TxContext): Coin<T>
+ *   top_up<T>(stream: &mut Stream<T>, coin: Coin<T>)
+ *   add_split<T>(stream: &mut Stream<T>, recipient: address, percent: u8, ctx: &mut TxContext)
+ *   remove_split<T>(stream: &mut Stream<T>, index: u64, ctx: &mut TxContext)
+ *   destroy_empty<T>(stream: Stream<T>)
+ */
+import { PIPER_TESTNET_PACKAGE_ID, target } from './constants.js';
+/**
+ * Resolves a value to a `TransactionArgument`.
+ * If the value is already a `TransactionArgument`, returns it directly.
+ * If it's a string (object ID), wraps it with `tx.object()`.
+ */
+function resolveObject(tx, value) {
+    if (typeof value === 'string') {
+        return tx.object(value);
+    }
+    return value;
+}
+/**
+ * The main Piper SDK class.
+ *
+ * All methods are static — there's no instance state.
+ * Call `Piper.setPackageId()` once at startup (or use the testnet default),
+ * then use any method to append Move calls to a `Transaction`.
+ */
+export class Piper {
+    /** The configured Move package ID */
+    static _packageId = PIPER_TESTNET_PACKAGE_ID;
+    // ===== Configuration =====
+    /**
+     * Sets the Move package ID for all subsequent calls.
+     * Defaults to the Piper testnet package.
+     */
+    static setPackageId(packageId) {
+        Piper._packageId = packageId;
+    }
+    /**
+     * Returns the currently configured package ID.
+     * @throws if no package ID has been set and the default has been cleared.
+     */
+    static getPackageId() {
+        if (!Piper._packageId) {
+            throw new Error('Piper package ID not set. Call Piper.setPackageId() before using SDK methods.');
+        }
+        return Piper._packageId;
+    }
+    // ===== Stream Creation =====
+    /**
+     * Creates a continuous (time-based) stream.
+     *
+     * Move: `piper::stream::create_stream<T>(coin, flow_rate, recipient, clock, ctx): Stream<T>`
+     *
+     * @returns A `TransactionResult` representing the created `Stream<T>` object.
+     *          You must transfer or share this object in the same transaction.
+     */
+    static createContinuousStream(tx, config) {
+        const packageId = Piper.getPackageId();
+        return tx.moveCall({
+            target: target(packageId, 'create_stream'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.coin),
+                tx.pure.u64(BigInt(config.flowRate)),
+                tx.pure.address(config.recipient),
+                tx.object.clock(),
+            ],
+        });
+    }
+    /**
+     * Creates an on-demand (pay-per-use) stream.
+     *
+     * Move: `piper::stream::create_on_demand_stream<T>(coin, recipient, authorized_spender, clock, ctx): Stream<T>`
+     *
+     * @returns A `TransactionResult` representing the created `Stream<T>` object.
+     *          You must transfer or share this object in the same transaction.
+     */
+    static createOnDemandStream(tx, config) {
+        const packageId = Piper.getPackageId();
+        return tx.moveCall({
+            target: target(packageId, 'create_on_demand_stream'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.coin),
+                tx.pure.address(config.recipient),
+                tx.pure.address(config.authorizedSpender),
+                tx.object.clock(),
+            ],
+        });
+    }
+    /**
+     * Shares a stream object so it can be autonomously ticked by anyone.
+     * This is the recommended way to handle newly created continuous streams.
+     *
+     * @param tx The Transaction
+     * @param stream The TransactionResult from createContinuousStream
+     * @param coinType The type of the coin in the stream
+     */
+    static shareStream(tx, stream, coinType) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: '0x2::transfer::public_share_object',
+            typeArguments: [`${packageId}::stream::Stream<${coinType}>`],
+            arguments: [stream],
+        });
+    }
+    // ===== Stream Actions =====
+    /**
+     * Triggers a payment tick on a continuous stream.
+     * Permissionless — anyone can call this.
+     *
+     * Move: `piper::stream::tick<T>(stream, clock, ctx)`
+     *
+     * The Move function handles all coin transfers internally.
+     * Funds are sent directly to the primary recipient and any split recipients on-chain.
+     */
+    static tick(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'tick'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                tx.object.clock(),
+            ],
+        });
+    }
+    /**
+     * Performs an on-demand payment from a pay-per-use stream.
+     * Must be called by the `authorizedSpender` — the transaction must be
+     * signed by the spender's key.
+     *
+     * Move: `piper::stream::pay<T>(stream, amount, clock, ctx)`
+     */
+    static pay(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'pay'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                tx.pure.u64(BigInt(config.amount)),
+                tx.object.clock(),
+            ],
+        });
+    }
+    /**
+     * Revokes a stream and returns the remaining balance as a `Coin<T>`.
+     * Only the stream creator can call this (enforced on-chain).
+     *
+     * Move: `piper::stream::revoke<T>(stream, clock, ctx): Coin<T>`
+     *
+     * @returns A `TransactionResult` representing the remaining `Coin<T>`.
+     *          You must transfer or consume this coin in the same transaction.
+     */
+    static revoke(tx, config) {
+        const packageId = Piper.getPackageId();
+        return tx.moveCall({
+            target: target(packageId, 'revoke'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                tx.object.clock(),
+            ],
+        });
+    }
+    /**
+     * Adds additional funds to an existing stream.
+     * Anyone can top up a stream.
+     *
+     * Move: `piper::stream::top_up<T>(stream, coin)`
+     */
+    static topUp(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'top_up'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                resolveObject(tx, config.coin),
+            ],
+        });
+    }
+    // ===== Split Management =====
+    /**
+     * Adds a percentage-based split recipient to a stream.
+     * Only the stream creator can manage splits (enforced on-chain).
+     * Total split percentages cannot exceed 100%.
+     *
+     * Move: `piper::stream::add_split<T>(stream, recipient, percent, ctx)`
+     */
+    static addSplit(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'add_split'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                tx.pure.address(config.recipient),
+                tx.pure.u8(config.percent),
+            ],
+        });
+    }
+    /**
+     * Removes a split by index.
+     * Only the stream creator can manage splits (enforced on-chain).
+     *
+     * Move: `piper::stream::remove_split<T>(stream, index, ctx)`
+     */
+    static removeSplit(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'remove_split'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+                tx.pure.u64(BigInt(config.index)),
+            ],
+        });
+    }
+    // ===== Destruction =====
+    /**
+     * Destroys an inactive stream with zero balance.
+     * Deletes the `Stream` object from on-chain storage.
+     *
+     * Move: `piper::stream::destroy_empty<T>(stream)`
+     *
+     * Note: The stream is consumed by value — if you pass a string ID,
+     * the SDK resolves it as an owned object.
+     */
+    static destroyEmpty(tx, config) {
+        const packageId = Piper.getPackageId();
+        tx.moveCall({
+            target: target(packageId, 'destroy_empty'),
+            typeArguments: [config.coinType],
+            arguments: [
+                resolveObject(tx, config.streamId),
+            ],
+        });
+    }
+}
+//# sourceMappingURL=piper.js.map

package/dist/piper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"piper.js","sourceRoot":"","sources":["../src/piper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,OAAO,EAAE,wBAAwB,EAAmB,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAanF;;;;GAIG;AACH,SAAS,aAAa,CACpB,EAAe,EACf,KAAmC;IAEnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,KAAK;IAChB,qCAAqC;IAC7B,MAAM,CAAC,UAAU,GAAW,wBAAwB,CAAC;IAE7D,4BAA4B;IAE5B;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,SAAiB;QACnC,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY;QACjB,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,CAAC;IAC1B,CAAC;IAED,8BAA8B;IAE9B;;;;;;;OAOG;IACH,MAAM,CAAC,sBAAsB,CAC3B,EAAe,EACf,MAAoC;QAEpC,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,OAAO,EAAE,CAAC,QAAQ,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC;YAC1C,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC9B,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACpC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;gBACjC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,oBAAoB,CACzB,EAAe,EACf,MAAkC;QAElC,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,OAAO,EAAE,CAAC,QAAQ,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,yBAAyB,CAAC;YACpD,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC9B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;gBACjC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;gBACzC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAChB,EAAe,EACf,MAAyB,EACzB,QAAgB;QAEhB,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QACvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,oCAAoC;YAC5C,aAAa,EAAE,CAAC,GAAG,SAAS,oBAAoB,QAAQ,GAAG,CAAC;YAC5D,SAAS,EAAE,CAAC,MAAM,CAAC;SACpB,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IAE7B;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,EAAe,EAAE,MAAkB;QAC7C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC;YACjC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,EAAe,EAAE,MAAiB;QAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;YAChC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CACX,EAAe,EACf,MAAoB;QAEpB,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,OAAO,EAAE,CAAC,QAAQ,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;YACnC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAe,EAAE,MAAmB;QAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;YACnC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC;aAC/B;SACF,CAAC,CAAC;IACL,CAAC;IAED,+BAA+B;IAE/B;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAe,EAAE,MAAsB;QACrD,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC;YACtC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;gBACjC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;aAC3B;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAe,EAAE,MAAyB;QAC3D,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC;YACzC,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;gBAClC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED,0BAA0B;IAE1B;;;;;;;;OAQG;IACH,MAAM,CAAC,YAAY,CAAC,EAAe,EAAE,MAA0B;QAC7D,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QAEvC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC;YAC1C,aAAa,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChC,SAAS,EAAE;gBACT,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC;aACnC;SACF,CAAC,CAAC;IACL,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,156 @@
+/**
+ * Piper SDK Type Definitions
+ *
+ * TypeScript interfaces for all SDK config objects and on-chain event types.
+ */
+import type { TransactionArgument } from '@mysten/sui/transactions';
+/** Configuration for creating a continuous (time-based) stream */
+export interface CreateContinuousStreamConfig {
+    /** The Coin<T> object to deposit — a TransactionArgument or object ID string */
+    coin: TransactionArgument | string;
+    /** Full coin type, e.g. '0x2::sui::SUI' */
+    coinType: string;
+    /** Tokens (in smallest units) to stream per second */
+    flowRate: number | bigint;
+    /** Sui address of the primary recipient */
+    recipient: string;
+}
+/** Configuration for creating an on-demand (pay-per-use) stream */
+export interface CreateOnDemandStreamConfig {
+    /** The Coin<T> object to deposit — a TransactionArgument or object ID string */
+    coin: TransactionArgument | string;
+    /** Full coin type, e.g. '0x2::sui::SUI' */
+    coinType: string;
+    /** Sui address that receives payments */
+    recipient: string;
+    /** Sui address allowed to call `pay` */
+    authorizedSpender: string;
+}
+/** Configuration for ticking a continuous stream */
+export interface TickConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+}
+/** Configuration for an on-demand payment */
+export interface PayConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+    /** Amount to deduct (in smallest units) */
+    amount: number | bigint;
+}
+/** Configuration for revoking a stream */
+export interface RevokeConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+}
+/** Configuration for topping up a stream */
+export interface TopUpConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+    /** The Coin<T> object to deposit — a TransactionArgument or object ID string */
+    coin: TransactionArgument | string;
+}
+/** Configuration for adding a split to a stream */
+export interface AddSplitConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+    /** Sui address that will receive this split */
+    recipient: string;
+    /** Percentage share (1–100) */
+    percent: number;
+}
+/** Configuration for removing a split from a stream */
+export interface RemoveSplitConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+    /** Index of the split to remove */
+    index: number;
+}
+/** Configuration for destroying an empty stream */
+export interface DestroyEmptyConfig {
+    /** The Stream<T> object ID or TransactionArgument */
+    streamId: string | TransactionArgument;
+    /** Full coin type of the stream */
+    coinType: string;
+}
+/** Emitted when a new stream is created */
+export interface StreamCreatedEvent {
+    stream_id: string;
+    sender: string;
+    recipient: string;
+    flow_rate: string;
+    initial_balance: string;
+}
+/** Emitted on every tick or on-demand payment to the primary recipient */
+export interface PaymentSentEvent {
+    stream_id: string;
+    recipient: string;
+    amount: string;
+    timestamp: string;
+}
+/** Emitted when a stream is revoked by its creator */
+export interface StreamRevokedEvent {
+    stream_id: string;
+    remaining_balance: string;
+}
+/** Emitted when additional funds are added to a stream */
+export interface StreamToppedUpEvent {
+    stream_id: string;
+    amount: string;
+    new_balance: string;
+}
+/** Emitted when a split payment is distributed */
+export interface SplitPaymentSentEvent {
+    stream_id: string;
+    recipient: string;
+    amount: string;
+    percent: number;
+}
+/** Emitted when a split is added to a stream */
+export interface SplitAddedEvent {
+    stream_id: string;
+    recipient: string;
+    percent: number;
+}
+/** Emitted when a split is removed from a stream */
+export interface SplitRemovedEvent {
+    stream_id: string;
+    recipient: string;
+    percent: number;
+}
+/** Union type of all Piper events */
+export type PiperEvent = {
+    type: 'StreamCreated';
+    data: StreamCreatedEvent;
+} | {
+    type: 'PaymentSent';
+    data: PaymentSentEvent;
+} | {
+    type: 'StreamRevoked';
+    data: StreamRevokedEvent;
+} | {
+    type: 'StreamToppedUp';
+    data: StreamToppedUpEvent;
+} | {
+    type: 'SplitPaymentSent';
+    data: SplitPaymentSentEvent;
+} | {
+    type: 'SplitAdded';
+    data: SplitAddedEvent;
+} | {
+    type: 'SplitRemoved';
+    data: SplitRemovedEvent;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAIpE,kEAAkE;AAClE,MAAM,WAAW,4BAA4B;IAC3C,gFAAgF;IAChF,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACnC,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,mEAAmE;AACnE,MAAM,WAAW,0BAA0B;IACzC,gFAAgF;IAChF,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACnC,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,oDAAoD;AACpD,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,6CAA6C;AAC7C,MAAM,WAAW,SAAS;IACxB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED,0CAA0C;AAC1C,MAAM,WAAW,YAAY;IAC3B,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,4CAA4C;AAC5C,MAAM,WAAW,WAAW;IAC1B,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAAC;CACpC;AAED,mDAAmD;AACnD,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,mDAAmD;AACnD,MAAM,WAAW,kBAAkB;IACjC,qDAAqD;IACrD,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAC;IACvC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAKD,2CAA2C;AAC3C,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,0DAA0D;AAC1D,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,kDAAkD;AAClD,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qCAAqC;AACrC,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CAAC"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Piper SDK Type Definitions
+ *
+ * TypeScript interfaces for all SDK config objects and on-chain event types.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/utils.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Piper SDK — Utility Functions
+ *
+ * Helper functions for extracting stream IDs from transaction results,
+ * calculating flow rates, and parsing Piper events.
+ */
+import type { PiperEvent } from './types.js';
+/**
+ * Extracts the created `Stream` object ID from a transaction result.
+ *
+ * Looks for a `StreamCreated` event in the transaction events and returns
+ * the `stream_id` field. Use this after calling `createContinuousStream`
+ * or `createOnDemandStream`.
+ *
+ * @param result - The transaction execution result. Must include events
+ *   (use `include: { events: true }` when executing).
+ * @returns The stream object ID as a hex string.
+ * @throws If no `StreamCreated` event is found in the result.
+ *
+ * @example
+ * ```typescript
+ * const result = await client.signAndExecuteTransaction({
+ *   signer: keypair,
+ *   transaction: tx,
+ *   include: { events: true },
+ * });
+ * const streamId = extractStreamId(result);
+ * ```
+ */
+export declare function extractStreamId(result: {
+    events?: Array<{
+        type: string;
+        parsedJson?: Record<string, unknown>;
+    }>;
+}): string;
+/**
+ * Computes the flow rate needed to stream a total amount evenly over a duration.
+ *
+ * @param totalAmount - Total tokens to stream (in smallest units, e.g. MIST for SUI).
+ * @param durationSeconds - Duration in seconds.
+ * @returns The per-second flow rate as a `bigint`.
+ * @throws If `durationSeconds` is zero or negative.
+ *
+ * @example
+ * ```typescript
+ * // 100 USDC over 30 days (USDC has 6 decimals)
+ * const flowRate = calculateFlowRate(100_000_000n, 30 * 24 * 3600);
+ * // flowRate = 38n (≈ 38 microUSDC per second)
+ * ```
+ */
+export declare function calculateFlowRate(totalAmount: bigint, durationSeconds: number): bigint;
+/**
+ * Parses all Piper events from a transaction result into typed event objects.
+ *
+ * @param result - The transaction execution result with events included.
+ * @returns An array of typed `PiperEvent` objects.
+ *
+ * @example
+ * ```typescript
+ * const events = parsePiperEvents(result);
+ * for (const event of events) {
+ *   if (event.type === 'PaymentSent') {
+ *     console.log(`Payment of ${event.data.amount} to ${event.data.recipient}`);
+ *   }
+ * }
+ * ```
+ */
+export declare function parsePiperEvents(result: {
+    events?: Array<{
+        type: string;
+        parsedJson?: Record<string, unknown>;
+    }>;
+}): PiperEvent[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,UAAU,EAQX,MAAM,YAAY,CAAC;AAapB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE;IACtC,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;CACxE,GAAG,MAAM,CA4BT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,GACtB,MAAM,CAKR;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IACvC,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;CACxE,GAAG,UAAU,EAAE,CAiDf"}

package/dist/utils.js

@@ -0,0 +1,147 @@
+/**
+ * Piper SDK — Utility Functions
+ *
+ * Helper functions for extracting stream IDs from transaction results,
+ * calculating flow rates, and parsing Piper events.
+ */
+/** Event type suffixes used to identify Piper events in transaction results */
+const EVENT_TYPES = {
+    StreamCreated: '::events::StreamCreated',
+    PaymentSent: '::events::PaymentSent',
+    StreamRevoked: '::events::StreamRevoked',
+    StreamToppedUp: '::events::StreamToppedUp',
+    SplitPaymentSent: '::events::SplitPaymentSent',
+    SplitAdded: '::events::SplitAdded',
+    SplitRemoved: '::events::SplitRemoved',
+};
+/**
+ * Extracts the created `Stream` object ID from a transaction result.
+ *
+ * Looks for a `StreamCreated` event in the transaction events and returns
+ * the `stream_id` field. Use this after calling `createContinuousStream`
+ * or `createOnDemandStream`.
+ *
+ * @param result - The transaction execution result. Must include events
+ *   (use `include: { events: true }` when executing).
+ * @returns The stream object ID as a hex string.
+ * @throws If no `StreamCreated` event is found in the result.
+ *
+ * @example
+ * ```typescript
+ * const result = await client.signAndExecuteTransaction({
+ *   signer: keypair,
+ *   transaction: tx,
+ *   include: { events: true },
+ * });
+ * const streamId = extractStreamId(result);
+ * ```
+ */
+export function extractStreamId(result) {
+    const events = result.events;
+    if (!events || events.length === 0) {
+        throw new Error('No events found in transaction result. Did you include events in the response? ' +
+            'Use `include: { events: true }` when executing the transaction.');
+    }
+    const streamEvent = events.find((e) => e.type.endsWith(EVENT_TYPES.StreamCreated));
+    if (!streamEvent || !streamEvent.parsedJson) {
+        throw new Error('No StreamCreated event found in transaction result. ' +
+            'Make sure the transaction includes a createContinuousStream or createOnDemandStream call.');
+    }
+    const streamId = streamEvent.parsedJson['stream_id'];
+    if (!streamId) {
+        throw new Error('StreamCreated event found but stream_id field is missing.');
+    }
+    return streamId;
+}
+/**
+ * Computes the flow rate needed to stream a total amount evenly over a duration.
+ *
+ * @param totalAmount - Total tokens to stream (in smallest units, e.g. MIST for SUI).
+ * @param durationSeconds - Duration in seconds.
+ * @returns The per-second flow rate as a `bigint`.
+ * @throws If `durationSeconds` is zero or negative.
+ *
+ * @example
+ * ```typescript
+ * // 100 USDC over 30 days (USDC has 6 decimals)
+ * const flowRate = calculateFlowRate(100_000_000n, 30 * 24 * 3600);
+ * // flowRate = 38n (≈ 38 microUSDC per second)
+ * ```
+ */
+export function calculateFlowRate(totalAmount, durationSeconds) {
+    if (durationSeconds <= 0) {
+        throw new Error('durationSeconds must be greater than zero.');
+    }
+    return totalAmount / BigInt(durationSeconds);
+}
+/**
+ * Parses all Piper events from a transaction result into typed event objects.
+ *
+ * @param result - The transaction execution result with events included.
+ * @returns An array of typed `PiperEvent` objects.
+ *
+ * @example
+ * ```typescript
+ * const events = parsePiperEvents(result);
+ * for (const event of events) {
+ *   if (event.type === 'PaymentSent') {
+ *     console.log(`Payment of ${event.data.amount} to ${event.data.recipient}`);
+ *   }
+ * }
+ * ```
+ */
+export function parsePiperEvents(result) {
+    const events = result.events;
+    if (!events)
+        return [];
+    const parsed = [];
+    for (const event of events) {
+        const json = event.parsedJson;
+        if (!json)
+            continue;
+        if (event.type.endsWith(EVENT_TYPES.StreamCreated)) {
+            parsed.push({
+                type: 'StreamCreated',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.PaymentSent)) {
+            parsed.push({
+                type: 'PaymentSent',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.StreamRevoked)) {
+            parsed.push({
+                type: 'StreamRevoked',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.StreamToppedUp)) {
+            parsed.push({
+                type: 'StreamToppedUp',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.SplitPaymentSent)) {
+            parsed.push({
+                type: 'SplitPaymentSent',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.SplitAdded)) {
+            parsed.push({
+                type: 'SplitAdded',
+                data: json,
+            });
+        }
+        else if (event.type.endsWith(EVENT_TYPES.SplitRemoved)) {
+            parsed.push({
+                type: 'SplitRemoved',
+                data: json,
+            });
+        }
+    }
+    return parsed;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,+EAA+E;AAC/E,MAAM,WAAW,GAAG;IAClB,aAAa,EAAE,yBAAyB;IACxC,WAAW,EAAE,uBAAuB;IACpC,aAAa,EAAE,yBAAyB;IACxC,cAAc,EAAE,0BAA0B;IAC1C,gBAAgB,EAAE,4BAA4B;IAC9C,UAAU,EAAE,sBAAsB;IAClC,YAAY,EAAE,wBAAwB;CAC9B,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,eAAe,CAAC,MAE/B;IACC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,iFAAiF;YAC/E,iEAAiE,CACpE,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACpC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAC3C,CAAC;IAEF,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CACb,sDAAsD;YACpD,2FAA2F,CAC9F,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAuB,CAAC;IAC3E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,eAAuB;IAEvB,IAAI,eAAe,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,WAAW,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAEhC;IACC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEvB,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC;QAC9B,IAAI,CAAC,IAAI;YAAE,SAAS;QAEpB,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,IAAqC;aAC5C,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,IAAmC;aAC1C,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,IAAqC;aAC5C,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YAC3D,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,IAAsC;aAC7C,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC7D,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,IAAwC;aAC/C,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,IAAkC;aACzC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,IAAoC;aAC3C,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}