Skip to content

Commit

Permalink
Merge pull request #246 from anoma/bengt/se-docs
Browse files Browse the repository at this point in the history
Bengt/se docs
  • Loading branch information
bengtlofgren authored Feb 1, 2024
2 parents 110ffec + 61d02cd commit 0e462a4
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 26 deletions.
1 change: 0 additions & 1 deletion packages/docs/pages/introduction/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ We recommend this step with [tmux](https://www.hamvocke.com/blog/a-quick-and-eas
tmux

# inside the tmux/or not

namadan ledger run

# can detach the tmux (Ctrl-B then D)
Expand Down
19 changes: 10 additions & 9 deletions packages/docs/pages/networks/testnets.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra-theme-docs'

# Namada Testnets

For more context read:
Expand All @@ -6,20 +8,19 @@ For more context read:

## Shielded expedition

<Callout type="info" emoji="👷">
For the shielded expedition, it is important to remember to add the `--memo` flag to every transaction. The memo should be filled with the `tpknam` submitted at the shielded-expedition registration period.
For example `namadac transfer --source me --target you --amount 10 --token naan --signing-keys my-key --memo tpknamq1337mypubkey1964qqqqqq`
</Callout>

The `balances.toml` file is located at `https://github.com/anoma/namada-shielded-expedition`.

- Namada Shielded expedition 1:
- From date: `TBD`
- Namada protocol version: `TBD`
- From date: 1st of February 2024 17:00 UTC
- Namada protocol version: `v0.31.0`
- Cometbft version: `0.37.2`
- CHAIN_ID: `TBD`
- CHAIN_ID: `shielded-expedition.b40d8e9055`

## Latest Testnet
- Namada public testnet 15:
- From date: 18th of December 2023 17:00 UTC
- Namada protocol version: `v0.28.1`
- Cometbft version: `0.37.2`
- CHAIN_ID: `public-testnet-15.0dacadb8d663`

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

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/pages/networks/testnets/environment-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Note that building from source can be a difficult process and is not recommended
Export the following variables:

```bash copy
export NAMADA_TAG=v0.30.0
export NAMADA_TAG=v0.31.0
```


Expand Down Expand Up @@ -66,6 +66,6 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Make sure you are using the correct CometBFT version
- `cometbft version` should output `0.37.2`
- Make sure you are using the correct Namada version
- `namada --version` should output `Namada v0.30.0`
- `namada --version` should output `Namada v0.31.0`

</Steps>
4 changes: 2 additions & 2 deletions packages/docs/pages/networks/testnets/joining-the-testnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you have been selected. You must run the following command:
```bash
CHAIN_ID="<chain-id>"
VALIDATOR_ALIAS="<your-validator-alias>"
namadac utils join-network --chain-id $CHAIN_ID --genesis-validator $VALIDATOR_ALIAS
NAMADA_NETWORK_CONFIGS_SERVER="https://github.com/anoma/namada-shielded-expedition/releases/download/shielded-expedition.b40d8e9055" namadac utils join-network --chain-id $CHAIN_ID --genesis-validator $VALIDATOR_ALIAS
```

<Callout>
Expand All @@ -29,7 +29,7 @@ E.g if your base directory is `.namada` and your validator alias is `my-validato
CHAIN_ID="<chain-id>"
VALIDATOR_ALIAS="my-validator"
BASE_DIR=".namada"
namadac utils join-network --chain-id $CHAIN_ID --pre-genesis-path $BASE_DIR/pre-genesis/$VALIDATOR_ALIAS
NAMADA_NETWORK_CONFIGS_SERVER="https://github.com/anoma/namada-shielded-expedition/releases/download/shielded-expedition.b40d8e9055" namadac utils join-network --chain-id $CHAIN_ID --pre-genesis-path $BASE_DIR/pre-genesis/$VALIDATOR_ALIAS
```
</Callout>

Expand Down
10 changes: 5 additions & 5 deletions packages/docs/pages/networks/testnets/testnet-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ No upgrades are currently scheduled.
## Shielded expedition

- Namada Shielded expedition 1:
- From date: `TBD`
- Namada protocol version: `TBD`
- From date: 1st of February 2024 17:00 UTC
- Namada protocol version: `v0.31.0`
- Cometbft version: `0.37.2`
- CHAIN_ID: `TBD`

- CHAIN_ID: `shielded-expedition.3d767ac5d5`
## Latest Testnet

- Namada public testnet 15:
- Namada public testnet 15 (offline):
- From date: 18th of December 2023 17:00 UTC
- Namada protocol version: `v0.28.1`
- Cometbft version: `0.37.2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Before starting a full node, the unique identifier of the `chain-id` will be nee
Once the `chain-id` has been distributed, it is possible to join the network with the `CHAIN_ID`:
```bash copy
export CHAIN_ID="namada-mainnet" ## (replace with the actual chain-id)
namada client utils join-network --chain-id $CHAIN_ID
NAMADA_NETWORK_CONFIGS_SERVER="https://github.com/anoma/namada-shielded-expedition/releases/download/shielded-expedition.b40d8e9055" namada client utils join-network --chain-id $CHAIN_ID
```

### Start your node and sync
Expand Down
4 changes: 3 additions & 1 deletion packages/docs/pages/operators/networks/local-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ python3 ./scripts/gen_localnet.py \
--mode release # Assuming the binaries were built using `make build-release` \
--parameters '{"parameters": {"max_expected_time_per_block": 10}, "pos_params": {"pipeline_len": 5}}'
# In order to change max_expected_time_per_block to 10 seconds from the default 30, and the pipeline length to 5 epochs from the default 2.
--num-nodes 2 # OPTIONAL: To run the localnet with 2 nodes
--num-vals 2 # OPTIONAL: To run the localnet with 2 validators
```

### Modifying the genesis configuration file
Expand All @@ -65,7 +67,7 @@ The genesis configuration can be modified in two ways. One is to change the cont

## Running the ledger

After the script has been run, a python process will have started in the background.
After the script has been run, all of the necessary folders will have been set up to run the chain.
The ledger can be run through the familiar command:

```shell
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/pages/users/governance/on-chain-governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ In the content field, most of the fields are self-explanatory. The `requires` fi
You should change the value of:

- `Author` field with the address of `my-new-acc`;
- `voting_start_epoch` with a future epoch (must be a multiple of 3) for which you want the voting to begin;
- `voting_end_epoch` with an epoch greater than `voting_start_epoch`, a multiple of 3, and by which no further votes will be accepted;
- `grace_epoch` with an epoch greater than `voting_end_epoch` + 6, in which the proposal, if passed, will come into effect.
- `voting_start_epoch` with a future epoch (must be a multiple of the `min-voting-period` found in the `parameters.toml`) for which you want the voting to begin;
- `voting_end_epoch` with an epoch greater than `voting_start_epoch`, a multiple of `min-voting-period`, and by which no further votes will be accepted;
- `grace_epoch` with an epoch greater than `voting_end_epoch` + `, in which the proposal, if passed, will come into effect.

The `data` field and its structure is dependent on the type of proposal being submitted. Below we outline the structure of the "data" field for each type of proposal. The one given in the example above is for a `Default Proposal`.

Expand Down
7 changes: 5 additions & 2 deletions packages/docs/pages/users/transparent-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Namada uses [ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) keypairs for
To manage your keys, various sub-commands are available under:

```shell copy
namada wallet key
namada wallet --help
```

### Generate a keypair
Expand Down Expand Up @@ -61,9 +61,12 @@ Loss of any of them would inevitably lead to impossible account recovery.

To recover the keypair from your mnemonic code and passphrase use
```shell copy
namada wallet key restore --alias keysha --hd-path default
namada wallet key derive --alias keysha --hd-path default
```

This will ask you to then enter a passphrase (unless you add the `--unsafe-dont-encrypt` flag),
and then will ask you to enter your mnemonic code.

### List all known keys

```shell copy
Expand Down

0 comments on commit 0e462a4

Please sign in to comment.