@zebec-network/zebec-vault-sdk 1.0.5 → 1.0.7

package/README.md

@@ -39,3 +39,72 @@ npm publish --access public
 ```
 
 ## Usage
+
+### Create Vault Instance
+
+```ts
+const network = "devnet";
+const wallet = <Anchor wallet>;
+const connection = <Connection Instance>;
+const provider = createAnchorProvider(connection, wallet);
+const service = await ZebecVaultService.create(provider, network);
+```
+
+### Create Vault
+
+```ts
+const vaultKeypair = Keypair.generate();
+console.log("Vault Keypair:", vaultKeypair.publicKey.toBase58());
+const payload = await service.createVault({
+   vaultKeypair,
+});
+
+const signature = await payload.execute({ commitment: "finalized" });
+console.log("Signature:", signature);
+```
+
+### Get Vault Info of User
+
+```ts
+const vaultsInfo = await service.getVaultsInfoOfUser(wallet.publicKey);
+console.log("vaults info:", JSON.stringify(vaultsInfo, null, 2));
+const vault = vaultsInfo[0].vault;
+```
+
+### Deposit Sol
+
+```ts
+const vault = <vault public key>;
+const amount = 2;
+const payload = await service.depositSol({ amount, vault });
+const signature = await payload.execute({ commitment: "finalized" });
+```
+
+### Withdraw Sol
+
+```ts
+const vault = <vault public key>;
+const amount = 0.01;
+const payload = await service.withdrawSol({ amount, vault });
+const signature = await payload.execute({ commitment: "finalized" });
+```
+
+### Deposit Token
+
+```ts
+const tokenMint = "De31sBPcDejCVpZZh1fq8SNs7AcuWcBKuU3k2jqnkmKc";
+const vault = <vault public key>;
+const amount = 1000
+const payload = await service.depositToken({ amount, vault, tokenMint });
+const signature = await payload.execute({ commitment: "finalized" });
+```
+
+### Withdraw Token
+
+```ts
+const vault = <vault public key>;
+const tokenMint = "De31sBPcDejCVpZZh1fq8SNs7AcuWcBKuU3k2jqnkmKc";
+const amount = 1;
+const payload = await service.withdrawToken({ amount, vault, tokenMint });
+const signature = await payload.execute({ commitment: "finalized" });
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zebec-network/zebec-vault-sdk",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "An SDK for zebec vault solana program",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
   "devDependencies": {
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.0.1",
-    "@zebec-network/zebec-stake-sdk": "^1.0.9",
+    "@zebec-network/zebec-stake-sdk": "^1.0.10",
     "dotenv": "^16.5.0",
     "mocha": "^11.6.0",
     "prettier": "^3.5.3",
@@ -39,7 +39,7 @@
     "@coral-xyz/anchor": "^0.31.1",
     "@solana/web3.js": "^1.98.2",
     "@types/bn.js": "^5.2.0",
-    "@zebec-network/solana-common": "^1.3.0",
+    "@zebec-network/solana-common": "^1.5.0",
     "bignumber.js": "^9.3.0",
     "buffer": "^6.0.3"
   }