@zebec-network/zebec-vault-sdk 5.0.3 → 5.0.4

package/README.md

@@ -27,23 +27,23 @@ yarn add @zebec-network/zebec-vault-sdk
 ### Setup
 
 ```typescript
-import { Connection, Keypair } from '@solana/web3.js';
-import { createAnchorProvider, ZebecVaultService } from '@zebec-network/zebec-vault-sdk';
+import { Connection, Keypair } from "@solana/web3.js";
+import { createAnchorProvider, ZebecVaultService } from "@zebec-network/zebec-vault-sdk";
 
 // Create connection
-const connection = new Connection('https://api.mainnet-beta.solana.com'); // use private dedicatd rpc for production
+const connection = new Connection("https://api.mainnet-beta.solana.com"); // use private dedicatd rpc for production
 
 // Create wallet adapter
 // for frontend application you can use wallet provided by the wallet provider
-const wallet = useAnchorWallet(); 
+const wallet = useAnchorWallet();
 // for server side app you can use Wallet class provided by @coral-xyz/anchor
-const wallet = new Wallet(keypair) // create keypair from secret key 
+const wallet = new Wallet(keypair); // create keypair from secret key
 
 // Create provider
 const provider = createAnchorProvider(connection, wallet);
 
 // Initialize service
-const vaultService = ZebecVaultService.create(provider, 'mainnet-beta');
+const vaultService = ZebecVaultService.create(provider, "mainnet-beta");
 ```
 
 ## Core Features
@@ -54,19 +54,19 @@ const vaultService = ZebecVaultService.create(provider, 'mainnet-beta');
 
 ```typescript
 const payload = await vaultService.createVault({
-  payer: wallet.publicKey // optional if using AnchorProvider
+ payer: wallet.publicKey, // optional if using AnchorProvider
 });
 
 const signature = await payload.execute();
-console.log('Vault created:', signature);
+console.log("Vault created:", signature);
 ```
 
 #### Deposit SOL
 
 ```typescript
 const payload = await vaultService.depositSol({
-  depositor: wallet.publicKey,
-  amount: 1.5 // SOL amount
+ depositor: wallet.publicKey,
+ amount: 1.5, // SOL amount
 });
 
 await payload.execute();
@@ -76,9 +76,9 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.deposit({
-  depositor: wallet.publicKey,
-  tokenMint: 'TOKEN_MINT_ADDRESS',
-  amount: 100 // token amount
+ depositor: wallet.publicKey,
+ tokenMint: "TOKEN_MINT_ADDRESS",
+ amount: 100, // token amount
 });
 
 await payload.execute();
@@ -90,8 +90,8 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.withdrawSol({
-  withdrawer: wallet.publicKey,
-  amount: 0.5
+ withdrawer: wallet.publicKey,
+ amount: 0.5,
 });
 
 await payload.execute();
@@ -100,13 +100,13 @@ await payload.execute();
 #### Withdraw SPL Tokens
 
 ```typescript
-const payload = await vaultService.withdraw({
+ const payload = await vaultService.withdraw({
   withdrawer: wallet.publicKey,
-  tokenMint: 'TOKEN_MINT_ADDRESS',
-  amount: 50
-});
+  tokenMint: "TOKEN_MINT_ADDRESS",
+  amount: 50,
+ });
 
-await payload.execute();
+ await payload.execute();
 
 // Note: if WSOL is address in given in tokenMint, it will with withdraw WSOL and unwrap into withdrawer wallet.
 ```
@@ -116,19 +116,19 @@ await payload.execute();
 #### Create a Proposal
 
 ```typescript
-import { SystemProgram } from '@solana/web3.js';
+import { SystemProgram } from "@solana/web3.js";
 
 // Create custom instructions
 const instruction = SystemProgram.transfer({
-  fromPubkey: vaultSigner,
-  toPubkey: recipient,
-  lamports: 1000000
+ fromPubkey: vaultSigner,
+ toPubkey: recipient,
+ lamports: 1000000,
 });
 
 const payload = await vaultService.createProposal({
-  proposer: wallet.publicKey,
-  name: 'Transfer SOL',
-  actions: [instruction]
+ proposer: wallet.publicKey,
+ name: "Transfer SOL",
+ actions: [instruction],
 });
 
 await payload.execute();
@@ -138,9 +138,9 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.executeProposal({
-  caller: wallet.publicKey,
-  proposal: proposalAddress,
-  addressLookupTables: [lookupTableAddress] // optional
+ caller: wallet.publicKey,
+ proposal: proposalAddress,
+ addressLookupTables: [lookupTableAddress], // optional
 });
 
 await payload.execute();
@@ -150,9 +150,9 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.executeProposalDirect({
-  proposer: wallet.publicKey,
-  actions: [instruction1, instruction2],
-  addressLookupTables: [lookupTableAddress]
+ proposer: wallet.publicKey,
+ actions: [instruction1, instruction2],
+ addressLookupTables: [lookupTableAddress],
 });
 
 await payload.execute();
@@ -164,24 +164,24 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.createStreamFromVault({
-  vaultOwner: wallet.publicKey,
-  receiver: recipientAddress,
-  streamToken: tokenMintAddress,
-  amount: 1000, // total amount
-  duration: 2592000, // 30 days in seconds
-  startNow: true,
-  startTime: Math.floor(Date.now() / 1000),
-  automaticWithdrawal: false,
-  cancelableByRecipient: true,
-  cancelableBySender: true,
-  isPausable: true,
-  transferableByRecipient: false,
-  transferableBySender: false,
-  canTopup: true,
-  rateUpdatable: false,
-  cliffPercentage: 0, // 0-100
-  autoWithdrawFrequency: 86400, // 1 day
-  streamName: 'Monthly Payment'
+ vaultOwner: wallet.publicKey,
+ receiver: recipientAddress,
+ streamToken: tokenMintAddress,
+ amount: 1000, // total amount
+ duration: 2592000, // 30 days in seconds
+ startNow: true,
+ startTime: Math.floor(Date.now() / 1000),
+ automaticWithdrawal: false,
+ cancelableByRecipient: true,
+ cancelableBySender: true,
+ isPausable: true,
+ transferableByRecipient: false,
+ transferableBySender: false,
+ canTopup: true,
+ rateUpdatable: false,
+ cliffPercentage: 0, // 0-100
+ autoWithdrawFrequency: 86400, // 1 day
+ streamName: "Monthly Payment",
 });
 
 await payload.execute();
@@ -191,23 +191,23 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.createMultipleStreamFromVault({
-  vaultOwner: wallet.publicKey,
-  streamInfo: [
-    {
-      receiver: recipient1,
-      streamToken: tokenMint,
-      amount: 500,
-      duration: 2592000,
-      // ... other stream parameters
-    },
-    {
-      receiver: recipient2,
-      streamToken: tokenMint,
-      amount: 1000,
-      duration: 2592000,
-      // ... other stream parameters
-    }
-  ]
+ vaultOwner: wallet.publicKey,
+ streamInfo: [
+  {
+   receiver: recipient1,
+   streamToken: tokenMint,
+   amount: 500,
+   duration: 2592000,
+   // ... other stream parameters
+  },
+  {
+   receiver: recipient2,
+   streamToken: tokenMint,
+   amount: 1000,
+   duration: 2592000,
+   // ... other stream parameters
+  },
+ ],
 });
 
 // Execute all streams in multiple transactions
@@ -218,8 +218,8 @@ await payload.executeAll();
 
 ```typescript
 const payload = await vaultService.pauseResumeStream({
-  vaultOwner: wallet.publicKey,
-  streamMetadata: streamAddress
+ vaultOwner: wallet.publicKey,
+ streamMetadata: streamAddress,
 });
 
 await payload.execute();
@@ -229,8 +229,8 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.cancelStream({
-  vaultOwner: wallet.publicKey,
-  streamMetadata: streamAddress
+ vaultOwner: wallet.publicKey,
+ streamMetadata: streamAddress,
 });
 
 await payload.execute();
@@ -240,8 +240,8 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.withdrawStream({
-  vaultOwner: wallet.publicKey,
-  streamMetadata: streamAddress
+ vaultOwner: wallet.publicKey,
+ streamMetadata: streamAddress,
 });
 
 await payload.execute();
@@ -251,9 +251,9 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.changeStreamReceiver({
-  vaultOwner: wallet.publicKey,
-  streamMetadata: streamAddress,
-  newRecipient: newRecipientAddress
+ vaultOwner: wallet.publicKey,
+ streamMetadata: streamAddress,
+ newRecipient: newRecipientAddress,
 });
 
 await payload.execute();
@@ -264,15 +264,15 @@ await payload.execute();
 ```typescript
 const streamInfo = await vaultService.getStreamMetadataInfo(streamAddress);
 
-console.log('Stream details:', {
-  sender: streamInfo.parties.sender,
-  receiver: streamInfo.parties.receiver,
-  token: streamInfo.financials.streamToken,
-  deposited: streamInfo.financials.depositedAmount,
-  withdrawn: streamInfo.financials.withdrawnAmount,
-  startTime: new Date(streamInfo.schedule.startTime * 1000),
-  endTime: new Date(streamInfo.schedule.endTime * 1000),
-  isPaused: streamInfo.schedule.pausedTimestamp > 0
+console.log("Stream details:", {
+ sender: streamInfo.parties.sender,
+ receiver: streamInfo.parties.receiver,
+ token: streamInfo.financials.streamToken,
+ deposited: streamInfo.financials.depositedAmount,
+ withdrawn: streamInfo.financials.withdrawnAmount,
+ startTime: new Date(streamInfo.schedule.startTime * 1000),
+ endTime: new Date(streamInfo.schedule.endTime * 1000),
+ isPaused: streamInfo.schedule.pausedTimestamp > 0,
 });
 ```
 
@@ -282,11 +282,11 @@ console.log('Stream details:', {
 
 ```typescript
 const payload = await vaultService.stake({
-  lockupName: 'main-lockup',
-  vaultOwner: wallet.publicKey,
-  amount: 1000,
-  lockPeriod: 7776000, // 90 days in seconds
-  nonce: 0n
+ lockupName: "main-lockup",
+ vaultOwner: wallet.publicKey,
+ amount: 1000,
+ lockPeriod: 7776000, // 90 days in seconds
+ nonce: 0n,
 });
 
 await payload.execute();
@@ -296,9 +296,9 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.unstake({
-  lockupName: 'main-lockup',
-  vaultOwner: wallet.publicKey,
-  nonce: 0n
+ lockupName: "main-lockup",
+ vaultOwner: wallet.publicKey,
+ nonce: 0n,
 });
 
 await payload.execute();
@@ -307,12 +307,9 @@ await payload.execute();
 #### Get Stake Nonce Information
 
 ```typescript
-const nonceInfo = await vaultService.getStakeUserNonceInfo(
-  'main-lockup',
-  wallet.publicKey
-);
+const nonceInfo = await vaultService.getStakeUserNonceInfo("main-lockup", wallet.publicKey);
 
-console.log('Current nonce:', nonceInfo?.nonce);
+console.log("Current nonce:", nonceInfo?.nonce);
 ```
 
 ### 5. Virtual Cards
@@ -323,12 +320,12 @@ console.log('Current nonce:', nonceInfo?.nonce);
 const nextIndex = await vaultService.getNextCardIndex();
 
 const payload = await vaultService.createSilverCard({
-  vaultOwnerAddress: wallet.publicKey,
-  nextCardIndex: nextIndex,
-  amount: 100, // USDC amount
-  usdcAddress: USDC_MINT_ADDRESS,
-  emailHash: Buffer.from('your-32-byte-hash'),
-  currency: 'USD'
+ vaultOwnerAddress: wallet.publicKey,
+ nextCardIndex: nextIndex,
+ amount: 100, // USDC amount
+ usdcAddress: USDC_MINT_ADDRESS,
+ emailHash: Buffer.from("your-32-byte-hash"),
+ currency: "USD",
 });
 
 await payload.execute();
@@ -340,13 +337,13 @@ await payload.execute();
 const nextIndex = await vaultService.getNextCardIndex();
 
 const payload = await vaultService.loadCarbonCard({
-  vaultOwnerAddress: wallet.publicKey,
-  nextCardIndex: nextIndex,
-  amount: 50,
-  usdcAddress: USDC_MINT_ADDRESS,
-  emailHash: Buffer.from('your-32-byte-hash'),
-  currency: 'USD',
-  reloadCardId: 'CARD_ID'
+ vaultOwnerAddress: wallet.publicKey,
+ nextCardIndex: nextIndex,
+ amount: 50,
+ usdcAddress: USDC_MINT_ADDRESS,
+ emailHash: Buffer.from("your-32-byte-hash"),
+ currency: "USD",
+ reloadCardId: "CARD_ID",
 });
 
 await payload.execute();
@@ -357,17 +354,17 @@ await payload.execute();
 ```typescript
 // First, get a Jupiter quote
 const quoteResponse = await fetch(
-  `https://quote-api.jup.ag/v6/quote?inputMint=${inputMint}&outputMint=${USDC}&amount=${amount}&slippageBps=50`
+ `https://quote-api.jup.ag/v6/quote?inputMint=${inputMint}&outputMint=${USDC}&amount=${amount}&slippageBps=50`,
 );
 const quoteInfo = await quoteResponse.json();
 
 const payload = await vaultService.swapAndCreateSilverCard({
-  vaultOwnerAddress: wallet.publicKey,
-  quoteInfo: quoteInfo,
-  nextCardCounter: nextIndex,
-  emailHash: Buffer.from('your-32-byte-hash'),
-  currency: 'USD',
-  wrapAndUnwrapSol: true // if swapping SOL
+ vaultOwnerAddress: wallet.publicKey,
+ quoteInfo: quoteInfo,
+ nextCardCounter: nextIndex,
+ emailHash: Buffer.from("your-32-byte-hash"),
+ currency: "USD",
+ wrapAndUnwrapSol: true, // if swapping SOL
 });
 
 await payload.execute();
@@ -377,13 +374,13 @@ await payload.execute();
 
 ```typescript
 const payload = await vaultService.swapAndLoadCarbonCard({
-  vaultOwnerAddress: wallet.publicKey,
-  quoteInfo: quoteInfo,
-  nextCardCounter: nextIndex,
-  emailHash: Buffer.from('your-32-byte-hash'),
-  currency: 'USD',
-  reloadCardId: 'CARD_ID',
-  wrapAndUnwrapSol: true
+ vaultOwnerAddress: wallet.publicKey,
+ quoteInfo: quoteInfo,
+ nextCardCounter: nextIndex,
+ emailHash: Buffer.from("your-32-byte-hash"),
+ currency: "USD",
+ reloadCardId: "CARD_ID",
+ wrapAndUnwrapSol: true,
 });
 
 await payload.execute();
@@ -394,8 +391,8 @@ await payload.execute();
 ```typescript
 const tokenFees = await vaultService.getCardCustomTokenFees();
 
-tokenFees.forEach(fee => {
-  console.log(`Token: ${fee.tokenAddress}, Fee: ${fee.fee}%`);
+tokenFees.forEach((fee) => {
+ console.log(`Token: ${fee.tokenAddress}, Fee: ${fee.fee}%`);
 });
 ```
 
@@ -408,9 +405,9 @@ tokenFees.forEach(fee => {
 const vaultInfo = await vaultService.getVaultInfoOfUser(userAddress);
 
 if (vaultInfo) {
-  console.log('Vault:', vaultInfo.vault.toString());
-  console.log('Owner:', vaultInfo.owner.toString());
-  console.log('Created:', new Date(vaultInfo.createdDate * 1000));
+ console.log("Vault:", vaultInfo.vault.toString());
+ console.log("Owner:", vaultInfo.owner.toString());
+ console.log("Created:", new Date(vaultInfo.createdDate * 1000));
 }
 
 // Get all vaults
@@ -423,11 +420,11 @@ console.log(`Total vaults: ${allVaults.length}`);
 ```typescript
 const proposals = await vaultService.getProposalsInfoOfVault(vaultAddress);
 
-proposals.forEach(proposal => {
-  console.log('Proposal:', proposal.name);
-  console.log('Status:', proposal.proposalStage);
-  console.log('Actions:', proposal.actions.length);
-  console.log('Executed:', proposal.isExecuted);
+proposals.forEach((proposal) => {
+ console.log("Proposal:", proposal.name);
+ console.log("Status:", proposal.proposalStage);
+ console.log("Actions:", proposal.actions.length);
+ console.log("Executed:", proposal.isExecuted);
 });
 ```
 
@@ -436,14 +433,11 @@ proposals.forEach(proposal => {
 For read-only operations without a wallet:
 
 ```typescript
-import { createReadonlyProvider } from '@zebec-network/zebec-vault-sdk';
+import { createReadonlyProvider } from "@zebec-network/zebec-vault-sdk";
 
-const readonlyProvider = createReadonlyProvider(
-  connection,
-  optionalWalletAddress
-);
+const readonlyProvider = createReadonlyProvider(connection, optionalWalletAddress);
 
-const service = ZebecVaultService.create(readonlyProvider, 'mainnet-beta');
+const service = ZebecVaultService.create(readonlyProvider, "mainnet-beta");
 
 // Can only call query methods
 const vaultInfo = await service.getVaultInfoOfUser(someAddress);
@@ -455,22 +449,22 @@ The SDK provides custom error types:
 
 ```typescript
 import {
-  AmountOutOfRangeError,
-  DailyCardLimitReachedError,
-  NotEnoughBalanceError,
-  AssociatedTokenAccountDoesNotExistsError
-} from '@zebec-network/zebec-vault-sdk';
+ AmountOutOfRangeError,
+ DailyCardLimitReachedError,
+ NotEnoughBalanceError,
+ AssociatedTokenAccountDoesNotExistsError,
+} from "@zebec-network/zebec-vault-sdk";
 
 try {
-  await payload.execute();
+ await payload.execute();
 } catch (error) {
-  if (error instanceof AmountOutOfRangeError) {
-    console.error('Amount must be between', error.minRange, 'and', error.maxRange);
-  } else if (error instanceof DailyCardLimitReachedError) {
-    console.error('Daily limit:', error.dailyCardLimit);
-  } else if (error instanceof NotEnoughBalanceError) {
-    console.error('Insufficient balance');
-  }
+ if (error instanceof AmountOutOfRangeError) {
+  console.error("Amount must be between", error.minRange, "and", error.maxRange);
+ } else if (error instanceof DailyCardLimitReachedError) {
+  console.error("Daily limit:", error.dailyCardLimit);
+ } else if (error instanceof NotEnoughBalanceError) {
+  console.error("Insufficient balance");
+ }
 }
 ```
 
@@ -480,34 +474,25 @@ try {
 
 ```typescript
 import {
-  deriveUserVault,
-  deriveVaultSigner,
-  deriveStreamConfigPda,
-  deriveCardConfigPda,
-  deriveLockupAddress
-} from '@zebec-network/zebec-vault-sdk';
-
-const [vaultAddress, vaultBump] = deriveUserVault(
-  userAddress,
-  vaultProgramId
-);
+ deriveUserVault,
+ deriveVaultSigner,
+ deriveStreamConfigPda,
+ deriveCardConfigPda,
+ deriveLockupAddress,
+} from "@zebec-network/zebec-vault-sdk";
 
-const [signerAddress, signerBump] = deriveVaultSigner(
-  vaultAddress,
-  vaultProgramId
-);
+const [vaultAddress, vaultBump] = deriveUserVault(userAddress, vaultProgramId);
+
+const [signerAddress, signerBump] = deriveVaultSigner(vaultAddress, vaultProgramId);
 ```
 
 ### Transaction Utilities
 
 ```typescript
-import {
-  calculateProposalSize,
-  transactionInstructionToProposalAction
-} from '@zebec-network/zebec-vault-sdk';
+import { calculateProposalSize, transactionInstructionToProposalAction } from "@zebec-network/zebec-vault-sdk";
 
 // Calculate proposal size
-const size = calculateProposalSize('proposal-name', actions);
+const size = calculateProposalSize("proposal-name", actions);
 
 // Convert instruction to proposal action
 const action = transactionInstructionToProposalAction(instruction);
@@ -517,23 +502,23 @@ const action = transactionInstructionToProposalAction(instruction);
 
 ```typescript
 // Mainnet
-const mainnetService = ZebecVaultService.create(provider, 'mainnet-beta');
+const mainnetService = ZebecVaultService.create(provider, "mainnet-beta");
 
 // Devnet
-const devnetService = ZebecVaultService.create(provider, 'devnet');
+const devnetService = ZebecVaultService.create(provider, "devnet");
 ```
 
 ## Constants
 
 ```typescript
 import {
-  ZEBEC_VAULT_PROGRAM_ID,
-  JUPITER_AGGREGATOR_PROGRAM_ID,
-  CARD_LOOKUP_TABLE_ADDRESS,
-  STAKE_LOOKUP_TABLE_ADDRESS
-} from '@zebec-network/zebec-vault-sdk';
+ ZEBEC_VAULT_PROGRAM_ID,
+ JUPITER_AGGREGATOR_PROGRAM_ID,
+ CARD_LOOKUP_TABLE_ADDRESS,
+ STAKE_LOOKUP_TABLE_ADDRESS,
+} from "@zebec-network/zebec-vault-sdk";
 
-console.log('Vault Program:', ZEBEC_VAULT_PROGRAM_ID['mainnet-beta']);
+console.log("Vault Program:", ZEBEC_VAULT_PROGRAM_ID["mainnet-beta"]);
 ```
 
 ## Types
@@ -542,15 +527,15 @@ The SDK exports comprehensive TypeScript types:
 
 ```typescript
 import type {
-  VaultInfo,
-  ProposalInfo,
-  ProposalAction,
-  CreateStreamFromVaultParams,
-  StreamMetadataInfo,
-  TokenFeeRecord,
-  QuoteInfo,
-  StakeUserNonceInfo
-} from '@zebec-network/zebec-vault-sdk';
+ VaultInfo,
+ ProposalInfo,
+ ProposalAction,
+ CreateStreamFromVaultParams,
+ StreamMetadataInfo,
+ TokenFeeRecord,
+ QuoteInfo,
+ StakeUserNonceInfo,
+} from "@zebec-network/zebec-vault-sdk";
 ```
 
 ## Best Practices

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zebec-network/zebec-vault-sdk",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "An SDK for zebec vault solana program",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -41,7 +41,7 @@
     "@solana/web3.js": "^1.98.2",
     "@types/bn.js": "^5.2.0",
     "@zebec-network/core-utils": "^1.1.1",
-    "@zebec-network/solana-common": "^2.3.0",
+    "@zebec-network/solana-common": "^2.3.1",
     "bignumber.js": "^9.3.1",
     "buffer": "^6.0.3"
   }