You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pool-apps/pool/README.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,4 +84,26 @@ Run the Pool (example using hosted Sv2 TP):
84
84
```bash
85
85
cd pool-apps/pool
86
86
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 |
0 commit comments