Skip to content

Commit 218c9db

Browse files
committed
Update readme
1 parent 1d0a657 commit 218c9db

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,23 @@ RUST_LOG=INFO cargo run -- run \
3131
--server-url https://quorum-1.pyth.network \
3232
--server-url https://quorum-2.pyth.network \
3333
--server-url https://quorum-3.pyth.network \
34-
--secret-key /path/to/secret.key \
34+
--signer-uri file:///path/to/secret.key \
3535
--wormhole-pid H3fxXJ86ADW2PNuDDmZJg6mzTtPxkYCpNuQUTgmJ7AjU
3636
```
3737

3838
You can specify multiple `--server-url` flags to broadcast observations to more than one server.
3939

40+
**Note on `--signer-uri`:**
41+
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).
42+
43+
**Supported schemes:**
44+
- `file://<path-to-file>` — Load an **armored OpenPGP secp256k1 private key** from a file.
45+
- `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.
46+
47+
**Example using AWS KMS:**
48+
```bash
49+
--signer-uri amazonkms://arn:aws:kms:us-west-2:123456789012:key/abcde-1234-5678
50+
```
4051

4152
---
4253

@@ -47,7 +58,7 @@ Instead of CLI flags, you can also set environment variables:
4758
```bash
4859
export PYTHNET_URL=wss://api2.pythnet.pyth.network
4960
export SERVER_URL=https://quorum-1.pyth.network,https://quorum-2.pyth.network,https://quorum-3.pyth.network
50-
export SECRET_KEY=/path/to/secret.key
61+
export SIGNER_URI=file:///path/to/secret.key
5162
export WORMHOLE_PID=H3fxXJ86ADW2PNuDDmZJg6mzTtPxkYCpNuQUTgmJ7AjU
5263
export RUST_LOG=INFO
5364

@@ -60,7 +71,7 @@ You can provide multiple server URLs in the `SERVER_URL` environment variable by
6071

6172
### 🔑 Generate a Secret Key
6273

63-
To generate a new secp256k1 secret key and write it to a file:
74+
To generate a new **armored OpenPGP secp256k1 secret key** and write it to a file:
6475

6576
```bash
6677
RUST_LOG=INFO cargo run -- generate-key --output-file .secret

0 commit comments

Comments
 (0)