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

Update README.md #73

Merged
merged 2 commits into from
Jun 19, 2023
Merged
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
49 changes: 24 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<p>
<img src="https://i.imgur.com/EI7Uvg1.jpeg">
</p>
<h2>A Cashu wallet for Android and iOS</h2>
<h1>A Cashu wallet for Android and iOS</h1>
<div style="display: flex; align-items: center; justify-content: center">

[![codecov](https://codecov.io/gh/cashubtc/eNuts/branch/main/graph/badge.svg?token=MGBC95KGHQ)](https://codecov.io/gh/cashubtc/eNuts)
Expand All @@ -13,7 +13,7 @@
</div>

<!-- <a href="cashu://cashuAeyJ0b2tlbiI6W3sicHJvb2ZzIjpbeyJpZCI6InVUWTFBTE5ZZmQ2ZyIsImFtb3VudCI6MSwic2VjcmV0IjoiRnRIL2EvWUppMGtPVHAvL2R0UkxHcFk2Mjl1VzcxNHBQZE1YZmJTRTFmQT0iLCJDIjoiMDJhZTg2ZWZjODk1OWZiYmU2MzUyM2NiMGVjMDY2MDMzOGNiZjAwNDUxZmFhNTYyNDQ2NGYxNDQ0Zjc4ODhiMDFhIn0seyJpZCI6InVUWTFBTE5ZZmQ2ZyIsImFtb3VudCI6NCwic2VjcmV0IjoiS3lJTDRrOWtNZkhrMjdQeER4MGFBV3E0Qk9RMWZUYzc3RmRjdG1sZVNFRT0iLCJDIjoiMDNiYWNjMjU3ZDFlYmRlNWQ0OThiOTQxNzZkZTFlNmEyYWM5Y2I0Njg4MjYwZDJkMjE1NzU3NWFkYTM1ODFmMjQyIn0seyJpZCI6InVUWTFBTE5ZZmQ2ZyIsImFtb3VudCI6NjQsInNlY3JldCI6IjZoYmptak1ZT01LMVpaS0pmek1LR0NjeXM3TEpUeE9MQ3p2VmJSZ1dqZ289IiwiQyI6IjAyODkwMTk5ODIyOTY4YzM1NWZlZDgzOTBkMDQxOWU2MjY3MjBlNWQ1NjQzMzNjYzRlOGQyOWM2NzdjZDA1MGM1NSJ9XSwibWludCI6Imh0dHBzOi8vdGVzdG51dC5jYXNodS5zcGFjZSJ9XX0"> token</a> -->
eNuts is a strongly typed mobile Cashu wallet that has Lightning support and can connect to multiple mints. This project uses the [**cashu-ts**](https://github.com/cashubtc/cashu-ts) library and manages proofs locally using SQLite. We aim to provide a great user experience by implementing features that make the usage of Ecash easier and safer at the same time. This project is in early stage and is not suitable for usage yet.
eNuts is a strongly typed mobile [**Cashu**](https://github.com/cashubtc) wallet that has Lightning support and can connect to multiple mints. This project uses the [**cashu-ts**](https://github.com/cashubtc/cashu-ts) library and manages proofs using SQLite. We aim to provide a great user experience by implementing features that make the usage of Ecash easier and safer at the same time. This project is in early stage and we strongly encourage you to exercise caution and only use it for **experimental** or **educational** purposes. Read more about Cashu at [https://docs.cashu.space/](https://docs.cashu.space/)

## 🐿️ Join the research and development groups

Expand All @@ -36,21 +36,21 @@ eNuts is a strongly typed mobile Cashu wallet that has Lightning support and can

## ⚠️ Disclaimer

**The author is NOT a cryptographer and this work has not been reviewed. This means that there is very likely a fatal flaw somewhere. [Cashu](https://github.com/cashubtc) is still experimental.**
**The author is NOT a cryptographer and this work has not been reviewed. This means that there is very likely a fatal flaw somewhere. Cashu is still experimental.**

Please be aware that there may be bugs, errors, and incomplete features that could cause unexpected behavior or loss of data. We do not assume any liability for any issues that may arise from using this project. We strongly encourage users to exercise caution and only use this project for **experimental** or **educational** purposes.
Please be aware that there may be bugs, errors, and incomplete features that could cause unexpected behavior or loss of data. We do not assume any liability for any issues that may arise from using this project.

The entire db (database) layer of this system has not fully undergone thorough testing. This means that the functionality and performance of this particular layer have not been verified, and there may be unforeseen issues or bugs present.

The untested db layer poses potential risks and uncertainties, including but not limited to:

- **Data integrity**
- **Data integrity**
There is a possibility of data corruption, loss, or inconsistency due to unverified interactions with the db layer.
- **Performance issues**
- **Performance issues**
The untested db layer might have suboptimal performance characteristics, such as slow query execution or inefficient resource utilization.
- **Compatibility problems**
- **Compatibility problems**
Interoperability issues might arise when integrating with other components or services that rely on the db layer.
- **Security vulnerabilities**
- **Security vulnerabilities**
The untested db layer might contain security weaknesses, exposing sensitive information or allowing unauthorized access.

Remember that the use of this untested db layer is entirely at your discretion, and the developers, contributors, or maintainers of this software cannot be held liable for any damages, losses, or adverse effects arising from its usage. If you choose to proceed with the untested db layer, exercise extreme caution and consider seeking expert advice or assistance to mitigate potential risks effectively.
Expand All @@ -59,20 +59,20 @@ Please note that this disclaimer should be taken seriously and should not be ign

We appreciate your interest in this project and will continue to work on improving it. Thank you for your understanding.

## 🥜 Implemented [NUTs](https://github.com/cashubtc/nuts)
## 🥜 Implemented NUTs

The NUT documents (Notation, Usage and Terminology) each specify parts of the Cashu protocol.
The NUT documents (**N**otation, **U**sage and **T**erminology) each specify parts of the Cashu protocol.

- [ ] NUT-00
- [ ] NUT-01
- [ ] NUT-02
- [ ] NUT-03
- [ ] NUT-04
- [ ] NUT-05
- [ ] NUT-06
- [ ] NUT-07
- [ ] NUT-08
- [ ] NUT-09
- [ ] [NUT-00](https://github.com/cashubtc/nuts/blob/main/00.md)
- [ ] [NUT-01](https://github.com/cashubtc/nuts/blob/main/01.md)
- [ ] [NUT-02](https://github.com/cashubtc/nuts/blob/main/02.md)
- [ ] [NUT-03](https://github.com/cashubtc/nuts/blob/main/03.md)
- [ ] [NUT-04](https://github.com/cashubtc/nuts/blob/main/04.md)
- [ ] [NUT-05](https://github.com/cashubtc/nuts/blob/main/05.md)
- [ ] [NUT-06](https://github.com/cashubtc/nuts/blob/main/06.md)
- [ ] [NUT-07](https://github.com/cashubtc/nuts/blob/main/07.md)
- [ ] [NUT-08](https://github.com/cashubtc/nuts/blob/main/08.md)
- [ ] [NUT-09](https://github.com/cashubtc/nuts/blob/main/09.md)

## 📋 Requirements

Expand All @@ -85,11 +85,11 @@ The main purpose of this repository is to continue evolving and pushing the adop

There are ways you can contribute without writing a single line of code. Here are a few things you can do to help out:

- **Replying and handling open issues**
- **Replying and handling open issues**
Some issues may lack necessary information. You can help out by guiding people through the process of filling out the issue template, asking for clarifying information, or pointing them to existing issues that match their description of the problem.
- **Reviewing pull requests for the docs**
- **Reviewing pull requests for the docs**
Reviewing Pull requests that contains documentation updates (marked with a documentation label) can be as simple as checking for spelling and grammar. If you encounter situations that can be explained better in the docs, just write a comment or edit the file right away to get started with your own contribution.
- **Providing translations**
- **Providing translations**
We will implement translations ASAP and provide a clear contribution guide to how you can help translating the application.

Each of these tasks is highly impactful, and maintainers will greatly appreciate your help.
Expand Down Expand Up @@ -118,8 +118,7 @@ If all goes well, your pull request will be merged. If it is not merged, maintai
2. Navigate inside the repository and run `npm i`
3. Start the Expo dev server by running `npm run start`
4. Download the [Expo Go](https://expo.dev/client) app.
5. Scan the QR code provided by your terminal using the app (iOS
users will have to use the Camera app).
5. Scan the QR code provided by your terminal using the app (iOS users will have to use the Camera app).
6. A browser tab will be opened. Press the "Expo Go" button in the bottom of the page.
7. eNuts will be bundled up and run on your device.

Expand Down