Squads Protocol

https://docs.squads.so/main/development
Admin
Squads Protocol is a collection of programs on the Solana blockchain that implements smart...
Tokens:27,849
Snippets:240
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /main/development/introduction/quickstart.md

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Perform an HTTP GET request to query the documentation dynamically by asking a question.

```APIDOC
## GET /main/development/introduction/quickstart.md

### Description
Query the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/introduction/quickstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Create Configuration Transaction Examples

Source: https://docs.squads.so/main/development/cli/commands.md

Various examples for creating different types of configuration transactions.

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "AddMember <NEW_MEMBER_PUBLIC_KEY> <PERMISSIONS>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "RemoveMember <MEMBER_PUBLIC_KEY>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "ChangeThreshold <NEW_THRESHOLD>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "SetTimeLock <TIME_LOCK_VALUE>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "AddSpendingLimit <CREATE_KEY> <VAULT_INDEX> <MINT> <AMOUNT> <PERIOD> <MEMBERS> <DESTINATIONS>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "RemoveSpendingLimit <SPENDING_LIMIT_PUBKEY>"
```

```bash
config-transaction-create --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action "SetRentCollector <NEW_RENT_COLLECTOR_PUBKEY>"
```

--------------------------------

### Create Multisig Examples

Source: https://docs.squads.so/main/development/cli/commands.md

Examples for initializing multisig accounts with specific member configurations and optional authorities.

```bash
multisig-create --keypair /path/to/keypair.json --members "Member1PubKey,Permission1" "Member2PubKey,Permission2" --threshold 2
```

```bash
multisig-create --keypair /path/to/keypair.json --config-authority <CONFIG_AUTHORITY_PUBKEY> --members "Member1PubKey,Permission1" "Member2PubKey,Permission2" --threshold 1
```

--------------------------------

### Execute Configuration Transaction Example

Source: https://docs.squads.so/main/development/cli/commands.md

Example usage for executing a configuration transaction by index.

```bash
config-transaction-execute --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index 1
```

--------------------------------

### GET /development/typescript/instructions/create-multisig.md

Source: https://docs.squads.so/main/development/typescript/instructions/create-multisig.md

Query the documentation dynamically using natural language.

```APIDOC
## GET /development/typescript/instructions/create-multisig.md

### Description
Perform a query against the documentation to retrieve specific information or context.

### Method
GET

### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal for context.
```

--------------------------------

### Proposal Vote Examples

Source: https://docs.squads.so/main/development/cli/commands.md

Examples for approving, rejecting, or cancelling a transaction proposal by index.

```bash
proposal-vote --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index 1 --action Approve
```

```bash
proposal-vote --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index 1 --action Reject
```

```bash
proposal-vote --keypair /path/to/keypair.json --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index 1 --action Cancel
```

--------------------------------

### GET /main/development/introduction.md

Source: https://docs.squads.so/main/development/introduction

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /main/development/introduction.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
/main/development/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Initialize main.ts

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Basic imports and connection setup for the Squads multisig client.

```typescript
import * as multisig from "@sqds/multisig";
import {
  Connection,
  Keypair,
  LAMPORTS_PER_SOL,
  SystemProgram,
  TransactionMessage,
  clusterApiUrl,
} from "@solana/web3.js";

const { Permission, Permissions } = multisig.types;

// Use 'https://api.devnet.solana.com' if there are struggles running locally
const connection = new Connection("http://localhost:8899", "confirmed");
```

--------------------------------

### GET /

Source: https://docs.squads.so/main/development/typescript/instructions/create-config-transaction.md

Perform a query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET / 

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/typescript/instructions/create-config-transaction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Vault Check Request Example

Source: https://docs.squads.so/main/development/api/vault-check.md

An example of a GET request to verify a specific Solana address.

```text
https://4fnetmviidiqkjzenwxe66vgoa0soerr.lambda-url.us-east-1.on.aws/isSquad/HFwi9HgNtFcMwNJPHa1czrPhuxeZFZ7G9tPQ1LqAd7sy
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.squads.so/main/development/get-support/were-here-to-help.md

Perform an HTTP GET request to the documentation URL with query parameters to retrieve specific information or context.

```http
GET https://docs.squads.so/main/development/get-support/were-here-to-help.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Squads CLI via Cargo

Source: https://docs.squads.so/main/development/cli/installation.md

Installs the Squads CLI tool. Requires a functional Rust and Cargo environment.

```bash
cargo install squads-multisig-cli
```

--------------------------------

### Install Solana Actions SDK

Source: https://docs.squads.so/main/development/other/squads-actions-and-blinks.md

Command to add the @solana/actions package to your project dependencies.

```bash
npm add @solana/actions
```

--------------------------------

### Start local validator with Squads V4

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Starts a local Solana test validator with the Squads V4 program and required configuration accounts cloned from mainnet.

```bash
solana-test-validator --url m --clone-upgradeable-program SQDS4ep65T869zMMBKyuUq6aD6EgTu8psMjkvj52pCf -c BSTq9w3kZwNwpBXJEvTZz2G9ZTNyKBvoSeXMvwb4cNZr -c Fy3YMJCvwbAXUgUM5b91ucUVA3jYzwWLHL3MwBqKsh8n
```

--------------------------------

### GET /main/development/get-support.md

Source: https://docs.squads.so/main/development/get-support

Queries the documentation for information by providing a specific question and an optional goal.

```APIDOC
## GET /main/development/get-support.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/get-support.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.squads.so/main/development/introduction/use-cases.md

Perform a dynamic query against the documentation by appending ask and goal parameters to the page URL.

```http
GET https://docs.squads.so/main/development/introduction/use-cases.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /main/development/reference/controlled-multisigs.md

Source: https://docs.squads.so/main/development/reference/controlled-multisigs.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /main/development/reference/controlled-multisigs.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, or sources related to a specific question.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/reference/controlled-multisigs.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /

Source: https://docs.squads.so/main/development/cli/installation.md

Queries the documentation for information based on a specific question and optional goal.

```APIDOC
## GET /

### Description
Performs a query against the documentation to retrieve answers and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
/[page_url]

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /main/development/other.md

Source: https://docs.squads.so/main/development/other

Queries the documentation dynamically by providing a natural language question and an optional goal.

```APIDOC
## GET /main/development/other.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/other.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /main/development/reference/sdks.md

Source: https://docs.squads.so/main/development/reference/sdks.md

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /main/development/reference/sdks.md

### Description
Performs a natural language query against the documentation to retrieve answers and relevant excerpts based on a specific question and an optional goal.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/reference/sdks.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /main/development/cli.md

Source: https://docs.squads.so/main/development/cli

Performs a natural language query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /main/development/cli.md

### Description
Performs an HTTP GET request on the documentation page to retrieve answers to specific questions using the `ask` and `goal` parameters.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/cli.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /main/development/reference/time-locks.md

Source: https://docs.squads.so/main/development/reference/time-locks.md

Queries the documentation dynamically using natural language questions.

```APIDOC
## GET /main/development/reference/time-locks.md

### Description
Performs a dynamic query against the documentation to retrieve answers or context.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/reference/time-locks.md

### Parameters
#### Query Parameters
- **ask** (String) - Required - The specific, self-contained question to ask.
- **goal** (String) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Add Spending Limit Instruction

Source: https://docs.squads.so/main/development/typescript/instructions/controlled-multisig-instructions/add-spending-limit.md

Demonstrates how to derive the necessary PDAs and execute the multisigAddSpendingLimit instruction. This requires a controlled multisig setup.

```typescript
import * as multisig from "@sqds/multisig";

// Cluster Connection
const connection = new Connection( < your rpc url > );

// Fee payer is the a signer that pays the transaction fees
const feePayer = Keypair.generate();

// Derive the multisig PDA
const multisigPda = multisig.getMultisigPda({
    // The createKey has to be a Public Key, see accounts reference for more info
    createKey,
})[0];

const spendingLimitCreateKey = Keypair.generate().publicKey;

const spendingLimitPda = multisig.getSpendingLimitPda({
    multisigPda
    createKey: spendingLimitCreateKey,
})[0];

multisig.rpc.multisigAddSpendingLimit({
    connection,
    feePayer,
    // The multisig account Public Key
    multisigPda,
    // The spending limit account Public Key
    spendingLimit: spendingLimitPda,
    createKey: spendingLimitCreateKey,
    // Rent payer for state
    rentPayer: feePayer,
    // Spending limit amount
    amount: BigInt(1000000000),
    configAuthority: null,
    // Spending limit will apply daily, see reference for more info
    period: multisig.generated.Period.Day,
    // The mint of the token to apply the spending limit on
    mint: Keypair.generate().publicKey,
    destinations: [Keypair.generate().publicKey],
    // null means it will apply to all members, make it an array of Public Keys to specify certain members
    members: null,
    vaultIndex: 1,
}),
```

--------------------------------

### GET /development/typescript/accounts/batch.md

Source: https://docs.squads.so/main/development/typescript/accounts/batch.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /development/typescript/accounts/batch.md

### Description
Queries the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/typescript/accounts/batch.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /?ask=<question>&goal=<endgoal>

Source: https://docs.squads.so/main/development/typescript/accounts/transactions.md

Perform a dynamic query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /?ask=<question>&goal=<endgoal>

### Description
Queries the documentation dynamically to receive a direct answer and relevant excerpts based on the provided question and optional goal.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/typescript/accounts/transactions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /main/development/reference/spending-limits.md

Source: https://docs.squads.so/main/development/reference/spending-limits.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /main/development/reference/spending-limits.md

### Description
Performs a natural language query against the documentation page to retrieve answers, excerpts, and sources.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/reference/spending-limits.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /development/get-support/were-here-to-help.md

Source: https://docs.squads.so/main/development/get-support/were-here-to-help.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /development/get-support/were-here-to-help.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/get-support/were-here-to-help.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /main/development/typescript/instructions/controlled-multisig-instructions.md

Source: https://docs.squads.so/main/development/typescript/instructions/controlled-multisig-instructions.md

Perform a query against the documentation to retrieve specific information or context regarding Controlled Multisigs.

```APIDOC
## GET /main/development/typescript/instructions/controlled-multisig-instructions.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to the current page content.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/typescript/instructions/controlled-multisig-instructions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /main/development/api.md

Source: https://docs.squads.so/main/development/api

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /main/development/api.md

### Description
Queries the documentation dynamically by providing a natural language question. This is useful for retrieving information not explicitly found in the current page.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/api.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET / (Documentation Query)

Source: https://docs.squads.so/main/development/cli/commands.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

```APIDOC
## GET / 

### Description
Queries the documentation dynamically to retrieve information based on a specific question and an optional broader goal.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/cli/commands.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /documentation-index

Source: https://docs.squads.so/main/development

Perform a natural language query against the documentation index to retrieve answers and relevant excerpts.

```APIDOC
## GET https://docs.squads.so/main/navigating-your-squad/developers-assets.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide a broader goal for context.

### Method
GET

### Endpoint
https://docs.squads.so/main/navigating-your-squad/developers-assets.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Source references for the provided information.
```

--------------------------------

### Create project directory

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Commands to initialize the project workspace.

```bash
mkdir squads_quickstart
```

```bash
cd squads_quickstart
```

--------------------------------

### Create a Multisig Account with TypeScript

Source: https://docs.squads.so/main/development/typescript/instructions/create-multisig.md

Demonstrates how to derive a multisig PDA and execute the multisigCreateV2 instruction with member permissions and threshold settings.

```typescript
import * as multisig from "@sqds/multisig";
import { Connection, Keypair } from "@solana/web3.js";

// Defines permissions enum
const { Permission, Permissions } = multisig.types;

async function main() {
    // Cluster Connection
    // Required argument if you use the .rpc method
    const connection = new Connection("< your rpc here >");
    
    // Random Public Key that will be used to derive a multisig PDA
    // This will need to be a signer on the transaction
    const createKey = Keypair.generate().publicKey;
    
    // Creator should be a Keypair or a Wallet Adapter wallet
    const creator = Keypair.generate();
    
    // Derive the multisig PDA
    const [multisigPda] = multisig.getMultisigPda({
        createKey,
    });
    
    const programConfigPda = multisig.getProgramConfigPda({})[0];

    const programConfig =
        await multisig.accounts.ProgramConfig.fromAccountAddress(
          connection,
          programConfigPda
        );

    const configTreasury = programConfig.treasury;
    
    const ix = await multisig.instructions.multisigCreateV2({
        // Must sign the transaction, unless the .rpc method is used.
        createKey: createKey.publicKey,
        // The creator & fee payer
        creator: creator.publicKey,
        // The PDA of the multisig you are creating, derived by a random PublicKey
        multisigPda,
        // Here the config authority will be the system program
        configAuthority: null,
        // Create without any time-lock
        timeLock: 0,
        // List of the members to add to the multisig
        members: [{
                // Members Public Key
                key: creator.publicKey,
                // Granted Proposer, Voter, and Executor permissions
                permissions: Permissions.all(),
            },
            {
                key: secondMember.publicKey,
                // Member can only add votes to proposed transactions
                permissions: Permissions.fromPermissions([Permission.Vote]),
            },
        ],
        // This means that there needs to be 2 votes for a transaction proposal to be approved
        threshold: 2,
        // This is for the program config treasury account
        treasury: configTreasury,
        // Rent reclaim account
        rentCollector: null
    });
    
    console.log("Multisig created: ", signature)
}
```

--------------------------------

### Create a Proposal with Squads SDK

Source: https://docs.squads.so/main/development/typescript/instructions/create-proposal.md

Demonstrates how to derive a multisig PDA, fetch the current transaction index, and create a proposal using the @sqds/multisig library.

```typescript
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 = Number(multisigInfo.transactionIndex);
    // or, if this is tied to your first transaction
    // const transactionIndex = 1n;
    
    const ix = await multisig.instructions.proposalCreate({
        multisigPda,
        transactionIndex,
        // Must have "Voter" permissions at minimum
        creator: member,
    });
}
```

--------------------------------

### Create Configuration Transaction Syntax

Source: https://docs.squads.so/main/development/cli/commands.md

General syntax for creating a new configuration proposal transaction.

```bash
config-transaction-create --rpc-url <RPC_URL> --program-id <PROGRAM_ID> --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action <ACTION> [--memo <MEMO>]
```

--------------------------------

### Initialize keypairs for Devnet

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Loads a filesystem keypair from the local Solana CLI configuration and generates a new keypair for testing.

```typescript
// Add these two dependencies
import path from "path";
import dotenv from "dotenv";

dotenv.config();

// Add this before you define `describe`
const keyFileContents = JSON.parse(
  readFileSync(path.join(process.env.HOME, ".config/solana/id.json")).toString()
);

const creator = Keypair.fromSecretKey(new Uint8Array(keyFileContents));
const secondMember = Keypair.generate();
```

--------------------------------

### Create Batch and Proposal with TypeScript SDK

Source: https://docs.squads.so/main/development/typescript/instructions/create-batch.md

Demonstrates initializing a batch and a corresponding draft proposal using the @sqds/multisig library. Requires a valid RPC connection and the multisig PDA.

```typescript
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 = Number(multisigInfo.transactionIndex);
    // or, if this is tied to your first transaction
    // const transactionIndex = 1n;
    
    // Create the batch, which we can add transactions to
    const batchCreateIx = await multisig.instructions.batchCreate({
        batchIndex: transactionIndex,
        creator: member,
        multisigPda,
        vaultIndex: 0,
        memo: "Creating a batch",
    });
    
    // Create the proposal for voting on the transactions
    const proposalCreateIx = await multisig.instructions.proposalCreate({
        multisigPda,
        // Created with the same index as the batch
        transactionIndex: transactionIndex,
        creator: member,
        // Proposal is created as a draft
        isDraft: true,
    });
}
```

--------------------------------

### Multisig Creation Syntax

Source: https://docs.squads.so/main/development/cli/commands.md

General syntax for creating a new multisig account using the CLI.

```bash
multisig-create --rpc-url <RPC_URL> --program-id <PROGRAM_ID> --keypair <KEYPAIR_PATH> --config-authority <CONFIG_AUTHORITY> --members <MEMBER_1> <MEMBER_2> ... --threshold <THRESHOLD>
```

--------------------------------

### GET /reference/accounts.md

Source: https://docs.squads.so/main/development/reference/accounts.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /reference/accounts.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.squads.so/main/development/reference/accounts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Approve a Proposal with TypeScript

Source: https://docs.squads.so/main/development/typescript/instructions/approve-proposal.md

Demonstrates how to derive the multisig PDA, fetch account information, and generate the proposal approval instruction.

```typescript
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 = Number(multisigInfo.transactionIndex);
    // or, if this is tied to your first transaction
    // const transactionIndex = 1n;
    
    const ix = await multisig.instructions.proposalApprove({
      multisigPda,
      transactionIndex,
      // Member must have "Voter" permissions
      member: member,
    });
}
```

--------------------------------

### multisig.instructions.multisigCreateV2

Source: https://docs.squads.so/main/development/typescript/instructions/create-multisig.md

Creates a new Multisig account. This instruction requires the creator and createKey to be signers.

```APIDOC
## multisig.instructions.multisigCreateV2

### Description
Creates a new Multisig account with specified members, threshold, and configuration.

### Parameters
- **createKey** (PublicKey) - Required - The public key used to derive the multisig PDA.
- **creator** (PublicKey) - Required - The creator and fee payer for the transaction.
- **multisigPda** (PublicKey) - Required - The PDA of the multisig being created.
- **configAuthority** (PublicKey | null) - Optional - Admin key to override configuration.
- **timeLock** (number) - Required - Time-lock duration for the multisig.
- **members** (Array) - Required - List of members with their respective permissions.
- **threshold** (number) - Required - Number of votes required for transaction approval.
- **treasury** (PublicKey) - Required - The program config treasury account.
- **rentCollector** (PublicKey | null) - Optional - Account to collect rent.
```

--------------------------------

### Execute Configuration Transaction Syntax

Source: https://docs.squads.so/main/development/cli/commands.md

General syntax for executing a proposed configuration transaction.

```bash
config-transaction-execute --rpc-url <RPC_URL> --program-id <PROGRAM_ID> --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index <TRANSACTION_INDEX>
```

--------------------------------

### Reject a Proposal with TypeScript

Source: https://docs.squads.so/main/development/typescript/instructions/reject-proposal.md

Demonstrates how to derive the multisig PDA, retrieve the current transaction index, and execute the proposalReject instruction.

```typescript
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 = Number(multisigInfo.transactionIndex);
    // or, if this is tied to your first transaction
    // const transactionIndex = 1n;
    
    const ix = await multisig.instructions.proposalReject({
      multisigPda,
      transactionIndex,
      // Member must have "Voter" permissions
      member: member,
    });
}
```

--------------------------------

### Remove Member Instruction Example

Source: https://docs.squads.so/main/development/typescript/instructions/controlled-multisig-instructions/remove-member.md

Demonstrates the usage of multisig.rpc.multisigRemoveMember to remove a member from a multisig account.

```typescript
import * as multisig from "@sqds/multisig";

// Cluster Connection
const connection = new Connection( < your rpc url > );

// Fee payer is the a signer that pays the transaction fees
const feePayer = Keypair.generate();

// Derive the multisig PDA
const multisigPda = multisig.getMultisigPda({
    // The createKey has to be a Public Key, see accounts reference for more info
    createKey,
})[0];

// Public Key of the old member
const oldMember = new PublicKey("");

await multisig.rpc.multisigRemoveMember({
    connection,
    feePayer,
    // The public key of the multisig account
    multisigPda,
    // Specify the config authority Public Key if there is one, else set to null
    configAuthority: null,
    // Account paying for the rent of the additional account space needed by adding a member
    rentPayer: feePayer,
    oldMember,
    memo,
    // ProgramId of the Squads Program
    programId
    
});
```

--------------------------------

### Use Ledger Hardware Wallet with Squads CLI

Source: https://docs.squads.so/main/development/cli/commands.md

Configure the CLI to use a Ledger device for signing. Supports both default and custom derivation paths.

```bash
squads-multisig-cli example-command --keypair usb://ledger
```

```bash
squads-multisig-cli example-command --keypair usb://ledger/BsNsvfXqQTtJnagwFWdBS7FBXgnsK8VZ5CmuznN85swK?key=0/0
```

--------------------------------

### Execute project tests

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Run the test suite for the project. Requires Node.js version 20 or higher.

```bash
yarn test
```

--------------------------------

### GET /isSquad/<ADDRESS>

Source: https://docs.squads.so/main/development/api/vault-check.md

Checks if a provided Solana address is a valid Squads V3 or V4 vault account.

```APIDOC
## GET /isSquad/<ADDRESS>

### Description
This endpoint allows the caller to specify a Solana address and return whether or not that address is a valid Squads V3 or V4 vault account, and can receive funds.

### Method
GET

### Endpoint
https://4fnetmviidiqkjzenwxe66vgoa0soerr.lambda-url.us-east-1.on.aws/isSquad/<ADDRESS>

### Parameters
#### Path Parameters
- **ADDRESS** (string) - Required - The Solana address to check.

### Response
#### Success Response (200)
- **isSquad** (boolean) - Indicates whether the address is a valid Squads vault.
- **version** (string) - The Squads program version (v3, v4, or empty string if false).
```

--------------------------------

### Execute a Config Transaction

Source: https://docs.squads.so/main/development/typescript/instructions/execute-config-transaction.md

Demonstrates how to derive the multisig PDA, retrieve the transaction index, and execute the config transaction instruction.

```typescript
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 = Number(multisigInfo.transactionIndex);
    // or, if this is tied to your first transaction
    // const transactionIndex = 1n;
    
    const ix = multisig.instructions.configTransactionExecute({
        multisigPda,
        transactionIndex: newTransactionIndex,
        // Member must have "Executor" permissions
        member: creator.publicKey,
    });
}
```

--------------------------------

### Implement MultisigCreate V2 in Rust

Source: https://docs.squads.so/main/development/other/migrating-from-multisigcreate-v1-to-v2.md

Constructs the transaction using the RpcClient and MultisigCreateV2 accounts and data structures.

```rust

        let rpc_client = RpcClient::new(rpc_url);

        let progress = ProgressBar::new_spinner().with_message("Sending transaction...");
        progress.enable_steady_tick(Duration::from_millis(100));

        let blockhash = rpc_client
            .get_latest_blockhash()
            .await
            .expect("Failed to get blockhash");

        let random_keypair = Keypair::new();

        let multisig_key = get_multisig_pda(&random_keypair.pubkey(), Some(&program_id));

        let program_config_pda = get_program_config_pda(Some(&program_id));

        let program_config = rpc_client
            .get_account(&program_config_pda.0)
            .await
            .expect("Failed to fetch program config account");

        let mut program_config_data = program_config.data.as_slice();

        let treasury = ProgramConfig::try_deserialize(&mut program_config_data)
            .unwrap()
            .treasury;

        let message = Message::try_compile(
            &transaction_creator,
            &[Instruction {
                accounts: MultisigCreateV2Accounts {
                    create_key: random_keypair.pubkey(),
                    creator: transaction_creator,
                    multisig: multisig_key.0,
                    system_program: system_program::id(),
                    program_config: program_config_pda.0,
                    treasury,
                }
                .to_account_metas(Some(false)),
                data: MultisigCreateV2Data {
                    args: MultisigCreateArgsV2 {
                        config_authority,
                        members,
                        threshold,
                        time_lock: 0,
                        memo: None,
                        rent_collector,
                    },
                }
                .data(),
                program_id,
            }],
            &[],
            blockhash,
        )
        .unwrap();

        let transaction = VersionedTransaction::try_new(
            VersionedMessage::V0(message),
            &[
                &*transaction_creator_keypair,
                &random_keypair as &dyn Signer,
            ],
        )
        .expect("Failed to create transaction");

        let signature = send_and_confirm_transaction(&transaction, &rpc_client).await?;
```

--------------------------------

### Use File System Wallet with Squads CLI

Source: https://docs.squads.so/main/development/cli/commands.md

Specify a local filesystem keypair for signing CLI transactions.

```bash
squads-multisig-cli example-command --keypair /path/to/keypair.json
```

--------------------------------

### Fetch a Proposal account in TypeScript

Source: https://docs.squads.so/main/development/typescript/accounts/proposal.md

Derive the Proposal PDA using the multisig address and transaction index, then fetch the account data.

```typescript
import * as multisig from "@sqds/multisig";

const { Proposal } = multisig.accounts;

async function main() {
    // Public Key of the Multisig PDA
    const multisigPda = new PublicKey("MyAmazingMultisig");
    
    // Fetch the deserialized Multisig account
    const multisigInfo = await multisig.accounts.Multisig.fromAccountAddress(
      connection,
      multisigPda
    );

    // Get the current transaction index
    const currentTransactionIndex = Number(multisigInfo.transactionIndex);
    const transactionIndex = BigInt(currentTransactionIndex + 1);
    // or, if this is your first transaction
    // const transactionIndex = 1n;    
    
    // Bump is generally not needed
    const [proposalPda, proposalBump] = multisig.getProposalPda({
        multisigPda,
        transactionIndex,
    });
    
    const proposalAccount = await Proposal.fromAccountAddress(
        connection,
        proposalPda
    );
          
    // Log the proposal status
    console.log("Proposal Status", proposalAccount.status);
}
```

--------------------------------

### Implement MultisigCreate V2 in TypeScript

Source: https://docs.squads.so/main/development/other/migrating-from-multisigcreate-v1-to-v2.md

Uses the multisig SDK to generate the PDA and execute the multisigCreateV2 instruction.

```typescript
    const creator = fundedKeypairExample();

    const createKey = Keypair.generate();
    
    const [multisigPda] = multisig.getMultisigPda({
      createKey: createKey.publicKey,
    });
    
  
    const programConfigPda = getProgramConfigPda({})[0];

    const programConfig =
      await multisig.accounts.ProgramConfig.fromAccountAddress(
        connection,
        programConfigPda
      );

    const configTreasury = programConfig.treasury;

    const tx = multisig.transactions.multisigCreateV2({
      blockhash: (await connection.getLatestBlockhash()).blockhash,
      treasury: configTreasury,
      createKey: createKey.publicKey,
      creator: creator.publicKey,
      multisigPda,
      configAuthority: null,
      timeLock: 0,
      threshold: 1,
      rentCollector: null,
      members: [
        {
          key: members.almighty.publicKey,
          permissions: Permissions.all(),
        },
        {
          key: members.almighty.publicKey,
          permissions: Permissions.all(),
        },
      ],
      programId,
    });

    
    tx.sign([creator, createKey]);
```

--------------------------------

### Define package dependencies

Source: https://docs.squads.so/main/development/introduction/quickstart.md

Configuration for project dependencies and test scripts.

```json
{
  "scripts": {
    "test": "npx mocha -r ts-node/register 'main.ts' --timeout 10000"
  },
  "dependencies": {
    "@solana/web3.js": "^1.73.0",
    "@sqds/multisig": "^2.1.3"
  },
  "devDependencies": {
    "@types/chai": "^4.3.3",
    "@types/mocha": "^10.0.6",
    "chai": "^4.3.6",
    "mocha": "^10.3.0",
    "ts-mocha": "^10.0.0",
    "typescript": "^4.8.3"
  }
}
```

--------------------------------

### multisig.instructions.configTransactionExecute

Source: https://docs.squads.so/main/development/typescript/instructions/execute-config-transaction.md

Executes a configuration transaction on a Multisig account. The member executing this must have 'Executor' permissions and the associated proposal must be 'Approved'.

```APIDOC
## multisig.instructions.configTransactionExecute

### Description
Executes the action specified in a Config Transaction account. This can include field changes or account creation on the Multisig.

### Parameters
- **multisigPda** (PublicKey) - Required - The PDA of the Multisig account.
- **transactionIndex** (bigint) - Required - The index of the transaction to execute.
- **member** (PublicKey) - Required - The public key of the member executing the transaction (must have 'Executor' permissions).

### Example
```typescript
const ix = multisig.instructions.configTransactionExecute({
    multisigPda,
    transactionIndex: newTransactionIndex,
    member: creator.publicKey,
});
```
```

--------------------------------

### Create a Vault Transaction

Source: https://docs.squads.so/main/development/typescript/instructions/create-vault-transaction.md

Demonstrates deriving PDAs, preparing a transaction message, and creating a vault transaction using the @sqds/multisig SDK.

```typescript
import * as multisig from "@sqds/multisig";
import { PublicKey, Connection, SystemProgram, TransactionMessage } 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>");
    
    // Derive the PDA of the Squads Vault
    const [vaultPda] = multisig.getVaultPda({
        multisigPda,
        index: 0,
    });
    
    // Get deserialized multisig account info
    const multisigInfo = await multisig.accounts.Multisig.fromAccountAddress(
      connection,
      multisigPda
    );

    // Get the updated transaction index
    const currentTransactionIndex = Number(multisigInfo.transactionIndex);
    const newTransactionIndex = BigInt(currentTransactionIndex + 1);
    
    const to = new PublicKey("<>");
    
    const transferInstruction = SystemProgram.transfer({
        // The transfer is being signed by the vault that's executing
        fromPubkey: vaultPda,
        toPubkey: to,
        lamports: 1 * LAMPORTS_PER_SOL
    });
    
    // Build a message with instructions we want to execute
    const testTransferMessage = new TransactionMessage({
        payerKey: vaultPda,
        recentBlockhash: (await connection.getLatestBlockhash()).blockhash,
        instructions: [transferInstruction],
    });
    
    const ix = await multisig.instructions.vaultTransactionCreate({
        multisigPda,
        transactionIndex,
        creator: member,
        vaultIndex: 0,
        ephemeralSigners: 0,
        transactionMessage: testTransferMessage,
        memo: "Our first transfer!"
    });
}
```
Tokens:
Raw