👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Archethic Wallet which is hosted in the Archethic Foundation on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
This project and everyone participating in it is governed by the Archethic code of conduct. By participating, you are expected to uphold this code.
Note: Please don't file an issue to ask a question.
We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.
This section guides you through submitting a bug report for Archethic Wallet. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Check the discussions for a list of common questions and problems.
- Check the issue list if it has been already opened.
Bugs are tracked as GitHub issues and create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- If you're reporting a crash, include a crash report with a stack trace. nclude the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem is related to performance or memory, include a screenshot of the
observer - If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of the wallet? What's the most recent version in which the problem doesn't happen?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
This section guides you through submitting an enhancement suggestion for Archethic Wallet, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues and create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a detailed description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful .
Unsure where to begin contributing to Atom? You can start by looking through these beginner and help-wanted issues:
- [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
- [Help wanted issues][help-wanted] - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
The process described here has several goals:
- Maintain Archethic Wallet's quality
- Fix problems that are important
- Enable a sustainable system for Archethic's maintainers to review contributions
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
A migration to hexagonal architecture is ongoing. We describe here the target architecture.
Application is composed of 4 layers. Here is the folder structure matching each layers :
- domain : Core data structures and logic. Everything in here is third party component agnostic.
- models : Data structures.
- repositories : Interfaces describing interactions with models.
- usecases : Complex use cases implementation.
- ui : All the display/user-interaction components
- application : Business logic components.
- infrastructure : This is the domain/repositories implementations. All third party SDK/API dependent code should end up here.
Rather than reinventing the wheel, I encourage you to check this excellent diagram from resocoder.com out.
- Application state management heavily relies on Riverpod.
- Dependency injection relies on Riverpod too. There is still a non neglectable part using the excellent GetIt library.
- Blockchain interaction is extracted to the archethic_lib_dart package.
In order to allow DApps to interact with Archethic Wallet, an RPC server is running.
RPC server implementation depends on the host platform capabilities :
- a
Websocketserver on Web, Windows, MacOS and GNU/Linux - a
DeeplinkRPC"server" on iOS and Android.
Some RPC commands require user explicit validation. Because of that, we need to handle RPC Commands on the UI layer.
│ INFRASTRUCTURE │ DOMAIN │ PRESENTATION / UI
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│
Deeplink request ┌──────────────────────────────┐ Result │
┌───────────────────────►│ │◄────┐ │
┌──────────┐ │ │ ArchethicDeeplinkRPCServer │ │ ┌───────────────────┐ │
│ ├───────────┘ ┌─────────────────────┤ ├──┐ └──┤ │ │
│ │ │ └──────────────────────────────┘ │ │ │ ┌────────────────────┐ ┌───────────┐
│ │◄─────────────┘ └────►│ ├───────►│ ├────┘ ▼
│ DApp │ Command │ CommandDispatcher │ │ RPCCommandReceiver │ performs action
│ │◄─────────────┐ ┌────►│ │◄───────┤ │◄───┐ │
│ │ │ │ │ │ └────────────────────┘ └───────────┘
│ ├───────────┐ │ ┌───────────────────────────────┐ │ ┌──┤ │ │
└──────────┘ │ └─────────────────────┤ ├─┘ │ └───────────────────┘ │
│ │ ArchethicWebsocketRPCServer │ │ │
└────────────────────────┤ │◄───┘ │
WebSocket request └───────────────────────────────┘ Result │
│
│ │ │
│ │ │
-
By default, the application is in English.
-
All texts (labels, messages, ...) must be written in files
lib/intl_en.arbandlib/intl_fr.arb. -
To get the labels in the widgets, you have to use
final localizations = AppLocalizations.of(context)!;then retrieve the value of the label with its key.
All information about internationalization with Flutter is available in the official documentation
- To start the code generator, run the following command:
run build_runner watch. See Riverpod generator documentation
We are using the icons from google, material icons : https://fonts.google.com/icons
- To convert all svg icons from
assets/fontsfolder, run the following command :icon_font_generator --from=assets/icons/menu --class-name=UiIcons --out-font=assets/fonts/ui_icons.ttf --out-flutter=lib/ui/widgets/components/icons.dart. See Icon Font Generator documentation
Wallet data are stored using Hive.
Storage Boxes are split into categories :
- Raw boxes : Those boxes contain non-sensitive data
- Vaults : those boxes are encrypted Hive boxes
- Web platform : to mitigate lack of FlutterSecureStorage on web platform, the Box Encryption Key is itself encrypted using user password.
- Other platforms : the Box Encryption Key is stored in the system FlutterSecureStorage
- Encrypted boxes : these boxes are used on non web platforms only. They store user Pin or Password code
- _preferencesBox : User settings
- tokensListBox : Cache for Tokens read from API
- contacts : User registered Contacts
- appWallet : Non-sensitive Wallet data
- price : Cache for currency Prices read from Oracle
- _vaultBox : Sensitive data
- keychain seed
- KeychainSecuredInfos
- CacheManagerHive: Blockchain cache for various data
- Token images data
- NotificationsSetup : Push notification data
- NonWebAuthentication : User authentication data (pin/password)