Skip to content

SOROBAN_VERSION_CHECKLIST.md

Latest commit

 

History

History
183 lines (145 loc) · 4.62 KB

SOROBAN_VERSION_CHECKLIST.md

File metadata and controls

183 lines (145 loc) · 4.62 KB

Soroban Version Validation Checklist

Use this checklist when validating contracts with a new Soroban version.

Pre-Validation

  • New Soroban SDK version identified: _____
  • New Soroban CLI version identified: _____
  • Release notes reviewed
  • Breaking changes documented
  • Team notified of upgrade plan
  • Backup of current deployment created

Environment Setup

  • New branch created: upgrade/soroban-v_____
  • Baseline gas benchmarks saved
  • Current versions documented
  • Development environment prepared

Code Updates

  • Updated remittance_split/Cargo.toml
  • Updated savings_goals/Cargo.toml
  • Updated bill_payments/Cargo.toml
  • Updated insurance/Cargo.toml
  • Updated family_wallet/Cargo.toml
  • Updated data_migration/Cargo.toml
  • Updated reporting/Cargo.toml
  • Updated orchestrator/Cargo.toml
  • Updated Soroban CLI to new version
  • Verified CLI version: soroban version

Build Validation

  • cargo clean executed
  • Cargo.lock removed
  • All contracts build successfully
  • No compilation warnings
  • WASM artifacts generated correctly

Testing

Unit Tests

  • remittance_split tests pass
  • savings_goals tests pass
  • bill_payments tests pass
  • insurance tests pass
  • family_wallet tests pass
  • reporting tests pass
  • orchestrator tests pass
  • data_migration tests pass
  • All tests pass: cargo test

Gas Benchmarks

  • Gas benchmarks executed
  • Results compared with baseline
  • CPU usage within 10% threshold
  • Memory usage within 10% threshold
  • Performance regressions investigated
  • Results documented

Testnet Deployment

Deployment

  • Testnet account funded
  • remittance_split deployed
  • savings_goals deployed
  • bill_payments deployed
  • insurance deployed
  • family_wallet deployed
  • reporting deployed
  • orchestrator deployed
  • All contract IDs recorded

Functional Testing

  • remittance_split - initialize_split works
  • remittance_split - calculate_split works
  • savings_goals - create_goal works
  • savings_goals - add_to_goal works
  • bill_payments - create_bill works
  • bill_payments - pay_bill works
  • insurance - create_policy works
  • insurance - pay_premium works
  • family_wallet - add_member works
  • reporting - get_financial_health_report works
  • orchestrator - cross-contract calls work

Event Validation

  • Events emitted correctly
  • Event structure unchanged (or documented)
  • Event topics correct
  • Event data complete

Storage Validation

  • Storage operations work
  • TTL extension works
  • Archival works
  • Restoration works
  • Storage stats accurate

Integration Testing

  • End-to-end remittance flow tested
  • Cross-contract calls validated
  • Multi-user scenarios tested
  • Edge cases verified
  • Error handling confirmed

Monitoring Period

  • Testnet monitoring for 7 days
  • No critical issues observed
  • Performance metrics stable
  • User feedback collected (if applicable)

Documentation

  • README.md compatibility section updated
  • VERSION_COMPATIBILITY.md updated
  • UPGRADE_GUIDE.md updated with version-specific notes
  • DEPLOYMENT.md reviewed and updated
  • COMPATIBILITY_QUICK_REFERENCE.md updated
  • Code comments updated (if APIs changed)
  • Migration guide created (if breaking changes)

Mainnet Preparation

  • All testnet validations passed
  • Team approval obtained
  • Deployment plan documented
  • Rollback plan prepared
  • Monitoring configured
  • Stakeholders notified
  • Deployment window scheduled

Mainnet Deployment

  • Mainnet account prepared
  • Contracts deployed to mainnet
  • Contract IDs recorded
  • Initial smoke tests passed
  • Monitoring active

Post-Deployment

  • 24-hour monitoring completed
  • No critical issues
  • Performance metrics acceptable
  • User feedback positive
  • Documentation finalized
  • Upgrade marked as complete

Sign-off

Role Name Date Signature
Developer
QA
DevOps
Product Owner

Notes

Use this section to document any issues, workarounds, or important observations:

[Add notes here]

Version Details

  • Previous SDK Version: _____
  • New SDK Version: _____
  • Previous CLI Version: _____
  • New CLI Version: _____
  • Upgrade Date: _____
  • Completed By: _____

Template Version: 1.0
Last Updated: 2024