diff --git a/README.md b/README.md index 09942542..892c2272 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,21 @@ $ npm install $ npm start # Follow the instructions on screen to build to your device or a simulator ``` +To configure the demo passkey wallet you'll need the following: +* A Turnkey organization ID: you can create one by following our [quickstart guide](https://docs.turnkey.com/getting-started/quickstart). +* 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 +* Turnkey's base URL: you can leave the default of `https://api.turnkey.com`. +* 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". +* An account on [Infura](https://www.infura.io/) and [Etherscan](https://etherscan.io/) + +You'll provide this information on first app start in the settings screen: + +Wallet settings + +Upon clicking "Save" the settings are saved in your phone's keychain and you should see your wallet address and ETH balance: + + Wallet home + ## Technical tl;dr 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 diff --git a/screenshots/wallet_home.png b/screenshots/wallet_home.png new file mode 100644 index 00000000..5fe21da6 Binary files /dev/null and b/screenshots/wallet_home.png differ diff --git a/screenshots/wallet_settings.png b/screenshots/wallet_settings.png new file mode 100644 index 00000000..325443e9 Binary files /dev/null and b/screenshots/wallet_settings.png differ