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

Add ecash section to guide #1093

Merged
merged 191 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
191 commits
Select commit Hold shift + click to select a range
55b8252
Create Ecash section
swedishfrenchpress Apr 7, 2024
8f7514b
Update introduction.md
swedishfrenchpress Apr 21, 2024
0ee3c0e
Updated into + added overview page
swedishfrenchpress May 6, 2024
551d08c
Copy for the Ecash guide.
swedishfrenchpress May 19, 2024
ab1479f
Update ecash.md
swedishfrenchpress May 19, 2024
9223ef6
Update ecash.md
swedishfrenchpress May 19, 2024
5b8e9c5
Updated Content
swedishfrenchpress May 25, 2024
c1aee7b
Updated intro
swedishfrenchpress May 25, 2024
4c9cc97
Updated
swedishfrenchpress May 25, 2024
4a21181
Updated
swedishfrenchpress May 25, 2024
724a970
Updated
swedishfrenchpress May 25, 2024
6c8265a
Update overview.md
swedishfrenchpress May 26, 2024
04a06aa
Update
swedishfrenchpress May 26, 2024
92ac554
Update
swedishfrenchpress May 26, 2024
c08510b
Updated
swedishfrenchpress May 26, 2024
65e6217
Update
swedishfrenchpress May 26, 2024
aa6adfd
Updated
swedishfrenchpress May 26, 2024
351ab4e
Updated
swedishfrenchpress May 27, 2024
7805533
Update
swedishfrenchpress May 27, 2024
30f0a36
updated
swedishfrenchpress May 27, 2024
bf81300
Updated
swedishfrenchpress May 31, 2024
76420ac
update
swedishfrenchpress Jun 1, 2024
099ccfe
update
swedishfrenchpress Jun 1, 2024
2e32a62
update
swedishfrenchpress Jun 1, 2024
da6d144
update
swedishfrenchpress Jun 1, 2024
59b0db3
update
swedishfrenchpress Jun 1, 2024
e7f4c63
update
swedishfrenchpress Jun 1, 2024
33ab3d2
update
swedishfrenchpress Jun 1, 2024
6be0d27
Update
swedishfrenchpress Jun 1, 2024
dbc2778
update
swedishfrenchpress Jun 1, 2024
0d4c870
Update
swedishfrenchpress Jun 1, 2024
34f4d2d
Updated Overview
swedishfrenchpress Jun 1, 2024
6980d54
updated images
swedishfrenchpress Jun 1, 2024
e8bfcfa
update image sizes
swedishfrenchpress Jun 1, 2024
2fe6b91
image updated
swedishfrenchpress Jun 1, 2024
b94b95b
updated
swedishfrenchpress Jun 1, 2024
7afd991
updated icons for table
swedishfrenchpress Jun 2, 2024
f11d57e
Updated table
swedishfrenchpress Jun 2, 2024
84786fb
updated layout
swedishfrenchpress Jun 2, 2024
8cc225e
updated
swedishfrenchpress Jun 2, 2024
fb59860
Update overview.md
swedishfrenchpress Jun 2, 2024
c63ee0a
update images on table
swedishfrenchpress Jun 2, 2024
628a911
table updates
swedishfrenchpress Jun 2, 2024
879ecac
updated table
swedishfrenchpress Jun 2, 2024
6f6145e
update
swedishfrenchpress Jun 2, 2024
d19abfb
update
swedishfrenchpress Jun 2, 2024
513279e
updated
swedishfrenchpress Jun 2, 2024
17a0f9a
Update overview.md
swedishfrenchpress Jun 2, 2024
6a4863a
updated images
swedishfrenchpress Jun 30, 2024
81b9357
updated images
swedishfrenchpress Jun 30, 2024
9a9b432
Updated
swedishfrenchpress Jun 30, 2024
7d0191f
Updated
swedishfrenchpress Jun 30, 2024
747cf4a
updated
swedishfrenchpress Jun 30, 2024
b066672
update
swedishfrenchpress Jun 30, 2024
2ee145e
Update overview.md
swedishfrenchpress Jun 30, 2024
d5a2654
update
swedishfrenchpress Jul 9, 2024
e3fe035
update
swedishfrenchpress Jul 9, 2024
0969f64
Updated overview
swedishfrenchpress Jul 9, 2024
1e514eb
update
swedishfrenchpress Jul 9, 2024
7dc4d67
Update overview.md
swedishfrenchpress Jul 13, 2024
493b1fb
update
swedishfrenchpress Jul 13, 2024
cec311a
updated images
swedishfrenchpress Jul 13, 2024
faa0ec1
updated image
swedishfrenchpress Jul 13, 2024
42bed26
update best practices skelleton
swedishfrenchpress Jul 14, 2024
ede2adc
updated settings.
swedishfrenchpress Jul 14, 2024
3d4220e
update
swedishfrenchpress Jul 14, 2024
9433c70
Update overview.md
swedishfrenchpress Jul 23, 2024
f3c1d99
Update overview.md
swedishfrenchpress Jul 23, 2024
011167f
Cashuuuuuu
swedishfrenchpress Jul 23, 2024
0c9da8f
updated cashu info
swedishfrenchpress Jul 23, 2024
406da46
updated
swedishfrenchpress Jul 23, 2024
2a65eb0
updated
swedishfrenchpress Jul 23, 2024
384451e
update
swedishfrenchpress Jul 23, 2024
fdf5020
Update design-best-practices.md
swedishfrenchpress Jul 23, 2024
2b983d8
Update design-best-practices.md
swedishfrenchpress Jul 23, 2024
1b0ff53
update
swedishfrenchpress Jul 23, 2024
5dd3aaf
Update design-best-practices.md
swedishfrenchpress Jul 23, 2024
7204ea0
Update fedimint.md
swedishfrenchpress Jul 28, 2024
ee1db82
Update design-best-practices.md
swedishfrenchpress Jul 28, 2024
7a73ecc
Update design-best-practices.md
swedishfrenchpress Jul 28, 2024
cba20b2
Update design-best-practices.md
swedishfrenchpress Jul 28, 2024
892bfd4
Update design-best-practices.md
swedishfrenchpress Jul 28, 2024
1651bab
Update design-best-practices.md
swedishfrenchpress Jul 28, 2024
1cb6437
Update guide/how-it-works/ecash/overview.md
swedishfrenchpress Jul 31, 2024
3c42c62
Update guide/how-it-works/ecash/cashu.md
swedishfrenchpress Jul 31, 2024
a9d519d
Update guide/how-it-works/ecash/introduction.md
swedishfrenchpress Jul 31, 2024
cd73ff7
Update guide/how-it-works/ecash/overview.md
swedishfrenchpress Jul 31, 2024
d074872
removed custody spectrum from header on image
swedishfrenchpress Aug 7, 2024
2f03209
Update introduction.md
swedishfrenchpress Aug 7, 2024
79b3ba9
Update guide/how-it-works/ecash/introduction.md
swedishfrenchpress Aug 7, 2024
aa2af41
Update overview.md
swedishfrenchpress Aug 7, 2024
a569783
Update overview.md
swedishfrenchpress Aug 7, 2024
bf4f380
updated
swedishfrenchpress Aug 7, 2024
5449ce2
Update guide/how-it-works/ecash/overview.md
swedishfrenchpress Aug 7, 2024
2ff96a2
updated
swedishfrenchpress Aug 7, 2024
ae87df1
Merge branch 'ecash' of https://github.com/swedishfrenchpress/Guide i…
swedishfrenchpress Aug 7, 2024
74d1ee3
Update overview.md
swedishfrenchpress Aug 7, 2024
a29814b
Update overview.md
swedishfrenchpress Aug 7, 2024
247b017
Update overview.md
swedishfrenchpress Aug 7, 2024
d2ffc46
Update overview.md
swedishfrenchpress Aug 7, 2024
20c837b
Update overview.md
swedishfrenchpress Aug 7, 2024
d12ede2
Update cashu.md
swedishfrenchpress Aug 7, 2024
40b92f7
Update overview.md
swedishfrenchpress Aug 7, 2024
bca36b1
Update introduction.md
swedishfrenchpress Aug 7, 2024
0f9f192
update overview and intro page
swedishfrenchpress Aug 7, 2024
c1abf54
Update introduction.md
swedishfrenchpress Aug 7, 2024
4beeb6c
Update introduction.md
swedishfrenchpress Aug 7, 2024
5bb49df
updated protocol images.
swedishfrenchpress Aug 7, 2024
c70252d
added sending bitcoin image + flow
swedishfrenchpress Aug 7, 2024
c538a05
Update introduction.md
swedishfrenchpress Aug 8, 2024
b4a3342
update images
swedishfrenchpress Aug 8, 2024
c853128
update
swedishfrenchpress Aug 8, 2024
fdfd433
updated
swedishfrenchpress Aug 8, 2024
4c91c4a
update
swedishfrenchpress Aug 8, 2024
97145c2
update
swedishfrenchpress Aug 8, 2024
c0a54ba
Update introduction.md
swedishfrenchpress Aug 8, 2024
9f7be17
Update introduction.md
swedishfrenchpress Aug 8, 2024
9a85365
Update introduction.md
swedishfrenchpress Aug 11, 2024
cde45ad
Update overview.md
swedishfrenchpress Aug 11, 2024
88e30e4
Update overview.md
swedishfrenchpress Aug 11, 2024
f185aef
Link update + overview removal
swedishfrenchpress Aug 16, 2024
b2b840b
Added backup images
swedishfrenchpress Aug 16, 2024
7c14b44
Update cashu.md
swedishfrenchpress Aug 16, 2024
2a02e81
fixed indentation issues
swedishfrenchpress Aug 16, 2024
d8c6ab3
Update cashu.md
swedishfrenchpress Aug 16, 2024
99c3570
Added restore UI images
swedishfrenchpress Aug 16, 2024
a5e8510
Updated design best practices page.
swedishfrenchpress Aug 17, 2024
3a31c9a
Updated Cashu, Best Practices, and Fedimint sections.
swedishfrenchpress Aug 17, 2024
8f09f75
Updated images + info
swedishfrenchpress Aug 17, 2024
24d1b8f
big update!
swedishfrenchpress Aug 17, 2024
eb04ec8
updated
swedishfrenchpress Aug 17, 2024
7426051
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
d5e6b98
update
swedishfrenchpress Aug 17, 2024
3f61855
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
fcde42c
updated
swedishfrenchpress Aug 17, 2024
ca15323
Update
swedishfrenchpress Aug 17, 2024
39a5c55
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
5df1240
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
eea7c56
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
cf69dec
update image
swedishfrenchpress Aug 17, 2024
4282874
updated mint features
swedishfrenchpress Aug 17, 2024
5a0f02b
Update design-best-practices.md
swedishfrenchpress Aug 17, 2024
a25430e
update
swedishfrenchpress Aug 17, 2024
e73ab88
Added P2PK images.
swedishfrenchpress Aug 18, 2024
97adf92
Update design-best-practices.md
swedishfrenchpress Aug 18, 2024
5a0ce12
Updated images
swedishfrenchpress Aug 18, 2024
7749e98
update images
swedishfrenchpress Aug 19, 2024
9d8819c
Updated images
swedishfrenchpress Aug 27, 2024
9b2db69
update
swedishfrenchpress Aug 27, 2024
917d241
Updated section header images for cashu, fedimint, and ecash.
swedishfrenchpress Aug 27, 2024
0ba15f1
updated images
swedishfrenchpress Aug 27, 2024
2d78ef9
Update design-best-practices.md
swedishfrenchpress Aug 27, 2024
2d77631
updated restore images
swedishfrenchpress Aug 27, 2024
8ba623c
Update design-best-practices.md
swedishfrenchpress Aug 27, 2024
43dbf4e
image updates
swedishfrenchpress Aug 27, 2024
af6b58c
Updated best practices, fedimint,
swedishfrenchpress Aug 31, 2024
2d19286
illustration and copy updates.
swedishfrenchpress Aug 31, 2024
7eab60e
It's ready!
swedishfrenchpress Aug 31, 2024
19d6e5f
Update guide/how-it-works/ecash/design-best-practices.md
swedishfrenchpress Sep 1, 2024
141c288
Apply suggestions from thesimplekid's technical review
swedishfrenchpress Sep 1, 2024
400c6e9
Major Update: This update incorporates feedback received during the P…
swedishfrenchpress Sep 8, 2024
975f77d
Updated best practices section
swedishfrenchpress Sep 14, 2024
3d2a761
Updated hero images
swedishfrenchpress Sep 14, 2024
b87a384
Layout, image, and copy updates.
swedishfrenchpress Sep 23, 2024
eacc84d
Update guide/how-it-works/ecash/design-best-practices.md
swedishfrenchpress Sep 24, 2024
0fab1c5
Update guide/how-it-works/ecash/design-best-practices.md
swedishfrenchpress Sep 24, 2024
13561c9
Update guide/how-it-works/ecash/design-best-practices.md
swedishfrenchpress Sep 24, 2024
5cd664a
Apply suggestions from code review
swedishfrenchpress Sep 24, 2024
39571e4
Update design-best-practices.md
swedishfrenchpress Sep 24, 2024
8fccf4b
fixed issue causing checks to fail
swedishfrenchpress Sep 24, 2024
1caa661
Images, copy, formatting updates.
swedishfrenchpress Sep 24, 2024
e1beb47
Gateway best practices update
swedishfrenchpress Sep 24, 2024
fdeb215
Updated Fedimint and design practices sections.
swedishfrenchpress Nov 2, 2024
137c113
Updated design best practices to include user onboarding and joining …
swedishfrenchpress Nov 11, 2024
029a46d
Updated federation images and some design best practices copy.
swedishfrenchpress Nov 11, 2024
fe70768
updated branch to include latest updates from master.
swedishfrenchpress Nov 11, 2024
f225f87
Pushed many updates, added Cashu request, updated cashu mint and fede…
swedishfrenchpress Nov 12, 2024
d58b580
updated cashu image.
swedishfrenchpress Nov 12, 2024
fb414fb
updated cashu image.
swedishfrenchpress Nov 12, 2024
90adae0
updated formating issues on best practices page.
swedishfrenchpress Nov 12, 2024
60fe2b3
Updated Fedimint images, added Athenut to Cashu products, updated som…
swedishfrenchpress Nov 18, 2024
5e03e50
updated ecash guide to address feedback left from rabbitholiness.
swedishfrenchpress Nov 20, 2024
6e31c94
optimized images, updated screens based on feedback, fixed typos, upd…
swedishfrenchpress Nov 29, 2024
e0287e0
updated sentence case issues on cashu.md page.
swedishfrenchpress Nov 29, 2024
6ff9883
Update guide/how-it-works/ecash/design-best-practices.md
swedishfrenchpress Dec 2, 2024
19d92b9
removed many mobile and mobile retina images based on feedabck from @…
swedishfrenchpress Dec 2, 2024
58827fc
removed redirect and image based from cashu.md
swedishfrenchpress Dec 2, 2024
72365f9
Apply suggestions from code review
swedishfrenchpress Dec 2, 2024
b0c8fde
updates.
swedishfrenchpress Dec 2, 2024
6a21fbb
Removed redundat mobile, and mobile retina images from fedimint.md an…
swedishfrenchpress Dec 2, 2024
ba2f380
fixed incorrect capitalization on cashu.md, design-best-practices.md,…
swedishfrenchpress Dec 2, 2024
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
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.
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 assets/images/guide/how-it-works/ecash/cashu.jpg
Binary file added assets/images/guide/how-it-works/ecash/ecash.jpg
Binary file added assets/images/guide/how-it-works/ecash/scan.png
111 changes: 111 additions & 0 deletions guide/how-it-works/ecash/cashu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
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/
image: https://bitcoin.design/assets/images/guide/how-it-works/ecash/cashu_og.jpg
main_classes: -no-top-padding
---

<!--

Editor's notes

An introduction to Cashu.

Illustration sources: https://www.figma.com/community/file/1444347139219091325/bitcoin-design-community-ecash-images

-->

{% 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 = 600
layout = "full-width"
%}

# Cashu
Cashu is an [ecash protocol]({{ '/guide/how-it-works/ecash/introduction/' | relative_url }}) that operates on a model where any user can run their own solo mint, or join existing mints run by others. This makes Cashu an easy to deploy, flexible, and agile approach to managing bitcoin-backed ecash.

## Design best practices
This page is about the unique approach of Cashu to ecash. To learn more about design aspects, check out the [design best practices]({{ '/guide/how-it-works/ecash/design-best-practices' | relative_url }}) page.

## Cashu mints

{% include picture.html
image = "/assets/images/guide/how-it-works/ecash/cashumint.jpg"
retina = "/assets/images/guide/how-it-works/ecash/[email protected]"
mobile = "/assets/images/guide/how-it-works/ecash/cashumint-mobile.jpg"
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 users interacts with a Cashu mint."
modalImage = "/assets/images/guide/how-it-works/ecash/[email protected]"
width = 800
height = 500
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 payments 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. Cashu currently only supports lightning payments, but in the future it will support on-chain payments as well.

#### Pros:

* **Quick and easy setup** - Ideal for those who need a simple, low-cost solution.

* **Cost-effective** - Fewer resources are required, making it an attractive option for smaller operations.

#### Cons:

* **High risk** - With all control in the hands of one operator, the risks of loss or theft are much higher. Additionally, if the server goes offline, users lose access to the mint until it’s restored.

## When to use Cashu

* **Rapid deployment and simple integration** - Great for projects that need to be launched quickly with minimal setup. Cashu has a much smaller codebase and is easier to understand and modify compared to Fedimint.

* **Localized or small community solutions** - Independent mints can be operated by trusted local entities to serve their communities, based on existing trust relationships and customized to local needs.

## Products that use Cashu

### Wallets
- [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/)
- [Nutshell](https://github.com/cashubtc/nutshell)
- [Nutstash](https://nutstash.app/)
- [Sovran](https://sovranbitcoin.com/)

### Services
- [Athenut](https://athenut.com/)
- [npub.cash](https://npub.cash/)
- [Shopstr](https://shopstr.store/)
- [Cashu Decoder](https://nostrapps.github.io/cashu/)

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 Website](https://cashu.space/)
- [Cashu Documentation](https://docs.cashu.space/)
- [Cashu Only Mint List](https://cashumints.space/)
- [Cashu & Fedimint Mint List](https://bitcoinmints.com)

---

Next, learn how [Fedimint]({{ '/guide/how-it-works/ecash/fedimint' | relative_url }}) works.

{% include next-previous.html
previousUrl = "/guide/how-it-works/ecash/introduction/"
previousName = "Introduction"
nextUrl = "/guide/how-it-works/ecash/fedimint/"
nextName = "Fedimint"
%}
Loading