Skip to content

Commit 49067d4

Browse files
Leo Weesegitbook-bot
Leo Weese
authored andcommitted
GITBOOK-320: Taproot Assets
1 parent b1896ac commit 49067d4

File tree

25 files changed

+647
-546
lines changed

25 files changed

+647
-546
lines changed

Diff for: .gitbook/assets/taproot-asset tree.png

165 KB
Loading

Diff for: .gitbook/assets/taproot-asset.png

165 KB
Loading

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Loop is a service that makes it easier to send and receive funds on Lightning, s
3939

4040
Pool is a non-custodial marketplace where users can buy inbound liquidity from node operators. Read our guides on how to join Pool as either a buyer or seller.
4141

42-
{% content-ref url="the-lightning-network/taro/" %}
43-
[taro](the-lightning-network/taro/)
42+
{% content-ref url="the-lightning-network/taproot-assets/" %}
43+
[taproot-assets](the-lightning-network/taproot-assets/)
4444
{% endcontent-ref %}
4545

4646
Taro is a Taproot-powered protocol for issuing assets on the bitcoin blockchain that can be transferred over the Lightning Network for instant, high volume, low fee transactions.

Diff for: SUMMARY.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@
3535
* [Aperture](the-lightning-network/l402/aperture.md)
3636
* [📋 Protocol Specification](the-lightning-network/l402/protocol-specification.md)
3737
* [Implementations and Links](the-lightning-network/l402/implementations-and-links.md)
38-
* [Taro](the-lightning-network/taro/README.md)
39-
* [Taro Protocol](the-lightning-network/taro/taro-protocol.md)
40-
* [Taro on Lightning](the-lightning-network/taro/taro-on-lightning.md)
41-
* [FAQ](the-lightning-network/taro/faq.md)
38+
* [Taproot Assets](the-lightning-network/taproot-assets/README.md)
39+
* [Taproot Assets Protocol](the-lightning-network/taproot-assets/taproot-assets-protocol.md)
40+
* [Taproot Assets on Lightning](the-lightning-network/taproot-assets/taproot-assets-on-lightning.md)
41+
* [FAQ](the-lightning-network/taproot-assets/faq.md)
4242

4343
## Lightning Network Tools
4444

@@ -119,9 +119,9 @@
119119
* [Account Recovery](lightning-network-tools/pool/account\_recovery.md)
120120
* [gRPC API](lightning-network-tools/pool/grpc-api.md)
121121
* [FAQs](lightning-network-tools/pool/faq.md)
122-
* [Taro](lightning-network-tools/taro/README.md)
123-
* [Get Started](lightning-network-tools/taro/get-taro.md)
124-
* [First Steps](lightning-network-tools/taro/first-steps.md)
122+
* [Taproot Assets](lightning-network-tools/taproot-assets/README.md)
123+
* [Get Started](lightning-network-tools/taproot-assets/get-taro.md)
124+
* [First Steps](lightning-network-tools/taproot-assets/first-steps.md)
125125
* [Faraday](lightning-network-tools/faraday/README.md)
126126
* [🛠 Get Started](lightning-network-tools/faraday/get-started.md)
127127
* [The Faraday CLI](lightning-network-tools/faraday/the-faraday-cli.md)

Diff for: community-resources/glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ Taproot is a bitcoin transaction type introduced in November 2021 that allows fo
598598

599599
Taro is a protocol for issuing assets on Bitcoin. It uses [Merkle Sum trees](glossary.md#docs-internal-guid-da9e136d-7fff-c284-15eb-82132eee8d94) and [Sparse Merkle trees](glossary.md#docs-internal-guid-3885545f-7fff-a51b-405a-54b62b6131d5) to commit assets to the Bitcoin Blockchain. Taro assets can be committed to [Lightning channels](glossary.md#channel) to instant transfers.
600600

601-
[Read more: Understanding Taro](../the-lightning-network/taro/)
601+
[Read more: Understanding Taro](../the-lightning-network/taproot-assets/)
602602

603603
## Time Lock Delta
604604

Diff for: lightning-network-tools/taproot-assets/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Learn how to install Taproot Assets, mint and transfer assets.
3+
---
4+
5+
# Taproot Assets
6+
7+
The Taproot Assets Daemon `tapd` implements the [Taproot Assets protocol](../../the-lightning-network/taproot-assets/taproot-assets-protocol.md) (formerly Taro) for issuing assets on the Bitcoin blockchain. Taproot Assets leverages Taproot transactions to commit to newly created assets and their transfers in an efficient and scalable manner. Multiple assets can be created and transferred in a single bitcoin UTXO, while witness data is transacted and kept off-chain.
8+
9+
{% content-ref url="get-taro.md" %}
10+
[get-taro.md](get-taro.md)
11+
{% endcontent-ref %}
12+
13+
{% content-ref url="first-steps.md" %}
14+
[first-steps.md](first-steps.md)
15+
{% endcontent-ref %}

Diff for: lightning-network-tools/taproot-assets/first-steps.md

+332
Large diffs are not rendered by default.

Diff for: lightning-network-tools/taproot-assets/get-taro.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
description: >-
3+
The Taproot Assets Daemon tapd implements the Taproot Assets Protocol for
4+
issuing assets on the Bitcoin blockchain.
5+
---
6+
7+
# Get Started
8+
9+
## #Craeful <a href="#docs-internal-guid-f9af6317-7fff-eeb2-2957-b358d3da86da" id="docs-internal-guid-f9af6317-7fff-eeb2-2957-b358d3da86da"></a>
10+
11+
Taproot Assets is alpha software. It is configured to run on regtest, testnet3 and simnet only, where it’s okay if bitcoin or Taproot Assets are irrevocably lost.
12+
13+
## Prerequisites <a href="#docs-internal-guid-29b5ec39-7fff-4a26-d7e9-dfa1d01ff2c6" id="docs-internal-guid-29b5ec39-7fff-4a26-d7e9-dfa1d01ff2c6"></a>
14+
15+
Taproot Assets requires [LND](https://github.com/lightningnetwork/lnd/) v0.16.2. If [compiled from source](../lnd/run-lnd.md#docs-internal-guid-8ffda72d-7fff-a07e-3bb8-93cdf01b5103), it needs to be built with `tags=signrpc walletrpc chainrpc invoicesrpc`. LND needs to be synced and running on the same bitcoin network as you are doing your testing. RPC connections need to be accepted and Macaroons need to be set. [Learn how to set up LND using the default configuration here](../lnd/run-lnd.md).
16+
17+
## Installation: <a href="#docs-internal-guid-0652b60a-7fff-d0e5-15fc-159e8557bc88" id="docs-internal-guid-0652b60a-7fff-d0e5-15fc-159e8557bc88"></a>
18+
19+
### From source: <a href="#docs-internal-guid-5879af55-7fff-021d-8347-7ef95cd98105" id="docs-internal-guid-5879af55-7fff-021d-8347-7ef95cd98105"></a>
20+
21+
Compile Taproot Assets from source by cloning the taproot-assets repository. [Go version 1.18](https://go.dev/dl/) or higher is required (you may check what version of go is running with go version).
22+
23+
`git clone https://github.com/lightninglabs/taproot-assets.git`\
24+
`cd taproot-assets`\
25+
`make install`
26+
27+
## Configuration: <a href="#docs-internal-guid-8aa3849c-7fff-4b8e-530a-a563b8d9d0b8" id="docs-internal-guid-8aa3849c-7fff-4b8e-530a-a563b8d9d0b8"></a>
28+
29+
Optionally, create a Taproot Assets configuration file under `~/.taproot-assets/tap.conf` on Linux or BSD, `~/Library/Application Support/Taproot-assets/tap.conf` in Mac OS or `$LOCALAPPDATA/Taproot-assets/tap.conf` in Windows.
30+
31+
Within the `tap.conf` file you can permanently set your variables, such as directory, macaroon or other paths and how to connect to your LND.
32+
33+
## Running tapd: <a href="#docs-internal-guid-ebf73e49-7fff-b5ed-44ff-b9b0953c6082" id="docs-internal-guid-ebf73e49-7fff-b5ed-44ff-b9b0953c6082"></a>
34+
35+
Run Taproot Assets with the command `tapd`. Specify how Taproot Assets can reach LND and what bitcoin network to run Taproot Assets with by passing it additional flags.
36+
37+
`tapd –network=testnet –debuglevel=debug —lnd.host=localhost:10009 --lnd.macaroonpath=/.lnd/data/chain/bitcoin/testnet/admin.macaroon --lnd.tlspath=/.lnd/tls.cert --tapdir=~/.taprooot-assets --rpclisten=127.0.0.1:10029 --restlisten=127.0.0.1:8089`
38+
39+
You may run multiple tapd instances on the same machine, but you will also have to set up multiple LND instances. [Refer to this guide](../lnd/run-lnd.md) for how to set up multiple LND instances with a single Bitcoin backend using `rpcpolling`. When running multiple `tapd` instances on one machine, don’t forget to set an alternate Taproot Assets directory and API endpoints and specify these when calling `tapcli` as well.
40+
41+
You can make use of `tapcli profiles` to make calls to separate `tapd` instances on the same machine.
42+

Diff for: lightning-network-tools/taro/README.md

-19
This file was deleted.

0 commit comments

Comments
 (0)