Skip to content
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

Adds new page about human readable addresses #1082

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions _sass/minima/_article.scss
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,16 @@ article.guide {
}
}

span {
&.-blue {
color: $blue;
}

&.-green {
color: $green;
}
}

> iframe {
display: block;
}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .../human-readable-addresses/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
283 changes: 283 additions & 0 deletions guide/how-it-works/human-readable-addresses.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion guide/how-it-works/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Learn about how nodes help keep bitcoin decentralized and enforce its rules.

### [Payment request formats]({{ '/guide/how-it-works/payment-request-formats/' | relative_url }})

Learn about the different types of payment request formats, from a standard on-chain address to a lightning address, that exist in bitcoin.
Learn about the different formats for payment information that exist in bitcoin, from standard on-chain to lightning, and [human readable addresses]({{ '/guide/how-it-works/human-readable-addresses/' | relative_url }}).

---

Expand Down
11 changes: 6 additions & 5 deletions guide/how-it-works/payment-request-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Payment request formats
description: An introduction to the different bitcoin payment request formats.
nav_order: 6
parent: How it works
has_children: true
permalink: /guide/how-it-works/payment-request-formats/
redirect_from:
- /guide/payments/send/payment-request-formats/
Expand Down Expand Up @@ -138,7 +139,7 @@ LNURL-Pay allows senders to dynamically request an invoice from the receiver to

##### Lightning address

[Lightning addresses](https://lightningaddress.com) build on top of LNURL-Pay and give users a more human-readable payment address. They use the very familiar email format ([email protected]) to request payments.
[Lightning addresses](https://lightningaddress.com) build on top of LNURL-Pay and give users a more [human readable payment address]({{ '/guide/how-it-works/human-readable-addresses/' | relative_url }}). They use the very familiar email format ([email protected]_) to request payments.

##### Withdraw

Expand Down Expand Up @@ -235,7 +236,7 @@ Payment codes have been popularised in wallets such as [Samourai](https://samour

A downside to payment codes is that they require an additional on-chain transaction each time two users want to connect and use them. [Silent payments](https://gist.github.com/RubenSomsen/c43b79517e7cb701ebf77eec6dbb46b8?permalink_comment_id=4113680) are a new experimental proposal that prevents the need for this additional on-chain transaction at the cost of extra bandwidth for receivers.

Some wallets use what is called a [PayNym](https://paynym.is/) to abstract payment codes into more human readable payment request formats. However, this is not standardized, directories are not open-source, and currently Samourai is the only operator running a directory.
Static payment codes are great for use with [DNS-based human readable addresses]({{ '/guide/how-it-works/human-readable-addresses/#dns-payment-instructions' | relative_url }}).

</div>

Expand All @@ -262,11 +263,11 @@ You can learn more about unified payment requests [here](https://bitcoinqr.dev/)

---

Next, we will learn about the different [private key schemes]({{ '/guide/how-it-works/private-key-management/introduction/' | relative_url }}) used to secure your bitcoin.
As you noticed, these formats are impossible to memorize and pronounce. That is what [human readable addresses]({{ '/guide/how-it-works/human-readable-addresses/' | relative_url }}) aim to solve.

{% include next-previous.html
previousUrl = "/guide/how-it-works/nodes/"
previousName = "Nodes"
nextUrl = "/guide/how-it-works/private-key-management/introduction/"
nextName = "Private key management"
nextUrl = "/guide/how-it-works/human-readable-addresses/"
nextName = "Human readable addresses"
%}