Document offline mode #1414
Document offline mode #1414
Conversation
| @@ -0,0 +1,9 @@ | |||
| Hydra supports an offline mode, which allows for disabling the Layer 1 interface (that is, the underlying Cardano blockchain which Hydra heads use to seed funds and ultimately funds are withdrawn to). Disabling Layer 1 interactions allows use-cases which would otherwise require running and configuring an entire Layer 1 private devnet. | |||
There was a problem hiding this comment.
can u mention some use-cases?
| @@ -0,0 +1,9 @@ | |||
| Hydra supports an offline mode, which allows for disabling the Layer 1 interface (that is, the underlying Cardano blockchain which Hydra heads use to seed funds and ultimately funds are withdrawn to). Disabling Layer 1 interactions allows use-cases which would otherwise require running and configuring an entire Layer 1 private devnet. | |||
|
|
|||
| In this offline mode, only the Layer 2 ledger is run. Therefore, ledger genesis parameters that normally influence things like time-based transaction validation, may be set to defaults that aren't reflective of mainnet. To set this, set --ledger-protocol-parameters to a non-zero file. TODO: show how to obtain this. | |||
There was a problem hiding this comment.
Would be great to resolve the TODO
There was a problem hiding this comment.
I think u not only have the l2 ledger but also:
- networking stack
- persistence
Would be really good to explain why did we maintain these 2 layers.
At the same time I would like to know:
"how fast an offline head runs and how many tx am I able process per unit of time."
There was a problem hiding this comment.
To resolve the TODO i think we can link to https://hydra.family/head-protocol/unstable/docs/configuration/#ledger-parameters
There was a problem hiding this comment.
We don't have those metrics yet but we'll obtain them soon and add them in
There was a problem hiding this comment.
additionally, when #1413 is merged, I think it'll be good to mention here, wrt additional flexibility in changing how persistence works
There was a problem hiding this comment.
would it be possible to add benchmarking info in a later PR or should it be done in order to get this merged?
ffakenz
force-pushed
the
document-offline-mode
branch
from
ea79cc7 to
5817f23
Compare
|
Would be great to add this section to https://hydra.family/head-protocol/unstable/docs/configuration#offline-mode |
ffakenz
force-pushed
the
document-offline-mode
branch
from
b6751b7 to
36fd70e
Compare
ch1bo
force-pushed
the
document-offline-mode
branch
from
e19a73e to
3a7b50f
Compare
Document the newly introduced Ledger-only offline-mode for Hydra, and improve error messages when it's misconfigured