Here, the main takeaway is that we are going to use the @sqds/sdk package.
Last but not least, create a main.ts file at the same location, and add this code:
import * as multisig from "@sqds/multisig";
import { Connection, Keypair, LAMPORTS_PER_SOL } from "@solana/web3.js";
const { Permission, Permissions } = multisig.types;
const connection = new Connection("http://localhost:8899", "confirmed");
Let's get to the code (8 minutes)
Create a multisig (2 minutes)
Let's set up a testing flow in which we're going to create a multisig, propose a new transaction, vote on that transaction and execute it.
First, let's add our first step: Setting up the multisig members and creating the multisig.
describe("Interacting with the Squads V4 SDK", () => {
const creator = Keypair.generate();
const secondMember = Keypair.generate();
before(async () => {
const airdropSignature = await connection.requestAirdrop(
creator.publicKey,
1 * LAMPORTS_PER_SOL
);
await connection.confirmTransaction(airdropSignature);
});
const createKey = Keypair.generate().publicKey;
// Derive the multisig account PDA
const [multisigPda] = multisig.getMultisigPda({
createKey,
});
it("Create a new multisig", async () => {
// Create the multisig
const signature = await multisig.rpc.multisigCreate({
connection,
// One time random Key
createKey,
// The creator & fee payer
creator,
multisigPda,
configAuthority: creator.publicKey,
timeLock: 0,
members: [{
key: creator.publicKey,
permissions: Permissions.all(),
},
{
key: secondMember.publicKey,
// This permission means that the user will only be able to vote on transactions
permissions: Permissions.fromPermissions([Permission.Vote]),
},
],
// This means that there needs to be 2 votes for a transaction proposal to be approved
threshold: 2,
});
console.log("Multisig created: ", signature);
});
});
Create transaction proposal (2 minutes)
Now, let's create a transaction proposal. We want the multisig to send 0.1 SOL to the creator.
For purposes of this tutorial, we first have to send that amount to the multisig, and can then create a message containing the instruction that needs to be executed.
it("Create a transaction proposal", async () => {
const [vaultPda, vaultBump] = multisig.getVaultPda({
multisigPda,
index: 0,
});
const instruction = SystemProgram.transfer(
// The transfer is being signed from the Squads Vault, that is why we use the VaultPda
vaultPda,
creator.publicKey,
1 * LAMPORTS_PER_SOL
);
// This message contains the instructions that the transaction is going to execute
const transferMessage = new TransactionMessage({
payerKey: vaultPda,
recentBlockhash: (await connection.getLatestBlockhash()).blockhash,
instructions: [instruction],
});
// This is the first transaction in the multisig
const transactionIndex = 1n;
const signature1 = await multisig.rpc.vaultTransactionCreate({
connection,
feePayer: creator,
multisigPda,
transactionIndex,
creator: creator.publicKey,
vaultIndex: 1,
ephemeralSigners: 0,
transactionMessage: transferMessage,
memo: "Transfer 0.1 SOL to creator",
});
console.log("Transaction created: ", signature1);
const signature2 = await multisig.rpc.proposalCreate({
connection,
feePayer: members.voter,
multisigPda,
transactionIndex,
creator: feePayer,
});
console.log("Transaction proposal created: ", signature2);
});
Vote on the transaction proposal (2 minutes)
Let's now vote on the transaction proposal we just made using the two Keypairs we created at the start of this tutorial: creator and secondMember.
Now that you have a completed flow, let's actually execute these transactions on chain.
For the purpose of this tutorial, we are going to do so on a local Solana instance.
If you do not yet have the Solana CLI installed, please do so by reading the following guide.
Now, start up a local validator with the Squads V4 program preloaded.
solana-test-validator --url m -c SQDS4ep65T869zMMBKyuUq6aD6EgTu8psMjkvj52pCf
Execute the script
Okay, let's execute the script and see what happens.
yarn test
Make sure you are using the Nodee.js version 16. If not, run nvm use 16 inside your terminal.
Visualize your transactions
Once the tests have passed, you can go to the Solana Explorer and visualize your transactions by pasting their signature in the search bar.
