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.

Sign up for GitHub

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

docs/runtime: Fix outdated storage nodes refs #5955

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs/runtime: Fix outdated storage nodes refs #5955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Empty file added .changelog/5955.trivial.md
View file
Open in desktop
Empty file.
1 change: 0 additions & 1 deletion docs/authenticated-grpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Oasis Core nodes communicate between themselves over various protocols. One of
those protocols is [gRPC] which is currently used for the following:

* Compute nodes talking to storage nodes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entire list is no longer true as we do not use gRPC for inter-node communication. We have been using a libp2p-based protocol for a long while now.

* Compute nodes talking to key manager nodes.
* Key manager nodes talking to other key manager nodes.
* Clients talking to compute nodes.
Expand Down
20 changes: 3 additions & 17 deletions docs/runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,11 @@ transactions from clients (also see the figure above for an overview).
need to have the executable available locally and must be configured as
compute nodes.

1. In addition to compute nodes a runtime also needs storage nodes to store its
state.

1. Both kinds of [nodes will register] on the consensus layer announcing their
1. Compute [nodes will register] on the consensus layer announcing their
willingness to participate in the operation of Runtime A.

1. After an [epoch transition] the [committee scheduler] service will elect
registered compute and storage nodes into different committees based on role.
registered compute nodes into different committees based on role.
Elections are randomized based on entropy provided by the [random beacon].

1. A client may submit transactions by querying the consensus layer to get the
Expand All @@ -78,7 +75,7 @@ transactions from clients (also see the figure above for an overview).
that computation was performed correctly and state was correctly persisted.

1. The compute nodes are ready to accept the next batch and the process can
repeat from step 6.
repeat from step 5.

Note that the above example describes the _happy path_, a scenario where there
are no failures. Described steps mention things like verifying that computation
Expand Down Expand Up @@ -153,17 +150,6 @@ computation.
[cryptographic commitments]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/roothash/api/commitment?tab=doc
<!-- markdownlint-enable line-length -->

### Storage Receipts

All runtime persistent state is stored by storage nodes. These provide a
[Merklized Key-Value Store (MKVS)] to compute nodes. The MKVS stores immutable
state cryptographically summarized by a single root hash. When a storage node
stores a given state update, it signs a receipt stating that it is storing a
specific root. These receipts are verified by the [roothash service] before
accepting a commitment from a compute node.

[Merklized Key-Value Store (MKVS)]: ../mkvs.md

### Suspending Runtimes

Since periodic maintenance work must be performed on each epoch transition
Expand Down
Loading