Prerequisites
Node.js
Version: >= 20.x
npm
Version: >= 10.x
Solana CLI
Version: >= 1.18.xRequired for devnet funding and program deployment
Anchor CLI
Version: >= 0.31.xRequired for escrow program build/deploy
Installing Prerequisites
Install Node.js and npm
Install Node.js and npm
- macOS (Homebrew)
- Linux (nvm)
- Windows (nvm-windows)
Install Solana CLI
Install Solana CLI
See Solana CLI documentation for more details.
Install Anchor CLI
Install Anchor CLI
Anchor is required for building and deploying the escrow program.Verify installation:
- Using avm (recommended)
- From source
Install Anchor Version Manager:Install Anchor:
See Anchor documentation for troubleshooting.
Installation Steps
Clone or Download Repository
If you have the repository locally, navigate to it:Or clone from your source:
Install Dependencies
Install all workspace dependencies:This installs dependencies for:
- 2 applications (
apps/*): API Gateway, CLI - 7 services (
services/*): wallet-engine, policy-engine, agent-runtime, protocol-adapters, transaction-engine, audit-observability, mcp-server - 3 packages (
packages/*): common, sdk, observability
The post-install script runs automatically to patch RPC WebSocket compatibility.
Post-Installation
Build All Packages
Build all services and packages:- All 7 microservices
- SDK and shared packages
- CLI application
Build Escrow Program (Optional)
If you plan to use escrow functionality, build the Anchor program:- Syncs the program ID from the deploy keypair
- Builds the Anchor program
- Generates IDL and type definitions
You only need to build the escrow program if you plan to deploy it or modify escrow functionality.
Verification
System Health Check
Run the doctor command to verify your installation:Service Startup Test
Verify all services can start:Ctrl+C to stop services.
Repository Structure
After installation, your repository should have this structure:Service Ports
After installation, these ports will be used by default:| Service | Port | Description |
|---|---|---|
| API Gateway | 3000 | Main entry point for all requests |
| Wallet Engine | 3002 | Wallet creation, signing, balances |
| Policy Engine | 3003 | Policy evaluation and approval gates |
| Agent Runtime | 4004 | Agent lifecycle and autonomous execution |
| Protocol Adapters | 3005 | Protocol-specific transaction builders |
| Transaction Engine | 3006 | Transaction pipeline and confirmation |
| Audit & Observability | 3007 | Audit events and metrics |
| MCP Server | 3008 | MCP-compatible tool endpoints |
All ports are configurable via environment variables. See the Configuration guide.
Data Directories
By default, services store data in their local directories:Next Steps
Quickstart
Create your first wallet and execute a transaction
Configuration
Configure environment variables and signer backends
Creating Wallets
Learn wallet creation and management
Deployment
Deploy to production with proper security
Troubleshooting
npm install fails with EACCES error
npm install fails with EACCES error
You may have permission issues. Try:Or use a Node version manager like
nvm to avoid permission issues.anchor build fails with 'cargo not found'
anchor build fails with 'cargo not found'
You need Rust installed for Anchor:Then retry:
TypeScript compilation errors
TypeScript compilation errors
Ensure you’re using the correct Node version:Clean and rebuild:
Port already in use errors
Port already in use errors