Improve documentation and API consistency in display_registry module#25390
Closed
Improve documentation and API consistency in display_registry module#25390
Conversation
…use a new displayKey by definition and never live long in the rpcs
## Description Previously, the Move Compiler's ID Leak check was updated, but not the verifier used during execution. This change also switches Display Registry to be created at its well-known address (0xd). ## Test plan Without this change, E2E tests would fail to execute the transaction that creates the Display Registry.
## Description Regenerate sui framework snapshots for Display Registry changes. ## Test plan CI
## Description Make it so that if Display Registry is enabled at Genesis, the Display Registry object is created. ## Test plan Used for E2E tests up the stack.
## Description Enables Display Registry in Protocol Config 109, for non-production networks. This is to unblock E2E tests in integration PRs, but should not be landed until we are comfortable with Display Registry going out to Devnet. ## Test plan E2E tests further up the stack. wip: display v2 integration
14 tasks
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Co-authored-by: damirka <8008055+damirka@users.noreply.github.com>
Co-authored-by: damirka <8008055+damirka@users.noreply.github.com>
Co-authored-by: damirka <8008055+damirka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] WIP Address documentation feedback for display registry PR
Improve documentation and API consistency in display_registry module
Feb 10, 2026
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.
Addresses documentation feedback from #23710 review. The display_registry module lacked comprehensive documentation and had several API inconsistencies.
Changes
API improvements
claim()andclaim_with_publisher(): Changed fromoption::some()to.fill()for explicit empty-Option semanticsset()documentation: Clarified upsert behavior ("sets value for key, replacing existing")new_with_publisher(): Added#[allow(unused_mut_ref)]with rationale for&mut PublisherparameterDocumentation enhancements
Technical clarifications
&mut Publisherdesign decision (API consistency, future-proofing)cap_id: Option<ID>semantics (None for system-migrated displays until claimed)All documentation now accurately reflects implementation details.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.