This repository was archived by the owner on Aug 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
[GH-24] Add understandable documentation for non-developers #81
Merged
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3b066d6
Initial write up for the document for non-developers
0cbab4f
Fix grammar
e2fde5b
Fix typo
ce4f8a4
Fix typo
2a6ab9a
Add diagrams
f20254f
Small fix
a5ff4c9
Replace interface with layer
2ca3ef1
Fix
ea4fae1
Add more description
ff43720
Small fix
1db1189
Fix
02fedc2
Add diagram
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# `cardano-shell` overview | ||
|
||
`cardano-shell` is an thin layer which brings all the other modules working | ||
together and makes sure that they have the required resources | ||
(configuration, exception handling, monitoring, logging, ...). | ||
|
||
The shell is also responsible for: | ||
|
||
* Logging | ||
* Monitoring | ||
* Configuration | ||
* Exception handling | ||
* Launcher | ||
|
||
## Features | ||
|
||
Various **features** are required for the cardano node to operate. | ||
|
||
* Blockchain layer | ||
* Ledger layer | ||
* Logging layer | ||
* Monitoring layer | ||
* Network layer | ||
* Wallet backend layer | ||
|
||
The shell will act as a **glue** of these features. It provides required | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The idea is that it will be a glue for some of them. |
||
resources/configurations to each of these features as well as resolving its dependencies. | ||
|
||
 | ||
|
||
## Resolving dependencies between the features | ||
|
||
There are **dependencies** between the features meaning some of the features | ||
depend on others. For example, | ||
|
||
* `networking` feature requires `logging` and `monitoring` | ||
* `blockchain` feature `logging` and `networking` | ||
|
||
and so on. | ||
|
||
The shell will resolve these dependencies by having each of the features to | ||
produce a `layer` and distributing them to other features that depend on it. | ||
|
||
### Layer | ||
|
||
To put it simple, **a layer is a record of functions that each feature generates when initialized**. | ||
For example, logging feature will produce logging layer when initialized. | ||
The logging layer will have a list of functions related to logging such as | ||
`logInfo`, `logDebug` which the other features can use. | ||
|
||
 | ||
|
||
Dependencies between the features are resolved by passing these layers. | ||
|
||
- If `networking` feature requires `logging`, then it will have logging | ||
layer as a dependency when initializing. | ||
|
||
 | ||
|
||
- If `blockchain` feature requires `logging` and `network`, then shell will | ||
provide those layers as dependencies. | ||
|
||
 | ||
|
||
Layers are defined in such a way that it can be **stubbed**. This will | ||
allow the developer to write test cases on each features with ease. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The shell is not responsible for logging and monitoring. That is brought in using the library, which is a part of shell (the part that can add features).