Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reaster/cardano_wallet_sdk
Targeting Flutter apps, the Cardano Wallet SDK is a high-level Dart library for managing cryptocurrency accounts & executing transactions on the blockchain.
https://github.com/reaster/cardano_wallet_sdk
ada blockchain cardano cryptocurrency dart finance flutter wallet
Last synced: about 2 months ago
JSON representation
Targeting Flutter apps, the Cardano Wallet SDK is a high-level Dart library for managing cryptocurrency accounts & executing transactions on the blockchain.
- Host: GitHub
- URL: https://github.com/reaster/cardano_wallet_sdk
- Owner: reaster
- License: apache-2.0
- Created: 2021-04-27T20:10:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-20T01:22:40.000Z (over 1 year ago)
- Last Synced: 2024-05-28T13:28:47.483Z (4 months ago)
- Topics: ada, blockchain, cardano, cryptocurrency, dart, finance, flutter, wallet
- Language: Dart
- Homepage:
- Size: 3.22 MB
- Stars: 38
- Watchers: 8
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
---
# cardano_wallet_sdk
Flutter SDK for building [Cardano](https://cardano.org) blockchain mobile apps in [Flutter](https://flutter.dev) using the [Dart](https://dart.dev) programming language.
## Current Features
* Create Wallets - Create and restore, both read-only and transactional wallets using staking addresses, mnemonics or private keys.
* Transaction History - List transactions, rewards and fees for both ADA and Native Tokens.
* Addresses - Generate and manage Shelley key pairs and addresses.
* Transactions - Build, sign and submit simple ADA payment transactions.
* Blockchain API - Cardano blockchain access via the [BlockFrost API package](https://github.com/reaster/blockfrost_api)
* Binary Encoding - Enough [CBOR](https://cbor.io) support is provided to submit simple payment transactions.
## Kick the Tires
To see the SDK in action, both a pure [Dart example](https://github.com/reaster/cardano_wallet_sdk/blob/main/example/dart_example.dart) and multi-platform [Flutter example](https://github.com/reaster/cardano_wallet_sdk/tree/main/example/flutter_example) are incuded in this distribution. You can also visit the live [Flutter Demonstration Wallet](https://flutter-cardano-wallet.web.app/) hosted on google cloud.
## Project Status
This library is currently under development and is not yet production quality. It is being developed on a part-time basis with an evolving schedule based on funding and developer resources. To date it has been funded by a series of modest [Project Catalyst](https://cardano.ideascale.com) grants. The current schedule is:
* 2022-04-07 [0.1.0-alpha.12](https://pub.dev/packages/cardano_wallet_sdk/versions/0.1.0-alpha.12) **completed** [Fund 5](https://cardano.ideascale.com/a/dtd/Cardano-Wallet-Flutter-SDK/352623-48088) SDK prototype and demo Flutter wallet supporting blockchain access, loading wallet balances and submitting simple transactions.
* 2022-12-31 **active** [Fund 7](https://cardano.ideascale.com/a/dtd/Flutter-SDK/381288-48088) phase to build a solid foundation for production SDK. Features include improved API, third-party dependency reduction, mnemonics, all Cardano address types, full CBOR support, native token/NFT minting/burning, basic staking and basic smart contract support.
* 2023-03-31 **planned** [Fund 8](https://cardano.ideascale.com/c/idea/400720) work will mostly focus on higher-level smart contract support, and as time allows, may include tutorials, DApp linking and community driven features.
* 2023-06-31 **planned** Fund 9 will be for ongoing maintenance and community-driven development requests.
This is an ambitious project, requiring much ongoing maintenance, development and community support. If you'd like to see this project succeed, please support us by voting for the Flutter SDK in Fund 9. Proposals will be published in June 2022 and voting will be in August 2022.
If you'd like to can contribute directly, the Flutter SDK has a dedicated wallet:
```
addr1qx90lkpwhpwu42jnw00w483krjyfvhhpgk97hdfw9nz3xqaqg6dycrrc4qw0l5fsvfgx95gnqmrfxhgrfy8afsxxje5qgplx9r
```
## Usage
Released versions and installation details can be found on [pub.dev](https://pub.dev/packages/cardano_wallet_sdk/install).
### Coding Style
Although Dart is an imperative language, the framework uses functional idioms whenever possible. In particular,
the majority of the classes are immutible and rather than creating side effects by throwing
exceptions, the Result class is used. The WalletBuilder's build method
provides a concrete example, returning either a wallet instance or error message if issues arise:
```dart
Result result = walletBuilder.build();
result.when(
ok: (wallet) => print("Success: ${wallet.walletName}"),
err: (message) => print("Error: $message"),
);
```
### Wallet Management
Create a wallet builder for the testnet using a [BlockFrost](https://github.com/reaster/blockfrost_api) key.
```dart
final walletBuilder = WalletBuilder()
..network = Networks.testnet
..testnetAdapterKey = blockfrostKey;
```
Create a read-only wallet using a staking address.
```dart
var address = ShelleyAddress.fromBech32('stake_test1uqvwl7a...');
final walletBuilder = WalletBuilder()
..network = Networks.testnet
..testnetAdapterKey = blockfrostKey
..stakeAddress = address;
Result result = await walletBuilder.readOnlyBuildAndSync();
result.when(
ok: (wallet) => print("${wallet.walletName}: ${wallet.balance}"),
err: (message) => print("Error: $message"),
);
```
Restore existing wallet using 24 word mnemonic.
```dart
List mnemonic = 'rude stadium move gallery receive just...'.split(' ');
final walletBuilder = WalletBuilder()
..network = Networks.testnet
..testnetAdapterKey = blockfrostKey
..mnemonic = mnemonic;
Result result = await walletBuilder.buildAndSync();
if (result.isOk()) {
var wallet = result.unwrap();
print("${wallet.walletName}: ${wallet.balance}");
}
```
Update existing wallet.
```dart
final walletBuilder = WalletBuilder()
..network = Networks.testnet
..testnetAdapterKey = blockfrostKey
..mnemonic = mnemonic;
Result result = walletBuilder.build();
Wallet wallet = result.unwrap();
Coin oldBalance = wallet.balance;
var result2 = await wallet.update();
result2.when(
ok: (_) => print("old:$oldBalance lovelace, new: ${wallet.balance} lovelace"),
err: (message) => print("Error: $message"),
);
```
Create a new 24 word mnemonic.
```dart
List mnemonic = WalletBuilder.generateNewMnemonic();
print("mnemonic: ${mnemonic.join(' ')}");
```
### Wallet Details
List transaction history.
```dart
wallet.transactions.forEach((tx) => print(tx));
```
List addresses.
```dart
wallet.addresses.forEach((addr) => print(addr.toBech32()));
```
List currency balances.
```dart
final formatter = AdaFormattter.compactCurrency();
wallet.currencies.forEach((assetId, balance) {
final isAda = assetId == lovelaceHex;
print("$assetId: ${isAda ? formatter.format(balance) : balance}");
});
```
List staking rewards.
```dart
wallet.stakeAccounts.forEach((acct) {
acct.rewards.forEach((reward) {
print("epoch: ${reward.epoch}, ${reward.amount} ADA");
});
});
```
### Wallet Keys and Addresses
Access root private and public key pair.
```dart
Bip32KeyPair pair = wallet.rootKeyPair;
print("${pair.signingKey}, ${pair.verifyKey}");
```
Access staking address.
```dart
print(wallet.account.stakeAddress));
```
First unused change address.
```dart
print(wallet.firstUnusedChangeAddress));
```
First unused spend address.
```dart
print(wallet.firstUnusedSpendAddress));
```
### Submit Transactions
Send 3 ADA to Bob.
```dart
var bobsAddress = parseAddress('addr1qyy6...');
final Result result = await wallet.sendAda(
toAddress: bobsAddress,
lovelace: 3 * 1000000,
);
if (result.isOk()) {
final tx = result.unwrap();
print("ADA sent. Fee: ${tx.body.fee} lovelace");
}
```
### Running Integration Tests
Several of the integration tests (suffixed with '_itest.dart') require a BlockFrost key to run. Installation steps are as follows:
* git clone [email protected]:reaster/cardano_wallet_sdk.git
* register for a free [BlockFrost](https://blockfrost.io/) testnet policy-id key.
* paste the policy-id key into a text file named: blockfrost_project_id.txt in the parent directory of this project.
```
echo "your-project-id" > ../blockfrost_project_id.txt
```
Now you can include the integration tests:
```
dart test -P itest
```
***
Copyright 2021 Richard Easterling\
SPDX-License-Identifier: Apache-2.0