Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merge-queue: embarking main (11baba5) and [#5932 + #5926 + #5892 + #5874 + #5931] together #5936

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions .github/workflows/continous-delivery.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ jobs:
if: ${{ !cancelled() && !failure() && ((github.event_name == 'push' && github.ref_name == 'main') || github.event_name == 'release') }}

steps:
- uses: actions/[email protected]
with:
persist-credentials: false

- name: Inject slug/short variables
uses: rlespinasse/github-slug-action@v4
with:
Expand Down Expand Up @@ -189,6 +193,10 @@ jobs:
if: github.event_name == 'workflow_dispatch'

steps:
- uses: actions/[email protected]
with:
persist-credentials: false

- name: Inject slug/short variables
uses: rlespinasse/github-slug-action@v4
with:
Expand Down Expand Up @@ -217,8 +225,9 @@ jobs:
--container-stdin \
--container-tty \
--container-image ${{ env.GAR_BASE }}/zebrad@${{ needs.build.outputs.image_digest }} \
--create-disk=name=auto-delete=yes,size=300GB,type=pd-ssd \
--container-mount-disk=mount-path='/zebrad-cache' \
--create-disk=auto-delete=yes,size=300GB,type=pd-ssd \
--create-disk=name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }},auto-delete=yes,size=300GB,type=pd-ssd \
--container-mount-disk=mount-path='/zebrad-cache',name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }} \
--machine-type ${{ env.MACHINE_TYPE }} \
--zone ${{ env.ZONE }} \
--labels=app=zebrad,environment=qa,network=${NETWORK},github_ref=${{ env.GITHUB_REF_SLUG_URL }} \
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:

- name: Rust files
id: changed-files-rust
uses: tj-actions/changed-files@v35.3.1
uses: tj-actions/changed-files@v35.4.0
with:
files: |
**/*.rs
Expand All @@ -49,7 +49,7 @@ jobs:

- name: Workflow files
id: changed-files-workflows
uses: tj-actions/changed-files@v35.3.1
uses: tj-actions/changed-files@v35.4.0
with:
files: |
.github/workflows/*.yml
Expand Down
25 changes: 7 additions & 18 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions book/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ command = "mdbook-mermaid"

[output.html]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
additional-css = ["theme/css/custom.css"]
174 changes: 174 additions & 0 deletions book/src/dev/diagrams/service-dependencies.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 43 additions & 2 deletions book/src/dev/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Design Overview

This document sketches the future design for Zebra.
This document sketches the design for Zebra.

## Desiderata

Expand Down Expand Up @@ -34,6 +34,46 @@ The following are general desiderata for Zebra:
lightweight applications like light wallets. Those applications
should use a light client protocol.

## Notable Blog Posts
- [A New Network Stack For Zcash](https://www.zfnd.org/blog/a-new-network-stack-for-zcash)
- [Composable Futures-based Batch Verification](https://www.zfnd.org/blog/futures-batch-verification)
- [Decoding Bitcoin Messages with Tokio Codecs](https://www.zfnd.org/blog/decoding-bitcoin-messages-with-tokio-codecs)

## Service Dependencies

Note: dotted lines are for "getblocktemplate-rpcs" feature

<div id="service-dep-diagram">
{{#include diagrams/service-dependencies.svg}}
</div>

<!--
Service dependencies diagram source:

digraph services {
transaction_verifier -> state
mempool -> state
inbound -> state
rpc_server -> state
mempool -> transaction_verifier
chain_verifier -> checkpoint_verifier
inbound -> mempool
rpc_server -> mempool
inbound -> chain_verifier
syncer -> chain_verifier
rpc_server -> chain_verifier [style=dotted]
syncer -> peer_set
mempool -> peer_set
block_verifier -> state
checkpoint_verifier -> state
block_verifier -> transaction_verifier
chain_verifier -> block_verifier
rpc_server -> inbound [style=invis] // for layout of the diagram
}

Render here: https://dreampuf.github.io/GraphvizOnline
-->

## Architecture

Unlike `zcashd`, which originated as a Bitcoin Core fork and inherited its
Expand Down Expand Up @@ -278,7 +318,8 @@ verify blocks or transactions, and add them to the relevant state.
#### Internal Dependencies

- `zebra-chain` for data structure definitions
- `zebra-network` possibly? for definitions of network messages?
- `zebra-node-services` for shared request type definitions
- `zebra-utils` for developer and power user tools

#### Responsible for

Expand Down
4 changes: 2 additions & 2 deletions book/src/dev/rfcs/0001-pipelinable-block-lookup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- Feature Name: Pipelinable Block Syncing and Lookup
- Start Date: 2020-07-02
- Design PR: [rust-lang/rfcs#0000](https://github.com/rust-lang/rfcs/pull/0000)
- Rust Issue: [rust-lang/rust#0000](https://github.com/rust-lang/rust/issues/0000)
- Design PR: [ZcashFoundation/zebra#583](https://github.com/ZcashFoundation/zebra/pull/583)
- Zebra Issue: [ZcashFoundation/zebra#504](https://github.com/ZcashFoundation/zebra/issues/504)

# Summary
[summary]: #summary
Expand Down
15 changes: 15 additions & 0 deletions book/theme/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#service-dep-diagram {
display: block;
margin: 0px auto;
}

#service-dep-diagram a:hover {
text-decoration: none;
opacity: 0.65;
}

html.navy #service-dep-diagram,
html.ayu #service-dep-diagram,
html.coal #service-dep-diagram {
filter: invert(1);
}
2 changes: 1 addition & 1 deletion zebra-network/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ ordered-map = "0.4.2"
pin-project = "1.0.12"
rand = { version = "0.8.5", package = "rand" }
rayon = "1.6.1"
regex = "1.7.0"
regex = "1.7.1"
serde = { version = "1.0.152", features = ["serde_derive"] }
thiserror = "1.0.38"

Expand Down
Loading