5IVE VM Project

A basic project built with 5IVE VM.

Getting Started

Prerequisites

• Node.js 18+
• Local monorepo CLI build: node ../five-cli/dist/index.js --help

Building

# Compile the project
npm run build

# Compile with optimizations
npm run build:release

# Compile with debug information
npm run build:debug

Testing

Discover and Run Tests

5IVE CLI automatically discovers test functions from your .v files:

# Run all tests
npm test

# Run with watch mode for continuous testing
node ../five-cli/dist/index.js test --watch

# Run specific tests by filter
node ../five-cli/dist/index.js test --filter "test_add"

# Run with verbose output
node ../five-cli/dist/index.js test --verbose

# Run with JSON output for CI/CD
node ../five-cli/dist/index.js test --format json

Writing Tests

Test functions in your .v files use the pub test_* naming convention and include @test-params comments:

// @test-params 10 20 30
pub test_add(a: u64, b: u64) -> u64 {
    return a + b;
}

// @test-params 5 2 10
pub test_multiply(a: u64, b: u64) -> u64 {
    return a * b;
}

The @test-params comment specifies the parameters to pass and expected result. The test runner will:

1. Discover test functions automatically
2. Compile the source file
3. Execute with the specified parameters
4. Validate the result matches

Development

# Watch for changes and auto-compile
npm run watch

Deployment

# Deploy to devnet
npm run deploy

Project Structure

• src/ - 5IVE VM source files (.v)
• tests/ - Test files (.v files with test_* functions)
• build/ - Compiled bytecode
• docs/ - Documentation
• five.toml - Project configuration
• SCENARIOS.md - Canonical local/on-chain run paths

Multi-File Projects

If your project uses multiple modules with use or import statements, 5IVE CLI automatically handles:

# Automatic discovery of imported modules
node ../five-cli/dist/index.js compile src/main.v --auto-discover

# Or use the build command which respects five.toml configuration
node ../five-cli/dist/index.js build --project .

Serializer and Typed Account Policy

1. Supported account serializers: raw, borsh, bincode.
2. Default account serializer is raw.
3. Precedence is: parameter @serializer(...) override > account type @serializer(...) > interface/program default.
4. anchor is not a serializer keyword.
5. For typed account metadata, use acct.ctx.* (for example acct.ctx.key), not acct.key.
6. For external state reads, prefer namespaced account types such as spl_token::Mint and spl_token::TokenAccount with explicit @serializer("raw") where needed.

Learn More

• 5IVE VM Documentation
• 5IVE VM GitHub
• Multi-File Compilation Guide
• Examples

License

MIT