From e9922ed39e2eb00ad151b3c41c38be9c3ae369b5 Mon Sep 17 00:00:00 2001 From: A91y Date: Sat, 28 Dec 2024 22:05:14 +0530 Subject: [PATCH] feat: add create_squads_multisig function and update deposit_to_multisig documentation for clarity --- src/tools/squads_multisig/create_multisig.ts | 9 +++++++++ src/tools/squads_multisig/deposit_to_multisig.ts | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/tools/squads_multisig/create_multisig.ts b/src/tools/squads_multisig/create_multisig.ts index 1146618..3fa76ef 100644 --- a/src/tools/squads_multisig/create_multisig.ts +++ b/src/tools/squads_multisig/create_multisig.ts @@ -2,6 +2,15 @@ import * as multisig from "@sqds/multisig"; import { PublicKey } from "@solana/web3.js"; import { SolanaAgentKit } from "../../index"; +/** + * Creates a new Squads multisig account. + * + * @param agent - The SolanaAgentKit instance containing the connection and wallet information. + * @param creator - The public key of the creator who will be a member of the multisig. + * @returns A promise that resolves to the transaction ID of the multisig creation transaction. + * + * @throws Will throw an error if the transaction fails. + */ export async function create_squads_multisig( agent: SolanaAgentKit, creator: PublicKey, diff --git a/src/tools/squads_multisig/deposit_to_multisig.ts b/src/tools/squads_multisig/deposit_to_multisig.ts index 4e1d9c2..11a2582 100644 --- a/src/tools/squads_multisig/deposit_to_multisig.ts +++ b/src/tools/squads_multisig/deposit_to_multisig.ts @@ -10,7 +10,7 @@ import { import * as multisig from "@sqds/multisig"; /** - * Transfer SOL or SPL tokens to a recipient + * Transfer SOL or SPL tokens to a multisig vault. * @param agent SolanaAgentKit instance * @param amount Amount to transfer * @param vaultIndex Optional vault index, default is 0