Skip to content

Add Documentation for Public Universe Server and Endpoints #712

Open
@ffranr

Description

@ffranr

We need to enhance the Universes documentation by adding a new section dedicated to Public Universe Servers.

Content to consider

  1. Introduce Public Universe Server:

    • Provide a clear and detailed description of what a public universe server is in the context of Taproot Assets.
    • Explain its role and purpose within the tap ecosystem.
    • Explain how some organizations may run a limited public universe server that might only recognize a limited set of tap assets.
    • Explain the role of a public universe server in proof transfers for tap asset transfers.
  2. Document RPC/REST Endpoints:

    • List and describe the RPC/REST endpoints available on a public universe server that developers can utilize.
    • Include direct links to the relevant endpoints in the API documentation, specifically from the Universe Service Endpoints.
      • For example, link to the InsertProof endpoint and provide a brief overview of its functionality.
  3. Clarify Macaroon Authentication:

    • Explain that while the API documentation may indicate that a macaroon is required for authentication, the public universe server endpoints actually ignore the macaroon if provided.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions