-
Notifications
You must be signed in to change notification settings - Fork 382
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
docs: add first documentation archetype. #957
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 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,9 @@ | ||
--- | ||
state: design # Nothing implemented yet, figuring out the best way to do it. | ||
--- | ||
|
||
# DAOs | ||
Decentralized Autonomous Organizations are represented as a group of people that can manage decisions using the blockchain through [Realm](./realm.md)s or/and [package](.)s. We have several DAOs that will be in charge of: | ||
|
||
- [OP Values prize DAO](.): It will define the prize per VM Op. | ||
- [Evaluation DAO](evaluation-dao.md): It will be in charge of making [Proof of Contribution](.) works. |
This file contains 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,10 @@ | ||
--- | ||
state: design # Nothing implemented yet, figuring out the best way to do it. | ||
--- | ||
|
||
# Evaluation DAO | ||
|
||
It is a smart contract framework for reviewing, measuring, and accepting contributions. It is not the consensus mechanism but rather a platform. | ||
|
||
It scales itself -> managed by its members; serving as an entry point to become a new member. | ||
V1 is currently being developed as a [GoR](.) (Game of Realms) task. |
This file contains 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,3 @@ | ||
# gno.land | ||
|
||
gno.land is a reference to all applications included in the ecosystem, from [Tendermint V2](./tendermint2.md) to [Gnovm](./gnovm.md), also including [Gnoweb](./gnoweb.md) and others. |
This file contains 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,12 @@ | ||
--- | ||
state: design # Nothing implemented yet, figuring out the best way to do it. | ||
--- | ||
|
||
# Gnodes | ||
|
||
Gnodes are interconnected [DAOs](./daos.md) for scaling and specialized communities. They enable secure collaboration and seamless integration, facilitating transparent ecosystem management at scale. | ||
|
||
Layers and overlays for different perspectives: | ||
- first layer: entities, people, and connections to projects and teams. | ||
ajnavarro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- second layer: relationships between entities, burn rate, and payments (the "basic income" layer). | ||
- third layer: conflicts of interest, ownership stakes (privacy-preserving). |
This file contains 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,11 @@ | ||
--- | ||
state: improvements-needed # The final PoC is working well, but it must evolve performance-wise. | ||
--- | ||
|
||
# Gnovm | ||
|
||
Gnovm is in charge to run [Gno](.) code. | ||
Firstly, [Gno](.) source code is parsed into an Abstract Syntax Tree (AST). | ||
Then, [Gnovm](./gnovm.md) interprets the AST to execute the code. | ||
After that, it emulates CPU instructions to execute the AST instead of executing it directly. | ||
It can store the state of a [Realm](./realm.md) and retrieve it on the next execution. |
This file contains 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,10 @@ | ||
--- | ||
state: improvements-needed # The final PoC is working well, but it must evolve performance-wise. | ||
--- | ||
|
||
# Gnoweb | ||
|
||
Gnoweb is an application that can call a special method on a [realm](./realm.md) that returns markdown as the output. | ||
This can be used to create any kind of web interface, like social networks, blog systems, forums, or standard status pages. | ||
|
||
The method that it calls is `Render(string) string` where the input is a path (to discriminate different requests, and potentially handle them through a router), and the return value is normally markdown to be rendered, but it can be any `string` representation. |
This file contains 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,12 @@ | ||
--- | ||
state: design # Nothing implemented yet, figuring out the best way to do it. | ||
--- | ||
|
||
# IBC Protocol | ||
|
||
The Inter-Blockchain Communication Protocol (IBC) allows independent blockchains to directly communicate and trade assets. | ||
|
||
- The Inter‐Blockchain Communication Protocol (IBC), an open‐source protocol for relaying messages between independently distributed ledgers, was created to connect independent blockchains. | ||
- IBC allows heterogeneous chains to trustlessly communicate with each other and exchange value, particularly tokens, which makes them interoperable. | ||
- A key feature of IBC is that the connected blockchains do not need to communicate with each other directly. Instead, they can send packets of information via dedicated channels using smart contracts to connect to the chains. | ||
- The Tendermint‐based decentralized exchange [Osmosis](https://www.coinbase.com/cloud/discover/protocol-guides/guide-to-osmosis) allows token holders to directly benefit from what IBC offers by enabling seamless swaps of tokens from different chains. |
This file contains 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,11 @@ | ||
--- | ||
state: improvements-needed # The final PoC is working well, but it must evolve performance-wise. | ||
--- | ||
|
||
# Realm State | ||
|
||
State stores the state of a Realm. It stores all the Realm public variables as a Merkle tree. | ||
|
||
## Format | ||
|
||
TODO |
This file contains 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,9 @@ | ||
--- | ||
state: improvements-needed # The final PoC is working well, but it must evolve performance-wise. | ||
--- | ||
|
||
# Realm | ||
|
||
A realm is the equivalent of a smart contract. It is a program that cannot be powered off. | ||
|
||
All public methods of a Realm can be accessed by anyone, and all the global variables will be stored between executions as the [State](./realm-state.md). |
This file contains 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,8 @@ | ||
--- | ||
state: improvements-needed # The final PoC is working well, but it must evolve performance-wise. | ||
--- | ||
|
||
# Tendermint 2 | ||
|
||
Tendermint is a consensus protocol that is Byzantine-Fault tolerant. | ||
In [gno.land](./gno.land.md), it is in charge of orchestrating consensus between nodes on the network and replicating state. |
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.
What kinds of states do we have in total?
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.
right now, 3: