-
Notifications
You must be signed in to change notification settings - Fork 96
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 ecash section to guide #1093
base: master
Are you sure you want to change the base?
Changes from 160 commits
55b8252
8f7514b
0ee3c0e
551d08c
ab1479f
9223ef6
5b8e9c5
c1aee7b
4c9cc97
4a21181
724a970
6c8265a
04a06aa
92ac554
c08510b
65e6217
aa6adfd
351ab4e
7805533
30f0a36
bf81300
76420ac
099ccfe
2e32a62
da6d144
59b0db3
e7f4c63
33ab3d2
6be0d27
dbc2778
0d4c870
34f4d2d
6980d54
e8bfcfa
2fe6b91
b94b95b
7afd991
f11d57e
84786fb
8cc225e
fb59860
c63ee0a
628a911
879ecac
6f6145e
d19abfb
513279e
17a0f9a
6a4863a
81b9357
9a9b432
7d0191f
747cf4a
b066672
2ee145e
d5a2654
e3fe035
0969f64
1e514eb
7dc4d67
493b1fb
cec311a
faa0ec1
42bed26
ede2adc
3d4220e
9433c70
f3c1d99
011167f
0c9da8f
406da46
2a65eb0
384451e
fdf5020
2b983d8
1b0ff53
5dd3aaf
7204ea0
ee1db82
7a73ecc
cba20b2
892bfd4
1651bab
1cb6437
3c42c62
a9d519d
cd73ff7
d074872
2f03209
79b3ba9
aa2af41
a569783
bf4f380
5449ce2
2ff96a2
ae87df1
74d1ee3
a29814b
247b017
d2ffc46
20c837b
d12ede2
40b92f7
bca36b1
0f9f192
c1abf54
4beeb6c
5bb49df
c70252d
c538a05
b4a3342
c853128
fdfd433
4c91c4a
97145c2
c0a54ba
9f7be17
9a85365
cde45ad
88e30e4
f185aef
b2b840b
7c14b44
2a02e81
d8c6ab3
99c3570
a5e8510
3a31c9a
8f09f75
24d1b8f
eb04ec8
7426051
d5e6b98
3f61855
fcde42c
ca15323
39a5c55
5df1240
eea7c56
cf69dec
4282874
5a0f02b
a25430e
e73ab88
97adf92
5a0ce12
7749e98
9d8819c
9b2db69
917d241
0ba15f1
2d78ef9
2d77631
8ba623c
43dbf4e
af6b58c
2d19286
7eab60e
19d6e5f
141c288
400c6e9
975f77d
3d2a761
b87a384
eacc84d
0fab1c5
13561c9
5cd664a
39571e4
8fccf4b
1caa661
e1beb47
fdeb215
137c113
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
--- | ||
layout: guide | ||
title: Cashu | ||
description: Learn the basics of Cashu. | ||
nav_order: 2 | ||
parent: Ecash | ||
grand_parent: How it works | ||
permalink: /guide/how-it-works/ecash/cashu/ | ||
redirect_from: | ||
- /guide/ecash/cashu | ||
image: https://bitcoin.design/assets/images/guide/how-it-works/ecash/cashu.jpg | ||
main_classes: -no-top-padding | ||
image_base: /assets/images/guide/how-it-works/ecash/ | ||
images_backup: | ||
- file: manual-backup-recovery-phrase-intro | ||
modalImage: manual-backup-recovery-phrase-intro-full | ||
alt: TBD | ||
caption: TBD | ||
- file: manual-backup-recovery-phrase | ||
modalImage: manual-backup-recovery-phrase-full | ||
alt: TBD | ||
caption: TBD | ||
- file: manual-backup-mint-intro | ||
modalImage: manual-backup-mint-intro-full | ||
alt: TBD | ||
caption: TBD | ||
- file: manual-backup-mint-back-up | ||
modalImage: manual-backup-mint-back-up-full | ||
alt: TBD | ||
caption: TBD | ||
images_restore: | ||
- file: restore-start | ||
modalImage: restore-start-full | ||
alt: TBD | ||
caption: TBD | ||
- file: restore-manual-recovery-phrase-complete | ||
modalImage: restore-manual-recovery-phrase-complete-full | ||
alt: TBD | ||
caption: TBD | ||
- file: restore-mints | ||
modalImage: restore-mints-full | ||
alt: TBD | ||
caption: TBD | ||
- file: restore-mint-info | ||
modalImage: restore-mint-info-full | ||
alt: TBD | ||
caption: TBD | ||
--- | ||
|
||
<!-- | ||
|
||
Editor's notes | ||
|
||
Explains generally how Cashu works. | ||
|
||
Illustration sources | ||
|
||
--> | ||
|
||
{% include picture.html | ||
image = "/assets/images/guide/how-it-works/ecash/cashu.jpg" | ||
retina = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
mobile = "/assets/images/guide/how-it-works/ecash/cashu-mobile.jpg" | ||
mobileRetina = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
alt-text = "ecash overview illustration" | ||
width = 1600 | ||
height = 700 | ||
layout = "full-width" | ||
%} | ||
|
||
# Cashu | ||
Cashu is an ecash protocol on that interoperates with the Lightning Network. Unlike Fedimint, which uses a federated model to distribute trust among multiple entities, Cashu operates with independent mints. This makes Cashu distinct in providing an easy to deploy, flexible, and agile approach to managing bitcoin backed ecash. | ||
|
||
## Design best practices | ||
To learn more about Cashu specific design best practices you can check out the [Design best practices]({{ '/guide/how-it-works/ecash/design-best-practices' | relative_url }}) section. | ||
swedishfrenchpress marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Cashu Mints | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment I left elsewhere. I think it would be good to just have a sentence about what is going to be discussed in this paragraph before throwing people right into a complex-looking illustration. What about "Cashu mints" is being discussed here? Are we starting from scratch or just looking at differences from the basics explained in the intro page? |
||
|
||
{% include picture.html | ||
image = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
retina = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
mobile = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
mobileRetina = "/assets/images/guide/how-it-works/ecash/[email protected]" | ||
alt-text = "An illustration of how users, ecash, and a Cashu mint interact." | ||
caption = "How a Cashu mint interacts with users." | ||
width = 800 | ||
height = 456 | ||
layout = "full-width" | ||
%} | ||
|
||
A Cashu mint operates simply and centrally. One entity (the mint) handles the entire process: issuing bitcoin backed ecash tokens when users deposit bitcoin and redeeming them when users request withdrawals. This centralized model enables fast transactions but requires trust in the mint’s integrity and security. Cashu’s design prioritizes simplicity and speed, relying on a single operator to manage all operations. | ||
|
||
## When to Use Cashu | ||
|
||
* **Rapid Deployment and Simple Integration** - Great for projects that need to be launched quickly with minimal setup. This includes community-based applications where speed and ease of deployment are crucial. | ||
|
||
* **Quick Interoperability with the Lightning Network** - Ideal when you need to integrate with the Lightning Network for fast, low-fee transactions. Cashu supports seamless, out of the box integration with the Lightning Network. | ||
|
||
* **Localized or Small Community Solutions** - In scenarios where independent mints operated by trusted local entities can serve a community, enhancing trust and customization based on local needs. | ||
|
||
## Products that use Cashu | ||
- [Boardwalk Cash](https://boardwalkcash.com/) | ||
- [Cashu.me](https://wallet.cashu.me/) | ||
- [eNuts](https://www.enuts.cash/) | ||
- [Macadamia](https://macadamia.cash/) | ||
- [Minibits](https://www.minibits.cash/) | ||
- [npub.cash](https://npub.cash/) | ||
- [Nutshell](https://github.com/cashubtc/nutshell) | ||
- [Nutstash](https://nutstash.app/) | ||
|
||
For a comprehensive list of products and services that use Cashu visit [Awesome Cashu](https://github.com/cashubtc/awesome-cashu). | ||
|
||
|
||
## Cashu resources | ||
Cashu Documentation - Access the official Cashu documentation for detailed information on setup, usage, and integration. | ||
- [Cashu Resources](https://cashu.space/) | ||
- [Cashu Documentation](https://docs.cashu.space/) | ||
|
||
--- | ||
|
||
Next, we do a technical deep dive into how [Fedimint]({{ '/guide/how-it-works/ecash/fedimint' | relative_url }}) works. | ||
|
||
{% include next-previous.html | ||
previousUrl = "/guide/how-it-works/ecash/overview/" | ||
previousName = "Overview" | ||
nextUrl = "/guide/how-it-works/ecash/fedimint/" | ||
nextName = "Fedimint" | ||
%} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text uses the term 'melting' but this illustration uses 'burning'. If they are the same, do replace the term. Also for the 2x image