mirror of https://github.com/zcash/simtfl.git
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# Trailing Finality Layer Simulator
|
|
|
|
This is an experimental simulator for research into a potential
|
|
[Trailing Finality Layer](https://electriccoin.co/blog/the-trailing-finality-layer-a-stepping-stone-to-proof-of-stake-in-zcash/)
|
|
for Zcash.
|
|
|
|
Note the caveats: *experimental*, *simulator*, *research*, *potential*.
|
|
|
|
## Instructions
|
|
|
|
1. Install `poetry`:
|
|
|
|
sudo apt install python3-poetry
|
|
|
|
or see [poetry's installation docs](https://python-poetry.org/docs/)
|
|
if not on Debian/Ubuntu.
|
|
|
|
2. Install dependencies:
|
|
|
|
poetry install
|
|
|
|
3. Run the demo (currently just an example of message passing):
|
|
|
|
poetry run demo
|
|
|
|
## Documentation
|
|
|
|
Design documentation is under the `doc/` directory:
|
|
|
|
* [Programming patterns for use of simpy and type annotations](doc/patterns.md).
|
|
|
|
You can also generate API documentation by running `./gendoc.sh`. This assumes
|
|
that you have run `poetry install` as shown above. The starting point for the
|
|
generated documentation is <apidoc/simtfl.html>.
|
|
|
|
## Contributing
|
|
|
|
Please use `./check.sh` before submitting a PR. This currently runs `flake8`,
|
|
`pyanalyze`, and the unit tests locally.
|
|
|
|
You can use `./check.sh -k <substring>` to run `flake8`, `pyanalyze`, and then
|
|
only tests with names matching the given substring. This will not suppress
|
|
output to stdout or stderr (but `./check.sh -bk <substring>` will).
|
|
|
|
To see other options for running unit tests, use `poetry run python -m unittest -h`.
|
|
|
|
## License
|
|
|
|
This software is provided under the terms of the [MIT License](LICENSE).
|