aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuillaume Ballet <gballet@gmail.com>2019-03-20 22:46:36 +0800
committerGuillaume Ballet <gballet@gmail.com>2019-04-08 19:21:22 +0800
commit9b66a8520a285309f44bb949ed7eecd4803c5cdb (patch)
tree9d95492fda2a0787fe8330529b94eb6591f0087c
parente273031dce14f0f490705000cb495398bb825333 (diff)
downloadgo-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar.gz
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar.bz2
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar.lz
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar.xz
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.tar.zst
go-tangerine-9b66a8520a285309f44bb949ed7eecd4803c5cdb.zip
Add some documentation
-rw-r--r--accounts/scwallet/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/accounts/scwallet/README.md b/accounts/scwallet/README.md
new file mode 100644
index 000000000..195603c0e
--- /dev/null
+++ b/accounts/scwallet/README.md
@@ -0,0 +1,30 @@
+# Using the smartcard wallet
+
+## Requirements
+
+ * A USB smartcard reader
+ * A keycard that supports the status app
+
+## Usage
+
+ 1. Start `geth` with the `console` command
+ 2. Check the card's URL by checking `personal.listWallets`:
+
+```
+ listWallets: [{
+ status: "Online, can derive public keys",
+ url: "pcsc://a4d73015"
+ }]
+```
+
+ 3. Open the wallet, you will be prompted for your pairing password, then PIN:
+
+```
+personal.openWallet("pcsc://a4d73015")
+```
+
+ 4. Check that creation was successful by typing e.g. `personal`. Then use it like a regular wallet.
+
+## Known issues
+
+ * Starting geth with a valid card seems to make firefox crash \ No newline at end of file