Andamio LogoAndamio
Protocol/Protocol V2

Protocol V2

Andamio Protocol V2 - Enhanced state management, simplified roles, and migration support

Andamio Protocol V2

Protocol V2 introduces architectural improvements that simplify the role structure, enhance state management, and provide a clear migration path from V1.

New to V2? Check out What's New in V2 for a detailed look at batch module management, SLT hash encoding, and cost savings.

Key Changes from V1

AspectV1V2
Transaction Types29 across 8 roles13 across 5 roles
Role Structureadmin, contributor, course-creator, project-creator, student, generaladmin, contributor, student, general, user
State ManagementSeparate state validatorsUnified Global State V2 with local state registration
MigrationN/ABuilt-in V1 to V2 migration support

V2 Architecture Overview

Simplified Role Structure

V2 consolidates roles by removing course-creator and project-creator - these functions are now handled by admin transactions. This reduces complexity while maintaining full functionality.

Active Roles in V2:

  • Admin - Instance administrators managing courses and projects
  • Contributor - Project participants earning rewards
  • Student - Course participants completing assignments
  • General - Protocol-wide operations (access tokens, registration)
  • User - Migration operations (V1 to V2 transition)

New Systems in V2

  1. Local State Registration - New global validator system for registering local states to the global V2 system
  2. Global State V2 - Enhanced state management with improved tracking and coordination
  3. Course State V2 - Upgraded course validators with better state handling
  4. Contributor State V2 - Enhanced contributor tracking and reward distribution

Protocol Components

Validators

V2 validators organized by system:

SystemValidatorsPurpose
Global State2Core protocol state (V1 compat + V2 enhanced)
Global1Local state registration
Index Validators3Access token minting and index references
Instance3Instance-level management
Course4 + 3 observersCourse and assignment management
Project3 + 4 observersContributor and treasury management

Transactions

V2 transactions organized by system and role:

SystemRoleTransactionsKey Operations
GeneralOpen1mint-access-token (~7.9 ADA)
CourseAdmin2create (~45 ADA), teachers-update (~5.3 ADA)
CourseTeacher2modules-manage, assignments-assess
CourseStudent3enroll, assignment-update, credential-claim

Single Credential Loop Cost: Student ~1.11 ADA + Teacher ~0.21 ADA = ~1.32 ADA total

Tokens

V2 tokens organized by system:

SystemKey Tokens
Global Stateaccess-token-user, access-token-global-state, access-token-index
Globallocal-state-registration
Local Statelocal-state-nft
Instanceinstance-admin-token, course-nft, project-nft
Coursecourse-state-v2-token, module-token
Projectcontributor-state-v2-token, treasury-token

Migration from V1

Users with V1 global state can migrate to V2 using the move-global-state-v1-to-v2 transaction. This preserves existing access tokens while enabling V2 features.

Source of Truth

V2 protocol documentation is built from multiple registry files:

RegistryPurpose
address-registry.jsonValidators, policies, observers with addresses
endpoint-registry.jsonAPI endpoints with request/response schemas
cost-registry.jsonTransaction fees, protocol fees, loop costs

API Endpoints:

  • /api/transaction-v2?file=<path>&format=v1 - Transaction YAML data
  • /api/costs/v2 - Cost registry (supports ?tx=, ?loop=, ?summary=true)

Status

Course System: ✅ Complete (8 transactions documented) Project System: 🔜 Coming soon

Documentation is aligned with the Atlas API Preprod swagger.