Lightnet sub-commands implementation (start/stop/status). #510
Conversation
shimkiv
requested review from
nicc,
ymekuria,
MartinMinkov,
barriebyron,
garwalsh,
mitschabaude and
Trivo25
|
I have forgotten to check it on Windows and of course there are some issues. It should not impact review process though. Apologies for inconvenience. |
Co-authored-by: Barrie Byron <[email protected]>
Co-authored-by: Barrie Byron <[email protected]>
Seems to be false alarm and the issue was caused by Docker Engine not being started. I'll add additional check. |
src/bin/index.js
Outdated
| hidden: false, | ||
| choices: Constants.lightnetProofLevels, | ||
| default: 'none', | ||
| description: '"none" value will make the network faster.', |
There was a problem hiding this comment.
@shimkiv what is the disadvantage of none proof-level? none is default, but does not test other proofs, right? maybe more description to help user choose the appropriate proof level?
There was a problem hiding this comment.
It is the protocol configuration. One of the expensive parts of the protocol is creating blockchain snark proofs, so mocking that is important for faster everything. The proof_level Mina constant can be used to disable proving (set it to be check) or disable block calculation altogether (set it to none). None is default because for zkApps development with o1js we don't really care about protocol proofs, assuming that it is well tested. Sometimes though one might want to run zkApps against network that has closer to "real world" properties (say, some of the Nightly CI tests). That is when zk lightnet start --mode multi-node --type real --proof-level full might be useful.
| hidden: false, | ||
| default: true, | ||
| description: | ||
| 'Whether to pull the latest version of the Docker image from the Docker Hub.', |
There was a problem hiding this comment.
@shimkiv advantages and disadvantages? default is true, so when would we want to use false?
There was a problem hiding this comment.
Docker images are updated each night and pulling the new image will takes resources and time should you start the network next day from scratch. It is useful to set false when you develop/test zkapp functionality using same version of o1js and Mina dependencies. The reason it is not set to false by default is because I was thinking to encourage people always use "latest and greatest" but not sure already.
| hidden: false, | ||
| default: true, | ||
| description: | ||
| 'Whether to save the Docker container processes logs to the host file system.', |
There was a problem hiding this comment.
default is true, what happens if false? where else would Docker container processes logs be saved? (or not saved at all?)
There was a problem hiding this comment.
zk lightnet stop- saves logs from container to host file-system, stops and removes the container.zk lightnet stop --no-save-logs- stops and removes the container, logs produced by different apps inside the container are gone. Useful for short lived networks when users will just check something zkapp related and don't care about logs.zk lightnet stop --no-save-logs --no-clean-up- stops the container, it is not removed so container still can be accessible by users in order to get logs manually.
Ah, so Windows does work? Even the logs store mechanism? I'm surprised since it's using non friendly windows seperators in paths 😅 |
… lightnet-start-stop-status
Co-authored-by: Barrie Byron <[email protected]>
Corresponding RFC implementation with slightly extended API.
FYI:
booleanoptions with default value oftruecan be negated by adding--no-prefix.For example:
--archiveoption ofzk lightnet startsub-command istrueby default. And to set it tofalseyou can dozk lightnet start --no-archive.Tests will be added later as part of the work on #509.
Closes #500