From 8eb8f7d915bcbd0e14bd27e66d9d0c636f02a24d Mon Sep 17 00:00:00 2001 From: w3irdrobot Date: Wed, 16 Jul 2025 12:59:02 -0400 Subject: [PATCH] update documentation --- .../lnd/recovery-planning-for-failure.md | 2 +- lightning-network-tools/taproot-assets/asset-loop.md | 4 ++-- lightning-network-tools/taproot-assets/debugging-tapd.md | 2 +- lightning-network-tools/taproot-assets/get-tapd.md | 2 +- .../minting-assets-with-an-external-signer.md | 2 +- lightning-network-tools/taproot-assets/polar.md | 8 ++++---- lightning-network-tools/taproot-assets/universes.md | 8 ++++---- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/lightning-network-tools/lnd/recovery-planning-for-failure.md b/lightning-network-tools/lnd/recovery-planning-for-failure.md index 7a31568e..28264ee3 100644 --- a/lightning-network-tools/lnd/recovery-planning-for-failure.md +++ b/lightning-network-tools/lnd/recovery-planning-for-failure.md @@ -66,6 +66,6 @@ Generally, if we have a channel with a peer that we don’t expect to come back [Manage liquidity in the Lightning Network.](../../the-lightning-network/liquidity/manage-liquidity.md) -## Be #craeful not #reckless +## Be #careful not #reckless The Lightning Network offers a multitude of options to recover from failure. LND continues to improve and eliminate bugs that might lead to a fatal node failure. If you encounter a bug, [file an issue](https://github.com/lightningnetwork/lnd/issues/) or contact us through[ Slack](https://lightning.engineering/slack.html),[ Discord](https://discord.gg/9u83Jxeu), and [Twitter](https://x.com/lightning/)! diff --git a/lightning-network-tools/taproot-assets/asset-loop.md b/lightning-network-tools/taproot-assets/asset-loop.md index 5baa3583..eecad971 100644 --- a/lightning-network-tools/taproot-assets/asset-loop.md +++ b/lightning-network-tools/taproot-assets/asset-loop.md @@ -10,7 +10,7 @@ Starting from Loop v0.30-beta it is possible to perform a Loop Out directly usin To perform such a Loop Out, you need Taproot Assets in a channel with a peer performing edge node services. This peer needs outbound liquidity to the wider Lightning Network. It is not necessary to run `loopd` as part of `litd` for easy Autoloop to work. -The command `loop out` needs to specify the amount you expect to receive onchain in satoshis, the asset ID of the asset to be dispensed and the public key of the edge node. At this point it is only possible to Loop Out assets from a single channel. +The command `loop out` needs to specify the amount you expect to receive onchain in satoshis, the asset ID of the asset to be dispensed and the public key of the edge node. At this point, it is only possible to Loop Out assets from a single channel. `loop out --amt 250000 --asset_id c5dc35d9ffa03abcbd22d2d2801d10813970875029843039bf4f99d543d15fef --asset_edge_node 0312bddcf146394bf0805feef967e8485b8648c66065fe7345c4bc97eac8312df7` @@ -33,7 +33,7 @@ HTLC address: tb1ps4jl2l5rs44t6lsp3fkp73396pjsn0syxx9yjqqxktjmtmjtk52sc45drr Run `loop monitor` to monitor progress. ``` -This feature is available on mainnet, testnet and signet. The usual Loop Out minimums and maximums apply. At this point the Loop node itself does not accept Taproot Asset channels. +This feature is available on mainnet, testnet and signet. The usual Loop Out minimums and maximums apply. At this point, the Loop node itself does not accept Taproot Asset channels. ## Easy Autoloop diff --git a/lightning-network-tools/taproot-assets/debugging-tapd.md b/lightning-network-tools/taproot-assets/debugging-tapd.md index 85623ef2..b0205f1d 100644 --- a/lightning-network-tools/taproot-assets/debugging-tapd.md +++ b/lightning-network-tools/taproot-assets/debugging-tapd.md @@ -33,7 +33,7 @@ You can use the following to increase the number of log files and their maximum ## Profiling -A go profile helps determine the state of a go program. You can enable profiling with at any port: +A go profile helps determine the state of a go program. You can enable profiling at any port: `lnd.profile=9736` diff --git a/lightning-network-tools/taproot-assets/get-tapd.md b/lightning-network-tools/taproot-assets/get-tapd.md index ddc8fb3f..18d91123 100644 --- a/lightning-network-tools/taproot-assets/get-tapd.md +++ b/lightning-network-tools/taproot-assets/get-tapd.md @@ -6,7 +6,7 @@ description: >- # Get Started -## #Craeful +## #Careful {% hint style="info" %} Taproot Assets is alpha software. Use it on mainnet at your own risk! diff --git a/lightning-network-tools/taproot-assets/minting-assets-with-an-external-signer.md b/lightning-network-tools/taproot-assets/minting-assets-with-an-external-signer.md index c5b58dce..02d8fd0b 100644 --- a/lightning-network-tools/taproot-assets/minting-assets-with-an-external-signer.md +++ b/lightning-network-tools/taproot-assets/minting-assets-with-an-external-signer.md @@ -36,6 +36,6 @@ There are multiple keys relevant to transfer Taproot Assets. While it is technically possible to keep either the Bitcoin key or the Asset Script key on a dedicated air-gapped or signing device, there is currently no mechanism equipped for that. -A special case is that of pocket universes, where the Bitcoin key is held by a service, while the Asset Script key is held by the user. This allows for the efficient batching of potentially millions of asset transfers in a single Bitcoin transaction. The service does however not control the assets of the users and cannot move them independently. +A special case is that of pocket universes, where the Bitcoin key is held by a service, while the Asset Script key is held by the user. This allows for the efficient batching of potentially millions of asset transfers in a single Bitcoin transaction. However, the service does not control the assets of the users and cannot move them independently. [FAQ: What is a pocket universe](../../the-lightning-network/taproot-assets/faq.md) diff --git a/lightning-network-tools/taproot-assets/polar.md b/lightning-network-tools/taproot-assets/polar.md index 70591784..3c2ced96 100644 --- a/lightning-network-tools/taproot-assets/polar.md +++ b/lightning-network-tools/taproot-assets/polar.md @@ -14,7 +14,7 @@ Tapping into Taproot Assets #2: Prototype with Polar ## Prerequisites -Before you can get started with Lightning Polar, you will need Docker. On Windows and Mac OS you can use [Docker Desktop](https://www.docker.com/products/docker-desktop/), while on Linux it is recommended to run [Docker Engine](https://docs.docker.com/engine/install/#server). +Before you can get started with Lightning Polar, you will need Docker. On Windows and Mac OS, you can use [Docker Desktop](https://www.docker.com/products/docker-desktop/), while on Linux it is recommended to run [Docker Engine](https://docs.docker.com/engine/install/#server). ## Download Lightning Polar @@ -24,7 +24,7 @@ You can [download Lightning Polar](https://lightningpolar.com/) from the officia Run polar by executing it on your machine. This will launch the Polar user interface from where you can launch a new network. -For the purpose of this guide, we are going to set up two Litd nodes, each with their own Bitcoin Core backend. One Litd node (Alice) acts as the user, the other (Edgar) acts as the edge node. The edge node is connected to a CLN, Eclair and LND node, representing the broader Lightning Network. +For the purpose of this guide, we are going to set up two Litd nodes, each with their own Bitcoin Core backend. One Litd node (Alice) acts as the user; the other (Edgar) acts as the edge node. The edge node is connected to a CLN, Eclair and LND node, representing the broader Lightning Network.

Sample Lightning Network to test edge node configuration.

@@ -40,9 +40,9 @@ We can then go ahead and mint this batch with `tapcli assets mint batches finali Don't forget to mine a few blocks to get the transaction confirmed! -Before we can use this asset to open a channel we will have to sync the asset to Alice' node. The easiest way to do that is to use the Polar UI by "creating an Asset address," then "sync assets from Edgar's node." Don't forget to click on "generate" to make sure the synchronization process is completed. +Before we can use this asset to open a channel, we will have to sync the asset to Alice's node. The easiest way to do that is to use the Polar UI by "creating an Asset address," then "sync assets from Edgar's node." Don't forget to click on "generate" to make sure the synchronization process is completed. -To open Taproot Asset channels we can use the command below. Don't forget to substitute the node key for Alice's key, and the asset ID for the asset you minted above. +To open Taproot Asset channels, we can use the command below. Don't forget to substitute the node key for Alice's key and the asset ID for the asset you minted above. `litcli --macaroonpath ~/.lnd/data/chain/bitcoin/regtest/admin.macaroon ln fundchannel --node_key 03d30bdaa3f44dd0a5ae7ed7cb1ad1c0ddd13b8db979b719cd963b65508815c4f1 --asset_amount 1000000 --asset_id b7e048c449feebb898138f1a7f340cc210ab2a04304b5595f20715a8a6e0ba34 --sat_per_vbyte 10` diff --git a/lightning-network-tools/taproot-assets/universes.md b/lightning-network-tools/taproot-assets/universes.md index 0bfd06e3..22298dfc 100644 --- a/lightning-network-tools/taproot-assets/universes.md +++ b/lightning-network-tools/taproot-assets/universes.md @@ -10,7 +10,7 @@ Anyone may run a universe, or use one or multiple universes provided by others, ## Your local universe -When running `tapd`, you will run a private universe by default. In this mode, all RPC calls to the universe require authentication using the tapd macaroon. To disable macaroon authentication for the `QueryProof and InsertProof` RPC calls, you may set the following configuration flag: +When running `tapd`, you will run a private universe by default. In this mode, all RPC calls to the universe require authentication using the tapd macaroon. To disable macaroon authentication for the `QueryProof` and `InsertProof` RPC calls, you may set the following configuration flag: ``` allow-public-uni-proof-courier=true @@ -76,7 +76,7 @@ You may also make use of the UI available through Lightning Terminal 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`. -If you would like to add a universe to this federation, you can do this on with `tapcli universe federation add --universe_host ` +If you would like to add a universe to this federation, you can do this with `tapcli universe federation add --universe_host ` Similarly, you can remove universes from this federation with `tapcli universe federation del --universe_host :port` @@ -86,7 +86,7 @@ Tapping into Taproot Assets #4: Join a Universe Federation ## Syncing to a universe -By default, your `tapd` will sync to universes which have configured in your local federation, and only for assets which you either hold or have created a taproot address for. You may also manually sync specific asset IDs or group keys. +By default, your `tapd` will sync to universes you have configured in your local federation, and only for assets which you either hold or have created a taproot address for. You may also manually sync specific asset IDs or group keys. `tapcli universe sync --universe_host --group_key ` @@ -98,7 +98,7 @@ To configure your `tapd` to regularly sync to other asset IDs or group keys, you ## The Universe APIs -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) on the default ports. You may run your own universe or interact with a public universe. Public universes are unauthenticated, the macaroon checks are skipped. +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) on the default ports. You may run your own universe or interact with a public universe. Public universes are unauthenticated; the macaroon checks are skipped. For instance, when making a transfer, the [proofs may be pushed](https://lightning.engineering/api-docs/api/taproot-assets/universe/insert-proof) to one or multiple universes using the REST API. This requires the asset ID, the leaf key index and script key.