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

Awa docs review #543

Merged
merged 4 commits into from
Oct 13, 2022
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ target/
wasm/*.wasm

# app version string file
/apps/version.rs
/apps/version.rs
28 changes: 25 additions & 3 deletions documentation/docs/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,34 @@ Welcome to Namada's docs!

## About Namada

[Namada](https://namada.net/) is a sovereign proof-of-stake blockchain, using Tendermint BFT consensus, that enables multi-asset private transfers for any native or non-native asset using a multi-asset shielded pool derived from the Sapling circuit.
[Namada](https://namada.net/) is a Proof-of-Stake layer 1 protocol for asset-agnostic, interchain privacy. Namada is Anoma's first fractal instance and is currently being developed by [Heliax](https://heliax.dev), a public goods lab.

To learn more about the protocol, we recommend the following resources:
Key innovations include:
- ZCash-like transfers for any assets (fungible and non-fungible)
- Rewarded usage of privacy as a public good
- Interoperability with Ethereum via a custom bridge with trust-minimisation
- Vertically integrated user interfaces

- [Introducing Namada: Shielded Transfers with Any Assets](https://medium.com/anomanetwork/introducing-namada-shielded-transfers-with-any-assets-dce2e579384c)
To learn more, we recommend:
- Article: [Introducing Namada: Shielded Transfers with Any Assets](https://medium.com/anomanetwork/introducing-namada-shielded-transfers-with-any-assets-dce2e579384c)

## Overview of features
- Proof-of-Stake with governance to secure and evolve Namada
- Fast-finality BFT with 4-second blocks
- Near-zero fees
- Trustless 2-way Ethereum bridge via IBC implementation on ETH
- IBC bridges to chains that already speak IBC (all Cosmos chains)
- MASP
- Convert Circuit (shielded set rewards)
- A reference interface
- Ledger application

To learn more about the protocol, we recommend the following in-depth resources:
- Talk at ZK8 [Namada: asset-agnostic interchain privacy](https://youtu.be/5K6YxmZPFkE)
- [Namada's specifications](https://specs.namada.net)
- [Codebase](https://github.com/anoma/namada)

## About this documentation

This book is written using [mdBook](https://rust-lang.github.io/mdBook/), the source can be found in the [Namada repository](https://github.com/anoma/namada/tree/main/documentation/docs).

Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Summary

- [Introduction](./README.md)
- [Quick Start](./quick-start.md)
- [User Guide](./user-guide/README.md)
- [Install Namada](./user-guide/install.md)
- [Quickstart](./quick-start.md)
- [User guide](./user-guide/README.md)
- [Installing Namada](./user-guide/install.md)
- [Getting started](./user-guide/getting-started.md)
- [Manage a Wallet](./user-guide/wallet.md)
- [Managing a wallet](./user-guide/wallet.md)
- [The Ledger](./user-guide/ledger.md)
- [Interact with PoS](./user-guide/ledger/pos.md)
- [Interacting with PoS](./user-guide/ledger/pos.md)
- [Governance](./user-guide/ledger/governance.md)
- [Private Transfers](./user-guide/ledger/masp.md)
- [Shielded transfers](./user-guide/ledger/masp.md)
- [Genesis validator setup](./user-guide/genesis-validator-setup.md)
- [Applying to be a genesis validator](./user-guide/genesis-validator-apply.md)
- [Testnets](./testnets/README.md)
Expand Down
1 change: 0 additions & 1 deletion documentation/docs/src/chapter_1.md

This file was deleted.

19 changes: 11 additions & 8 deletions documentation/docs/src/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Quick Start - How to run a validator node
# Quickstart - How to run a validator on Namada?

## About this guide

This guide is aimed at people interested in running a validator node and assumes basic knowledge of the terminal and how commands are used.
This guide is for the ones interested in operating a Namada validator node and assumes basic knowledge of the terminal and how commands are used.

* Comments start with `#`:
`# this is a comment make sure you read them!`
* Sample outputs start with an arrow:
`➜ this is an example command line output useful for comparing`
* Comments start with `#`:

## Install Namada
```# this is a comment make sure you read them!```

See [the install guide](user-guide/install.md) for details on installing the Namada binaries. Commands in this guide will assume you have the Namada binaries (`namada`, `namadan`, `namadaw`, `namadac`) on your path.
* Sample outputs start with an arrow:

```➜ this is an example command line output useful for comparing```

## Installing Namada

See [the installation guide](user-guide/install.md) for details on installing the Namada binaries. Commands in this guide will assume you have the Namada binaries (`namada`, `namadan`, `namadaw`, `namadac`) on your path.

## Joining a network

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/src/user-guide/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# User Guide

Welcome to Namada user guide!
Welcome to Namada's user guide!

This guide is intended to help you find how to install, operate and interact with the Namada ledger node, the client and the wallet.
This guide will help you find how to install, operate and interact with the Namada ledger node, the client, and the wallet.
4 changes: 2 additions & 2 deletions documentation/docs/src/user-guide/ledger/masp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Private transfers
# Shielded transfers

In Namada, private transfers are enabled by the Multi-Asset Shielded Pool (MASP). The MASP is a zero-knowledge circuit (zk-SNARK) that extends the Zcash Sapling circuit to add support for sending arbitrary assets. All assets in the pool share the same anonymity set, this means that the more transactions are issued to MASP, the stronger are the privacity guarantees.
In Namada, shielded transfers are enabled by the Multi-Asset Shielded Pool (MASP). The MASP is a zero-knowledge circuit (zk-SNARK) that extends the Zcash Sapling circuit to add support for sending arbitrary assets. All assets in the pool share the same anonymity set, this means that the more transactions are issued to MASP, the stronger are the privacity guarantees.

## Using MASP

Expand Down
Binary file modified documentation/docs/theme/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions documentation/docs/theme/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.