Skip to content

Commit ae48ac7

Browse files
authored
readme: add screenshot and functionality
1 parent 3aab1e2 commit ae48ac7

File tree

3 files changed

+35
-3
lines changed

3 files changed

+35
-3
lines changed

BDKSwiftExampleWallet/Service/BDK Service/BDKService.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ private class BDKService {
8080
changeDescriptor: changeDescriptor.asStringPrivate()
8181
)
8282
try keyService.saveBackupInfo(backupInfo)
83-
let wallet = try Wallet.init(
83+
let wallet = try Wallet(
8484
descriptor: descriptor,
8585
changeDescriptor: changeDescriptor,
8686
network: network,
@@ -90,7 +90,7 @@ private class BDKService {
9090
}
9191

9292
private func loadWallet(descriptor: Descriptor, changeDescriptor: Descriptor) throws {
93-
let wallet = try Wallet.init(
93+
let wallet = try Wallet(
9494
descriptor: descriptor,
9595
changeDescriptor: changeDescriptor,
9696
network: network,

Docs/bitcoin-screen.png

251 KB
Loading

README.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
# BDKSwiftExampleWallet
2-
This is a Work in Progress.
32

43
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/reez/BDKSwiftExampleWallet/blob/main/LICENSE)
54

5+
An example iOS app using [BDK](https://github.com/bitcoindevkit)
6+
7+
<img src="Docs/bitcoin-screen.png" alt="Screenshot" width="236" height="511">
8+
9+
## Functionality
10+
11+
*This is an experimental work in progress.*
12+
13+
### Wallet
14+
15+
Supports single key HD segwit/bech32 wallets with BIP84 derivation paths.
16+
17+
`wpkh([extended private key]/84'/1'/0'/0/*)`
18+
19+
### Implemented
20+
21+
- [x] Create Wallet `Wallet(descriptor: changeDescriptor: network: databaseConfig:)`
22+
23+
- [x] Get Address `getAddress`
24+
25+
- [x] Get Balance `getBalance`
26+
27+
- [x] List Transactions `listTransactions`
28+
29+
- [x] Send `send`
30+
31+
- [x] Sync `sync`
32+
33+
## Swift Packages
34+
35+
- [BDK Swift](https://github.com/bitcoindevkit/bdk-swift)
36+
37+
- [BitcoinUI](https://github.com/reez/BitcoinUI)

0 commit comments

Comments
 (0)