Skip to content

Commit 61aac69

Browse files
committed
update README.md with instructions on how to use the solo mining mode
1 parent d4d823c commit 61aac69

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

pool-apps/pool/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,26 @@ Run the Pool (example using hosted Sv2 TP):
8484
```bash
8585
cd pool-apps/pool
8686
cargo run -- -c config-examples/pool-config-hosted-sv2-tp-example.toml
87-
```
87+
```
88+
89+
## Solo Mining Mode
90+
91+
The solo mining mode is computed during runtime and expects that the user_identity value to be crafted in specific patterns.
92+
Enable solo mining by adding to your config. If the `user_identity` any of the patterns, the pool continues with the payout to the pool. If the `user_identity` matches the magic bytes: `sri` but the pattern is malformed we send a `OpenMiningChannelError`.
93+
### User Identity Patterns
94+
95+
Miners must specify their payout mode via `user_identity`:
96+
97+
| Pattern | Mode | Description |
98+
|---------|------|-------------|
99+
| `sri/donate/worker_name` | Pool | Full reward goes to pool |
100+
| `sri/solo/payout_address/worker_name` | Solo | Full reward goes to miner's address |
101+
| `bc1qtzqxqaxyy6lda2fhdtp5dp0v56vlf6g0tljy2x` | Solo | Full reward goes to miner's address |
102+
| `sri/donate/percentage/payout_address/worker_name` | Donate | Pool gets %, miner gets remainder |
103+
104+
### Error Scenarios
105+
106+
| Error Code | Cause |
107+
|------------|-------|
108+
| `invalid-user-identity` | Pattern doesn't match expected format |
109+

0 commit comments

Comments
 (0)