Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
@sqds/multisig package installedimport * as multisig from "@sqds/multisig";
import { Connection, PublicKey } from "@solana/web3.js";
const ix = await multisig.instructions.vaultTransactionAccountsClose({
multisigPda,
// Must be the rent collector set on the multisig
rentCollector,
transactionIndex,
});
| Condition | Description |
|---|---|
| Rejected | Corresponding proposal status is Rejected |
| Cancelled | Corresponding proposal status is Cancelled |
| Executed | Transaction has been executed |
| Stale | transactionIndex ≤ staleTransactionIndex, and the proposal is Draft or Active or does not exist |
| Parameter | Type | Required | Description |
|---|---|---|---|
multisigPda | PublicKey | Yes | PDA of the multisig |
transactionIndex | bigint | Yes | Index of the transaction to close |
rentCollector | PublicKey | Yes | Account to receive the reclaimed rent |
programId | PublicKey | No | Squads program ID. Defaults to multisig.PROGRAM_ID |
import * as multisig from "@sqds/multisig";
import { Connection, PublicKey } from "@solana/web3.js"
async function main(member: PublicKey) {
// Cluster Connection
const connection = new Connection("<your rpc url>");
// If you've saved your createKey, you can define it as a static PublicKey
const createKey = new PublicKey("<your createkey>")
// Derive the multisig PDA
const [multisigPda] = multisig.getMultisigPda({
createKey,
});
// or
// const multisigPda = new PublicKey("<your multisig key>");
// Get deserialized multisig account info
const multisigInfo = await multisig.accounts.Multisig.fromAccountAddress(
connection,
multisigPda
);
// Get the current transaction index
const transactionIndex = BigInt(multisigInfo.transactionIndex.toString());
// or, if this is tied to your first transaction
// const transactionIndex = 1n;
// Rent can only be reclaimed if a rent collector is set on the multisig
const rentCollector = multisigInfo.rentCollector;
if (!rentCollector) {
throw new Error("This multisig has no rent collector set");
}
const ix = await multisig.instructions.vaultTransactionAccountsClose({
multisigPda,
// This value must be the current rent collector Public Key of the Multisig.
rentCollector,
transactionIndex,
});
}
| Error | Cause | Solution |
|---|---|---|
| Transaction active | Transaction is not rejected, cancelled, executed, or stale | Wait for appropriate status |
| Invalid rent collector | Wrong rent collector address | Use the address configured on the multisig |
| Rent reclamation disabled | No rent collector set on the multisig | Set a rent collector with a Config Transaction |