Rename OrderBook to Raindex by thedavidmeister · Pull Request #2526 · rainlanguage/raindex

thedavidmeister · 2026-03-27T05:43:41Z

Summary

Comprehensive rename of "OrderBook" / "orderbook" to "Raindex" / "raindex" across the entire codebase and dependent repositories.

What changed

~10,000+ string references renamed across all crates, packages, subgraph, Solidity, CI, docs
Struct fields, variable names, function names, type names, error variants
ob_id struct field → raindex_id (~300 usages)
All ob abbreviation variable names → descriptive raindex* names
Directory renames: src/concrete/ob/ → src/concrete/raindex/, test/concrete/ob/ → test/concrete/raindex/
packages/orderbook → packages/raindex (directory rename)
SvelteKit route params: [orderbook] → [raindex]
Nix commands: ob-rs-test → raindex-rs-test, ob-ui-components-prelude → raindex-ui-components-prelude, rainix-ob-cli-artifact → raindex-cli-artifact
Subgraph schema: Orderbook entity → Raindex, all orderbook fields → raindex
Goldsky subgraph name: ob4 → raindex
Rainlang sub-parser word: "orderbook" → "raindex" (breaking for existing expressions)
Sub-parser pointers regenerated (new bytecode hash and deployment address)
Gas snapshot regenerated
Audit markdown files deleted (all findings triaged, remaining items in GitHub issues Test: spender != pool path in GenericPool _exchange #2533-Add zero-address guards for decoded spender/pool in LibGenericPoolExchange #2539)

Companion PRs (merged)

Rename ob-yaml.md to raindex-yaml.md specs#52 — Rename ob-yaml.md → raindex-yaml.md, document version 6
Rename OrderBook to Raindex in docs and test data rain.metadata#101, subgraph query integration tests #102 — Rename OrderBook refs in metadata tooling
Update rain.metadata submodule and delete audit MDs rainlang#451 — Update metadata submodule, delete audit MDs
Delete audit markdown files raindex.interface#55 — Delete audit MDs

Breaking changes

Surface	Change	Impact
YAML config	Version bumped to 6. `orderbooks:` → `raindexes:`, `orderbook:` → `raindex:`	All `.rain` frontmatter and standalone YAML configs must be updated
DB schema	`orderbook_address` columns → `raindex_address` across all tables (including PRIMARY KEYs). `DB_SCHEMA_VERSION` bumped 2→3	Existing local databases are incompatible — requires fresh sync
Remote DB dumps	Column names changed in dump SQL	Remote dumps must be rebuilt before local clients can bootstrap
Subgraph schema	`Orderbook` entity → `Raindex`, all `orderbook` fields → `raindex` on every entity (Vault, Order, Trade, Deposit, Withdrawal, etc.)	Subgraphs need redeployment. All existing queries using old field names break
Goldsky deployment	`ob4` → `raindex`	New subgraph instances deployed. Old `ob4-*` endpoints stop updating
REST API	`"orderbook"` field → `"raindex"` in `TakeOrdersReadyResponse`. Doc strings updated ("the raindex contract")	API consumers parsing that field break
npm package	`@rainlanguage/orderbook` → `@rainlanguage/raindex`	All importers must update package.json and imports. Not an in-place upgrade — new package name
WASM/JS API classes	`OrderbookYaml` → `RaindexYaml`, `OrderbookYamlError` → `RaindexYamlError`, `getOrderbookByAddress()` → `getRaindexByAddress()`	All JS/TS consumers of the WASM API must update class and method names
WASM getters	`.orderbook()` → `.raindex()` on `RaindexOrder`, `RaindexVault`, `TakeOrdersInfo`; `.orderbookAddress` → `.raindexAddress` on `DeploymentTransactionArgs`	All code accessing these properties must update
JSON serialization	`"obId"` → `"raindexId"` on sync status; `"orderbookAddress"` → `"raindexAddress"` on vault/order objects; `"orderbook"` → `"raindex"` on trade/order objects	All consumers of serialized JSON (frontend, tools, API clients) must update field names
Rainlang word	Sub-parser word `"orderbook"` → `"raindex"`. Sub-parser bytecode and deterministic deploy address changed	Existing compiled expressions unaffected. Source `.rain` files using `orderbook()` must update. New sub-parser must be deployed
Webapp URLs	`/orders/[chainId]-[orderbook]-[orderHash]` → `[raindex]`, same for vaults	Bookmarked URLs break
CLI	`ob-addr` alias → `raindex-addr`	Scripts using old alias break
Nix commands	`ob-rs-test`, `ob-ui-components-prelude`, `rainix-ob-cli-artifact` renamed	CI/scripts referencing old names break
UI labels	"Orderbook" → "Raindex" in webapp	Visual change for users

Intentionally preserved

Deprecated IOrderBookV1-V5 Solidity interfaces in lib/rain.raindex.interface/src/interface/deprecated/ — historical ABIs for backwards compatibility
1 historical comment in crates/settings/src/local_db_manifest.rs documenting the DB column rename
raindexs in GraphQL codegen — The Graph framework naively appends s to entity names

Migration checklist

🤖 Generated with Claude Code

Summary by CodeRabbit

Chores
- Rebranded project from "Rain Orderbook" to "Raindex," updating package names (@rainlanguage/raindex), Rust crate identifiers, CI/CD workflows, configuration files, and build processes throughout the repository.
Documentation
- Updated developer guides, architecture documentation, setup instructions, and implementation guidelines to reflect the project rebranding.

Summary by CodeRabbit

Chores
- Rebranded project naming from "Rain Orderbook" to "Raindex" across packages, crates, and documentation.
- Updated npm package names, build commands, and workspace dependencies.
- Updated CI/CD workflows, GitHub Actions, and development configurations.
- Updated gas snapshots and test references for new contract naming.

Rename all Solidity source contracts, libraries, and scripts from OrderBook naming to Raindex naming. File renames and content updates for src/abstract/, src/concrete/, src/lib/, src/generated/, and script/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Content and file renames for all test utility, abstract, concrete, and lib test files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update root Cargo.toml, crate Cargo.toml files, and all Rust source files. Rename crate names from rain_orderbook_* to raindex_*. Update settings crate types (OrderbookCfg -> RaindexCfg, etc.), YAML keys, module declarations, and file names. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rename YAML config keys (orderbooks -> raindexes) and bump spec version from 5 to 6. Fix remaining Orderbook type references in js_api yaml module and settings crate. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update import paths, YAML key strings, and constant prefixes that were missed in the initial Rust rename pass. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Update foundry.toml, flake.nix, .gitignore, .devcontainer.json, package.json, README.md, AGENTS.md, copilot instructions, and GitHub workflow files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rename directory, update package.json names and URLs, update build scripts (wasm crate name, wbg json), ARCHITECTURE.md, README.md, test files, and ui-components dependency reference. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Rename Svelte components (DropdownOrderbooksFilter -> DropdownRaindexesFilter, ListViewOrderbookFilters -> ListViewRaindexFilters), update imports, types, and variable names. Update ui-components and raindex package dependencies and URLs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-03-27T05:43:54Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

This PR performs a comprehensive, repository-wide rename from "Rain Orderbook" to "Raindex" across Rust crates, npm packages, Solidity bindings, CI/CD workflows, configuration, and documentation. Workspace dependencies, crate names, package references, generated bindings, CLI implementations, and all related workflows and documentation are systematically updated to use the new raindex namespace.

Changes

Orderbook → Raindex Repository-wide Rebranding

Layer / File(s)	Summary
Workspace configuration and Cargo dependencies `Cargo.toml`	Workspace `exclude` list reformatted and all `[workspace.dependencies.]` entries renamed from `rain_orderbook_` to `raindex_*` (bindings, common, cli, subgraph_client, app_settings, quote, test_fixtures, math, js_api, rest_api) while preserving path references.
Solidity bindings crate rename `crates/bindings/Cargo.toml`, `crates/bindings/src/lib.rs`, `crates/bindings/ARCHITECTURE.md`	Package name and description changed from `rain_orderbook_bindings` to `raindex_bindings`; generated Solidity module switched from `OrderBook` (OrderBookV6.json) to `Raindex` (RaindexV6.json); exported event constant renamed `ORDERBOOK_EVENT_TOPICS` → `RAINDEX_EVENT_TOPICS`; architecture documentation updated with `IRaindexV5`/`Raindex` binding examples.
CLI crate rename and workspace dependencies `crates/cli/Cargo.toml`	Crate name and description updated from `rain_orderbook_cli` to `raindex_cli`; all workspace dependency references switched from `rain_orderbook_` to `raindex_`.
Chart command implementation rewiring `crates/cli/src/commands/chart.rs`	Imports updated to `raindex_*` crates; generated dotrain templates renamed from `orderbooks`/`orderbook` to `raindexes`/`raindex` with subgraph paths changed to `raindex-flare`; test setup and all test cases updated to use `LocalEvm.raindex` and `raindex_subparser` fields.
Local DB pipeline modules `crates/cli/src/commands/local_db/`, including `bootstrap.rs`, `executor.rs`, `cli.rs`, `pipeline/runner/environment.rs`, `pipeline/runner/export.rs`, `README.md`	All imports switched from `rain_orderbook_common::local_db` to `raindex_common::local_db`; identifier types renamed `OrderbookIdentifier` → `RaindexIdentifier`; struct field names changed `ob_id` → `raindex_id`, `orderbook_key` → `raindex_key`, `orderbook_address` → `raindex_address`; CLI report rendering, error messages, and test fixtures updated to match raindex terminology.
npm-package-release workflow `.github/workflows/npm-package-release.yml`	Workflow retargeted from `@rainlanguage/orderbook` to `@rainlanguage/raindex`: repository consistency checks now validate `./packages/raindex/package.json`; npm blacklist runs against `packages/raindex`; package hash detection, versioning, dependency updates, tarball creation, publishing, and git commit/tag/release naming all updated to raindex namespace.
CI/CD workflows updated for raindex paths `.github/workflows/rainix.yaml`, `test-ui-components.yaml`, `test-webapp.yaml`, `vercel-*.yaml`, `deploy-subgraph.yaml`, `manual-sol-artifacts.yaml`	All workflows updated to target `packages/raindex` instead of `packages/orderbook`; Nix task names changed from `ob-rs-test` to `raindex-rs-test`; subgraph deployment environment variable updated from `ob4` to `raindex`; secrets/deployment configuration simplified.
Documentation and configuration files `README.md`, `.gitignore`, `.devcontainer.json`, `AGENTS.md`, `Cargo.toml` (metadata), `.github/copilot-instructions.md`, `ai_commands/*`, `crates/bindings/ARCHITECTURE.md`	Core branding updated throughout: README project title/terminology and DEPLOYMENT_SUITE mappings, build artifacts in `.gitignore` redirected to raindex paths, dev container name updated, agent instructions updated with raindex package/build commands, AI task docs retargeted to `packages/raindex`, and bindings architecture documentation updated with raindex type names.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

This PR directly implements the code/artifact renames that support repository rebranding and deployment tracking, addressing the systematic rename objectives for the Raindex project.

Suggested reviewers

0xgleb

Poem

🐰 From OrderBook to Raindex we hop,
The rename train just won't stop!
Packages dance, workflows aligned,
A cleaner brand, organized and refined—
Raindex reigns, config takes flight! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and directly summarizes the primary change: a comprehensive rename of OrderBook to Raindex across the entire repository.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch rename-orderbook-to-raindex

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}