> For the complete documentation index, see [llms.txt](https://gotts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gotts.gitbook.io/docs/gotts-vaults/vault.md).

# Index

> **Package**: `packages/vault/` (`@gotts.ai/vault`) | **Last Updated**: 2026-02-18 | **Parent Index**: [`prd/README.md`](/docs/prd-product-requirements/prd.md)
>
> This directory contains the Product Requirements Document for Gotts Vaults — permissionless vault infrastructure for Agent Capital Markets. The protocol enables any ERC-8004 registered agent to deploy, manage, and participate in ERC-4626 tokenized vaults. By agents, for agents.

***

## Supporting Documents

| Document                                                                    | Purpose                                                                                |
| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [IMPLEMENTATION-STATE.md](/docs/gotts-vaults/vault/implementation-state.md) | What's actually built in `packages/vault/`, what's missing, known gaps                 |
| [DECISIONS.md](/docs/gotts-vaults/vault/decisions.md)                       | Design decisions, adopted research mechanisms, anti-abuse controls, and deferred items |

***

## PRD Files

| #  | File                                                                | Topic                                                                                                                                                    |
| -- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 00 | [00-quickstart.md](/docs/gotts-vaults/vault/00-quickstart.md)       | From zero to vault participation in 4 steps + optional proxy setup                                                                                       |
| 01 | [01-overview.md](/docs/gotts-vaults/vault/01-overview.md)           | Vision, problem statement, design principles, goals                                                                                                      |
| 02 | [02-personas.md](/docs/gotts-vaults/vault/02-personas.md)           | Agent roles and personas (14 archetypes)                                                                                                                 |
| 03 | [03-custody.md](/docs/gotts-vaults/vault/03-custody.md)             | Wallet custody architecture (4 types), provider selection, time-delayed proxy, policy engines, prompt injection defense                                  |
| 04 | [04-architecture.md](/docs/gotts-vaults/vault/04-architecture.md)   | Architecture diagrams, package structure, data flows, standalone server                                                                                  |
| 05 | [05-local-dev.md](/docs/gotts-vaults/vault/05-local-dev.md)         | Factory testnet, debug UI, multi-agent swarm simulation                                                                                                  |
| 06 | [06-contracts.md](/docs/gotts-vaults/vault/06-contracts.md)         | Solidity specs (AgentVaultFactory, AgentVaultCore, VaultHook, CCABidAdapter, FeeModule, AgentGatedPool)                                                  |
| 07 | [07-sdk.md](/docs/gotts-vaults/vault/07-sdk.md)                     | TypeScript SDK (VaultFactoryClient, VaultClient, StrategyEngine, CCABidder, HookDeployer, x402Gateway, ReputationReader)                                 |
| 08 | [08-mcp-tools.md](/docs/gotts-vaults/vault/08-mcp-tools.md)         | Canonical MCP tool contracts and categories (core + optional + deferred)                                                                                 |
| 09 | [09-agents-skills.md](/docs/gotts-vaults/vault/09-agents-skills.md) | Core agent/skill definitions, optional proxy ops, deferred CCA workflow                                                                                  |
| 10 | [10-safety.md](/docs/gotts-vaults/vault/10-safety.md)               | Safety architecture (15-layer defense (refs shared/safety-layers.md) incl. time-delayed proxy + monitoring), prompt injection defense, CCA risk controls |
| 11 | [11-config.md](/docs/gotts-vaults/vault/11-config.md)               | Wallet provider config, environment variables, config schema                                                                                             |
| 12 | [12-dependencies.md](/docs/gotts-vaults/vault/12-dependencies.md)   | Tech stack, dependencies (Solidity, TS, UI, CCA contracts)                                                                                               |
| 13 | [13-performance.md](/docs/gotts-vaults/vault/13-performance.md)     | Latency targets, gas targets (including factory + CCA)                                                                                                   |
| 14 | [14-milestones.md](/docs/gotts-vaults/vault/14-milestones.md)       | 5 phases with deliverables (Weeks 1-25+), including onboarding and swarm testing                                                                         |
| 15 | [15-metrics.md](/docs/gotts-vaults/vault/15-metrics.md)             | Success, quality, infrastructure metrics (4 categories)                                                                                                  |
| 16 | [16-synergies.md](/docs/gotts-vaults/vault/16-synergies.md)         | Growth mechanics, competitive positioning, ecosystem synergies                                                                                           |
| 17 | [17-testing.md](/docs/gotts-vaults/vault/17-testing.md)             | Testing strategy: invariant properties, fuzzing, fork tests, CI gates                                                                                    |
| 18 | [18-deployment.md](/docs/gotts-vaults/vault/18-deployment.md)       | Deployment runbook: deployment order, constructor args, verification, monitoring                                                                         |
| 19 | [19-threat-model.md](/docs/gotts-vaults/vault/19-threat-model.md)   | Threat model: attacker taxonomy, attack trees, residual risk register                                                                                    |

***

## Status Overview

For detailed implementation status, see [IMPLEMENTATION-STATE.md](/docs/gotts-vaults/vault/implementation-state.md).

| Layer                  | PRD                                                                                                                                      | Implemented        | Notes       |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
| Solidity Contracts     | 6 vault + 3 proxy contracts + interfaces                                                                                                 | Nothing built      | Not started |
| Contract Tests         | 7 vault + 3 proxy test files                                                                                                             | Nothing built      | Not started |
| TypeScript SDK         | 7 vault + 5 proxy classes + utils                                                                                                        | Nothing built      | Not started |
| Gotts Safe vault tools | 24 core + 5 am-AMM + 6 proxy + 8 deferred = 43 total ([canonical counts](/docs/gotts-vaults/vault/08-mcp-tools.md))                      | 0 tools            | Not started |
| Debug UI               | 6 views + 3 swarm views                                                                                                                  | Nothing built      | Not started |
| Gotts Agents & Skills  | 6 core agents + 1 optional watchdog; see [`agents/09-agents-vault.md`](/docs/agents/agents/09-agents-vault.md) for canonical definitions | 0 agents, 0 skills | Not started |
| Scripts                | 8 scripts (incl. swarm)                                                                                                                  | Nothing built      | Not started |
| Wallet Custody         | 4 architectures, 3 integration paths                                                                                                     | Nothing built      | Not started |
| Mainnet Deployment     | Base                                                                                                                                     | Not deployed       | Not started |
| Audit                  | Required                                                                                                                                 | Not started        | Not started |

***

## Workflow

```
1. UPDATE PRD          Edit the ideal spec in the relevant PRD file(s)
       │
       ▼
2. DIFF vs STATE       Compare the updated PRD against IMPLEMENTATION-STATE.md
       │                to identify what changed and what's missing
       ▼
3. PLAN CHANGES        Write an implementation plan for the delta
       │
       ▼
4. ADD TO TODO.md      Add actionable items to the project TODO.md
       │
       ▼
5. IMPLEMENT           Execute the plan, updating code in packages/vault/
       │
       ▼
6. UPDATE STATE        After implementing, update IMPLEMENTATION-STATE.md
                       to reflect the new current state
```

### Quick Reference

* **Want to change the spec?** Edit the relevant `XX-*.md` file
* **Want to see what's built?** Read [IMPLEMENTATION-STATE.md](/docs/gotts-vaults/vault/implementation-state.md)
* **Want to find gaps?** Compare any PRD file against the matching section in IMPLEMENTATION-STATE.md
* **Implementation-level docs** (how to use, API reference): `packages/vault/docs/`
* **Project-wide TODO list**: `../../TODO.md`
