This implementation enables secure shared control over assets between an AI agent and a user.
Core Features
-
Multisig Management
- Create 2-of-2 multisig
- Deposit funds
- Create proposals
- Execute transactions
-
Proposal Operations
- Create proposals
- Approve proposals
- Reject proposals
- Execute transactions
Quick Start
// Create multisig
const multisig = await agent.createSquadsMultisig(
new PublicKey("creator-address")
);
// Deposit funds
const deposit = await agent.depositToMultisig(
1.5 // amount in SOL
);
// Transfer from multisig
const transfer = await agent.transferFromMultisig(
1.0, // amount
new PublicKey("recipient")
);
Example Prompts
Natural Language Prompts
"Create a 2-of-2 multisig with me"
"Deposit 1 SOL to our multisig"
"Transfer 0.5 SOL from multisig to address"
"Approve pending proposal"
Create Multisig
{
"creator": "creator-public-key"
}
Deposit Funds
Transfer Funds
{
"amount": 1.0,
"recipient": "recipient-address"
}
Detailed Function Reference
Creation Operations
createSquadsMultisig
async function create_squads_multisig(
agent: SolanaAgentKit,
creator: PublicKey
): Promise<string>
Creates a new 2-of-2 multisig account with the agent and creator as members.
agent: SolanaAgentKit instancecreator: Public key of the second member- Returns: Transaction signature
depositToMultisig
async function deposit_to_multisig(
agent: SolanaAgentKit,
amount: number,
vaultIndex?: number,
mint?: PublicKey
): Promise<string>
Deposits funds to the multisig vault.
amount: Amount to depositvaultIndex: Optional vault index (default: 0)mint: Optional SPL token mint address- Returns: Transaction signature
Proposal Operations
createProposal
async function create_proposal(
agent: SolanaAgentKit,
transactionIndex?: number | bigint
): Promise<string>
Creates a new proposal for a pending transaction.
transactionIndex: Optional specific transaction index- Returns: Transaction signature
approveProposal
async function approve_proposal(
agent: SolanaAgentKit,
transactionIndex?: number | bigint
): Promise<string>
Approves a pending proposal.
transactionIndex: Optional specific transaction index- Returns: Transaction signature
rejectProposal
async function reject_proposal(
agent: SolanaAgentKit,
transactionIndex?: number | bigint
): Promise<string>
Rejects a pending proposal.
transactionIndex: Optional specific transaction index- Returns: Transaction signature
Transaction Operations
transferFromMultisig
async function transfer_from_multisig(
agent: SolanaAgentKit,
amount: number,
to: PublicKey,
vaultIndex?: number = 0,
mint?: PublicKey
): Promise<string>
Creates a transaction to transfer funds from the multisig vault.
amount: Amount to transferto: Recipient addressvaultIndex: Optional vault index (default: 0)mint: Optional SPL token mint address- Returns: Transaction signature
executeTransaction
async function execute_transaction(
agent: SolanaAgentKit,
transactionIndex?: number | bigint
): Promise<string>
Executes an approved transaction.
transactionIndex: Optional specific transaction index- Returns: Transaction signature
Usage Examples
Complete Workflow Example
// 1. Create multisig
const multisig = await create_squads_multisig(
agent,
new PublicKey("creator")
);
// 2. Deposit funds
const deposit = await deposit_to_multisig(
agent,
1.5 // SOL amount
);
// 3. Create transfer
const transfer = await transfer_from_multisig(
agent,
1.0, // amount
new PublicKey("recipient")
);
// 4. Create proposal
const proposal = await create_proposal(agent);
// 5. Approve proposal
const approval = await approve_proposal(agent);
// 6. Execute transaction
const execution = await execute_transaction(agent);
SPL Token Example
// Deposit SPL tokens
const tokenDeposit = await deposit_to_multisig(
agent,
100,
0, // vault index
new PublicKey("token-mint")
);
// Transfer SPL tokens
const tokenTransfer = await transfer_from_multisig(
agent,
50,
new PublicKey("recipient"),
0, // vault index
new PublicKey("token-mint")
);
Common Function Patterns
Transaction Index Management
// Get current transaction index
const multisigInfo = await Multisig.fromAccountAddress(
agent.connection,
multisigPda
);
const currentIndex = Number(multisigInfo.transactionIndex);
// Use specific or current index
const transactionIndex = specificIndex || BigInt(currentIndex);
Error Handling
try {
const result = await function();
} catch (error) {
throw new Error(`Operation failed: ${error.message}`);
}
Multisig Operations
1. Create Multisig
interface MultisigParams {
threshold: number; // Always 2 for 2-of-2
members: {
key: PublicKey;
permissions: number;
}[];
timeLock?: number; // Optional timelock
}
2. Deposit Funds
interface DepositParams {
amount: number; // Amount to deposit
vaultIndex?: number; // Optional vault index
mint?: PublicKey; // Optional SPL token mint
}
3. Create Transfer
interface TransferParams {
amount: number; // Amount to transfer
recipient: PublicKey; // Recipient address
vaultIndex?: number; // Optional vault index
mint?: PublicKey; // Optional SPL token mint
}
Proposal Lifecycle
- Create Proposal
const proposal = await agent.createMultisigProposal();
- Approve Proposal
const approval = await agent.approveMultisigProposal(
proposalIndex // Optional
);
- Execute Transaction
const execution = await agent.executeMultisigTransaction(
proposalIndex // Optional
);
Implementation Details
Member Permissions
const permissions = multisig.types.Permissions.all();
// Includes:
// - INITIATE
// - VOTE
// - EXECUTE
// - CANCEL
Transaction Workflow
- Create transaction
- Create proposal
- Collect approvals
- Execute transaction
Error Handling
try {
const tx = await agent.createMultisigProposal();
} catch (error) {
if (error.message.includes("insufficient approvals")) {
// Handle approval issues
} else if (error.message.includes("already executed")) {
// Handle duplicate execution
}
}
Best Practices
-
Account Management
- Secure private keys
- Track proposal indices
- Monitor balances
- Verify permissions
-
Transaction Flow
- Validate amounts
- Check approvals
- Monitor timeouts
- Handle failures
-
Security
- Double-check recipients
- Verify amounts
- Confirm approvals
- Track transactions
Common Issues
-
Transaction Failures
- Insufficient approvals
- Invalid indices
- Balance issues
- Permission errors
-
Proposal Management
- Missing approvals
- Invalid sequences
- Timeout issues
- Execution failures
-
Account Issues
- Permission problems
- Invalid addresses
- Wrong indices
- State conflicts
Success Response
{
status: "success",
message: "Operation completed successfully",
transaction: "transaction-signature",
// Additional operation-specific data
}
Error Response
{
status: "error",
message: "Error message",
code: "ERROR_CODE"
}
Technical Notes
-
Vault Management
- Vault indices
- Balance tracking
- Token support
- Permission checks
-
Proposal Tracking
- Index management
- State tracking
- Approval counting
- Execution status
-
Transaction Building
- Instruction creation
- Message compilation
- Signature collection
- Execution verification
getMultisigBalance: Check vault balancegetProposalStatus: Check proposal stategetApprovals: Get approval countcancelProposal: Cancel pending proposal
Resources
