Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 3.73 KB

README.md

File metadata and controls

98 lines (63 loc) · 3.73 KB
Raw

EttaWalletSP: A fork of Etta Wallet designed for Silent Payments

Etta Wallet Preview

Uses Silent-Pay TS module to do SP operations

  • Built with React Native for Android & iOS.
  • Written in Typescript
  • Fully customizable with designed components
  • Built with accessibility in mind ♿️
  • Built-in localization 💬
  • Open source 😸

License

Twitter Github

The project is strongly inspired by Bitcoin Design Community's daily spending wallet and will continue to evolve with their sound suggestions.

Features

  • Bitcoin only wallet
  • Non-custodial

Current Limitations

  • Ships in testnet for now
  • Translations are outdated.
  • Accessibility features are outdated for most components.

Reproducible Build (Don't trust, verify)

Note Please make sure have set up your development environment properly. Here is a good guide

Start by forking the repo from GitHub, clone it locally and install dependencies.

git clone https://github.com/YOUR_GITHUB_USERNAME/EttaWallet
cd EttaWallet
yarn install

Developing

Once you've cloned the repo, installed dependencies, run the following command.

yarn start

Android

  1. Using a physical android phone? Enable Developer mode and USB Debugging, and confirm it is connected by running adb devices. If you want to use an Android simulator, this step isn't necessary
  2. Open a new tab in your terminal and run yarn android

iOS

  1. Open a new tab in your terminal
  2. cd ios && pod install. For M1, you might have to do arch -x86_64 pod install
  3. cd .. && yarn ios.

Contributing

EttaWallet is an open-source project so anybody can use and contribute to it. You also don't necessarily need to know how to code. Some meaningful contributions include:

  • Sharing ideas and suggestions
  • Improving documentation
  • Sharing well-written bug reports
  • Improving the translation scope.
  • Requesting new features.

You can start in the discussion forum here.

If you would like to contribute code, here a few guidelines:

  • It would be helpful to create an issue first before submitting a PR just to make sure nobody isn't working on the same yet or it just wouldn't be a good fit.
  • Even if your changes are obvious, your PR should define what you are changing. Nothing is too obvious.
  • PRs should be opened against the next branch.

Branches

silentpayment - The branch to submit pull requests against.

License

EttaWalletSP is 100% open-source and available under the MIT license.

Attribution

Special thanks to the following open-source projects that help make EttaWallet possible.