@zebec-network/zebec-stream-sdk 1.0.0 → 1.1.0

package/README.md

@@ -42,24 +42,24 @@ const streamService = ZebecStreamService.create(provider, "devnet");
 
 ```typescript
 const streamParams = {
-  receiver: "ReceiverPublicKeyHere",
-  sender: "SenderPublicKeyHere", 
-  streamToken: "TokenMintAddressHere",
-  amount: "1000", // Amount in token units
-  duration: 86400, // 1 day in seconds
-  streamFrequency: 3600, // 1 hour in seconds
-  streamName: "Monthly Salary",
-  startNow: true,
-  automaticWithdrawal: false,
-  cancelableByRecipient: true,
-  cancelableBySender: true,
-  isPausable: true,
-  transferableByRecipient: false,
-  transferableBySender: false,
-  canTopup: true,
-  rateUpdatable: false,
-  cliffPercentage: 0, // No cliff
-  startTime: Math.floor(Date.now() / 1000)
+	receiver: "ReceiverPublicKeyHere",
+	sender: "SenderPublicKeyHere",
+	streamToken: "TokenMintAddressHere",
+	amount: "1000", // Amount in token units
+	duration: 86400, // 1 day in seconds
+	streamFrequency: 3600, // 1 hour in seconds
+	streamName: "Monthly Salary",
+	startNow: true,
+	automaticWithdrawal: false,
+	cancelableByRecipient: true,
+	cancelableBySender: true,
+	isPausable: true,
+	transferableByRecipient: false,
+	transferableBySender: false,
+	canTopup: true,
+	rateUpdatable: false,
+	cliffPercentage: 0, // No cliff
+	startTime: Math.floor(Date.now() / 1000),
 };
 
 const transaction = await streamService.createStream(streamParams);
@@ -87,7 +87,7 @@ Creates a new payment stream.
 **Parameters:**
 
 - `receiver`: Address - The recipient's public key
-- `sender`: Address - The sender's public key  
+- `sender`: Address - The sender's public key
 - `streamToken`: Address - The SPL token mint address
 - `amount`: Numeric - Amount to stream (in token units)
 - `duration`: number - Stream duration in seconds
@@ -169,7 +169,7 @@ Retrieves global stream configuration.
 - `withdrawerAccount`: Withdraw account address
 - `whitelistedTokens`: Array of whitelisted token addresses
 - `platformFee`: Platform fee percentage
-- `baseFee`: Base fee percentage  
+- `baseFee`: Base fee percentage
 - `frequencies`: Allowed stream frequencies
 
 ### Admin Operations
@@ -201,37 +201,37 @@ Adds tokens to the whitelist (admin only).
 
 ```typescript
 type StreamMetadataInfo = {
-  parties: {
-    sender: PublicKey;
-    receiver: PublicKey;
-  };
-  financials: {
-    streamToken: PublicKey;
-    cliffPercentage: number;
-    depositedAmount: string;
-    withdrawnAmount: string;
-  };
-  schedule: {
-    startTime: number;
-    endTime: number;
-    lastWithdrawTime: number;
-    frequency: number;
-    duration: number;
-    pausedTimestamp: number;
-    pausedInterval: number;
-    canceledTimestamp: number;
-  };
-  permissions: {
-    cancelableBySender: boolean;
-    cancelableByRecipient: boolean;
-    automaticWithdrawal: boolean;
-    transferableBySender: boolean;
-    transferableByRecipient: boolean;
-    canTopup: boolean;
-    isPausable: boolean;
-    rateUpdatable: boolean;
-  };
-  streamName: string;
+	parties: {
+		sender: PublicKey;
+		receiver: PublicKey;
+	};
+	financials: {
+		streamToken: PublicKey;
+		cliffPercentage: number;
+		depositedAmount: string;
+		withdrawnAmount: string;
+	};
+	schedule: {
+		startTime: number;
+		endTime: number;
+		lastWithdrawTime: number;
+		frequency: number;
+		duration: number;
+		pausedTimestamp: number;
+		pausedInterval: number;
+		canceledTimestamp: number;
+	};
+	permissions: {
+		cancelableBySender: boolean;
+		cancelableByRecipient: boolean;
+		automaticWithdrawal: boolean;
+		transferableBySender: boolean;
+		transferableByRecipient: boolean;
+		canTopup: boolean;
+		isPausable: boolean;
+		rateUpdatable: boolean;
+	};
+	streamName: string;
 };
 ```
 
@@ -239,12 +239,12 @@ type StreamMetadataInfo = {
 
 ```typescript
 type StreamConfigInfo = {
-  admin: PublicKey;
-  withdrawerAccount: PublicKey;
-  whitelistedTokens: PublicKey[];
-  platformFee: number;
-  baseFee: number;
-  frequencies: number[];
+	admin: PublicKey;
+	withdrawerAccount: PublicKey;
+	whitelistedTokens: PublicKey[];
+	platformFee: number;
+	baseFee: number;
+	frequencies: number[];
 };
 ```
 
@@ -258,8 +258,8 @@ For operations that require signing transactions:
 import { createAnchorProvider } from "@zebec-network/stream-sdk";
 
 const provider = createAnchorProvider(connection, wallet, {
-  commitment: "confirmed",
-  preflightCommitment: "confirmed"
+	commitment: "confirmed",
+	preflightCommitment: "confirmed",
 });
 ```
 
@@ -280,15 +280,15 @@ const provider = createReadonlyProvider(connection, optionalWalletAddress);
 ```typescript
 // 1. Create a stream
 const createParams = {
-  receiver: receiverAddress,
-  sender: senderAddress,
-  streamToken: tokenMintAddress,
-  amount: "1000",
-  duration: 86400, // 1 day
-  streamFrequency: 3600, // 1 hour
-  streamName: "Test Stream",
-  startNow: true,
-  // ... other parameters
+	receiver: receiverAddress,
+	sender: senderAddress,
+	streamToken: tokenMintAddress,
+	amount: "1000",
+	duration: 86400, // 1 day
+	streamFrequency: 3600, // 1 hour
+	streamName: "Test Stream",
+	startNow: true,
+	// ... other parameters
 };
 
 const createTx = await streamService.createStream(createParams);
@@ -300,15 +300,15 @@ console.log("Stream info:", streamInfo);
 
 // 3. Withdraw from stream
 const withdrawTx = await streamService.withdrawStream({
-  streamMetadata,
-  receiver: receiverAddress
+	streamMetadata,
+	receiver: receiverAddress,
 });
 await withdrawTx.execute();
 
 // 4. Cancel stream
 const cancelTx = await streamService.cancelStream({
-  streamMetadata,
-  user: senderAddress
+	streamMetadata,
+	user: senderAddress,
 });
 await cancelTx.execute();
 ```
@@ -317,15 +317,15 @@ await cancelTx.execute();
 
 ```typescript
 try {
-  const transaction = await streamService.createStream(params);
-  const signature = await transaction.execute();
-  console.log("Stream created:", signature);
+	const transaction = await streamService.createStream(params);
+	const signature = await transaction.execute();
+	console.log("Stream created:", signature);
 } catch (error) {
-  if (error.message.includes("Invalid stream frequency")) {
-    console.error("Please use an allowed stream frequency");
-  } else {
-    console.error("Stream creation failed:", error);
-  }
+	if (error.message.includes("Invalid stream frequency")) {
+		console.error("Please use an allowed stream frequency");
+	} else {
+		console.error("Stream creation failed:", error);
+	}
 }
 ```