Commit Graph

321 Commits

Author SHA1 Message Date
Arya 839cbaba13 Merge remote-tracking branch 'origin/main' into index-tx-loc-by-spent-out-loc 2024-12-12 20:17:17 -05:00
Arya 179aaa4c4f
Release v2.1.0 (#9072)
* Updates changelog, crate versions, end of support height, and docs.

* Update CHANGELOG.md

Co-authored-by: Conrado Gouvea <conrado@zfnd.org>

---------

Co-authored-by: Conrado Gouvea <conrado@zfnd.org>
2024-12-06 18:28:56 +00:00
Arya 1ebb1a5c1a updates db column families table 2024-11-22 14:51:26 -05:00
Arya 22c92899d5 Updates Zebra book with the latest changes to the rocks db column families 2024-11-22 14:51:26 -05:00
Alfredo Garcia 4f0746a613
fix links in release templates (#9050) 2024-11-22 12:15:06 +00:00
Cypher Pepe 7d37f77059
fix: typos correction docs (#9014)
* typo 0005-treestate.md

* typo xxxx-block-subsidy.md

* typo continuous-delivery.md

* typo docker.md

* typo shielded-scan.md
2024-11-14 13:15:26 +00:00
pinglanlu 987a34a6e0
chore: remove redundant words in comment (#9015)
Signed-off-by: pinglanlu <pinglanlu@outlook.com>
2024-11-14 13:15:21 +00:00
Conrado Gouvea 54fe39a91b
book: add section about private testnet testing (#8937)
* book: add section about private testnet testing

* Apply suggestions from code review

Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

---------

Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com>
Co-authored-by: Arya <aryasolhi@gmail.com>
2024-10-30 19:14:44 +00:00
Marek fef500a728
chore: Release v2.0.1 (#8979)
* Run `cargo update`

* chore: Release

* Update `release-crates-dry-run.sh`

* Update `ESTIMATED_RELEASE_HEIGHT`

* Update `CHANGELOG.md`

* Update `ESTIMATED_RELEASE_HEIGHT`
2024-10-30 11:41:41 -03:00
Marek f45f6f282c
chore: Release v2.0.0 (#8974)
* Update `CHANGELOG.md`

* Update EOS

* Update CHANGELOG.md

Co-authored-by: Arya <aryasolhi@gmail.com>

* Update `release crates` script

* chore: Release

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-10-25 22:52:19 +00:00
Alfredo Garcia 8f887f2ed4
fix(docs): Update documents for cookie auth where needed (#8965)
* update documentation related auth cookie method for rpcs in the zebra book

* Update book/src/user/lightwalletd.md

* update rpc auth statement

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-10-25 16:13:01 +00:00
Marek 4097bdb364
chore: Update docs (#8970)
* Update badges

* Simplify Zebra's description

* Change "Building Zebra" to "Manual Build"

* Update "Known Issues"

* Fix a typo
2024-10-25 14:56:12 +00:00
Marek f2427d62e6
add(docs): Add minimal hardware requirements (#8822)
* clean-up: Remove outdated note

* Add minimal hardware requirements

Source & credit: https://x.com/Zerodartz/status/1811460885996798159

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com>
2024-09-03 13:43:51 +00:00
Arya 8b1be8846e
chore: Release v1.9.0 (#8734)
* Updates `EOS_PANIC_AFTER` end of support constant from 16 weeks to 14 weeks, so the Mainnet panic height is just before the second halving and end of the current dev fund.

* version bumps

* Updates CHANGELOG.md

* Updates changelog

* updates end of support time to 10 weeks

* Adds a note to the changelog about recovering after finalizing blocks from a fork

* Add new changes on main to CHANGELOG.md

* Updates ESTIMATED_RELEASE_HEIGHT

* Apply suggestions from code review

Co-authored-by: Conrado Gouvea <conrado@zfnd.org>

* Update zebrad/src/components/sync/end_of_support.rs

---------

Co-authored-by: Conrado Gouvea <conrado@zfnd.org>
2024-08-28 01:07:37 +00:00
Alfredo Garcia cccf98bbfa
fix sample configurations in the custom testnet book documentation (#8794) 2024-08-21 21:11:54 +00:00
ying tong c3334cec5b
Update lightwalletd.md (#8714) 2024-07-23 12:34:37 +00:00
Conrado Gouvea 4cbf442f91
config, docs: update hardcoded users (#8710) 2024-07-22 17:00:32 +00:00
Conrado Gouvea bbb710f24c
config, docs: update hardcoded users (#8703) 2024-07-19 21:43:09 +00:00
Alfredo Garcia 61746f2095
docs(blockchain-scanner): Update documentation for the new `zebra-scanner` binary (#8675)
* validate zebrad cache dir

* update scanner documentation

* clippy

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

* add info level by default to scanner application

* remove `RUST_LOG=info` from some of the test examples on how to run

* remove `RUST_LOG=info` from the book sample

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-07-16 23:35:02 +00:00
Marek 0d8b10b95f
chore: Release v1.8.0 (#8655)
* Update `CHANGELOG.md`

* chore: Release

* Update versions in the release dry-run workflow

* Update EOS

* Estimate release height to ~ upcoming Tuesday

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

* Add a "Summary" title to the changelog

* Remove the summary title

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-07-02 16:46:49 +00:00
Marek 5ff2563542
Refactor `README.md` and docs (#8654)
* Move "Known Issues" from README to the book

* Remove an old note from the book

* Move optional configs & features to the book

* Fix TOC in `README.md`

* Refactor the section on installing Zebra

* Fix badges in `README.md`

* Mention optional features and troubleshooting
2024-06-29 00:11:06 +00:00
Arya 979ed0d720
add(book): Describes custom Testnets in the Zebra book (#8636)
* Adds documention to the Zebra book about custom Testnets, allows for configuring custom Testnet genesis hashes, refactors check for compatible custom Testnets, adds a TODO, and uses the default testnet when there's an empty or default `testnet_parameters` field in Zebra's network config.

* Adds example configs to custom Testnet docs, moves note about inbound connections on Regtest to a footnote.

* Adds a changelog entry

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

* Addresses suggestions from code review.

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

* Update book/src/user/custom-testnets.md

---------

Co-authored-by: Marek <mail@marek.onl>
2024-06-28 00:33:17 +00:00
Alfredo Garcia 76bad07c68
add(support): Include Windows as a tier2 supported platform (#8637)
* add windows to tier2 supported platforms document

* add changelog entry
2024-06-24 20:09:57 +00:00
Alfredo Garcia 0e6eee373e
fix typos (#8612) 2024-06-14 18:29:21 +00:00
Arya 3147d20f18
add(book): Adds a section on Regtest usage to the Zebra book (#8526)
* Always set mempool.debug_enable_at_height to 0 on Regtest

* Adds a Regtest with Zebra page to the book

* Deduplicates calls to is_regtest() in start fn

* upgrade min rust version in zebrad

* Display full network name in logs except for Mainnet and default Testnet

* Add example logs/code to regtest section of the book

* apply some extra information

Co-authored-by: Arya <aryasolhi@gmail.com>

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
Co-authored-by: Marek <mail@marek.onl>
Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com>
2024-05-22 15:14:22 +00:00
Arya 0f5450f565
change(release): Reduce the end of support time from 20 weeks to 16 weeks (#8530)
* Reduce the end of support time from 20 weeks to 16 weeks.

* Update release-process section of the book

* Adds changelog entry

* Update CHANGELOG.md

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>

---------

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
2024-05-15 21:12:52 +00:00
Alfredo Garcia 0ca01e6a46
chore: Release v1.7.0 (#8507)
* changelog and readme for 1.7.0 release

* chore: Release

* update zebra-scan and zebra-grpc to the release crates dry run script

* update ESTIMATED_RELEASE_HEIGHT

* update the release period to 6 weeks

* update release block

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
2024-05-07 14:25:50 +00:00
Alfredo Garcia d869ec6fe4
change(release): Adjust estimated release interval and end of support (#8429)
* change estimated release interval and end of support

* update readme
2024-04-24 19:22:07 +00:00
Arya 1498f8e24e
Release v1.6.1 (#8396)
* Updates crates versions

* Updates end of support height

* Updates README

* Updates CHANGELOG

* Updates Known Issues in README

* Updates Changelog

* updates release-crates-dry-run.sh

* updates install.md and docker.md

* Update CHANGELOG.md

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
2024-04-15 23:24:40 +00:00
Alfredo Garcia c22404f639
fix openapi now showing up in book summary (#8357) 2024-03-18 22:05:22 +00:00
Alfredo Garcia 652b4c3263
add openapiu.md to the book summary (#8351) 2024-03-14 16:32:53 +00:00
Alfredo Garcia f2be73eebb
feat(rpc): OpenAPI spec (#8342)
* add an openapi generator

* fix run command

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
2024-03-14 15:04:19 +00:00
Marek 58bfe974e1
chore: Release v1.6.0 (#8319)
* Prepare the CHANGELOG for v1.6.0

* chore: Release

* Set `ESTIMATED_RELEASE_HEIGHT` to 2_413_000

* Revert "chore: Release"

This reverts commit 5261e85c37.

* chore: Release

* Fix release-crates-dry-run

* Temporarily turn off bumps for `zebra-{scan,grpc}`

* Apply suggestions from code review

Co-authored-by: Arya <aryasolhi@gmail.com>

* Re-enable test bump for `zebra-scan`

* Re-enable test bumps for `zebra-{scan, grpc}`

* Turn off dry-run bumps for `zebra-{scan, grpc}`

* Re-enable bumps and disable dry-run publishing

* Re-enable dry-run publishing

* Exclude `zebra-scan` from publishing

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-02-23 23:28:44 +00:00
Marek c2cfde0749
chore: Update docs for building Zebra (#8315)
* Update build instructions with scanning enabled

* Remove `pkg-config` from build deps in README

I tried compiling Zebra with `--all-features` on a Linux machine without
`pkg-config` or `pkfgconf` (which is an alternative to `pkg-config`),
and it worked.

* Add `protoc` to build deps in README
2024-02-23 16:49:53 +00:00
Arya 4ebd7a80d0
add(scan): Adds gRPC reflection and documents how to use the zebra-scan gRPC server (#8288)
* adds tonic-reflection

* adds listen_addr to log

* Adds user guide for scan server to zebra book

* fixes typo

* Applies suggestions from code review

* update link

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
Co-authored-by: Marek <mail@marek.onl>
2024-02-22 18:51:14 +00:00
Marek 584bd23718
Update Debian from Bullseye to Bookworm (#8273) 2024-02-14 23:02:06 +00:00
Gustavo Valverde 5feb40e0b8
feat(docker): allow users to use Zebra + LWD with persistent states (#8215)
* feat(docker): allow users to use Zebra + LWD with persistent states

* fix(docs): better documentation and compose execution

* chore(docs): better context box

* chore: do not commit further user changes to the `.env`

This can always be overriden by forcing this pushes if it was intended

* fix(compose): do not add extra volumes and ports

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
2024-02-01 21:54:17 +00:00
Gustavo Valverde 18477ecbbe
feat(docker): add `docker-compose` file to run CI locally (#8209)
* ref(docker): Consolidate all tests in the `entrypoint.sh` script

* fix(ci): missing docker argument

* fix(ci): do not blank `ENTRYPOINT_FEATURES` vairable

* fix(docker): do not add `shielded-scan` as part of `TEST_FEATURES`

* chore: remove misleading comment

* feat(docker): add `docker-compose` file to run CI locally

* fix(docs): do not remove previous sections until we have a substitute for users

* fix(docs): revert some changes

* fix: typos

* ref(docker): Consolidate all tests in the `entrypoint.sh` script

* fix(ci): missing docker argument

* fix(ci): do not blank `ENTRYPOINT_FEATURES` vairable

* fix(docker): do not add `shielded-scan` as part of `TEST_FEATURES`

* chore: remove misleading comment

* Update docker/Dockerfile

Co-authored-by: Arya <aryasolhi@gmail.com>

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-01-30 19:19:44 +00:00
Alfredo Garcia 2c18835510
chore: Release (#8187) 2024-01-23 20:00:38 +00:00
Alfredo Garcia 5824f85bb4
Release v1.5.1 (#8165)
* add 1.5.1 changelog

* extend eos

* chore: Release

* add suggestions from review

Co-authored-by: Marek <mail@marek.onl>

* Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
2024-01-19 21:14:32 +00:00
Marek 3ce539805f
Fix docs links (#8160)
PR #7886 introduced this link to docs.rs for the docs of the public
APIs: https://docs.rs/releases/search?query=zebra. However, the query in
the link returns crates that are not part of the Zebra's public API,
and doesn't return the two tower-* crates that are part of Zebra.

This commit refers to a manually created list of links pointing to the
docs of the public APIs of all current Zebra crates.
2024-01-17 11:43:43 +00:00
Marek 01fa50cba3
change(doc): Refactor user & dev docs (#8145)
* Fix the rendering of expandable content

* Refactor the docs refs in the readme

* Change the search query for docs.rs

* Refactor the landing docs for the `zebrad` crate

* List Zebra crates in the landing docs for `zebrad`

* Remove `## Future Work` from the main readme

This section doesn't say anything useful.

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
2024-01-12 22:36:04 +00:00
teor b2e71f41fe
change(doc): Document how to add a column family (#8149)
* Document how to add a column family

* Add the column family to the list in the DB

* Fix rust formatting
2024-01-12 02:11:06 +00:00
Marek f82c23b62e
change(scan): Refactor the user documentation for scanning (#8124)
* Refactor the scanning docs

* Refactor the docs for the scanning reader
2023-12-29 13:48:32 +00:00
Alfredo Garcia d1e72c114f
docs(shielded-scan) Improve feature docs (#8114)
* improve shielded-scan feature docs

* apply suggestions from review

* Fix links and typos

* Use the right birthday height for ZECpages vk

---------

Co-authored-by: Marek <mail@marek.onl>
2023-12-21 17:05:56 +00:00
Alfredo Garcia 2d217e29e7
rename worflows to fix readme badges (#8116) 2023-12-18 21:07:40 +00:00
teor ac72c2b1de
Add shielded-scan.md to the index (#8095) 2023-12-12 23:51:52 +00:00
Arya 5bdad1bcaa
Release Zebra 1.5.0 (#8027)
* adds a summary to changelog

* chore: Release

* Apply suggestions from code review

* updates Changelog.md

* updates changelog.md

* mentions/updates MSRV

* updates checkpoints

* updates ESTIMATE_RELEASE_HEIGHT

* Apply suggestions from code review

Co-authored-by: teor <teor@riseup.net>

* updates estimated release height

* combines changelog entries about scanner db

* zebra-scan is still in alpha

* Update CHANGELOG.md

* update release checklist for zebra-scan

* use fastmod to update zebra-scan version

* corrects zebra-scan version requirement in zebrad

* Applies suggestions from review

* updates changelog

* Update zebrad/src/components/sync/end_of_support.rs

---------

Co-authored-by: teor <teor@riseup.net>
2023-12-12 00:44:15 +00:00
Gustavo Valverde e5b810a52a
imp(ci): fix `codespell` words and ignore others (#8089)
This cleans the annotations on every PR, so it doesn't show up from now on.
2023-12-11 22:33:03 +00:00
teor 5dd33d7265
Add `ldb` RocksDB query tool to the Dockerfile (#8074)
* Add `ldb` RocksDB query tool to the Dockerfile

* Add shielded scanning link to run.md

* Add `ldb` tool instructions to install.md

* Add a rough framework for shielded-scan.md

* Add security warning and feature limitations to shielded-scan.md
2023-12-08 00:14:54 +00:00