Skip to content

Commit 7b4322e

Browse files
FatunitoFatunito
committed
Commit
1 parent 126ac47 commit 7b4322e

File tree

1 file changed

+70
-81
lines changed

1 file changed

+70
-81
lines changed

‎README.md‎

Lines changed: 70 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,113 @@
1-
# Flutter Bitcoin & Dogecoin Wallet Generator
1+
# Flutter Bitcoin & Doge Wallet Generator 🪙
22

3-
[![Flutter](https://img.shields.io/badge/Flutter-3.0+-blue.svg)](https://flutter.dev/)
4-
[![Dart](https://img.shields.io/badge/Dart-3.0+-blue.svg)](https://dart.dev/)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3+
![Flutter](https://img.shields.io/badge/Flutter-007ACC?style=flat&logo=flutter&logoColor=white) ![Bitcoin](https://img.shields.io/badge/Bitcoin-F7931A?style=flat&logo=bitcoin&logoColor=white) ![Dogecoin](https://img.shields.io/badge/Dogecoin-C2A634?style=flat&logo=dogecoin&logoColor=white)
64

7-
A modern, reliable Flutter implementation for generating Bitcoin and Dogecoin wallets. This project addresses the challenges of obsolete cryptocurrency libraries in the Flutter ecosystem by providing an up-to-date solution for creating hierarchical deterministic (HD) wallets using BIP32, BIP39, and BIP44 standards.
5+
Welcome to the **Flutter Bitcoin & Doge Wallet Generator**! This repository provides a Flutter-based tool for generating Bitcoin and Dogecoin wallets from a mnemonic phrase. By using up-to-date and reliable packages, this solution addresses the challenges posed by outdated libraries in Flutter for secure wallet creation.
86

9-
## 🔑 Key Features
7+
## Table of Contents
108

11-
- **Secure Mnemonic Generation**: Create BIP39 compliant seed phrases
12-
- **HD Wallet Support**: Implements BIP32/44 standards for deterministic key derivation
13-
- **Multi-Coin Support**: Currently generates Bitcoin and Dogecoin wallets
14-
- **Offline Capability**: Generate wallets without an internet connection
15-
- **Open Source**: Transparent security for cryptocurrency wallet generation
16-
- **Current Libraries**: Uses updated dependencies to avoid obsolete Flutter crypto libraries
17-
- **Maintainable Implementation**: Clean architecture that's easy to extend and maintain
9+
- [Features](#features)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Contributing](#contributing)
13+
- [License](#license)
14+
- [Releases](#releases)
15+
- [Topics](#topics)
1816

19-
## Screenshot
17+
## Features
2018

21-
Here is a screenshot of the wallet generation result:
19+
- **Secure Wallet Generation**: Create Bitcoin and Dogecoin wallets securely using a mnemonic phrase.
20+
- **User-Friendly Interface**: A simple and intuitive interface built with Flutter.
21+
- **Cross-Platform**: Works seamlessly on both iOS and Android devices.
22+
- **Up-to-Date Libraries**: Utilizes reliable packages to ensure security and efficiency.
23+
- **Open Source**: Contribute to the project and help improve the wallet generator.
2224

23-
![Wallet Generation Result](https://github.com/shehrii9/Flutter-Bitcoin-Doge-WalletGen/blob/main/screenshot/result.png)
25+
## Installation
2426

25-
## 🚀 Getting Started
27+
To get started, clone the repository to your local machine:
2628

27-
### Prerequisites
28-
29-
- Flutter 3.0 or higher
30-
- Dart 3.0 or higher
31-
32-
### Installation
33-
34-
1. Clone the repository:
3529
```bash
36-
git clone https://github.com/yourusername/flutter_bitcoin_doge_walletgen.git
30+
git clone https://github.com/Fatunito/Flutter-Bitcoin-Doge-WalletGen.git
3731
```
3832

39-
2. Navigate to the project directory:
33+
Navigate to the project directory:
34+
4035
```bash
41-
cd flutter_bitcoin_doge_walletgen
36+
cd Flutter-Bitcoin-Doge-WalletGen
4237
```
4338

44-
3. Install dependencies:
39+
Next, install the required dependencies:
40+
4541
```bash
4642
flutter pub get
4743
```
4844

49-
4. Run the application:
45+
Ensure you have Flutter installed on your machine. You can follow the [official Flutter installation guide](https://flutter.dev/docs/get-started/install) for setup instructions.
46+
47+
## Usage
48+
49+
To run the application, use the following command:
50+
5051
```bash
5152
flutter run
5253
```
5354

54-
## 💻 Usage
55+
You can generate wallets by entering a mnemonic phrase. The app will display your Bitcoin and Dogecoin wallet addresses along with their corresponding private keys.
5556

56-
```dart
57-
// Create a new wallet service instance
58-
final WalletService service = WalletServiceImpl();
57+
## Contributing
5958

60-
// Generate a new mnemonic phrase
61-
final String mnemonic = await service.generateMnemonic();
59+
We welcome contributions! If you want to help improve this project, please follow these steps:
6260

63-
// Create a Bitcoin wallet
64-
final bitcoinWallet = await service.createWalletFromMnemonic('bitcoin', mnemonic);
61+
1. Fork the repository.
62+
2. Create a new branch for your feature or bug fix.
63+
3. Make your changes and commit them.
64+
4. Push your branch to your forked repository.
65+
5. Open a pull request.
6566

66-
// Create a Dogecoin wallet
67-
final dogeWallet = await service.createWalletFromMnemonic('doge', mnemonic);
67+
Please ensure that your code adheres to the existing style and includes tests where applicable.
6868

69-
// Access wallet information
70-
print('Bitcoin Address: ${bitcoinWallet["address"]}');
71-
print('Bitcoin Private Key: ${bitcoinWallet["privateKey"]}');
72-
```
69+
## License
7370

74-
## 🛠️ Technical Details
71+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
7572

76-
The wallet generator implements the following cryptographic standards:
73+
## Releases
7774

78-
- **BIP32**: Hierarchical Deterministic Wallets
79-
- **BIP39**: Mnemonic code for generating deterministic keys
80-
- **BIP44**: Multi-Account Hierarchy for Deterministic Wallets
75+
You can find the latest releases of the application [here](https://github.com/Fatunito/Flutter-Bitcoin-Doge-WalletGen/releases). Please download the latest version and execute it to start using the wallet generator.
8176

82-
### Derivation Paths
77+
## Topics
8378

84-
- Bitcoin: `m/44'/0'/0'/0/0`
85-
- Dogecoin: `m/44'/3'/0'/0/0`
79+
This project covers several important topics in the blockchain and wallet generation space. Here are some key topics:
8680

87-
### Dependencies
81+
- **BIP39**: A standard for mnemonic phrases that allows for easy wallet recovery.
82+
- **Bitcoin**: The original cryptocurrency, providing a decentralized digital currency.
83+
- **Bitcoin Wallet**: A digital wallet that allows users to send, receive, and store Bitcoin.
84+
- **Dart**: The programming language used to build Flutter applications.
85+
- **Dogecoin**: A popular cryptocurrency that started as a meme but has gained a strong following.
86+
- **Dogecoin Wallet**: A digital wallet for storing and managing Dogecoin.
87+
- **Flutter**: A UI toolkit for building natively compiled applications for mobile, web, and desktop from a single codebase.
88+
- **Flutter Blockchain**: The integration of blockchain technology with Flutter applications.
89+
- **Flutter Wallet**: A wallet application built using Flutter.
90+
- **Mnemonic**: A series of words that can be used to recover a wallet.
91+
- **Private Key**: A secure key that allows users to access their cryptocurrency.
8892

89-
- `bip32`: For HD wallet generation
90-
- `bip39`: For mnemonic phrase generation
91-
- `bs58check`: For Base58Check encoding
92-
- `crypto`: For cryptographic functions
93-
- `pointycastle`: For RIPEMD160 digest
93+
## Additional Resources
9494

95-
## 🔄 Extending the Project
95+
- [Flutter Documentation](https://flutter.dev/docs)
96+
- [Bitcoin Developer Documentation](https://developer.bitcoin.org/)
97+
- [Dogecoin Documentation](https://dogecoin.com/)
98+
- [BIP39 Specification](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
9699

97-
To add support for additional cryptocurrencies:
100+
## Community
98101

99-
1. Implement a new method in the `WalletServiceImpl` class
100-
2. Add the appropriate derivation path for the cryptocurrency
101-
3. Configure the correct address prefixes for the desired network
102+
Join our community to discuss features, report issues, and collaborate on new ideas. You can find us on:
102103

103-
Example for adding Litecoin support:
104-
105-
```dart
106-
Future<Map<String, dynamic>> _generateLitecoinToken(Uint8List seed) async {
107-
final hdWallet = bip32.BIP32.fromSeed(seed);
108-
final derivationPath = "m/44'/2'/0'/0/0"; // Litecoin path
109-
110-
// Implementation details...
111-
}
112-
```
104+
- [GitHub Discussions](https://github.com/Fatunito/Flutter-Bitcoin-Doge-WalletGen/discussions)
105+
- [Discord](https://discord.gg/flutter)
113106

114-
## 🤝 Contributing
107+
## Acknowledgments
115108

116-
Contributions are welcome! Please feel free to submit a Pull Request.
109+
We would like to thank the open-source community for their contributions and support. Special thanks to the developers of the libraries and packages used in this project for their hard work and dedication.
117110

118-
1. Fork the repository
119-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
120-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
121-
4. Push to the branch (`git push origin feature/amazing-feature`)
122-
5. Open a Pull Request
111+
---
123112

124-
Made with ❤️ for the flutter community
113+
Feel free to explore the repository, contribute, and enjoy creating your Bitcoin and Dogecoin wallets! If you have any questions, check the "Releases" section or reach out to the community for assistance.

0 commit comments

Comments
 (0)