Wallet interface #134
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| .dart_tool/ | ||
| build/ | ||
| coverage/ | ||
| .idea/ | ||
|
|
||
| .env* | ||
|
|
||
| protos/ | ||
| coverage/ | ||
|
|
||
| lib/src/crypto/tron/repositories/rpc/api/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Project Structure & Module Organization | ||
| - `lib/`: Package source entry `walletkit_dart.dart` plus modules under `src/` (EVM, UTXO, Tron, wallet utils, domain entities, utils). | ||
| - `test/`: Organized by domain (e.g., `test/ci/evm`, `test/ci/fetching`, `test/ci/tron`). `ci-mocked/` holds tests with mocks; `no_ci/` are local-only. | ||
| - `example/`: Minimal CLI helpers and usage snippets. | ||
| - `protos/`: Protocol definitions; generated Dart files live in `lib/src/crypto/tron/repositories/rpc/`. | ||
| - `coverage/`: Local/CI coverage outputs. | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| - Prereqs: Dart SDK `^3.7.2` (see `pubspec.yaml`). | ||
| - Install deps: `dart pub get` | ||
| - Static analysis: `dart analyze` | ||
| - Format code: `dart format .` | ||
| - Run all tests: `dart test` | ||
| - Run a test subset: `dart test test/ci/evm` | ||
| - Generate coverage (local): | ||
| - `dart pub global activate coverage` | ||
| - `dart test --coverage=coverage` | ||
| - `dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --package=. --report-on=lib` | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Style: Dart `package:lints/recommended` (see `analysis_options.yml`). | ||
| - Indentation: 2 spaces; max line length per Dart defaults. | ||
| - Naming: types in `UpperCamelCase`, methods/vars in `lowerCamelCase`, files in `lower_snake_case.dart`. | ||
| - Keep public API exports centralized in `lib/walletkit_dart.dart`. | ||
|
|
||
| ## Testing Guidelines | ||
| - Framework: `package:test` with domain-focused directories. | ||
| - Name tests after subject and behavior: `feature_action_test.dart`. | ||
| - Prefer deterministic tests; use `ci-mocked` for network-sensitive paths. | ||
| - Env for integration tests: uses `.env` via `dotenv`. Common keys: `ETHERSCAN_API_KEYS`, `TRONSCAN_API_KEYS`, `DEV_SEED`, `REJECT_SEED`, `TRON_SEED`. Do not commit secrets. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Commits: prefer Conventional Commits (`feat:`, `fix:`, `refactor:`, `test:`, `chore:`). Keep changes scoped and descriptive. | ||
| - PRs should include: | ||
| - Purpose and summary of changes; link related issues. | ||
| - Notes on API surface changes (exports in `walletkit_dart.dart`). | ||
| - Test coverage: list added/updated tests and how to run a focused subset. | ||
| - Screenshots/trace snippets when debugging protocol/tx parsing. | ||
|
|
||
| ## Security & Configuration Tips | ||
| - Secrets: store locally in `.env`; CI uses repository secrets. Never log private keys or seeds. | ||
| - When adding new RPC/backends, gate keys via `dotenv` and add mocked tests under `test/ci-mocked`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 NOMO | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,154 +1,104 @@ | ||
| [](https://github.com/nomo-app/walletkit-dart/actions/workflows/dart.yml) | ||
| [](https://dev.nomo.app/walletkit-dart/coverage/) | ||
|
|
||
| # WalletKit-Dart | ||
|
|
||
| A powerful Dart library for interacting with multiple blockchain networks, including Bitcoin, Ethereum, Tron, ZENIQ, Polygon, Binance Smart Chain, Litecoin, Bitcoin Cash, and Eurocoin, as well as various layer 2 chains. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Multi-Chain Support**: Native support for both UTXO-based and EVM-based chains | ||
| - **Transaction Management**: | ||
| - Send transactions (legacy/SegWit/P2SH/EVM) | ||
| - Fetch transactions and balances (including xPub/zPub/ERC20) | ||
| - Advanced smart contract call parsing for human readability | ||
| - **Wallet Features**: | ||
| - HD-Wallet support with mnemonic phrase derivation | ||
| - Address validation and management | ||
| - Fee estimation | ||
| - **Performance Optimized**: | ||
| - In-memory caching for immutable data | ||
| - Stateless API design | ||
| - **Comprehensive Testing**: | ||
| - Extensive unit test suite | ||
| - CI/CD integration | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Installation | ||
|
|
||
| Add WalletKit-Dart to your project as a Git submodule: | ||
|
|
||
| ```bash | ||
| git submodule add https://github.com/nomo-app/walletkit-dart.git packages/walletkit-dart | ||
| ``` | ||
|
|
||
| Update your `pubspec.yaml`: | ||
|
|
||
| ```yaml | ||
| dependencies: | ||
| walletkit_dart: | ||
| path: packages/walletkit-dart | ||
| ``` | ||
|
|
||
| Initialize the submodules: | ||
|
|
||
| ```bash | ||
| git submodule update --init --recursive | ||
| ``` | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Dart SDK: ^3.7.2 | ||
| - See [pubspec.yaml](pubspec.yaml) for detailed dependencies | ||
|
|
||
| ## Architecture | ||
|
|
||
| WalletKit-Dart is designed to handle both UTXO-based and EVM-based chains efficiently: | ||
|
|
||
| ### UTXO Chains | ||
| - Bitcoin and similar cryptocurrencies | ||
| - Tracks ownership through unspent transaction outputs | ||
| - Efficient for simple value transfers | ||
|
|
||
| ### EVM Chains | ||
| - Ethereum and compatible networks | ||
| - Supports smart contracts and complex transactions | ||
| - State-based architecture | ||
|
|
||
| ## API Design Philosophy | ||
|
|
||
| - **Stateless**: No storage of seed phrases or transactions | ||
| - **Memory-Efficient**: Uses in-memory caches for performance | ||
| - **Chain-Specific APIs**: Specialized interfaces for different chain architectures | ||
| - **No Broken Abstractions**: Maintains clear separation between chain types | ||
|
|
||
| ## Backend Integration | ||
|
|
||
| - **UTXO Chains**: Uses the [ElectrumX Protocol](https://electrumx.readthedocs.io/en/latest/protocol-methods.html) | ||
| - **EVM Chains**: Integrates with JSON-RPC providers and Etherscan-style APIs | ||
|
|
||
| ## Examples | ||
|
|
||
| Check out these example implementations: | ||
|
|
||
| - [Uniswap WebOn](https://github.com/nomo-app/uniswap-webon) | ||
| - [API Documentation](https://dev.nomo.app/walletkit-dart) | ||
|
|
||
| ### Test Examples | ||
|
|
||
| The test suite provides practical examples for various use cases: | ||
|
|
||
| - [ERC20 Token Info](test/ci/evm/erc20_test.dart) | ||
| - [EVM Transaction Fetching](test/ci/evm/evm_explorer_test.dart) | ||
| - [Bitcoin Transaction Management](test/ci/fetching/assets/bitcoin_fetch_test.dart) | ||
| - [Address Validation](test/ci/sending/address_validation_test.dart) | ||
| - [Gas Fee Estimation](test/ci/gasfees_test.dart) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome! Please feel free to submit a Pull Request. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the LICENSE file for details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import 'dart:async'; | ||
|
|
||
| abstract class Command<T> { | ||
| String get name; | ||
| String get description; | ||
| FutureOr<T> execute(List<String> args); | ||
| } | ||
|
|
||
| class CommandResult<T> { | ||
| final bool success; | ||
| final T? data; | ||
| final String? error; | ||
|
|
||
| CommandResult.success(this.data) | ||
| : success = true, | ||
| error = null; | ||
| CommandResult.failure(this.error) | ||
| : success = false, | ||
| data = null; | ||
|
|
||
| @override | ||
| String toString() { | ||
| if (success) { | ||
| return data?.toString() ?? 'Command completed successfully'; | ||
| } else { | ||
| return 'Error: ${error ?? "Unknown error"}'; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class CommandRegistry { | ||
| final Map<String, Command> _commands = {}; | ||
|
|
||
| void register(Command command) { | ||
| _commands[command.name.toLowerCase()] = command; | ||
| } | ||
|
|
||
| Command? get(String name) { | ||
| return _commands[name.toLowerCase()]; | ||
| } | ||
|
|
||
| List<Command> get commands => _commands.values.toList(); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import 'dart:io'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import 'command.dart'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class HelpCommand extends Command<String> { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| final CommandRegistry registry; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HelpCommand(this.registry); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| String get name => 'help'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| String get description => 'Show available commands'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| String execute(List<String> args) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| final buffer = StringBuffer('Available commands:\n'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| for (final command in registry.commands) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| buffer.writeln(' ${command.name.padRight(10)} - ${command.description}'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return buffer.toString(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class ExitCommand extends Command<void> { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| String get name => 'exit'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| String get description => 'Exit the application'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| @override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Future<void> execute(List<String> args) async { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| print('Goodbye!'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| exit(0); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+26
to
+38
There was a problem hiding this comment. 🛠️ Refactor suggestion Implement graceful shutdown. The @override
Future<void> execute(List<String> args) async {
print('Goodbye!');
- exit(0);
+ // Signal the application to start cleanup
+ return Future.value();
}📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add duplicate command name validation.
The
registermethod should check for existing commands with the same name (case-insensitive) to prevent overwriting.void register(Command command) { + ArgumentError.checkNotNull(command, 'command'); + final normalizedName = command.name.toLowerCase(); + if (_commands.containsKey(normalizedName)) { + throw ArgumentError('Command "${command.name}" is already registered'); + } - _commands[command.name.toLowerCase()] = command; + _commands[normalizedName] = command; }📝 Committable suggestion