feat(sdk): add action builders

[joeymeere]

Adds another export in the TS SDK called actions, containing builders for various common actions in the SDK. These are optimized for quick succession with as few lines of code as possible.

A developer using these would simply initialize the builder (createThing) with minimal arguments, only covering what's required by the underlying instruction, with the ability to add-on more if needed for additional customization. From there, they can call it synchronously to chain methods for things like returning relevant inferred data (i.e transaction index), adding more complimentary instructions (like creating & voting on proposals), as well as returning a transaction or sending one like the base SDK.

Actions include:

• Creating a multisig
• Creating a vault transaction, proposal, voting, and executing
• Creating a config transaction, proposal, voting, and executing
• Creating a buffer from a transaction, initializing account, slicing / uploading, and converting to a vault transaction
• Creating a batch, proposal, adding transactions and executing

Examples:

async function ExampleOne() {
  const connection = new Connection("...");
  const feePayer = Keypair.generate();
  
  const signature = await createMultisig({
    connection,
    members: createMembers([
      { key: PublicKey.default, permissions: SquadPermissions.All },
    ]),
    creator: PublicKey.default,
    threshold: 1,
  }).sendAndConfirm(feePayer);

  console.log("Signature:", signature);
}

async function ExampleTwo() {
  const connection = new Connection("...");
  
  const multisig = createMultisig({
    connection,
    members: createMembers([
      { key: PublicKey.default, permissions: SquadPermissions.All },
    ]),
    creator: PublicKey.default,
    threshold: 1,
  });

  // Returns instructions
  const a = await multisig.getInstructions();
  // Returns PDA
  const b = multisig.getMultisigKey();
  // Returns deserialized account data
  const c = await multisig.getMultisigAccount(b!);

  console.log(c.members);
}

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
v4-sdk-typedoc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 4, 2024 9:31pm

[0xRigel]

Looks great 🙌 Love the detailed docs above the individual functions, we should adopt this across the rest of the SDK as well 🔥

[palmaswell-squads]

ACK - nice work 👌

[palmaswell-squads]

You may have already considered this, but if you want methods and properties to be "truly" private, meaning they can't be accessed with trickery, I recommend using the native JS private properties #send: boolean = false.

In case you're curious: MDN: Private Properties