Integration guide

[JanKuczma]

Summary by CodeRabbit

• Documentation
  • Reorganized the Integration Guide with new sections (Migration Key, Prerequisites, Lock State, Bridge archive root, Migration data components) for clearer workflows.
  • Rewrote migration flows (previous Mode A/Mode B narratives) into clarified steps and prerequisites emphasizing cross-rollup and archival bridging.
  • Expanded and updated code examples, wallet/proof guidance, and data-flow explanations to match the new structure.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8df4a71 and 7d6a5f7.

📒 Files selected for processing (1)

• docs/integration-guide.md

---

Walkthrough

This pull request performs a comprehensive editorial rewrite of the integration guide: reorganizing sections and headings, renaming terminology, updating migration flows and prerequisites, and replacing many TypeScript/Noir examples and builders. No functional code or API changes are included. (≤50 words)

Changes

Cohort / File(s)

Summary

Documentation — integration guide docs/integration-guide.md

Major editorial rework: reorganized headings (Prerequisites, Migration Key, Lock State, Bridge archive root, Migration data components), reframed components (Noir library, App contracts V1/V2, TS SDK), replaced Mode A/B narratives with new flows and prerequisites, updated and expanded TS and Noir code examples and builders, added wallet/account and archive bridging notes. No executable logic changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped through headings, nibbling lines of text,
I tied new keys and knitted code examples next,
I left fresh paths where migrations roam,
A tiny pawprint on the guide's new home,
Crunchy carrots for documentation success. 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Integration guide' is vague and generic, failing to convey the specific nature of changes (reorganization, renaming, and content updates to the integration documentation).	Use a more descriptive title that reflects the primary change, such as 'Reorganize and update integration guide with new architecture terminology' or 'Refactor integration guide: update sections and code examples for new workflows'.

✅ 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.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch jk-integration-guide

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

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

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/integration-guide.md`:
- Around line 397-400: The snippet calling migrate_mode_b passes arguments in
the wrong order compared to the documented Noir signature; update the call to
match the contract method migrate_mode_b(signature, amount, fullProof,
archiveProof.archive_block_header, owner, publicKeys, partialAddress, keyProof,
nhk) by moving the signature argument to the first position and shifting amount
to the second, ensuring the parameter order in the example exactly matches the
documented function signature for migrate_mode_b.
- Line 171: The example call to
oldContract.methods.lock_for_migration_mode_a(...) uses three arguments but the
function signature in the docs is lock_for_migration_mode_a(private_amount,
public_amount, destination_rollup, mpk); update the example invocation (the call
at oldContract.methods.lock_for_migration_mode_a(amount, newRollupVersion,
mpk).send().wait()) to pass four arguments in the correct order (private_amount,
public_amount, destination_rollup, mpk) — e.g., supply the missing public_amount
parameter (or 0 if none) so the call shape matches the documented signature.
- Around line 30-33: The fenced code block containing the key-derivation snippet
(msk = sha512ToGrumpkinScalar([secretKey, DOM_SEP__MSK_M_GEN]) and mpk = msk *
G) lacks a language tag and triggers MD040; update that fenced block to include
a language identifier (for example `text`) after the opening backticks so the
snippet is annotated and the linter warning is resolved.

---

ℹ️ Review info

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 77181a0 and 05aa13b.

📒 Files selected for processing (1)

• docs/integration-guide.md