Skip to content

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

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

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