Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Orange-Wallet/wallet-connect-dart
Wallet Connect client in Dart.
https://github.com/Orange-Wallet/wallet-connect-dart
dapp-protocol dart ethereum flutter hacktoberfest library walletconnect
Last synced: about 1 month ago
JSON representation
Wallet Connect client in Dart.
- Host: GitHub
- URL: https://github.com/Orange-Wallet/wallet-connect-dart
- Owner: Orange-Wallet
- License: bsd-3-clause
- Created: 2021-09-16T10:55:21.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-22T08:03:18.000Z (about 1 year ago)
- Last Synced: 2024-06-19T04:11:08.341Z (3 months ago)
- Topics: dapp-protocol, dart, ethereum, flutter, hacktoberfest, library, walletconnect
- Language: Dart
- Homepage: https://pub.dev/packages/wallet_connect
- Size: 143 KB
- Stars: 116
- Watchers: 6
- Forks: 78
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-walletconnect - WalletConnect Dart - connect-kotlin by Trust Wallet. (Uncategorized / Uncategorized)
README
Wallet Connect
Wallet Connect client in dart highly inspired from [wallet-connect-kotlin](https://github.com/trustwallet/wallet-connect-kotlin) by [Trust Wallet](https://github.com/trustwallet).
## Usage
```dart
import 'package:wallet_connect/wallet_connect.dart';
```
1. Create instance of Wallet connect client and define callbacks.
```dart
final wcClient = WCClient(
onConnect: () {
// Respond to connect callback
},
onDisconnect: (code, reason) {
// Respond to disconnect callback
},
onFailure: (error) {
// Respond to connection failure callback
},
onSessionRequest: (id, peerMeta) {
// Respond to connection request callback
},
onEthSign: (id, message) {
// Respond to personal_sign or eth_sign or eth_signTypedData request callback
},
onEthSendTransaction: (id, tx) {
// Respond to eth_sendTransaction request callback
},
onEthSignTransaction: (id, tx) {
// Respond to eth_signTransaction request callback
},
);
```
2. Create WCSession object from wc: uri.
```dart
final session = WCSession.from(wcUri);
```
3. Create WCPeerMeta object containing metadata for your app.
```dart
final peerMeta = WCPeerMeta(
name: 'Example Wallet',
url: 'https://example.wallet',
description: 'Example Wallet',
icons: [],
);
```
4. Connect to a new session.
```dart
wcClient.connectNewSession(session: session, peerMeta: peerMeta);
```
5. Or connect to a saved session (from step 8).
```dart
wcClient.connectFromSessionStore(sessionStore);
```
6. Approve a session connection request.
```dart
wcClient.approveSession(
accounts: [], // account addresses
chainId: 1, // chain id
);
```
7. Or reject a session connection request.
```dart
wcClient.rejectSession();
```
8. Get active session from sessionStore getter to save for later use.
```dart
final sessionStore = wcClient.sessionStore;
```
9. Approve a sign transaction request by signing the transaction and sending the signed hex data.
```dart
wcClient.approveRequest(
id: id,
result: signedDataAsHex,
);
```
10. Approve a send transaction request by sending the transaction hash generated from sending the transaction.
```dart
wcClient.approveRequest(
id: id,
result: transactionHash,
);
```
11. Approve a sign request by sending the signed data hex generated.
```dart
wcClient.approveRequest(
id: id,
result: signedDataAsHex,
);
```
12. Or reject any of the requests above by specifying request id.
```dart
wcClient.rejectRequest(id: id);
```
13. Disconnect from a connected session locally.
```dart
wcClient.disconnect();
```
14. Permanently close a connected session.
```dart
wcClient.killSession();
```