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

package/README.md

@@ -37,3 +37,74 @@ Build package and bump package version to specific need and publish
 ```
 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/dist/index.d.ts

@@ -5,4 +5,3 @@ export * from "./providers";
 export * from "./service";
 export * from "./types";
 export * from "./utils";
-export { deriveLockupAddress, deriveRewardVaultAddress, deriveStakeAddress, deriveStakeVaultAddress, deriveUserNonceAddress, InitLockupInstructionData, LockupInfo, ParsedRewardScheme, RateLimitedQueue, ReadonlyProvider, RewardScheme, StakeInfo, StakeInfoWithHash, StakeInstructionData, StakeService, StakeServiceBuilder, UserNonceInfo, ZEBEC_STAKE_IDL_V1, ZEBEC_STAKE_PROGRAM, ZebecStakeIdlV1, } from "@zebec-network/zebec-stake-sdk";

package/dist/index.js

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZEBEC_STAKE_PROGRAM = exports.ZEBEC_STAKE_IDL_V1 = exports.StakeServiceBuilder = exports.StakeService = exports.ReadonlyProvider = exports.RateLimitedQueue = exports.deriveUserNonceAddress = exports.deriveStakeVaultAddress = exports.deriveStakeAddress = exports.deriveRewardVaultAddress = exports.deriveLockupAddress = void 0;
 __exportStar(require("./artifacts"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./pda"), exports);
@@ -22,15 +21,3 @@ __exportStar(require("./providers"), exports);
 __exportStar(require("./service"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
-var zebec_stake_sdk_1 = require("@zebec-network/zebec-stake-sdk");
-Object.defineProperty(exports, "deriveLockupAddress", { enumerable: true, get: function () { return zebec_stake_sdk_1.deriveLockupAddress; } });
-Object.defineProperty(exports, "deriveRewardVaultAddress", { enumerable: true, get: function () { return zebec_stake_sdk_1.deriveRewardVaultAddress; } });
-Object.defineProperty(exports, "deriveStakeAddress", { enumerable: true, get: function () { return zebec_stake_sdk_1.deriveStakeAddress; } });
-Object.defineProperty(exports, "deriveStakeVaultAddress", { enumerable: true, get: function () { return zebec_stake_sdk_1.deriveStakeVaultAddress; } });
-Object.defineProperty(exports, "deriveUserNonceAddress", { enumerable: true, get: function () { return zebec_stake_sdk_1.deriveUserNonceAddress; } });
-Object.defineProperty(exports, "RateLimitedQueue", { enumerable: true, get: function () { return zebec_stake_sdk_1.RateLimitedQueue; } });
-Object.defineProperty(exports, "ReadonlyProvider", { enumerable: true, get: function () { return zebec_stake_sdk_1.ReadonlyProvider; } });
-Object.defineProperty(exports, "StakeService", { enumerable: true, get: function () { return zebec_stake_sdk_1.StakeService; } });
-Object.defineProperty(exports, "StakeServiceBuilder", { enumerable: true, get: function () { return zebec_stake_sdk_1.StakeServiceBuilder; } });
-Object.defineProperty(exports, "ZEBEC_STAKE_IDL_V1", { enumerable: true, get: function () { return zebec_stake_sdk_1.ZEBEC_STAKE_IDL_V1; } });
-Object.defineProperty(exports, "ZEBEC_STAKE_PROGRAM", { enumerable: true, get: function () { return zebec_stake_sdk_1.ZEBEC_STAKE_PROGRAM; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zebec-network/zebec-vault-sdk",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "An SDK for zebec vault solana program",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,6 +26,7 @@
   "devDependencies": {
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.0.1",
+    "@zebec-network/zebec-stake-sdk": "^1.0.10",
     "dotenv": "^16.5.0",
     "mocha": "^11.6.0",
     "prettier": "^3.5.3",
@@ -38,8 +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/zebec-stake-sdk": "^1.0.8",
+    "@zebec-network/solana-common": "^1.5.0",
     "bignumber.js": "^9.3.0",
     "buffer": "^6.0.3"
   }