Skip to content

Commit be66404

Browse files
authored
Merge pull request #828 from Chia-Network/add-chia-signer-docs
add chia signer docs
2 parents 87f7523 + aa0b5a6 commit be66404

3 files changed

Lines changed: 142 additions & 9 deletions

File tree

docs/chia-signer/faq.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: FAQ
3+
slug: /chia-signer/faq
4+
---
5+
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
9+
## Chia Signer App: Frequently Asked Questions (FAQ)
10+
11+
### What is the Chia Signer app?
12+
13+
The Chia Signer app is a dedicated mobile application currently available for iOS devices designed to provide an enhanced layer of security for your Chia Wallet transactions. It allows you to securely store your private keys in your phone's Secure Enclave and approve transactions initiated from your Chia Wallet.
14+
15+
### What are the key benefits of using the Chia Signer app?
16+
17+
- **Secure Enclave Protection:** Your private keys are generated and stored within your device's Secure Enclave, a hardware-isolated security component. This means your keys never leave your device and are highly protected against software vulnerabilities.
18+
- **Secure, Device-Based Approval:** The Signer app allows you to securely approve transactions initiated from your Chia Cloud Wallet on a separate, dedicated device.
19+
- **Enhanced Security:** By separating your signing key from your main Chia Cloud Wallet interface (requiring two devices), it adds a significant layer of security against online threats and unauthorized access.
20+
21+
### What are the device requirements for the Chia Signer app?
22+
23+
To use the Chia Signer app, your iOS device must:
24+
25+
- Run **iOS 15 or later**.
26+
- Have a **Secure Enclave** (most iPhone models starting with iPhone 6s and iPad models starting with iPad mini 4 or newer typically have this).
27+
28+
### Can I use the Chia Cloud Wallet and the Chia Signer app on the same device?
29+
30+
Currently, no. For security purposes, you need two separate devices: one for accessing your Chia Cloud Wallet (e.g., a computer or another phone) and a separate iOS device with the Chia Signer app installed. This functionality (using both on the same device) is planned for a future release.
31+
32+
### How do I create a new key within the Chia Signer app?
33+
34+
After opening the app for the first time, you can tap the `+` button, name your key, and select "Generate Key." This will securely generate a new private key within your device's Secure Enclave.
35+
36+
### How do I link my Chia Signer key to a Chia Cloud Wallet vault?
37+
38+
The linking process involves scanning a QR code displayed by your Chia Cloud Wallet using the Signer app. Depending on whether you've already created the key in the Signer app, you can either:
39+
40+
- Tap on your existing key in the Signer app and select "Link Key," then scan the QR code.
41+
- Or, from the Signer app's main screen, tap the scan button, scan the QR code, and then select an existing key or create a new one as prompted.
42+
43+
### How do I sign a transaction using the Chia Signer app?
44+
45+
When you initiate a transaction from your linked Chia Cloud Wallet, the Chia Signer app on your iOS device will receive a request. You will review the transaction details presented on the Signer app's screen and, if correct, tap "Sign transaction." Your device may require a biometric (Face ID/Touch ID) or passcode confirmation to authorize the signing.
46+
47+
### Is an Android version of the Chia Signer app available?
48+
49+
Currently, the Chia Signer app is only available for iOS devices. An Android version is planned for a future release.
50+
51+
### Can the Chia Signer app be used as the Chia Cloud Wallet recovery key?
52+
53+
Currently, the Chia Signer app can only be used as the custody key for your vault but the ability to use it for the recovery key is planned for a future release.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Getting Started
3+
slug: /chia-signer/getting-started
4+
---
5+
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
9+
Welcome to the **Chia Signer app**, your secure companion for interacting with the Chia blockchain. This app provides a robust layer of security by allowing you to sign transactions using the dedicated hardware security of your mobile device, keeping your private keys safe.
10+
11+
This guide will show you how to get started with the Chia Signer app, from setting up your secure key to linking it with your Chia Cloud Wallet and approving transactions.
12+
13+
**Prerequisites:**
14+
15+
- An iOS device (iPhone or iPad) running iOS 15 or later and has the Secure Enclave.
16+
17+
**Key Concepts:**
18+
19+
- **Secure Enclave Protection:** Your private keys are generated and stored in your device's Secure Enclave, a dedicated hardware security module, ensuring they never leave your device.
20+
- **Secure, Device-Based Approval:** The Signer app allows you to securely approve transactions initiated from your Chia Cloud Wallet on a separate, dedicated device.
21+
- **Two-Device Requirement:** Currently, the Chia Cloud Wallet and Chia Signer app must be on separate devices (e.g., Chia Cloud Wallet on your computer/phone, Signer on your iPhone).
22+
23+
## 1. Get the Chia Signer App
24+
25+
- **Download:** The Chia Signer app is available on the [iOS App Store](https://apps.apple.com/app/chia-signer/id6504493785). (Note: An Android version is planned for the future).
26+
27+
## 2. Create a New Key in the Chia Signer App
28+
29+
After installing and opening the app for the first time:
30+
31+
1. **Add Key:** Tap the `+` button, usually located in the upper-right corner of the app's main screen.
32+
2. **Name Your Key:** Enter a descriptive name for your key (e.g., "My Vault Key" or "Main Signer Key").
33+
3. **Generate Key:** Select the option to "Generate Key" (currently, the only option is to create a hardware key directly in your device's Secure Enclave). Tap `Generate Key`. (NOTE: Software key options planned for the future).
34+
- Your device will securely generate and store a new private key within its Secure Enclave.
35+
4. **View Key:** Your newly created key will now appear on the app's main screen.
36+
37+
## 3. Link Your Chia Signer Key to a Chia Cloud Wallet Vault
38+
39+
This step connects your secure key in the Signer app to a specific vault created in the Chia Cloud Wallet.
40+
41+
1. **Initiate Linking (from Chia Cloud Wallet):** On your separate device (where you access your Chia Cloud Wallet), you will begin the process of creating or linking a vault as described [here](/cloud-wallet/getting-started). The Chia Cloud Wallet will display a **QR Code**.
42+
43+
2. **Link Key from Chia Signer App:**
44+
There are two primary methods to link a key, depending on whether you've already created the key in the Signer app or are linking for the first time:
45+
- **Method A: Linking an Existing Key (Key selected in Step 2)**
46+
1. Open the Chia Signer app and ensure your existing key is visible on the main screen.
47+
2. Tap on the specific key you wish to link.
48+
3. Locate and tap the "Link Key" button (this will activate your device's camera).
49+
4. Use your device's camera to scan the QR code displayed by your Chia Cloud Wallet.
50+
51+
- **Method B: Linking and/or Creating a Key via Main Screen Scan**
52+
1. From the Chia Signer app's main screen, tap the scan button (often located in the lower-middle part of the screen, resembling a QR code scanner icon). This will activate your device's camera.
53+
2. Use your device's camera to scan the QR code displayed by your Chia Cloud Wallet.
54+
3. After scanning, the app will prompt you to "Choose a key."
55+
- If you have existing keys, select the one you wish to link.
56+
- If you need to create a new key, select Generate Key and follow the steps to name and create your key.
57+
58+
3. **Confirm Link:**
59+
- Regardless of the method used, after selecting or creating your key, confirm the link. Tap the `Link key` button (if not already pressed).
60+
- The Signer app will communicate with the Chia Cloud Wallet to establish the secure link.
61+
- If successful, you will typically see a confirmation, such as a green checkmark, on both the Signer app and the Chia Cloud Wallet interface.
62+
63+
## 4. Sign Transactions with the Chia Signer App
64+
65+
Once linked, your Signer app becomes the gatekeeper for all transactions from that specific Chia Cloud Wallet vault.
66+
67+
1. **Initiate Transaction (from Chia Cloud Wallet):** When you want to send funds or perform other actions from your Chia Cloud Wallet, you will set up the transaction details in the Chia Cloud Wallet interface and click "Send" or confirm the action.
68+
2. **Receive Signing Request (on Chia Signer App):** The Chia Signer app will automatically receive a transaction signing request. You will see a notification or the app will open, displaying the transaction details.
69+
3. **Review Details:** **Carefully review all the transaction details** shown on your Chia Signer app screen (e.g., recipient address, amount, fee). This is your last chance to verify the transaction before it is sent.
70+
4. **Sign Transaction:** If the details are correct, scroll down and tap the `Sign transaction` button within the Chia Signer app.
71+
- Your device may require a biometric (Face ID/Touch ID) or passcode confirmation to authorize the signing.
72+
5. **Confirmation:** Once signed, the transaction is sent to the Chia network via your Chia Cloud Wallet, and you should see a confirmation message on both the Signer app and the Chia Cloud Wallet.

sidebars.js

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -163,15 +163,23 @@ module.exports = {
163163
],
164164
},
165165
{
166-
type: 'category',
167-
label: 'Chia Cloud Wallet',
168-
items: [
169-
'cloud-wallet/getting-started',
170-
'cloud-wallet/faq',
171-
'cloud-wallet/known-issues',
172-
'cloud-wallet/tooltips',
173-
]
174-
},
166+
type: 'category',
167+
label: 'Chia Cloud Wallet',
168+
items: [
169+
'cloud-wallet/getting-started',
170+
'cloud-wallet/faq',
171+
'cloud-wallet/known-issues',
172+
'cloud-wallet/tooltips',
173+
]
174+
},
175+
{
176+
type: 'category',
177+
label: 'Chia Signer App',
178+
items: [
179+
'chia-signer/getting-started',
180+
'chia-signer/faq',
181+
]
182+
},
175183
{
176184
type: 'category',
177185
label: 'Chia Reference Client',

0 commit comments

Comments
 (0)