* Add instructions for mining with s-nomp to Zebra book
* Update book/src/SUMMARY.md
nest under mining
Co-authored-by: Arya <aryasolhi@gmail.com>
* Fixes from review
---------
Co-authored-by: Arya <aryasolhi@gmail.com>
* add mining section to the zebra book
* Apply suggestions from code review
Co-authored-by: teor <teor@riseup.net>
* add more suggestions from review
---------
Co-authored-by: teor <teor@riseup.net>
* Update audit scope based on audit-v1.0.0-rc.0 branch
* Minor wording fixes and clarifications
Co-authored-by: Arya <aryasolhi@gmail.com>
* Set scope for `reddsa` and explain code movement
* Just base everything on rc.0
* I'm just about to make it into a tag, not a branch
* Make it clearer that the Crates categories are Zebra crates
* Add reddsa and redjubjub
Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
* Fix links to red(jubjub|dsa) signing_key
* Add missing space
* Remove `redjubjub` from "Out of scope"
* Fix formatting
* Make previous audit clearer
* Add missing space
Co-authored-by: Arya <aryasolhi@gmail.com>
---------
Co-authored-by: Arya <aryasolhi@gmail.com>
Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
* bump v1.0.0-rc.4
* Add new mainnet and testnet checkpoints generated using zcashd
* make changes to changelog from review
* move item to new section
* change section name
---------
Co-authored-by: teor <teor@riseup.net>
* make `zebra-checkpoint` util work with zebra as the backend
* update snapshots
* update documentation
* applies suggestions from code review
* irefactor zebra-checkpoints to work with zebra using deserialization of the raw block
* fix imports and derives
* rename mode to backend
* remove old stuff
* fix docs
Co-authored-by: arya2 <aryasolhi@gmail.com>
* Updates design overview page of book with:
- a simplified graph of service dependencies in design overview
- links to notable blog posts
- removals of some out-of-date text
also corrects issue/pr refs in an rfc
* Updates service dependencies diagram
* Apply suggestions from code review
Co-authored-by: teor <teor@riseup.net>
* updates diagram and adds doc links
* uses opacity to indicate clickability instead of drop shadow
Co-authored-by: teor <teor@riseup.net>
* Changelog with trivial entries
* Delete trivial entries
* Summarise known issues in README, but don't change the list yet
* Add block timeouts to known issues
* Update the release template to add missing version files
* Bump crate versions
* Add the required Rust version to the release checklist
* Update the Rust version requirement to 1.65, Zebra now uses `let ... else ...`
* Update checkpoints
* Add checkpoints to the CHANGELOG
* Breaking Rust compiler version change
* Clarify the latest stable supported rust version
* Clean up references to fpe that were not removed when we removed orchard code
* Update Cargo.lock
Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Fix the branch name in the release template
* Use a docker command with colour and Ctrl-C support
* Make branch name example more readable
* Fix a link typo
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* add a list of dependencies for auditors
* change intro
Co-authored-by: teor <teor@riseup.net>
* add zebra-checkpoints to audit
* replace colors in the legend as they don't render in github
* make crypto deps out of the scope
* add a reason to keep rocksdb out of the scope
* add a not of why chrono is out of the scope
* add note for bitvec dep
* move structopt to out of scope
* add zcash_script as partially in scope
* applies suggestion, updates versions, bolds ed25519-zebra
* adds zcash_proofs audit notes
* Splits list of zebra deps into sections for full audits, partial audits, and out of scope.
* Update book/src/dev/zebra-dependencies-for-audit.md
Co-authored-by: teor <teor@riseup.net>
* Update book/src/dev/zebra-dependencies-for-audit.md
* Add missing newline
* Update book/src/dev/zebra-dependencies-for-audit.md
Co-authored-by: teor <teor@riseup.net>
* updates crate versions
* Update zcash_script to 0.1.8
* Only link to the audit version of each crate or file
* Clarify out of scope versions
* Fix source paths
* Fix zcash_script paths
* Improve formatting
* Update zebra-dependencies-for-audit.md
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: arya2 <aryasolhi@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* docs: add user documentation on how to use Zebra with docker
Motivation:
We don't have a user documentation on how to use/deploy Zebra using our
the Dockerfile available in our repository or were the images are being
hosted
Solution:
Add user documentation explaining how to pull the image from the Docker
Hub or how to build it locally. With extra information on which images
we're hosting and where we're hosting it
* docs(docker): use existing getting started header
* Update book/src/user/docker.md
Co-authored-by: Arya <aryasolhi@gmail.com>
* docs(docker): add build alternative instructions from Docker
* docs: add docker documentation to Rust doc sidebar
* docs: update checklist with docker user documentation
* Update README.md
Co-authored-by: teor <teor@riseup.net>
* Update new refs to rc.1
Co-authored-by: Arya <aryasolhi@gmail.com>
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Document parameter download workaround, particularly for macOS
* Replace outdated build docs with a link to the README
* Remove incorrectly rendered heading links
* Add an initial draft audit process
* Add dependency criteria
* draft
* docs(release): add information on how we tag and release
* docs(release): remove outdated document
* Apply suggestions from code review
Co-authored-by: teor <teor@riseup.net>
* Remove rough draft analysis of alternatives
Co-authored-by: teor <teor@riseup.net>
* Increment Zebra versions
* Initial draft changelog
* Add blog post to the release checklist
* Say "user testing"
Co-authored-by: teor <teor@riseup.net>
* Explain how to find Mergify failures
* Explain how to fix cache errors
* Fix instructions - clear all caches
* Fix which errors need which actions
* Add a newline to appease GitHub markdown renderer
Co-authored-by: Arya <aryasolhi@gmail.com>
Co-authored-by: Arya <aryasolhi@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Try running coverage with Rust 1.63
* Run GitHub Actions tests with Rust 1.63
* Change from stable to 1.63 in the patch file
* Use Rust 1.63 to download Zcash parameters
* Use Rust 1.63 to build Docker zebrad images
* Make Rust 1.63 a supported platform, and make stable temporarily unsupported
* Delete test instances after 3 days
* Use correct delete command, improve shell quoting
* Use sed to provide the correct zone or region
* Fix quoting
* Fix IFS
* Fix IFS for multiple disks
* Document why we can't quote some shell variables
* Document that instances can get deleted
* Fix exact names in deletion docs
* Increase the full sync timeout to 28 hours
And put the timeout constant with the rest of them.
* Update developer documentation for the new constant location
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Fix delete GCP resources commands
* Don't create a GCP credentials file
* Keep the latest 2 images
* Explain time
* Show the names of disks that are being deleted
* Actually run the image delete steps
* Only delete commit-based instance templates
* Document automated deletion
* Explain how to resolve duplicate dependency warnings
* Explain why the errors happen and add the CI job name
* Add extra steps
* Add some examples, tools, and extra steps
* feat(build): deploy long running instances on release
Previous behavior:
Each time we merged to main new nodes would be deployed, this is an
expected behavior as we need to ensure nodes get deployed and run
without issues, but this could also replace nodes very hastily.
Expected behavior:
We want instances which would run for a longer time, to allow us to
troubleshoot issues or inspect the behavior of this instances for longer
periods of time (2+ weeks)
Applied solution:
Deploy a versioned manage instance group (MiG) using the major version
of the release semver. We just use the first part of the version to
replace old instances, and change it when a major version is released
to keep a segregation between new and old versions.
* ci(build): allow v0 as a major version tag
* fix(build): use rust conventions for versioning
* fix(deploy): improve documentation and trigger on release
* Update .github/workflows/continous-delivery.yml
Co-authored-by: teor <teor@riseup.net>
* fix(versioning): typo
* fix(deploy): use `zebrad-v1` as the instance name, with no SHA
* fix(deploy): create and update MiG must use the same name
* docs(deployments): add Continuous Delivery process
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Save cached state on full syncs and updates
* Add an -update suffix to CI images created by updating cached state
* Make disk image names unique by adding a time suffix
* Use the latest image from any branch, but prefer the current commit if available
* Document Zebra's continuous integration tests
* Fix typos in environmental variable names
* Expand documentation
* Fix variable name typo
* Fix shell syntax
* update zebra to 1.0.0-beta.13
* add changelog
* update the release date
* Update changelog for cryptographic batch PRs
* Add `bitvec` to the changelog
* Update CHANGELOG.md
* Add zebra-network fix and tokio version bump
* Recommend that users update their rust compiler
* Update disk and network usage for recent large blocks
* Fix spacing
* Add disk and network usage update to README
* apply size suggestions
Co-authored-by: teor <teor@riseup.net>
* add known performance issues
* update changelog
* change release date
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* docs: include target tier policies
This documentation is based on Rust supported platforms and tiers, and adapted to Zebra
* docs: add supported platforms by Tier
* docs(release): remove references to use RFCs
* docs(release): adapt teams to ZFND reality
* docs(release): remove text that might generate confusion
* docs(release): refactor general wording to our needs
* docs(release): update wording in supported platforms
* docs: clarify we're not having build artifacts for Tier 2
* docs: remove stub requirements
* docs: tidy up
* docs: last fixes
* docs(platforms): improve overall documentation
* docs: remove legal language
* docs: rewording tier 3 summary
* Update book/src/user/supported-platforms.md
Co-authored-by: teor <teor@riseup.net>
* docs: remove reference to core engineering team
* fix(docs): make rust version a separate column
* tiny fix
* If a supported platform isn't pinned to a specific release, link to the latest release
* Add space for readability
* Clarify some phrasing
* Remove Rust-compiler specific language, replace with consensus rules and features
* Update book/src/user/supported-platforms.md
Co-authored-by: teor <teor@riseup.net>
* Update book/src/user/target-tier-policies.md
Co-authored-by: teor <teor@riseup.net>
* Update book/src/user/target-tier-policies.md
Co-authored-by: teor <teor@riseup.net>
* Update book/src/user/target-tier-policies.md
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: teor <teor@riseup.net>
* Rename `block_by_height` to `block_header_by_height` in fin state
* Rename `tx_by_hash` to `tx_loc_by_hash` in both (non & fin) states
* Rename `utxo_by_outpoint` to `utxo_by_out_loc` in finalized state
* Reorder the column families so that they match the docs
* Update `struct Chain` in the RFCs
* Increment `DATABASE_FORMAT_VERSION` to 25
* Remove obsolete docs from `0004-asynchronous-script-verification.md`
* Remove an obsolete `TODO` from `disk_db.rs`
* Delete unused snapshots
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Update Zebra to 1.0.0-beta.12
* Simplify tower-* versioning by updating both to 0.2.27
* Simplify version search and replace by removing an old version from the docs
* Update Cargo.lock
* Add draft changelog as of PR #4693
* Update CHANGELOG to PR #4680