Skip to content

Commit a2edb81

Browse files
Leo Weesegitbook-bot
authored andcommitted
GITBOOK-459: change request with no subject merged in GitBook
1 parent 0ba7c3c commit a2edb81

File tree

5 files changed

+28
-43
lines changed

5 files changed

+28
-43
lines changed

SUMMARY.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
* [Debugging LND](lightning-network-tools/lnd/debugging\_lnd.md)
7676
* [Fuzzing LND](lightning-network-tools/lnd/fuzz.md)
7777
* [LND and etcd](lightning-network-tools/lnd/etcd.md)
78-
* [gRPC API](lightning-network-tools/lnd/grpc-api.md)
78+
* [LND API documentation](https://lightning.engineering/api-docs/api/lnd/)
7979
* [Channel Acceptor](lightning-network-tools/lnd/channel-acceptor.md)
8080
* [RPC Middleware Interceptor](lightning-network-tools/lnd/rpc-middleware-interceptor.md)
8181
* [HTLC Interceptor](lightning-network-tools/lnd/htlc-interceptor.md)
@@ -107,16 +107,17 @@
107107
* [Troubleshooting](lightning-network-tools/lightning-terminal/troubleshooting.md)
108108
* [Lightning Node Connect: Under the hood](lightning-network-tools/lightning-terminal/lightning-node-connect.md)
109109
* [LNC Node Package](lightning-network-tools/lightning-terminal/lnc-npm.md)
110+
* [LITD API Documentation](https://lightning.engineering/api-docs/api/lit/)
110111
* [Privacy and Security](lightning-network-tools/lightning-terminal/privacy-and-security.md)
111112
* [Privacy Policy](lightning-network-tools/lightning-terminal/privacy.md)
112113
* [Terms of Use](lightning-network-tools/lightning-terminal/tos.md)
113114
* [Loop](lightning-network-tools/loop/README.md)
114115
* [🛠️ Get Started](lightning-network-tools/loop/get-started.md)
115116
* [The Loop CLI](lightning-network-tools/loop/the-loop-cli.md)
116-
* [gRPC API](lightning-network-tools/loop/grpc-api.md)
117117
* [Autoloop](lightning-network-tools/loop/autoloop.md)
118118
* [Instant Loop Outs](lightning-network-tools/loop/instant-loop-outs.md)
119119
* [Peer with Loop](lightning-network-tools/loop/peer-with-loop.md)
120+
* [Loop API Documentation](https://lightning.engineering/api-docs/api/loop/)
120121
* [Pool](lightning-network-tools/pool/README.md)
121122
* [Overview](lightning-network-tools/pool/overview.md)
122123
* [Quickstart](lightning-network-tools/pool/quickstart.md)
@@ -129,7 +130,7 @@
129130
* [Channel Leases](lightning-network-tools/pool/channel\_leases.md)
130131
* [Batch Execution](lightning-network-tools/pool/batch\_execution.md)
131132
* [Account Recovery](lightning-network-tools/pool/account\_recovery.md)
132-
* [gRPC API](lightning-network-tools/pool/grpc-api.md)
133+
* [Pool API Documentation](https://lightning.engineering/api-docs/api/pool/)
133134
* [FAQs](lightning-network-tools/pool/faq.md)
134135
* [Taproot Assets](lightning-network-tools/taproot-assets/README.md)
135136
* [Get Started](lightning-network-tools/taproot-assets/get-tapd.md)
@@ -142,6 +143,7 @@
142143
* [Multisignature](lightning-network-tools/taproot-assets/multisignature.md)
143144
* [Lightning Polar](lightning-network-tools/taproot-assets/polar.md)
144145
* [Operational Safety Guidelines](lightning-network-tools/taproot-assets/operational-safety-guidelines.md)
146+
* [Taproot Assets API Documentation](https://lightning.engineering/api-docs/api/taproot-assets/)
145147
* [Aperture](lightning-network-tools/aperture/README.md)
146148
* [⚒️ Get Aperture](lightning-network-tools/aperture/get-aperture.md)
147149
* [LNC Backend](lightning-network-tools/aperture/lnc-backend.md)
@@ -150,6 +152,7 @@
150152
* [Faraday](lightning-network-tools/faraday/README.md)
151153
* [🛠️ Get Started](lightning-network-tools/faraday/get-started.md)
152154
* [The Faraday CLI](lightning-network-tools/faraday/the-faraday-cli.md)
155+
* [Faraday API Documentation](https://lightning.engineering/api-docs/api/faraday/)
153156

154157
## LAPPs
155158

lightning-network-tools/lnd/grpc-api.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

lightning-network-tools/loop/grpc-api.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

lightning-network-tools/pool/grpc-api.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

lightning-network-tools/taproot-assets/universes.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ description: Learn how to run a universe and connect to other universes.
44

55
# Universes
66

7+
In the context of Taproot Assets, a universe is a service that acts as a repository for publicly minted assets. It contains knowledge of assets, mints, metadata, public transfers and their proofs. A universe is required for users to fetch data necessary to validate transfers, and may be public or private.
8+
9+
Anyone may run a universe, or use one or multiple universes provided by others, such as Lightning Labs. In addition to universes, mailboxes are used to transfer proofs from sender to receiver. For help with running your own mailbox, please refer to [the Aperture guides](../aperture/).
10+
711
## Running a universe <a href="#docs-internal-guid-a793947b-7fff-5e06-ddbf-f64bd25da85f" id="docs-internal-guid-a793947b-7fff-5e06-ddbf-f64bd25da85f"></a>
812

9-
Running a universe is as simple as running `tapd` and amending your configuration file. To run a universe, set your instance to listen on the RPC port (10029) and ensure this port is open on your machine. Being publicly reachable is not a requirement for a universe, however. Your universe may only serve resources on a private network, or be otherwise restricted.
13+
Running a universe is as simple as running `tapd` and amending your configuration file. You may run a universe over RPC or REST. By default, `tapd` is expected to listen on port (`10029`), so ensure this port is open on your machine if you would like others to connect to you. Being publicly reachable is not a requirement for a universe, however. Your universe may only serve resources on a private network, or be otherwise restricted.
14+
15+
When running `tapd` as part of `litd`, you may also use port `8443` or define your own port. For example, as the REST universe is also usable through a browser over HTTPS, you may configure it over port `443` or set up a proxy.
1016

1117
Sample`tapd.conf` file:
1218

1319
`rpclisten=0.0.0.0:10029`\
20+
`restlisten=0.0.0.0:8089`\
1421
`allow-public-uni-proof-courier=true`\
1522
`allow-public-stats=true`\
1623
`universe.public-access=rw`
@@ -41,12 +48,14 @@ You can change the configuration from the CLI using `tapcli universe federation
4148

4249
By default, your `tapd` will connect to the default universe, for instance `testnet.universe.lightning.finance:10029` for testnet, or `universe.lightning.finance:10029` on mainnet.
4350

44-
When running `litd` in integrated mode, your universe may also be available at port `:8443`
45-
4651
The contents of the default universe are also available via a public API:
4752

4853
{% embed url="https://universe.lightning.finance/v1/taproot-assets/universe/roots" %}
4954

55+
You may also make use of the UI available through Lightning Terminal
56+
57+
{% embed url="https://terminal.lightning.engineering/assets/" %}
58+
5059
## Federations
5160

5261
By default, your tapd instance will connect to a default universe. You can manually add additional universes to sync to and from, called a federation. You can see this federation with `tapcli universe federation list`.
@@ -70,3 +79,13 @@ To configure your `tapd` to regularly sync to other asset IDs or group keys, you
7079
`tapcli universe federation config global --proof_type issuance --allow_insert true`
7180

7281
`tapcli universe federation config local --proof_type transfer --allow_insert true --group_key <group key>`
82+
83+
## The Universe APIs
84+
85+
A Taproot Asset Universe is available over [gRPC](https://lightning.engineering/api-docs/api/taproot-assets/#grpc) and [REST](https://lightning.engineering/api-docs/api/taproot-assets/#rest). You may run your own universe or interact with a public universe. Public universes are unauthenticated, the macaroon checks are skipped.
86+
87+
For instance, when making a transfer, the proofs may be pushed to one or multiple universes using the REST Api. This requires the asset ID, the leaf key index and script key.
88+
89+
`/v1/taproot-assets/universe/proofs/asset-id/{key.id.asset_id_str}/{key.leaf_key.op.hash_str}/{key.leaf_key.op.index}/{key.leaf_key.script_key_str}`
90+
91+
A detailed list of all available fields as well as code examples can be found under the [Taproot Assets API documentation.](https://lightning.engineering/api-docs/api/taproot-assets/universe/insert-proof)

0 commit comments

Comments
 (0)