Add example to README (#130)

irulast · Nov 27, 2023 · f4c3c9d · f4c3c9d
1 parent 4061ab1
commit f4c3c9d
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,39 @@ simulator_gen_path.json
 }
 ```
 
+## Example
+```dart
+ // Initialize keychain
+const mnemonic = 'abandon broom kind...';
+
+final keychainSecret = KeychainCoreSecret.fromMnemonicString(mnemonic);
+
+final keychain = WalletKeychain.fromCoreSecret(
+  keychainSecret,
+  walletSize: 50,
+);
+
+// Initialize full node
+final certBytes = File('CERT_PATH').readAsBytesSync();
+final keyBytes = File('KEY_PATH').readAsBytesSync();
+
+final fullNode = ChiaFullNodeInterface.fromURL(
+  'FULL_NODE_URL',
+  certBytes: Bytes(certBytes),
+  keyBytes: Bytes(keyBytes),
+);
+
+final wallet = ColdWallet(
+  fullNode: fullNode,
+  keychain: keychain,
+);
+
+await wallet.sendXch(
+  Address('RECEIVER_ADDRESS').toPuzzlehash(),
+  amount: 1000000000,
+);
+```
+
 ## Coverage 
 
 ### Dependencies

diff --git a/bin/chia_crypto_utils.dart b/bin/chia_crypto_utils.dart
@@ -832,7 +832,7 @@ class TransferDidCommand extends Command<Future<void>> {
     final coins = await fullNode.getCoinsByPuzzleHashes(keychain.puzzlehashes);
     final dids = currentDidAddress != null
         ? await fullNode.getDidRecordsFromHint(currentDidAddress.toPuzzlehash())
-        : await fullNode.getDidRecordsFromHints(keychain.puzzlehashes);
+        : await fullNode.getDidRecordsByHints(keychain.puzzlehashes);
 
     final coinsForFee = () {
       try {

diff --git a/lib/src/api/enhanced_full_node/enhanced_chia_full_node_interface.dart b/lib/src/api/enhanced_full_node/enhanced_chia_full_node_interface.dart
@@ -142,6 +142,7 @@ class EnhancedChiaFullNodeInterface extends ChiaFullNodeInterface {
     );
   }
 
+  @override
   Future<List<NftRecord>> getNftRecordsByHints(
     List<Puzzlehash> hints, {
     int? startHeight,
@@ -182,6 +183,7 @@ class EnhancedChiaFullNodeInterface extends ChiaFullNodeInterface {
     return nfts;
   }
 
+  @override
   Future<List<CatFullCoin>> getCatCoinsByHints(
     List<Puzzlehash> hints, {
     int? startHeight,
@@ -224,6 +226,7 @@ class EnhancedChiaFullNodeInterface extends ChiaFullNodeInterface {
     );
   }
 
+  @override
   Future<List<DidRecord>> getDidRecordsByHints(List<Puzzlehash> hints) async {
     final coins = await getCoinsByHints(hints);
     return getDidsFromCoins(coins);

diff --git a/lib/src/api/full_node/chia_full_node_interface.dart b/lib/src/api/full_node/chia_full_node_interface.dart
@@ -171,6 +171,11 @@ class ChiaFullNodeInterface {
     return getNftRecordsFromCoins(coins);
   }
 
+  Future<List<NftRecord>> getNftRecordsByHints(List<Puzzlehash> hints) async {
+    final coins = await getCoinsByHints(hints);
+    return getNftRecordsFromCoins(coins);
+  }
+
   Future<List<NftRecord>> getNftRecordsFromCoins(List<Coin> coins) async {
     final nfts = <NftRecord>[];
 
@@ -201,7 +206,7 @@ class ChiaFullNodeInterface {
     return matches.single;
   }
 
-  Future<List<DidRecord>> getDidRecordsFromHints(List<Puzzlehash> hints) async {
+  Future<List<DidRecord>> getDidRecordsByHints(List<Puzzlehash> hints) async {
     final coins = await getCoinsByHints(hints);
     final didInfos = await getDidsFromCoins(coins);
     return didInfos;
@@ -371,6 +376,14 @@ class ChiaFullNodeInterface {
     return coinSpendResponse.coinSpend;
   }
 
+  Future<List<CatFullCoin>> getCatCoinsByHints(
+    List<Puzzlehash> hints,
+  ) async {
+    final coins = await getCoinsByHints(hints);
+
+    return hydrateCatCoins(coins);
+  }
+
   Future<List<CatFullCoin>> getCatCoinsByHint(
     Puzzlehash hint,
   ) async {

diff --git a/lib/src/api/wallet_connect/service/wallet_client/cold_wallet.dart b/lib/src/api/wallet_connect/service/wallet_client/cold_wallet.dart
@@ -7,7 +7,7 @@ class ColdWallet implements Wallet {
   });
 
   @override
-  final EnhancedChiaFullNodeInterface fullNode;
+  final ChiaFullNodeInterface fullNode;
   final WalletKeychain keychain;
 
   @override