@perena/vault-sdk 1.0.20 → 1.0.24

package/README.md

@@ -105,6 +105,41 @@ const plan = await client.tx.executeDeposit.getTx({
 const sig = await client.sendTransaction(payer, plan);
 ```
 
+### Squads proposal routing
+
+Browser integrations can map a connected Squads member wallet to a multisig and
+vault index, then use the derived vault PDA while building the instruction:
+
+```typescript
+import {
+  prepareVaultTransaction,
+  vaultAuthorityForWallet,
+  type SquadsWalletRouteConfig,
+} from "@perena/vault-sdk";
+
+const routes: SquadsWalletRouteConfig[] = [
+  { wallet: "MEMBER_WALLET", multisigPda: "MULTISIG_PDA", vaultIndex: 0 },
+];
+const authority = vaultAuthorityForWallet(connectedWallet, routes);
+const plan = await client.tx.setVaultConfig.getTx({
+  curator: address(authority.toBase58()),
+  // ...
+});
+const prepared = await prepareVaultTransaction({
+  connection,
+  proposer: connectedWallet,
+  instructions: plan.instructions.map(fromKitInstruction),
+  squadsRoutes: routes,
+});
+```
+
+When the wallet is configured, `prepared.transaction` creates a Squads vault
+transaction and proposal. The member signs and submits that outer transaction;
+the multisig must still approve and execute the proposal. When no route matches,
+the helper returns the original instructions as a normal direct transaction.
+The configured member must have Squads' `Initiate` permission, and the vault
+program role must be assigned to the derived Squads vault PDA.
+
 `VaultTransactionPlan` contains:
 
 - `instructions` — ordered `@solana/kit` instructions (preamble + program ix)