Skip to content

Add a key metadata endpoint returning the on-chain name, bio, and avatar URI for a creator key #845

Closed

Description

@Chucks1093

Summary

Creator metadata stored on-chain via initialise_key and update_metadata is not currently surfaced through the server API. A GET /keys/:keyId/metadata endpoint that reads the on-chain metadata fields and returns them should be added.

Scope

  • Add GET /keys/:keyId/metadata endpoint (no auth required)
  • Read name, bio, and avatar_uri from the on-chain persistent storage via the Soroban RPC
  • Cache the response in Redis for 5 minutes and invalidate when a metadata_updated event is received
  • Return 404 when no metadata has been initialised for the key
  • Include the key creator address in the response

Acceptance Criteria

  • name, bio, avatar_uri, and creator address returned correctly
  • Redis cache served within 5-minute TTL
  • Cache invalidated on metadata_updated event
  • 404 returned when no metadata exists for the key
  • 404 returned for unknown key ID

ETA: 12 hours


Coordinate on Telegram

Activity

  1. Chigybillionz commented on Aug 27, 2026

    @Chigybillionz
    Contributor

    I can take this up and deliver a fix. Please assign.

  2. codewithzubair07 commented on Aug 29, 2026

    @codewithzubair07

    @codewithzubair07 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    i would like to work on this issue

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @codewithzubair07 to this issue.

  3. Ha-biba3 commented on Aug 29, 2026

    @Ha-biba3

    @Ha-biba3 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    I understand requirements and can handle implementation.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Ha-biba3 to this issue.

  4. devJaja commented on Aug 29, 2026

    @devJaja
    Contributor

    @devJaja has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    can I work on this please

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @devJaja to this issue.

  5. drips-wave commented on Aug 29, 2026

    @drips-wave

    Congratulations, @devJaja! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

    🧑‍💻 @devJaja: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  6. devJaja commented on Aug 31, 2026

    @devJaja
    Contributor

    Closed by PR #859 — key metadata endpoint implemented.

  7. devJaja commented on Aug 31, 2026

    @devJaja
    Contributor

    Closed by PR #859

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions