Skip to content

Commit 33f4f1a

Browse files
committed
Update readme
1 parent 8538324 commit 33f4f1a

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,22 @@ Make sure to set `RUST_LOG=INFO` to enable logs from tracing:
2929
RUST_LOG=INFO cargo run -- run \
3030
--pythnet-url wss://api2.pythnet.pyth.network \
3131
--server-url https://quorum.pyth.network \
32-
--secret-key /path/to/secret.key \
32+
--signer-uri file:///path/to/secret.key \
3333
--wormhole-pid H3fxXJ86ADW2PNuDDmZJg6mzTtPxkYCpNuQUTgmJ7AjU
3434
```
3535

36+
**Note on `--signer-uri`:**
37+
This argument specifies the signer backend and is compatible with the formats supported by the [Wormhole Guardian Signer](https://github.com/wormhole-foundation/wormhole/blob/main/docs/guardian_signer.md).
38+
39+
**Supported schemes:**
40+
- `file://<path-to-file>` — Load an **armored OpenPGP secp256k1 private key** from a file.
41+
- `amazonkms://<key-id-or-arn>` — Use a key stored in AWS KMS. The key must support `ECDSA_SHA_256` and use the `ECC_SECG_P256K1` curve.
42+
43+
**Example using AWS KMS:**
44+
```bash
45+
--signer-uri amazonkms://arn:aws:kms:us-west-2:123456789012:key/abcde-1234-5678
46+
```
47+
3648
---
3749

3850
### 🌱 Environment Variables (Optional)
@@ -42,7 +54,7 @@ Instead of CLI flags, you can also set environment variables:
4254
```bash
4355
export PYTHNET_URL=wss://api2.pythnet.pyth.network
4456
export SERVER_URL=https://quorum.pyth.network
45-
export SECRET_KEY=/path/to/secret.key
57+
export SIGNER_URI=file:///path/to/secret.key
4658
export WORMHOLE_PID=H3fxXJ86ADW2PNuDDmZJg6mzTtPxkYCpNuQUTgmJ7AjU
4759
export RUST_LOG=INFO
4860

@@ -53,7 +65,7 @@ cargo run
5365

5466
### 🔑 Generate a Secret Key
5567

56-
To generate a new secp256k1 secret key and write it to a file:
68+
To generate a new **armored OpenPGP secp256k1 secret key** and write it to a file:
5769

5870
```bash
5971
RUST_LOG=INFO cargo run -- generate-key --output-file .secret

0 commit comments

Comments
 (0)