Skip to content

v3.alpha.4#766

Merged
DZakh merged 1 commit intomainfrom
dz/v3-alpha.4
Dec 22, 2025
Merged

v3.alpha.4#766
DZakh merged 1 commit intomainfrom
dz/v3-alpha.4

Conversation

@DZakh
Copy link
Member

@DZakh DZakh commented Dec 19, 2025

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated migration guide with breaking API changes for v3.0.0-alpha.4
    • Address type semantics updated to 0x${string} format
    • Replaced transaction.chainId usage with context.chain.id or event.chainId
    • Updated Solana/SVM initialization commands

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Dec 19, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
envio-docs Ready Ready Preview, Comment Dec 19, 2025 1:27pm

@DZakh DZakh requested a review from nikbhintade December 19, 2025 13:26
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 19, 2025

Walkthrough

Update migration and quickstart documentation for Envio v3.0.0-alpha.4: bump version from alpha.3 to alpha.4, change Solana init command target from "solana" to "svm", document Address type change to 0x${string}, and note transaction.chainId deprecation.

Changes

Cohort / File(s) Change Summary
Version and Migration Updates
docs/HyperIndex/migrate-to-v3.md, docs/HyperIndex/solana/solana.md
Updated Envio dependency version from 3.0.0-alpha.3 to 3.0.0-alpha.4 and changed init command target from solana to svm. Added migration notes documenting Address type change to 0x${string} and transaction.chainId deprecation in favor of context.chain.id or event.chainId.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Simple documentation updates with consistent version and command changes across two files
  • No logic or code alterations; straightforward text replacements and additions

Possibly related PRs

  • Mention Solana support #756: Modifies the same Solana documentation file (docs/HyperIndex/solana/solana.md) with quickstart/init command updates
  • V3 migration guide #763: Updates the same migration and Solana documentation files with V3 migration guidance and command version details

Suggested reviewers

  • moose-code
  • JasoonS

Poem

🐰 From alpha.three to four we hop with glee,
SVM replaces solana, wild and free,
Address strings now wear their 0x crown,
Chain IDs migrate, a new migration town,
Docs refined, our guides now gleam so bright!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'v3.alpha.4' is vague and generic, using only a version number without describing what changed or why this update matters. Use a more descriptive title that explains the main change, such as 'Update docs for Envio v3.0.0-alpha.4 release' or 'Update Solana initialization and migration guide for v3.0.0-alpha.4'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dz/v3-alpha.4

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f51994 and e4cd9df.

📒 Files selected for processing (2)
  • docs/HyperIndex/migrate-to-v3.md (7 hunks)
  • docs/HyperIndex/solana/solana.md (1 hunks)
🔇 Additional comments (7)
docs/HyperIndex/migrate-to-v3.md (5)

119-121: Solana init command update is consistent with solana.md.

The command change from init solana to init svm is properly aligned across both documentation files.


159-160: Breaking changes are well-documented with clear migration paths.

Both the Address type change and transaction.chainId removal are properly documented with specific alternatives provided, making migration guidance clear.


381-387: Migration table is comprehensive and properly formatted.

The table accurately documents all API renames and replacements, with proper markdown table formatting and alignment. The addition of the transaction.chainId entry completes the mapping of removed/deprecated APIs.


441-442: Checklist items properly capture the new breaking changes.

The additions to the checklist align with the documented breaking changes and provide clear action items for migration, including the Address type semantics change and transaction.chainId replacement.


223-223: Envio dependency version correctly updated to alpha.4.

docs/HyperIndex/solana/solana.md (2)

20-22: Solana quickstart command is consistent with migration documentation.

The command update from init solana to init svm with version bump to alpha.4 matches the changes in the migration guide.


9-9: Experimental feature history note is appropriately retained.

The "Available since 3.0.0-alpha.3" notation correctly documents when Solana support was first introduced as an experimental feature, which is useful context for users.


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.

@DZakh DZakh merged commit e6c1490 into main Dec 22, 2025
3 checks passed
@DZakh DZakh deleted the dz/v3-alpha.4 branch December 22, 2025 09:31
@DenhamPreen DenhamPreen mentioned this pull request Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants