docs(attester-registry): explain two-step admin transfer on NoPendingTransfer - #294
Open
petermuazu wants to merge 1 commit into
Open
docs(attester-registry): explain two-step admin transfer on NoPendingTransfer#294petermuazu wants to merge 1 commit into
petermuazu wants to merge 1 commit into
Conversation
…Transfer The error is returned when accept_admin runs without a prior propose_admin, but the doc comment did not spell out the two-step flow callers must follow. Document the propose_admin -> accept_admin sequence on Error::NoPendingTransfer, matching the wording used in the attestation-registry fix, and sync docs/error-codes.md. 🤖 Generated with Codebuff Co-Authored-By: Codebuff <noreply@codebuff.com>
|
@petermuazu Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Closes #272
Closes #273
Closes #274
Closes #275
Summary
Error::NoPendingTransferis returned whenaccept_adminis called without a priorpropose_admin, but the doc comment didn't spell out the two-step admin-transfer flow callers must follow. This PR documents thepropose_admin→accept_adminsequence on the attester-registry variant and syncsdocs/error-codes.mdto match — mirroring the equivalent fix for attestation-registry (#266).Changes
contracts/attester-registry/src/lib.rs— expanded theError::NoPendingTransferdoc comment to explain the two-step flow: the current admin must first callpropose_adminto nominate a successor, then the nominated address must callaccept_adminto complete the transfer. Wording matches the style used in the attestation-registry fix.docs/error-codes.md— updated theattester-registryNoPendingTransferrow description to reflect the two-step flow.Validation
cargo check/clippy/testor the error-docs conformance check — no Rust toolchain or stellar CLI is available in this sandbox. Note the conformance script only validates error codes and names, which are unchanged; recommend CI confirms.Closes #272