@@ -20,15 +20,15 @@ It is up to the crate user to send and receive the raw cktap APDU messages via N
2020#### Shared Commands
2121
2222- [x] [ status] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#status )
23- - [x] [ read] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#status ) (messages)
24- - [x] response verification
25- - [x] [ derive] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#derive ) (messages)
23+ - [x] [ read] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#read )
2624 - [x] response verification
25+ - [x] [ derive] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#derive )
26+ - [ ] response verification
2727- [x] [ certs] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#certs )
2828- [x] [ new] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#new )
29- - [x ] [ nfc] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#nfc )
30- - [x] [ sign] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#sign ) (messages)
31- - [ ] response verification
29+ - [ ] [ nfc] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#nfc )
30+ - [x] [ sign] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#sign )
31+ - [x ] response verification
3232- [x] [ wait] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#wait )
3333
3434#### SATSCARD-Only Commands
@@ -39,31 +39,49 @@ It is up to the crate user to send and receive the raw cktap APDU messages via N
3939#### TAPSIGNER-Only Commands
4040
4141- [x] [ change] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#change )
42- - [x ] [ xpub] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#xpub )
42+ - [ ] [ xpub] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#xpub )
4343- [x] [ backup] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/docs/protocol.md#backup )
4444
45- ### Automated Testing with Emulator
45+ ### Automated and CLI Testing with Emulator
46+
47+ #### Prerequisites
4648
47491 . Install dependencies for [ cktap emulator] ( https://github.com/coinkite/coinkite-tap-proto/blob/master/emulator/README.md )
48- 2 . run tests with emulator: ` just test `
50+
51+ #### Run tests with emulator
52+
53+ ```
54+ just test
55+ ```
56+
57+ #### Run CLI with emulated card reader
58+
59+ ```
60+ just start # for SATSCARD emulator
61+ just start -t # for TAPSIGNER emulator
62+ just run_emu --help
63+ just run_emu certs
64+ just run_emu read
65+ just stop # stop emulator
66+ ```
4967
5068### Manual Testing with real cards
5169
5270#### Prerequisites
5371
54- 1 . USB PCSC NFC card reader, for example:
72+ 1 . Get USB PCSC NFC card reader, for example:
5573 - [ OMNIKEY 5022 CL] ( https://www.hidglobal.com/products/omnikey-5022-reader )
56- 2 . Coinkite SATSCARD, TAPSIGNER, or SATSCHIP cards
57- Install vendor PCSC driver
58- 3 . Connect NFC reader to desktop system
59- 4 . Place SATSCARD, TAPSIGNER, or SATSCHIP on reader
74+ 2 . Get Coinkite SATSCARD, TAPSIGNER, or SATSCHIP cards
75+ 3 . Install card reader PCSC driver
76+ 4 . Connect USB PCSC NFC reader to desktop system
77+ 5 . Place SATSCARD, TAPSIGNER, or SATSCHIP on reader
6078
61- #### Run CLI
79+ #### Run CLI with desktop USB PCSC NFC card reader
6280
6381```
64- cargo run -p cktap-cli -- --help
65- cargo run -p cktap-cli -- certs
66- cargo run -p cktap-cli -- read
82+ just run --help
83+ just run certs
84+ just run read
6785```
6886
6987## Minimum Supported Rust Version (MSRV)
0 commit comments