Skip to content

Commit e167a04

Browse files
committed
fix broken urls
1 parent 2a849ed commit e167a04

2 files changed

Lines changed: 13 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
> Kora is pre-alpha software. Do not expect this to run. Do not run this in production.
2727
2828
> [!IMPORTANT]
29-
> Kora uses BLS12-381 threshold consensus via [commonware](https://github.com/commonwarexyz/monorepo), [REVM](https://github.com/bluealloy/revm) for EVM execution, and [QMDB](https://github.com/kora-labs/qmdb) for state storage.
29+
> Kora uses BLS12-381 threshold consensus via [commonware](https://github.com/commonwarexyz/monorepo), [REVM](https://github.com/bluealloy/revm) for EVM execution, and [QMDB](https://github.com/commonwarexyz/monorepo/tree/main/storage) for state storage.
3030
3131
## What's Kora?
3232

‎bin/kora/README.md‎

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,35 @@ The main Kora node binary. Implements BLS12-381 threshold consensus via [commonw
77

88
[commonware]: https://github.com/commonwarexyz/monorepo
99
[revm]: https://github.com/bluealloy/revm
10-
[QMDB]: https://github.com/LayerZero-Labs/qmdb
10+
[QMDB]: https://github.com/commonwarexyz/monorepo/tree/main/storage
1111

1212
## Usage
1313

14-
### Running the Devnet
14+
Start the devnet with interactive DKG (Distributed Key Generation):
1515

1616
```bash
1717
just devnet
1818
```
1919

20-
### CLI Options
20+
Run with a custom configuration file:
2121

2222
```bash
23-
# Run with default configuration (legacy mode)
24-
kora
25-
26-
# Run with a custom configuration file
2723
kora --config /path/to/config.toml
24+
```
2825

29-
# Run with CLI overrides
30-
kora --chain-id 1 --data-dir /path/to/data
26+
Run the DKG ceremony:
3127

32-
# Run DKG ceremony
28+
```bash
3329
kora dkg --peers peers.json
34-
35-
# Run as validator (requires completed DKG)
36-
kora validator --peers peers.json
3730
```
3831

39-
| Flag | Description |
40-
|------|-------------|
41-
| `-c, --config <FILE>` | Path to TOML configuration file |
42-
| `--chain-id <ID>` | Override the chain ID |
43-
| `--data-dir <PATH>` | Override the data directory |
44-
| `-v, --verbose` | Enable verbose logging |
32+
Run as a validator (requires completed DKG):
4533

46-
### Environment Variables
34+
```bash
35+
kora validator --peers peers.json
36+
```
4737

48-
| Variable | Description |
49-
|----------|-------------|
50-
| `RUST_LOG` | Controls log level (e.g., `info`, `debug`, `kora=trace`) |
38+
The `--chain-id` and `--data-dir` flags can override configuration values. Set `RUST_LOG` to control log level (e.g., `info`, `debug`, `kora=trace`).
5139

5240
## Configuration
5341

@@ -62,11 +50,6 @@ listen_addr = "0.0.0.0:9000"
6250
bootstrap_peers = []
6351
```
6452

65-
## Related Crates
66-
67-
- [`kora-service`](../../crates/node/service) - Node service orchestration
68-
- [`kora-config`](../../crates/node/config) - Configuration types and loading
69-
7053
## License
7154

72-
[MIT License](https://opensource.org/licenses/MIT)
55+
This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.

0 commit comments

Comments
 (0)