-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Documentation for Public Universe Server and Endpoints #712
Comments
Found some definition of the public endpoints here: https://github.com/Roasbeef/bips/blob/bip-tap/bip-tap-universe.mediawiki#universe-grpc-api . The reference comes from here: docs.lightning.engineering/the-lightning-network/taproot-assets/taproot-assets-protocol.md Line 177 in 0ba7c3c
|
I made edits to this guide, have a look if this is satisfactory: |
I made some comments: a2edb81#comments . |
Here is a list of the public REST endpoints https://github.com/Roasbeef/bips/blob/bip-tap/bip-tap-universe.mediawiki#universe-rest-api Is there any way we can label each endpoint on https://lightning.engineering/api-docs/category/universe-service/index.html to say if it is a public or private one? |
Thank you very much for that! I've addressed your points in this change: |
Do we want to mention at all that a big reason the universe must exist is because Taproot Assets try to do as much stuff off chain as possible in order to increase scalability and improve privacy? |
How does a public universe limit what proofs it accepts in order avoid abuse/spam/overload? |
I think we are still missing some differentiation between the public and private RPC endpoints? |
What's the current status with mailboxes? Are we moving away from them entirely, and universes will take over that functionality? I'm not aware of what private RPC endpoints exist so that would be very much worth documenting |
By default, if you run
Allows access without macaroons to:
Allows access without macaroons to:
The code for this can be found here: https://github.com/lightninglabs/taproot-assets/blob/47e78750da8269663d85bba4ffc22de813569fee/perms/perms.go#L318
They can still be used (and are still the fallback/default if nothing is configured manually) for on-chain transfers. But because of script key collision issues with keys involved in Taproot Asset Channels (see lightninglabs/taproot-assets#1113), the hashmail based proof courier should not be used when operating Taproot Asset channels and a universe server should be configured instead. |
Thank you for the information! I'll make sure our current guides reflect that properly |
We need to enhance the Universes documentation by adding a new section dedicated to Public Universe Servers.
Content to consider
Introduce Public Universe Server:
Document RPC/REST Endpoints:
InsertProof
endpoint and provide a brief overview of its functionality.Clarify Macaroon Authentication:
The text was updated successfully, but these errors were encountered: