Add authority claimer documentation to node #143
Conversation
README.md
Outdated
| @@ -90,42 +88,64 @@ The [**State-fold Server**](./offchain/state-server/README.md) is the component | |||
|
|
|||
| The [**Dispatcher**](./offchain/dispatcher/README.md) is the component that messages *Inputs* via the **Broker** to be processed elsewhere and submits *Claims* to the blockchain. | |||
There was a problem hiding this comment.
| The [**Dispatcher**](./offchain/dispatcher/README.md) is the component that messages *Inputs* via the **Broker** to be processed elsewhere and submits *Claims* to the blockchain. | |
| The [**Dispatcher**](./offchain/dispatcher/README.md) is the component that messages *Inputs* via the **Broker** to be processed elsewhere. |
README.md
Outdated
| The [**Advance Runner**](./offchain/advance-runner/README.md) is the one responsible for relaying *Inputs* to the **Server Manager** to be processed by the underlying DApp running in the embedded **Cartesi Machine**. | ||
| The **Advance Runner** obtains the resulting **Outputs** and **Claims** from the **Server Manager** and adds them to the **Broker**. | ||
|
|
||
| The [**Indexer**](./offchain/indexer/README.md) consumes all *Inputs* and *Outputs* transferred by the **Broker** and stores them in a **PostgreSQL** database for later querying via a **GraphQL Server** instance. | ||
|
|
||
| The [**Inspect Server**](./offchain/inspect-server/README.md) is responsible for the processing of *Inspect* requests via HTTP. | ||
|
|
||
| ## Workflows | ||
| ## Framework features |
There was a problem hiding this comment.
| ## Framework features | |
| ## Rollups Node Features |
README.md
Outdated
|
|
||
| ### Reader Flow | ||
| ### Reader Feature |
There was a problem hiding this comment.
| ### Reader Feature | |
| ### Processing Inputs |
README.md
Outdated
|
|
||
| In the Reader Flow, any *Input* read from the blockchain by the **State-fold Server** is received by the **Dispatcher** and relayed to the **Broker** through an input-specific stream. | ||
| With the Reader Feature, any *Input* read from the blockchain by the **State-fold Server** is received by the **Dispatcher** and relayed to the **Broker** through an input-specific stream. |
There was a problem hiding this comment.
This paragraph seems strange because the text describes details of the implementation instead of the feature itself.
We first need an explanatory paragraph for each feature. For instance, in the processing inputs feature, we could have something like:
The Node is capable of processing rollup inputs stored in the blockchain. To do that, the node gets the inputs from the blockchain, sends them to the Cartesi machine, and stores the result in the node database. Once the input result is in the database, the node client can query the outputs in the GraphQL API.
README.md
Outdated
| ## Host mode | ||
| ## Execution modes | ||
|
|
||
| The Cartesi Node may act as a *User* (aka *Reader*), as a *Validator* or run locally as a *Host*, hence performing different roles, which may be represented by different workflows. |
There was a problem hiding this comment.
| The Cartesi Node may act as a *User* (aka *Reader*), as a *Validator* or run locally as a *Host*, hence performing different roles, which may be represented by different workflows. | |
| The Cartesi Node may act as a *Reader*, or a *Validator*, or run locally as a *Host*, performing different roles, which different workflows may represent. |
I removed the "User" part; I think it is confusing. I also applied some suggestions from Grammarly.
I'm still not sure what "different workflows may represent" means.
README.md
Outdated
|
|
||
| ### Reader Mode | ||
|
|
||
| The *Reader Mode* is the default running operation of the node. It doesn't submit claims to the blockchain, instead only reads and updates the state. It contains the Reader and Inspect Data features. |
There was a problem hiding this comment.
Each sentence should have its own line so the diffs later are easier to read.
README.md
Outdated
|
|
||
| ### Reader Mode | ||
|
|
||
| The *Reader Mode* is the default running operation of the node. It doesn't submit claims to the blockchain, instead only reads and updates the state. It contains the Reader and Inspect Data features. |
There was a problem hiding this comment.
The Reader Mode is the default running operation of the node.
I'm afraid I have to disagree. We shouldn't provide a default mode because the user should be conscious of his actions.
There was a problem hiding this comment.
Fair enough, by default I meant that every node will run this logic, even a validator node that has the claiming as well. But I can see now I did not made myself clear.
There was a problem hiding this comment.
Looks good!
I just have a few extra comments.
Also, the link at the line below is broken. Perhaps we should change the sentences to reflect the changes made in the PR.
Line 153 in 9889297
GMKrieger
force-pushed
the
feature/document-authority-claimer
branch
3 times, most recently
from
19c43fe
to
18df374
Compare
GMKrieger
force-pushed
the
feature/document-authority-claimer
branch
from
18df374
to
6613291
Compare
#43