Repository navigation
docs: add deposit-wallet address migration runbook - #40
Open
arunimshukla wants to merge 1 commit into
Open
arunimshukla wants to merge 1 commit into
arunimshukla wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a documentation-only migration runbook for integrations that used UUPS-only
deriveDepositWallet()or persisted an earlier deposit address.0.0.10and the current factory/beacon/legacy-wallet address-selection matrix.Context and boundaries
Related to #39 and Polymarket/py-builder-relayer-client#27. This PR does not resolve their recovery requests, verify reported balances, submit transactions or introduce an operator-recovery procedure.
The behaviour was checked against
src/client.tsandsrc/builder/derive.tsat upstream commit9122f6fb1856f1ecfe4406685bfa19a2c5a7b290. An existing deployed UUPS wallet remains selected; upgrading the package alone does not change calls to the deprecated standalone helper.Validation
The full SDK test suite was not run. These checks validate documented selection/preflight behaviour, not CREATE2 cryptography or live relayer availability.
Note
Low Risk
Documentation-only changes with no runtime, auth, or deployment behavior changes.
Overview
Adds a deposit-wallet migration runbook for integrators who still call deprecated
deriveDepositWallet()or reuse a stored funding address, and links it from the README deposit-wallet section.The runbook documents upgrading to
client.deriveDepositWalletAddress()(v0.0.10+), the factory beacon vs legacy UUPS address-selection matrix, and that derivation alone does not deploy wallets or recover prior deposits. It adds a read-onlygetDepositWalletPreflightpattern that re-derives the address, fails on a persisted mismatch, and checks relayer deployment viagetDeployed(). A final section sets expectations for earlier-deposit recovery (operator path, redacted evidence checklist) and points to related GitHub issues without promising a user SDK workflow.Reviewed by Cursor Bugbot for commit e8bc156. Bugbot is set up for automated code reviews on this repo. Configure here.