Skip to content

Commit

Permalink
Merge pull request #165 from anoma/bengt/fix-links-users
Browse files Browse the repository at this point in the history
users section links fixed
  • Loading branch information
bengtlofgren authored Oct 10, 2023
2 parents 1f9f543 + a4de5b6 commit e60fedd
Show file tree
Hide file tree
Showing 56 changed files with 139 additions and 140 deletions.
8 changes: 4 additions & 4 deletions packages/docs/pages/introduction/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ At the moment, Namada only supports Linux and MacOS.
## Installing Namada
Namada can be installed through the following methods:

1. [From source](./install/source.md)
2. [From binaries](./install/binaries.md)
3. [From a docker image](./install/docker.md)
1. [From source](./install/source.mdx)
2. [From binaries](./install/binaries.mdx)
3. [From a docker image](./install/docker.mdx)

The hardware requirements for installing and running a Namada full node can be found [here](../../validators/hardware.md)
The hardware requirements for installing and running a Namada full node can be found [here](../../validators/hardware.mdx)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Installing CometBFT

Follow [these instructions](.introduction/installing-cometbft.md) in order to setup CometBFT.
Follow [these instructions](.introduction/installing-cometbft.mdx) in order to setup CometBFT.

## Installing GLIBC
Finally, you should have GLIBC `v2.29` or higher.
Expand All @@ -9,4 +9,4 @@ Finally, you should have GLIBC `v2.29` or higher.

**Ubuntu 20.04**: glibc is installed by default and you don't have to do anything more.

**Ubuntu 18.04**: glibc has `v2.27` by default which is lower than the required version to run Namada. We recommend to directly [install from source](./source.md) or upgrade to Ubuntu 19.04, instead of updating glibc to the required version, since the latter way can be a messy and tedious task. In case updating glibc would interest you, this [website](http://www.linuxfromscratch.org/lfs/view/9.0-systemd/chapter05/glibc.html) gives you the steps to build the package from source.
**Ubuntu 18.04**: glibc has `v2.27` by default which is lower than the required version to run Namada. We recommend to directly [install from source](./source.mdx) or upgrade to Ubuntu 19.04, instead of updating glibc to the required version, since the latter way can be a messy and tedious task. In case updating glibc would interest you, this [website](http://www.linuxfromscratch.org/lfs/view/9.0-systemd/chapter05/glibc.html) gives you the steps to build the package from source.
2 changes: 1 addition & 1 deletion packages/docs/pages/introduction/install/source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ make install

<Callout type="warning">
During internal and private testnets, checkout the latest testnet branch using `git checkout $NAMADA_TESTNET_BRANCH`.
Where `$NAMADA_TESTNET_BRANCH` is the name of the testnet branch, which will be specified in the [testnet documentation](../testnets/environment-setup.md).
Where `$NAMADA_TESTNET_BRANCH` is the name of the testnet branch, which will be specified in the [testnet documentation](../testnets/environment-setup.mdx).
</Callout>

## Adding binaries to `$PATH`
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/pages/introduction/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide is for those interested in getting Namada up and running as quickly a

## Installing Namada

See [the installation 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`.
See [the installation guide](./install.mdx) 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`.

If the binaries are stored somewhere, but are not on your path (perhaps you downloaded the binaries), you can add the binaries to your $PATH with:

Expand Down Expand Up @@ -67,4 +67,4 @@ Testnet tokens can be sourced from the faucet, which is available on Discord.

## From here

From here, you can do a variety of cool things. Perhaps try [shielding your NAM](../../users/shielded-transfers.md), bonding your tokens to a validator for [delegating purposes](../../delegators.md), or [becoming a validator](../../validators.md).
From here, you can do a variety of cool things. Perhaps try [shielding your NAM](../../users/shielded-transfers.mdx), bonding your tokens to a validator for [delegating purposes](../../delegators.mdx), or [becoming a validator](../../validators.mdx).
16 changes: 8 additions & 8 deletions packages/docs/pages/networks/testnets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For more context read:
- Cometbft version: `0.37.2`
- CHAIN_ID: `public-testnet-14.5d79b6958580`

The history of all testnets can be found [here](./testnets/testnet-history.md).
The history of all testnets can be found [here](./testnets/testnet-history.mdx).

## Namada protocol versions

Expand All @@ -23,13 +23,13 @@ If you find a bug, please submit an issue with the `bug` [issue template](https:

## How to join a Namada testnet

1. [Environment setup](./testnets/environment-setup.md)
2. [Pre-genesis instructions](./testnets/pre-genesis.md)
3. [Pre-genesis validator setup](../operators/validators/genesis-validator-setup.md)
4. [Pre-genesis validator apply](./testnets/genesis-validator-apply.md)
5. [Running your genesis validator](../operators/validators/run-your-genesis-validator.md)
6. [Running a full node](../operators/ledger/running-a-full-node.md)
7. [Becoming a validator post-genesis](./testnets/post-genesis-validator.md)
1. [Environment setup](./testnets/environment-setup.mdx)
2. [Pre-genesis instructions](./testnets/pre-genesis.mdx)
3. [Pre-genesis validator setup](../operators/validators/genesis-validator-setup.mdx)
4. [Pre-genesis validator apply](./testnets/genesis-validator-apply.mdx)
5. [Running your genesis validator](../operators/validators/run-your-genesis-validator.mdx)
6. [Running a full node](../operators/ledger/running-a-full-node.mdx)
7. [Becoming a validator post-genesis](./testnets/post-genesis-validator.mdx)

## Testnet flowchart
![testnet_flowchart](/images/testnet_flowchart.png)
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/networks/testnets/environment-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ export NAMADA_TAG=v0.23.0
<Steps>
### Install all pre-requisites
- [Rust](https://www.rust-lang.org/tools/install)
- [CometBFT](../../introduction/installing-cometbft.md)
- [Protobuf](../../introduction/install/source/pre-requisites.md)
- [CometBFT](../../introduction/installing-cometbft.mdx)
- [Protobuf](../../introduction/install/source/pre-requisites.mdx)

### Clone namada repository and checkout the correct versions

Expand All @@ -40,7 +40,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
</Steps>
## Installing CometBFT
<Steps>
### See the installing CometBFT section [here](../../introduction/installing-cometbft.md) for instructions on how to install CometBFT.
### See the installing CometBFT section [here](../../introduction/installing-cometbft.mdx) for instructions on how to install CometBFT.
### Copy both the namada and CometBFT binaries to somewhere on $PATH (or use the relative paths). This step may or may not be necessary.

- namada binaries can be found in `/target/release`
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/networks/testnets/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### **Q: How do I join as a validator post-genesis?**

**A:** Joining as a validator post genesis can be done following [these instructions](../../operators/validators/post-genesis-validator-setup.md).
**A:** Joining as a validator post genesis can be done following [these instructions](../../operators/validators/post-genesis-validator-setup.mdx).

### **Q: How do I use the Faucet?**

Expand All @@ -27,10 +27,10 @@ HINT: `namadac balance`

### **Q: What requirements do I need to be a User/Validator?**

**A:** See [hardware requirements](../../operators/validators/hardware.md).
**A:** See [hardware requirements](../../operators/validators/hardware.mdx).

In order to build binaries from source, at least 16GB RAM will be required.

### **Q: Where can I find the binaries to run Namada if I do not want to build from source?**

**A:** See [Installing Namada from binaries](../../introduction/install/binaries.md)
**A:** See [Installing Namada from binaries](../../introduction/install/binaries.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Before a testnet launches, you can apply to be a genesis validator.

### Set up

Follow [this guide](../../operators/validators/genesis-validator-setup.md#pre-genesis) on how to generate your "pre-genesis" validator files.
Follow [this guide](../../operators/validators/genesis-validator-setup.mdx#pre-genesis) on how to generate your "pre-genesis" validator files.

After this, you'll have a `validator.toml` file, the contents of which will look something like the following:

Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/networks/testnets/joining-the-testnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Depending on whether you are a genesis validator, you can join the latest testne
## Joining as a genesis validator
Joining the testnet validator is identical to that of a mainnet validator.

For this reason, please refer to [these docs](../../operators/validators/run-your-genesis-validator.md).
For this reason, please refer to [these docs](../../operators/validators/run-your-genesis-validator.mdx).

## Joining as a full node
If you are not a genesis validator, please follow the steps for [joining as a full node](../../operators/ledger/running-a-full-node.md).
If you are not a genesis validator, please follow the steps for [joining as a full node](../../operators/ledger/running-a-full-node.mdx).

It is then possible to test being a validator by [becoming a post-genesis validator](./post-genesis-validator.md).
It is then possible to test being a validator by [becoming a post-genesis validator](./post-genesis-validator.mdx).


Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

After genesis, you can still join the network as a user and become a validator through self-bonding.

After [joining the network as a full node](../../operators/ledger/running-a-full-node.md), you must [create a validator account](../../operators/validators/post-genesis-validator-setup.md).
After [joining the network as a full node](../../operators/ledger/running-a-full-node.mdx), you must [create a validator account](../../operators/validators/post-genesis-validator-setup.mdx).

After this has been completed, you will need to increase your validator's `bonded-stake`, which can be done by self-bonding tokens sourced from the faucet.


## Bonding

Follow [this guide](../../operators/validators/staking.md#self-bonding) on how to self-bond a validator's tokens.
Follow [this guide](../../operators/validators/staking.mdx#self-bonding) on how to self-bond a validator's tokens.

## Check bonded-stake
In order to vote on blocks, a validator must have enough `bonded-stake` to be included in the validators "consensus-set". A validator is in the consensus set if and only if it has enough `bonded-stake` to be in the top 128 validators by `bonded-stake`.
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/pages/networks/testnets/pre-genesis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Pre-genesis is defined as "before" the first (a.k.a genesis) block.
At genesis, there will be a set of validators with a pre-defined amount of tokens (described in the genesis file).

For testnets, it is possible to apply to become a pre-genesis validator.
In order to do so, please follow [these steps](./genesis-validator-apply.md).
In order to do so, please follow [these steps](./genesis-validator-apply.mdx).

If the testnet is already running and you have not been selected as a pre-genesis validator, please follow the steps for [joining as a full node](../../ledger/running-a-full-node.md). If you still wish to validate, you can follow the steps to [become a post-genesis-validator](./post-genesis-validator.md).
If the testnet is already running and you have not been selected as a pre-genesis validator, please follow the steps for [joining as a full node](../../ledger/running-a-full-node.mdx). If you still wish to validate, you can follow the steps to [become a post-genesis-validator](./post-genesis-validator.mdx).
6 changes: 3 additions & 3 deletions packages/docs/pages/networks/testnets/testnet-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ cd namada
export NAMADA_TAG=v0.13.4
make build-release
```
3. Copy the new binaries to path. More in depth instructions can be found at [here](./environment-setup.md)
3. Copy the new binaries to path. More in depth instructions can be found at [here](./environment-setup.mdx)
4. Once this has been completed, **the node must tesync from genesis** (see below)

**How to resync from genesis:**
Expand All @@ -178,7 +178,7 @@ mkdir backup-pregenesis && cp -r .namada/pre-genesis backup-pregenesis/
rm -r .namada/public-testnet-3.0.81edd4d6eb6
rm .namada/public-testnet-3.0.81edd4d6eb6.toml
```
WARNING: Do not delete the entire `.namada` folder, as it contains your pre-genesis keys. If this is accidentally done, you will have to copy over the backup-pregenesis file. See [these instructions](../../validators/run-your-genesis-validator.md) for more details
WARNING: Do not delete the entire `.namada` folder, as it contains your pre-genesis keys. If this is accidentally done, you will have to copy over the backup-pregenesis file. See [these instructions](../../validators/run-your-genesis-validator.mdx) for more details
3. Rejoin the network
```bash copy
export CHAIN_ID="public-testnet-3.0.81edd4d6eb6"
Expand Down Expand Up @@ -206,7 +206,7 @@ A patch was released [v0.13.3](https://github.com/anoma/namada/releases/tag/v0.1

***23/01/2023***

A new testnet was released before the fortnightly testnet release schedule due to the below hardfork not working as intended. Follow the steps in [setting up a new testnet](./environment-setup.md)
A new testnet was released before the fortnightly testnet release schedule due to the below hardfork not working as intended. Follow the steps in [setting up a new testnet](./environment-setup.mdx)

### Hardfork v0.13.1

Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/operators/ledger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namada ledger

The node will attempt to connect to the persistent validator nodes and other peers in the network, and synchronize to the latest block.

By default, the ledger will store its configuration and state in your [base directory](./ledger/base-directory.md).
By default, the ledger will store its configuration and state in your [base directory](./ledger/base-directory.mdx).
You can use the `--base-dir` CLI global argument or `BASE_DIR` environment variable to change it.

Assuming you do not have a custom base_dir, you can export the BASE_DIR environment variable as follows:
Expand All @@ -32,12 +32,12 @@ The ledger will also download the genesis block, which contains the initial stat
The ledger also needs access to the built WASM files that are used in the genesis block.
These files are included in release and shouldn't be modified, otherwise your node will fail with a consensus error on the genesis block.
By default, these are expected to be in the `wasm` directory inside the chain directory that's in the base directory, i.e `$BASE_DIR/$CHAIN_ID/wasm`.
The wasm directory can also be set with the `--wasm-dir` CLI global argument, `NAMADA_WASM_DIR` [environment variable](./ledger/env-vars.md) or the configuration file.
The wasm directory can also be set with the `--wasm-dir` CLI global argument, `NAMADA_WASM_DIR` [environment variable](./ledger/env-vars.mdx) or the configuration file.

### Ledger configuration
The ledger configuration is stored in `$BASE_DIR/$CHAIN_ID/config.toml` (with
default `--base-dir`). It is created when you join the network. You can modify
that file to change the configuration of your node. All values can also be set
via [environment variables](./ledger/env-vars.md).
via [environment variables](./ledger/env-vars.mdx).


2 changes: 1 addition & 1 deletion packages/docs/pages/operators/local-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Expandable from "../../components/Expandable";

## Prerequisites

Namada must be installed [from source](../introduction/install/source.md) in order to run a local network.
Namada must be installed [from source](../introduction/install/source.mdx) in order to run a local network.

There is a script that has been written specifically for this purpose, which can be found under `scripts` in the [Namada repository](https://github.com/anoma/namada).

Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/operators/validators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ A post-genesis validator, on the other hand, is a validating account which was c
#### Pre-requisites
Validators require stake in the form of NAM in order to participate in the consensus process. The amount of stake required is specified in the genesis file. In order to become a validator, you must have at least the minimum amount of stake required.

In addition, the validator node must meet the [minimum hardware requirements](./validators/hardware.md).
In addition, the validator node must meet the [minimum hardware requirements](./validators/hardware.mdx).

#### Steps

See these steps for [setting up a genesis validator](./validators/genesis-validator-setup.md).
See these steps for [setting up a genesis validator](./validators/genesis-validator-setup.mdx).

See these steps for [setting up a post-genesis validator](./validators/post-genesis-validator-setup.md).
See these steps for [setting up a post-genesis validator](./validators/post-genesis-validator-setup.mdx).
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A genesis validator is one which is a validator right from the first block of th

### Prerequisites

- a machine that meets the [requirements](./hardware.md) for running a validator node
- a machine that meets the [requirements](./hardware.mdx) for running a validator node
- an associated public IPv4 address with ports 26656 reachable from anywhere for P2P connections

## Pre-genesis
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ Note that the balance of NAM tokens that is in your validator account does not c
namada client balance --owner my-validator --token NAM
```

That is, the balance of your account's address is a regular liquid balance that you can transfer using your validator account key, depending on the rules of the validator account's validity predicate. The default validity predicate allows you to transfer it with a signed transaction and/or stake it in the PoS system. Therefore, in order to increase the voting power of your validator, you need to accrue [some stake](./staking.md).
That is, the balance of your account's address is a regular liquid balance that you can transfer using your validator account key, depending on the rules of the validator account's validity predicate. The default validity predicate allows you to transfer it with a signed transaction and/or stake it in the PoS system. Therefore, in order to increase the voting power of your validator, you need to accrue [some stake](./staking.mdx).

1 change: 0 additions & 1 deletion packages/docs/pages/users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ This guide is tailored towards users who are interested in using Namada to its m
- [Delegating on Namada](./users/delegators.mdx)
- [Governance and Public Goods Funding](./users/governance.mdx)
- [Using the Namada wallet](./users/wallet.mdx)
- [Experimental Features](./users/experimental.mdx)

6 changes: 3 additions & 3 deletions packages/docs/pages/users/delegators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ All accounts on Namada with any amount of *bonded* NAM, is by definition, either
> A delegate is an account that has been bonded to by a delegator.
## Becoming a delegator
In order to become a delegator, you must first have an account with positive NAM balance. If you do not have an account, you can follow the instructions [here](../users/an-introduction-to-namada-addresses.md) to create one.
In order to become a delegator, you must first have an account with positive NAM balance. If you do not have an account, you can follow the instructions [here](./transparent-accounts.mdx) to create one.

Once you have an account, you can bond your NAM to a delegate. At the time of writing, the only possible delegates are validators. In future Namada versions, there will be the option to delegate to other, non-validating accounts as well.

Delegating to a validator is the same as [staking with a validator](../validators/staking.md).
Delegating to a validator is the same as [staking with a validator](../operators/validators/staking.mdx).

First, you may want to list the available validators you can stake to:

Expand All @@ -34,4 +34,4 @@ If you have the alias saved in your wallet, you can also pass `<validator-alias>
Redelegating is the process of changing the delegate you have bonded to. This process takes 4 epochs, after which your NAM will be redelegated.

## Unbonding
Unbonding is the process of removing your bonded NAM from a delegate. This process is identical to [unbonding tokens from a validator](../validators/staking.md#unbonding).
Unbonding is the process of removing your bonded NAM from a delegate. This process is identical to [unbonding tokens from a validator](../operators/validators/staking.mdx#unbonding).
Loading

0 comments on commit e60fedd

Please sign in to comment.