@zebec-network/zebec-vault-sdk 1.0.8 → 1.1.0

package/README.md

@@ -2,29 +2,29 @@
 
 ## Installation
 
-```
+```bash
 yarn add @zebec-network/zebec-vault-sdk
 ```
 
-```
+```bash
 npm install @zebec-network/zebec-vault-sdk
 ```
 
 ## Dependency Map
 
-![VaultSDKDependencyMap](./assets/VaultSDKDependencyMap.png)
+![Vault SDK Dependency Map](./assets/VaultSDKDependencyMap.png)
 
 ## Development
 
 To build the package
 
-```
+```bash
 yarn build
 ```
 
 To run specific test filess
 
-```
+```bash
 yarn test <test file path> -f "<regex for test name>"
 // example:
 // yarn test ./test/<filename>.test.ts
@@ -34,7 +34,7 @@ yarn test <test file path> -f "<regex for test name>"
 
 Build package and bump package version to specific need and publish
 
-```
+```bash
 npm publish --access public
 ```
 
@@ -56,7 +56,7 @@ const service = await ZebecVaultService.create(provider, network);
 const vaultKeypair = Keypair.generate();
 console.log("Vault Keypair:", vaultKeypair.publicKey.toBase58());
 const payload = await service.createVault({
-   vaultKeypair,
+ vaultKeypair,
 });
 
 const signature = await payload.execute({ commitment: "finalized" });
@@ -108,3 +108,112 @@ const amount = 1;
 const payload = await service.withdrawToken({ amount, vault, tokenMint });
 const signature = await payload.execute({ commitment: "finalized" });
 ```
+
+### Execute Proposal Direct
+
+```ts
+const proposer = <wallet public key>;
+const vault = <vault public key>;
+
+const memoInstruction = new TransactionInstruction({
+ keys: [],
+ programId: MEMO_PROGRAM_ID,
+ data: Buffer.from("This is test memo", "utf8"),
+});
+const actions = [memoInstruction];
+
+const payload = await service.executeProposalDirect({
+ actions,
+ proposer,
+ vault,
+});
+
+const signature = await payload.execute({ commitment: "finalized" });
+console.log("Execute Proposal Direct Signature:", signature);
+```
+
+### Create Proposal
+
+```ts
+const proposer = <wallet public key>;
+const receiver = <wallet public Key>;
+const vault = <vault public key>;
+
+const [vaultSigner] = deriveVaultSigner(vault, service.programId);
+const name = "Transfer Funds";
+const ix = SystemProgram.transfer({
+ fromPubkey: vaultSigner,
+ toPubkey: receiver,
+ lamports: Number(parseSol(1)),
+});
+const actions = [ix];
+const proposalKeypair = Keypair.generate();
+
+const createProposalPayload = await service.createProposal({
+ actions,
+ name,
+ proposer,
+ vault,
+ proposalKeypair,
+});
+
+const signature = await createProposalPayload.execute({ commitment: "finalized" });
+```
+
+### Append Actions
+
+```ts
+const proposal = <proposal public key>;
+
+const ixB = new TransactionInstruction({
+ keys: [],
+ programId: MEMO_PROGRAM_ID,
+ data: Buffer.from("This is test memo", "utf8"),
+});
+const actionsB = [ixB];
+
+const appendActionsPayload = await service.appendActions({
+ actions: actionsB,
+ proposal,
+});
+
+const appendActionsSignature = await appendActionsPayload.execute({ commitment: "confirmed" });
+```
+
+### Execute Proposal
+
+```ts
+const proposal = <proposal public key>;
+const payload = await service.executeProposal({
+   proposal,
+});
+
+const signature = await payload.execute({ commitment: "confirmed" });
+console.log("Execute Proposal Signature:", signature);
+```
+
+### Delete Proposal
+
+```ts
+const proposal = <proposal public key>;
+
+const deleteProposalPayload = await service.deleteProposal({ proposal });
+const deleteProposalSignature = await deleteProposalPayload.execute({
+ commitment: "confirmed",
+});
+console.log("Delete Proposal Signature:", deleteProposalSignature);
+```
+
+### Get Proposals Info of a Vault
+
+```ts
+const vault = <vault public key>;
+
+const proposalsInfo = await service.getProposalsInfoOfVault(vault);
+```
+
+### Get All Vaults Info
+
+```ts
+const vaultsInfo = await service.getAllVaultsInfo();
+```

package/dist/artifacts/zebec_vault.d.ts

@@ -200,39 +200,6 @@ export type ZebecVault = {
                         ];
                     };
                 },
-                {
-                    name: "whitelist";
-                    pda: {
-                        seeds: [
-                            {
-                                kind: "const";
-                                value: [
-                                    122,
-                                    101,
-                                    98,
-                                    101,
-                                    99,
-                                    95,
-                                    118,
-                                    97,
-                                    117,
-                                    108,
-                                    116,
-                                    95,
-                                    119,
-                                    104,
-                                    105,
-                                    116,
-                                    101,
-                                    108,
-                                    105,
-                                    115,
-                                    116
-                                ];
-                            }
-                        ];
-                    };
-                },
                 {
                     name: "tokenMint";
                 },
@@ -517,65 +484,6 @@ export type ZebecVault = {
                 }
             ];
         },
-        {
-            name: "whitelistToken";
-            discriminator: [6, 141, 83, 167, 31, 6, 2, 224];
-            accounts: [
-                {
-                    name: "whitelister";
-                    writable: true;
-                    signer: true;
-                },
-                {
-                    name: "whitelist";
-                    writable: true;
-                    pda: {
-                        seeds: [
-                            {
-                                kind: "const";
-                                value: [
-                                    122,
-                                    101,
-                                    98,
-                                    101,
-                                    99,
-                                    95,
-                                    118,
-                                    97,
-                                    117,
-                                    108,
-                                    116,
-                                    95,
-                                    119,
-                                    104,
-                                    105,
-                                    116,
-                                    101,
-                                    108,
-                                    105,
-                                    115,
-                                    116
-                                ];
-                            }
-                        ];
-                    };
-                },
-                {
-                    name: "systemProgram";
-                    address: "11111111111111111111111111111111";
-                }
-            ];
-            args: [
-                {
-                    name: "params";
-                    type: {
-                        defined: {
-                            name: "whitelistTokenParams";
-                        };
-                    };
-                }
-            ];
-        },
         {
             name: "withdrawSol";
             discriminator: [145, 131, 74, 136, 65, 137, 42, 38];
@@ -864,10 +772,6 @@ export type ZebecVault = {
         {
             name: "vault";
             discriminator: [211, 8, 232, 43, 2, 152, 117, 119];
-        },
-        {
-            name: "whitelist";
-            discriminator: [204, 176, 52, 79, 146, 121, 54, 247];
         }
     ];
     events: [
@@ -1440,6 +1344,10 @@ export type ZebecVault = {
                     {
                         name: "amount";
                         type: "u64";
+                    },
+                    {
+                        name: "tokenAddress";
+                        type: "pubkey";
                     }
                 ];
             };
@@ -1490,6 +1398,10 @@ export type ZebecVault = {
                     {
                         name: "amount";
                         type: "u64";
+                    },
+                    {
+                        name: "tokenAddress";
+                        type: "pubkey";
                     }
                 ];
             };
@@ -1534,54 +1446,6 @@ export type ZebecVault = {
                 ];
             };
         },
-        {
-            name: "whitelist";
-            type: {
-                kind: "struct";
-                fields: [
-                    {
-                        name: "admin";
-                        type: "pubkey";
-                    },
-                    {
-                        name: "whitelistedTokens";
-                        type: {
-                            vec: {
-                                defined: {
-                                    name: "whitelistedToken";
-                                };
-                            };
-                        };
-                    }
-                ];
-            };
-        },
-        {
-            name: "whitelistTokenParams";
-            type: {
-                kind: "struct";
-                fields: [
-                    {
-                        name: "tokenAddresses";
-                        type: {
-                            vec: "pubkey";
-                        };
-                    }
-                ];
-            };
-        },
-        {
-            name: "whitelistedToken";
-            type: {
-                kind: "struct";
-                fields: [
-                    {
-                        name: "tokenAddress";
-                        type: "pubkey";
-                    }
-                ];
-            };
-        },
         {
             name: "withdrawSolParams";
             type: {