Skip to content

feat(docs): adds operator documentation for adding a data migration #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aristidesstaffieri wants to merge 2 commits into
base: feature/data-migrations
Choose a base branch
from
Open

feat(docs): adds operator documentation for adding a data migration #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8a4244
adds operator documentation for adding a data migration
aristidesstaffieri Mar 31, 2026
3c35b32
adds operator command reference for running a data migration
aristidesstaffieri Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ account management, and payment tracking capabilities.
- [Authentication](#authentication)
- [API Reference](internal/serve/graphql/README.md)
- [Architecture](#architecture)
- [Data Migrations](#data-migrations)
- [Integration Tests Setup](#integration-tests-setup)
- [Deployment](#deployment)

Expand Down Expand Up @@ -1016,6 +1017,21 @@ FetchAndStoreMetadata(ctx context.Context, contractTypesByID map[string]types.Co
- Worker pool limits concurrent RPC connections
- No large in-memory buffers required

## Data Migrations

The wallet-backend includes a protocol data migration system that enables classification of Soroban smart contracts and production of protocol-specific state. Operators can add support for new protocols (e.g., token standards, lending pools, AMMs) by implementing a validator, processor, and data model, then running a multi-step migration workflow that converges with live ingestion via compare-and-swap (CAS) cursors.

The migration workflow for each protocol consists of four steps:

1. **Protocol Setup** (`protocol-setup`) -- Classifies existing contracts by validating WASM bytecode against protocol specifications
2. **Live Ingestion** (`ingest`) -- Restarts with the new processor to produce state from the current ledger onward
3. **History Migration** (`protocol-migrate history`) -- Backfills historical state changes within the retention window
4. **Current-State Migration** (`protocol-migrate current-state`) -- Builds current state from a start ledger to the tip

Steps 2, 3, and 4 run concurrently, each converging independently with live ingestion via dedicated CAS cursors.

For a detailed walkthrough on how to add a new protocol, see [Adding a New Protocol](docs/data-migrations/adding-a-protocol.md). For the full system design, see [Data Migrations Design Document](docs/feature-design/data-migrations.md).

## Integration Tests Setup

**In this section:**
Expand Down
Loading
Loading