Skip to content

Commit 14f7e55

Browse files
committed
Add setup instructions and screenshots to README
1 parent 9feaaee commit 14f7e55

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ $ npm install
2222
$ npm start # Follow the instructions on screen to build to your device or a simulator
2323
```
2424

25+
To configure the demo passkey wallet you'll need the following:
26+
* A Turnkey organization ID: you can create one by following our [quickstart guide](https://docs.turnkey.com/getting-started/quickstart).
27+
* A new Turnkey API key (public/private key pair). You can generate one using [our CLI](https://github.com/tkhq/tkcli), or through the Turnkey dashboard dashboard
28+
* Turnkey's base URL: you can leave the default of `https://api.turnkey.com`.
29+
* A new Turnkey private key ID: head to "Private Keys" in your Turnkey dashboard and create a new one ("Create private key"). The "Curve type" should be "SECP256K1", and the "Asset address type" should be "ETHEREUM".
30+
* An account on [Infura](https://www.infura.io/) and [Etherscan](https://etherscan.io/)
31+
32+
You'll provide this information on first app start in the settings screen:
33+
34+
<img src="screenshots/wallet_settings.png" alt="Wallet settings" width="300px" />
35+
36+
Upon clicking "Save" the settings are saved in your phone's keychain and you should see your wallet address and ETH balance:
37+
38+
<img src="screenshots/wallet_home.png" alt="Wallet home" width="300px" />
39+
2540
## Technical tl;dr
2641

2742
Turnkey API keys and other credentials are encrypted and stored in your phone's Keychain: https://github.com/tkhq/demo-consumer-wallet/blob/e479ed7c0db8037e36166c6e2464ceb3d38bd848/src/turnkey/CredentialsContext.tsx#L111

screenshots/wallet_home.png

132 KB
Loading

screenshots/wallet_settings.png

160 KB
Loading

0 commit comments

Comments
 (0)