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

Edits after restructure #285

Merged
merged 2 commits into from
Feb 15, 2024
Merged
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
11 changes: 10 additions & 1 deletion packages/specs/pages/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,13 @@ Namada includes the following modules:
- [Multi-asset-shielded-pool (MASP)](./modules/masp.mdx)
- [Governance](./modules/governance.mdx)
- [IBC](./modules/ibc.mdx)
- [Ethereum bridge](./modules/ethereum-bridge.mdx)
- [Ethereum bridge](./modules/ethereum-bridge.mdx)

Each module page herein includes the following sub-sections:
- Introduction
- Design rationale
- Data types
- Storage layout
- Validity predicate logic
- Transactions
- Handlers
7 changes: 6 additions & 1 deletion packages/specs/pages/modules/ethereum-bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ fungible assets are held in escrow.
[ICS20]: <https://github.com/cosmos/ibc/blob/ed849c7bacf16204e9509f0f0df325391f3ce25c/spec/app/ics-020-fungible-token-transfer/README.md>
[ERC20]: <https://eips.ethereum.org/EIPS/eip-20>


- [Design rationale](./ethereum-bridge/design.mdx)
- [Data types](./ethereum-bridge/data-types.mdx)
- [Storage layout](./ethereum-bridge/storage.mdx)
- [Validity predicate logic](./ethereum-bridge/vp.mdx)
- [Transactions](./ethereum-bridge/txs.mdx)
- [Handlers](./ethereum-bridge/handlers.mdx)

## Topics
- [Bootstrapping](./ethereum-bridge/bootstrapping.mdx)
Expand Down
6 changes: 3 additions & 3 deletions packages/specs/pages/modules/ethereum-bridge/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"design": "Design",
"design": "Design rationale",
"data-types": "Data types",
"storage": "Storage",
"vp": "Validity Predicate logic",
"storage": "Storage layout",
"vp": "Validity predicate logic",
"txs": "Transactions",
"handlers": "Handlers"
}
7 changes: 7 additions & 0 deletions packages/specs/pages/modules/governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ Namada introduces a governance mechanism to propose and apply protocol changes w
Any user able to deposit the correct amount of `NAM` is able to propose some changes in a proposal for which delegators and validators cast their `yay` or `nay` votes.
It is also possible to attach some payloads to proposals, in specific cases, to embed additional information.

- [Design rationale](./governance/design.mdx)
- [Data types](./governance/data-types.mdx)
- [Storage layout](./governance/storage.mdx)
- [Validity predicate logic](./governance/vp.mdx)
- [Transactions](./governance/txs.mdx)
- [Handlers](./governance/handlers.mdx)

Governance on Namada supports both `signaling` and `voting` mechanisms.
The signaling mechanism is used for changes which require a hard fork, while the voting mechanism is used for changes which merely alter state.
In cases where the chain is not able to produce blocks anymore, Namada relies on [off-chain signaling](#off-chain-protocol) to agree on a common move.
Expand Down
6 changes: 3 additions & 3 deletions packages/specs/pages/modules/governance/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"design": "Design",
"design": "Design rationale",
"data-types": "Data types",
"storage": "Storage",
"vp": "Validity Predicate logic",
"storage": "Storage layout",
"vp": "Validity predicate logic",
"txs": "Transactions",
"handlers": "Handlers"
}
7 changes: 7 additions & 0 deletions packages/specs/pages/modules/ibc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# IBC integration

- [Design rationale](./ibc/design.mdx)
- [Data types](./ibc/data-types.mdx)
- [Storage layout](./ibc/storage.mdx)
- [Validity predicate logic](./ibc/vp.mdx)
- [Transactions](./ibc/txs.mdx)
- [Handlers](./ibc/handlers.mdx)

* [IBC (Inter-blockchain communication protocol) spec](https://github.com/cosmos/ibc)

## IBC transaction
Expand Down
6 changes: 3 additions & 3 deletions packages/specs/pages/modules/ibc/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"design": "Design",
"design": "Design rationale",
"data-types": "Data types",
"storage": "Storage",
"vp": "Validity Predicate logic",
"storage": "Storage layout",
"vp": "Validity predicate logic",
"txs": "Transactions",
"handlers": "Handlers"
}
7 changes: 7 additions & 0 deletions packages/specs/pages/modules/masp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

The multi-asset shielded pool (MASP) is an extension to the Sapling circuit which adds support for sending arbitrary assets.

- [Design rationale](./masp/design.mdx)
- [Data types](./masp/data-types.mdx)
- [Storage layout](./masp/storage.mdx)
- [Validity predicate logic](./masp/vp.mdx)
- [Transactions](./masp/txs.mdx)
- [Handlers](./masp/handlers.mdx)

See the following documents:
- [Cryptographic specification](https://github.com/anoma/masp/blob/main/docs/multi-asset-shielded-pool.pdf)
- [Ledger integration](./masp/ledger-integration.mdx)
Expand Down
6 changes: 3 additions & 3 deletions packages/specs/pages/modules/masp/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"design": "Design",
"design": "Design rationale",
"data-types": "Data types",
"storage": "Storage",
"vp": "Validity Predicate logic",
"storage": "Storage layout",
"vp": "Validity predicate logic",
"txs": "Transactions",
"handlers": "Handlers"
}
6 changes: 6 additions & 0 deletions packages/specs/pages/modules/multisignature.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@ import { Callout } from 'nextra-theme-docs'

The "user" validity predicate is the default validity predicate for all user-owned accounts. It is a multisignature validity predicate that requires at least `k` out of `n` valid signatures to be present in the signed transaction data for every transaction originating from the user. By default, both `k` and `n` are set to 1, meaning that the user can sign transactions on their own. This is the default validity predicate for all user-owned accounts.

- [Design rationale](./multisignature/design.mdx)
- [Data types](./multisignature/data-types.mdx)
- [Storage layout](./multisignature/storage.mdx)
- [Validity predicate logic](./multisignature/vp.mdx)
- [Transactions](./multisignature/txs.mdx)
- [Handlers](./multisignature/handlers.mdx)
6 changes: 6 additions & 0 deletions packages/specs/pages/modules/multitoken.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@ The fungible token validity predicate authorises token balance changes on the ba

{/* TODO: This is the same as design rationale atm, needs changing */}

- [Design rationale](./multitoken/design.mdx)
- [Data types](./multitoken/data-types.mdx)
- [Storage layout](./multitoken/storage.mdx)
- [Validity predicate logic](./multitoken/vp.mdx)
- [Transactions](./multitoken/txs.mdx)
- [Handlers](./multitoken/handlers.mdx)
6 changes: 3 additions & 3 deletions packages/specs/pages/modules/multitoken/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"design": "Design",
"design": "Design rationale",
"data-types": "Data types",
"storage": "Storage",
"vp": "Validity Predicate logic",
"storage": "Storage layout",
"vp": "Validity predicate logic",
"txs": "Transactions",
"handlers": "Handlers"
}
7 changes: 7 additions & 0 deletions packages/specs/pages/modules/proof-of-stake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ This section of the specification describes the proof-of-stake mechanism of Nama

This section is split into three subcomponents: the [bonding mechanism](./proof-of-stake/objects-and-txs.mdx), [reward distribution](./proof-of-stake/reward-distribution.mdx), and [cubic slashing](./proof-of-stake/cubic-slashing.mdx).

- [Design rationale](./proof-of-stake/design.mdx)
- [Data types](./proof-of-stake/data-types.mdx)
- [Storage layout](./proof-of-stake/storage.mdx)
- [Validity predicate logic](./proof-of-stake/vp.mdx)
- [Transactions](./proof-of-stake/txs.mdx)
- [Handlers](./proof-of-stake/handlers.mdx)

## Context

Blockchain systems rely on economic security (directly or indirectly) to
Expand Down
Loading