Skip to content

book: Document that z_setmigration is not implemented#470

Open
jackrieck wants to merge 1 commit into
zcash:mainfrom
jackrieck:document-z-setmigration
Open

book: Document that z_setmigration is not implemented#470
jackrieck wants to merge 1 commit into
zcash:mainfrom
jackrieck:document-z-setmigration

Conversation

@jackrieck

Copy link
Copy Markdown

Issue

Closes #331

Motivation

A user migrating from zcashd may reach for z_setmigration (which controlled
the automatic Sprout-to-Sapling fund migration) and be confused when it is
absent from Zallet. There was no documentation explaining why it is gone or what
to do instead.

Solution

Zallet does not support Sprout, so there is no migration to configure and no
equivalent RPC is provided. This adds z_setmigration to the "Omitted RPC
methods" table in book/src/zcashd/json_rpc.md (alongside the existing
z_getmigrationstatus entry) and a short note explaining that any remaining
Sprout funds must be migrated out before transitioning to Zallet. The framing
mirrors the existing migrate-warn-sprout-migration message used by
zallet migrate-zcash-conf.

Test evidence

Documentation-only change (single Markdown file); no code paths affected.

Zallet does not support Sprout, so the automatic Sprout-to-Sapling fund
migration configured by z_setmigration (and reported by
z_getmigrationstatus) has no equivalent. Add z_setmigration to the omitted
RPC methods table and explain that remaining Sprout funds must be migrated
out before transitioning to Zallet.

Co-Authored-By: Claude <noreply@anthropic.com>
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.

Document how to handle z_setmigration not being implemented

1 participant