Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/edgeware-builders/edgeware-wallet

A Simple Wallet Application for Edgeware
https://github.com/edgeware-builders/edgeware-wallet

edgeware ffi flutter rust substrate wallet

Last synced: about 1 month ago
JSON representation

A Simple Wallet Application for Edgeware

Host: GitHub
URL: https://github.com/edgeware-builders/edgeware-wallet
Owner: edgeware-builders
License: gpl-3.0
Created: 2020-11-12T15:49:20.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2020-12-15T07:08:11.000Z (about 4 years ago)
Last Synced: 2024-08-04T05:01:33.587Z (5 months ago)
Topics: edgeware, ffi, flutter, rust, substrate, wallet
Language: Dart
Homepage: https://edgewa.re/
Size: 668 KB
Stars: 9
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-edgeware - Edgeware Wallet(beta)

README

# Edgeware Wallet

_{⚠ Still Under Constructions ⚠.}

This project uses [cargo make](https://github.com/sagiegurari/cargo-make) to combine the build commands for compiling the Rust `edgeware-wallet` module and linking it to the Flutter interface. This structure will eventually enable our substrate RPC client to talk directly to the Flutter interface (with no dependency on polkadot.js).

[`shekohex/flutterust`](https://github.com/shekohex/flutterust) is a generic template for Rust to Dart FFI.

![Lints](https://github.com/shekohex/edgeware-wallet/workflows/Lints/badge.svg)
![Android](https://github.com/shekohex/edgeware-wallet/workflows/Android/badge.svg)
![iOS](https://github.com/shekohex/edgeware-wallet/workflows/iOS/badge.svg)

## Features

- [x] Generate a new Edgeware Account.
- [x] Backup/Restore your account using `Paper Key` (Seed Phrase).
- [x] Transfer `EDG` to your contacts (Tested on Edgeware testnet).
- [x] Keep track of your contacts (view balances, share contacts).
- [x] Share your account using QR Code and add contacts by scanning the QR Code.
- [x] Biometric Authorization when sending tokens instead of using passwords (Face ID, Touch ID, Fingerprint, ..etc).

> Need to see a new feature? Open a new issue with `Feature Request` label :)

## Download

You can get the APK (For Android) from [releases](https://github.com/shekohex/edgeware-wallet/releases) you will find two variants one for (ARM64, real devices) and the other one for (x86_64, emulators).
If you don't have a recent Android device (Android 7+) you could download the (x86_64) APK and "Drag & Drop" it on an Emulator.

For iOS, well .. you can't just install anything (IPA) on Real device, you will have to compile and test the code on the iOS Simulator.

## Build Instructions

1. **[Install Flutter](https://flutter.dev/docs/get-started/install)**.

It is common for developers to get stuck setting the path to the Dart and Flutter SDKs after installation so take careful note of where these are installed. See the Dart docs: [Configure PATH and environment variables](https://dartcode.org/docs/configuring-path-and-environment-variables/) for more info.

2. Run `flutter doctor` to verify that you have everything needed to build and run a flutter application.

You probably won't have a connected device and that's OK, you can pick your emulator in step (5) below.

3. Install Cargo Make, and CBindgen (skip if you already have them installed)

```
$ cargo install cargo-make cbindgen
```

4. Clone this repository.

### Android

_These instructions assume that you have installed Android Studio or the flutter plugins for Android Studio._

5. [Open the Android emulator](https://developer.android.com/studio/run/emulator).

6. Run the following commands in the root of the cloned repository.

```
$ rustup target add aarch64-linux-android x86_64-linux-android
$ cargo make android-dev # for android only using x86_64 emulator (run cargo make android to build for all android targets)
$ flutter run
```

### iOS

_These instructions assume that you may NOT have installed Android Studio nor the flutter plugins for Android Studio._

5. [Open the iOS emulator](https://stackoverflow.com/questions/10379622/how-to-run-iphone-emulator-without-starting-xcode). This could be as simple as invoking the following command if you've set this alias before.

```
$ open -a simulator
```

You may have to specify File -> Open Device -> `$MODEL` once the simulator opens.

6. In the root of the cloned repo, run the following commands.

```
$ rustup target add aarch64-apple-ios x86_64-apple-ios
$ cargo make ios --profile release # Release Build is Required since debug build is very big.
$ flutter run
```

## FAQ

1. How do I create an account?

When you open the application for the first time, the application will try to find if you already got an account on your device.
if there is no account, it will ask you if you want to "Generate account" or "Recover my account".
Click on "Generate account" and follow the steps (it is only one step, really that easy!).

2. How do I get free EDG for testing?

assuming the app built against the `testnet` (beresheet1.edgewa.re) you can use this [tool](https://beresheet-faucet.vercel.app/) to `mint` your account with a free balance.
Go to your account (Click on the little icon on the top left corner) and go to `My Information` and you will see your address there (Long press to copy it).
after adding tokens (EDG) to your account, close the information screen and open it again, or simply close the app and open it again.

## Safety

This crate uses `#![deny(unsafe_code)]` to ensure everything is implemented in
100% Safe Rust, although there are some places where FFI is used, this lint is disabled.

## License

^{Licensed under GPL v3.0 license.}

_{Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in this crate by you, as defined in the GPL-3.0 license, shall

be licensed as above, without any additional terms or conditions.}