Skip to content

Commit dec61b1

Browse files
committed
chore(docs): update docs for testnet 10
1 parent ddd40e6 commit dec61b1

File tree

10 files changed

+49
-102
lines changed

10 files changed

+49
-102
lines changed

docs/src/content/docs/infrastructure/node-operators/getting-started.mdx

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Code from '#/components/Code.astro'
99
import DownloadFile from "#/components/DownloadFile.astro"
1010
import { Tabs, TabItem } from "@astrojs/starlight/components"
1111
import FunctionResult from '#/components/FunctionResult.astro'
12-
import { chainVersion, getSeedsParts } from '#/lib/constants/versions.ts'
12+
import { chainVersion } from '#/lib/constants/versions.ts'
1313

1414
This guide is intended for validators running on bare-metal servers and explains how Union releases work. Check out the [NixOS](/infrastructure/node-operators/nixos/) and the [Kubernetes](/infrastructure/node-operators/kubernetes/) guide for more production-ready deployments.
1515

@@ -38,14 +38,14 @@ Double-check the version and architecture in the link before downloading.
3838
```sh frame="none"
3939
curl --output uniond --location https://github.com/unionlabs/union/releases/download/$UNIOND_VERSION/uniond-release-x86_64-linux
4040
```
41-
*Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />*
41+
*Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />*
4242

4343
</TabItem>
4444
<TabItem label='aarch64-linux'>
4545
```sh frame='none'
4646
curl --output uniond --location https://github.com/unionlabs/union/releases/download/$UNIOND_VERSION/uniond-release-aarch64-linux
4747
```
48-
*Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />*
48+
*Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />*
4949

5050
</TabItem>
5151
</Tabs>
@@ -70,7 +70,7 @@ We also provide containers in our [package registry](https://github.com/orgs/uni
7070
docker pull ghcr.io/unionlabs/uniond-release:$UNIOND_VERSION
7171
```
7272

73-
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />_
73+
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />_
7474

7575
When running the container, make sure to map a volume to the path passed in `--home` options to ensure data persistence. From here on the guide assumes the usage of a regular binary. The [docker-compose](/infrastructure/node-operators/docker-compose/) section is more suited for docker users.
7676

@@ -87,7 +87,7 @@ We'll need to set up a few configuration files and obtain the <DownloadFile file
8787
First, set some environment variables, which are used throughout initialization.
8888

8989
```sh title="env.sh"
90-
export CHAIN_ID=union-testnet-9
90+
export CHAIN_ID=union-testnet-10
9191
export MONIKER="Unionized Goblin"
9292
export KEY_NAME=alice
9393
export GENESIS_URL="https://union.build/genesis.json"
@@ -99,18 +99,6 @@ Then we'll have `uniond` initialize our data and configuration directories. By d
9999
uniond init $MONIKER --chain-id $CHAIN_ID
100100
```
101101

102-
### Seeds
103-
104-
Next, edit `~/.union/config/config.toml`. We'll set the seeds to ensure your node can connect to the peer-to-peer network.
105-
106-
For `union-testnet-9` replace `seeds = ""` with:
107-
108-
<Code
109-
lang='toml'
110-
code={`seeds = "${chainVersion({ chainId: 'union-testnet-9' }).seeds}"`}
111-
/>
112-
113-
114102
### Genesis Configuration
115103

116104
Download the `genesis.json` and copy it to your `uniond` home directory.

docs/src/content/docs/infrastructure/node-operators/node-configuration.mdx

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Located in `config/client.toml`, this file is host to client settings.
2121

2222
Update this value to ensure that your client is supplied with the correct chain ID.
2323

24-
For the Union Testnet, this value should be `"union-testnet-9"`.
24+
For the Union Testnet, this value should be `"union-testnet-10"`.
2525

2626
```toml
2727
# The network chain ID
28-
chain-id = "union-testnet-9"
28+
chain-id = "union-testnet-10"
2929
```
3030

3131
### Host/Port for the Tendermint RPC
@@ -47,7 +47,7 @@ Located in `config/app.toml`, this file is host to app settings.
4747

4848
Located under the "Base Configuration" section of `config/app.toml`.
4949

50-
While optional, you may wish to ensure your node receives a minimum fee when processing transactions. Whatever you choose for this value, ensure it uses the correct denom. For the Union Testnet, the correct denom is `muno`.
50+
The [skip-mev/feemarket](https://github.com/skip-mev/feemarket/) module sets a global gas price/fee. To ensure consistency with the rest of the network, set this to `"0muno"`.
5151

5252
```toml
5353
# The minimum gas prices a validator is willing to accept for processing a
@@ -96,7 +96,7 @@ timeout_precommit_delta = "500ms"
9696
# How long we wait after committing a block, before starting on the new
9797
# height (this gives us a chance to receive some more precommits, even
9898
# though we already have +2/3).
99-
timeout_commit = "3s"
99+
timeout_commit = "5s"
100100
```
101101

102102
### RPC Listening Address
@@ -140,18 +140,6 @@ If you've configured a domain name for your node, this is the place to inform yo
140140
external_address = "example.com:26656"
141141
```
142142

143-
### Seeds
144-
145-
Located in the `p2p` TOML table under the "P2P Configuration Options" section.
146-
147-
Seed nodes help orchestrate initial connections to the network. For union-testnet-9, the seed nodes are:
148-
149-
<Code
150-
lang='toml'
151-
code={`seeds = "${chainVersion({ chainId: 'union-testnet-9' }).seeds}"`}
152-
/>
153-
154-
155143
### Seed Mode
156144

157145
Located in the `p2p` TOML table under the "P2P Configuration Options" section.

docs/src/content/docs/joining-testnet/creating-validators.mdx

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -65,40 +65,14 @@ Replacing:
6565
- `<MONIKER>` with your moniker
6666
- And the optional content with your preferred details
6767

68-
### 2) Create a Proof of Possession
69-
70-
:::note
71-
72-
This step is currently specific to the Union network, other Cosmos based chains do not currently replicate this process.
73-
74-
:::
75-
76-
Assuming your private validator key is in the default location:
77-
78-
<Tabs>
79-
<TabItem label='uniond-release'>
80-
```sh frame="none"
81-
export PRIV_KEY=$(jq -r '.priv_key.value' ~/.union/config/priv_validator_key.json)
82-
export POSSESSION_PROOF=$(uniond prove-possession "$PRIV_KEY")
83-
```
84-
</TabItem>
85-
<TabItem label='Unionvisor'>
86-
```sh frame="none"
87-
export PRIV_KEY=$(jq -r '.priv_key.value' ~/.unionvisor/home/config/priv_validator_key.json)
88-
export POSSESSION_PROOF=$(uniond prove-possession "$PRIV_KEY")
89-
```
90-
</TabItem>
91-
</Tabs>
92-
93-
94-
### 3) Run the Create Validator Command
68+
### 2) Run the Create Validator Command
9569

9670
Then you can submit this file using the `create-union-validator` sub-command:
9771

9872
```sh frame="none"
99-
uniond union-staking create-union-validator $VALIDATOR_JSON_PATH $POSSESSION_PROOF \
100-
--from $KEY_NAME \
101-
--chain-id union-testnet-9
73+
uniond tx poa create-validator path/to/validator.json \
74+
--from $KEY_NAME \
75+
--chain-id union-testnet-10
10276
```
10377

10478
_Where `VALIDATOR_JSON_PATH` is the path to your `validator.json`_
@@ -116,9 +90,9 @@ touch ~/.unionvisor/validator.json
11690

11791
# Then after editing the json content
11892

119-
uniond union-staking create-union-validator /.unionvisor/validator.json $POSSESSION_PROOF \
93+
uniond tx poa create-validator /.unionvisor/validator.json \
12094
--from $KEY_NAME \
121-
--chain-id union-testnet-9
95+
--chain-id union-testnet-10
12296
```
12397

12498
:::

docs/src/content/docs/joining-testnet/faq.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,21 @@ As we continue onboarding validators and expanding the testnet, we'll populate t
88

99
### How can I become a validator?
1010

11-
We started our testnet with the goal of onboarding 64 validators. The sign-up form for these first 64 slots has been closed.
12-
13-
We have now expanded the Union testnet to support 128 validators. Those interested can submit their Union address to the Subo Survey Bot on [our Discord](https://discord.gg/union-build) to have a chance of being selected as a validator and receiving tokens from the Union team. The Subo "Union Testnet Validator Intake Form" closed on February 19th, 2024.
11+
The Union testnet is fully permissioned. We are not actively seeking new validators at this time.
1412

1513
### Why can't I submit transactions to `localhost` when using `docker run`?
1614

1715
Ensure you have exposed your host machine's network via the `--network` flag in docker.
1816

19-
### My query commands aren't using values from my client config?
17+
### My query commands aren't using values from my client config? (uniond v0.25.0 and lower)
2018

2119
Due to [an issue in the cosmos-sdk](https://github.com/cosmos/cosmos-sdk/issues/18868), commands using AutoCLI do not respect the `--home` flag and instead always try and read the default home. As a temporary fix, we've removed the behavior reading the default home, always require a `--home` flag, and moved all `tx` commands away from AutoCLI. However, `query` commands still use AutoCLI and won't read the `--home` flag.
2220

2321
To get around this behavior, we suggest always supplying `--node` and `--chain-id` when using query commands.
2422

2523
### Can I have access to the Union GitHub repository?
2624

27-
We are not currently providing the general public access to our GitHub repositories.
25+
You can find the Union monorepo at [unionlabs/union](https://github.com/unionlabs/union/)
2826

2927
### Other questions?
3028

docs/src/content/docs/joining-testnet/getting-started.mdx

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@ sidebar:
44
order: 0
55
---
66

7-
Welcome to the Union Testnet! This guide will instruct you on running a node and creating a validator for `union-testnet-9`.
7+
Welcome to the Union Testnet! This guide will instruct you on running a node and creating a validator for `union-testnet-10`.
8+
9+
:::note
10+
Currently, `union-testnet-10` has a fully permissioned validator set that is managed via the [strangelove-ventures/poa](https://github.com/strangelove-ventures/poa/) module.
11+
:::
812

913
## Steps
1014

1115
These are the general steps for running a node and creating a validator for the Union testnet.
1216

13-
### Acquiring a Machine
17+
### Hardware Requirements
1418

1519
You may run the Union node on your own machine or a VPS, please ensure your machine or VPS meets our [node operator requirements](/infrastructure/node-operators/requirements/).
1620

@@ -30,15 +34,7 @@ For more manual control, we also release each version of `uniond` as a Docker im
3034

3135
### Getting Testnet Tokens
3236

33-
Visit the Testnet Faucet to receive tokens to experiment with the Union Testnet.
34-
35-
If you've been selected as a testnet validator and do not already have a token balance, please reach out in [our Discord](https://discord.union.build)
36-
37-
:::note
38-
39-
The faucet linked to the Union Testnet token transfer demo is not intended as a source of tokens for validators. The faucet exists only to allow users to experiment with the demo.
40-
41-
:::
37+
Tokens will be distributed by the Union team to those that need them to create their validator or conduct testing.
4238

4339
### Creating a Validator
4440

docs/src/content/docs/joining-testnet/getting-tokens.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,6 @@ Take note of your `address` here and continue to [Receiving Testnet Tokens](#rec
5050

5151
## Receiving Testnet Tokens
5252

53-
Those interested can submit their Union address to the Subo Survey Bot on [our Discord](https://discord.union.build) to have a chance of being selected as a validator and receiving tokens from the Union team.
54-
55-
:::note
56-
57-
The Subo "Union Testnet Validator Intake Form" is set to close on February 19th, 2024.
58-
59-
:::
60-
6153
### Finding your Union Address
6254

6355
To ensure your account will have an UNO balance, please submit the address from your newly created or recovered account.

docs/src/content/docs/joining-testnet/obtaining-uniond.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To get the `uniond` image, you can visit [our container](https://github.com/orgs
1919
docker pull ghcr.io/unionlabs/uniond-release:$UNIOND_VERSION
2020
```
2121

22-
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />_
22+
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />_
2323

2424
## Running uniond
2525

@@ -94,7 +94,7 @@ For example, in `zsh`, you can add the following alias to your `.zshrc`:
9494
alias uniond='docker run -v ~/.union:/.union -v /tmp:/tmp --network host -it ghcr.io/unionlabs/uniond-release:$UNIOND_VERSION --home /.union'
9595
```
9696

97-
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />_
97+
_Where `UNIOND_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />_
9898

9999
This will enable you to issue `uniond` sub-commands with such as `uniond keys add` with ease.
100100

docs/src/content/docs/joining-testnet/unionvisor.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Unionvisor is a utility for managing `uniond` deployments. It manages running, u
1414

1515
## Obtaining Unionvisor
1616

17-
We release container images of Unionvisor called bundles. Each bundle contains everything required for running Unionvisor and joining a particular network. The Unionvisor bundle for `union-testnet-9` is `bundle-testnet-9`. You can obtain the Unionvisor bundle for `union-testnet-9` from our [GitHub Container Registry](https://github.com/orgs/unionlabs/packages/container/package/bundle-testnet-9).
17+
We release container images of Unionvisor called bundles. Each bundle contains everything required for running Unionvisor and joining a particular network. The Unionvisor bundle for `union-testnet-10` is `bundle-testnet-10`. You can obtain the Unionvisor bundle for `union-testnet-10` from our [GitHub Container Registry](https://github.com/orgs/unionlabs/packages/container/package/bundle-testnet-10).
1818

1919
Alternatively, you can run the following command:
2020

2121
```sh frame="none"
22-
docker pull ghcr.io/unionlabs/bundle-testnet-9:$UNIONVISOR_VERSION
22+
docker pull ghcr.io/unionlabs/bundle-testnet-10:$UNIONVISOR_VERSION
2323
```
2424

25-
_Where `UNIONVISOR_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />_
25+
_Where `UNIONVISOR_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />_
2626

2727
## Running Unionvisor
2828

@@ -54,10 +54,10 @@ To do this, we'll be using Docker volumes.
5454
docker run \\
5555
--volume ~/.unionvisor:/.unionvisor \\
5656
--volume /tmp:/tmp \\
57-
-it ghcr.io/unionlabs/bundle-testnet-9:$UNIONVISOR_VERSION \\
57+
-it ghcr.io/unionlabs/bundle-testnet-10:$UNIONVISOR_VERSION \\
5858
init --moniker $MONIKER \\
59-
--network union-testnet-9 \\
60-
--seeds "${chainVersion({chainId: 'union-testnet-9'}).seeds}"
59+
--network union-testnet-10 \\
60+
--seeds "${chainVersion({chainId: 'union-testnet-10'}).seeds}"
6161
`)}
6262
/>
6363
_Where `MONIKER` is the preferred moniker you'd like to use on this node._
@@ -86,7 +86,7 @@ After the above command is done running, you should have a `.unionvisor` folder
8686
- data
8787
- priv_validator_state.json
8888
- versions
89-
- <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />- uniond
89+
- <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />- uniond
9090

9191
</FileTree>
9292

@@ -122,7 +122,7 @@ You can use the `set-uniond-version` command as follows:
122122
docker run \
123123
--volume ~/.unionvisor:/.unionvisor \
124124
--volume /tmp:/tmp \
125-
-it ghcr.io/unionlabs/bundle-testnet-9:$UNIONVISOR_VERSION \
125+
-it ghcr.io/unionlabs/bundle-testnet-10:$UNIONVISOR_VERSION \
126126
set-uniond-version $UNIOND_VERSION
127127
```
128128
*Where `UNIOND_VERSION` is the version of `uniond` used when the snapshot was generated*
@@ -135,10 +135,10 @@ To run `uniond` sub-commands, it will be useful to alias the Docker command in y
135135
For example, in `zsh`, you can add the following alias to your `.zshrc`:
136136

137137
```sh frame="none"
138-
alias uniond='docker run -v ~/.unionvisor:/.unionvisor -v /tmp:/tmp --network host -it ghcr.io/unionlabs/bundle-testnet-9:$UNIONVISOR_VERSION --log-level off call --'
138+
alias uniond='docker run -v ~/.unionvisor:/.unionvisor -v /tmp:/tmp --network host -it ghcr.io/unionlabs/bundle-testnet-10:$UNIONVISOR_VERSION --log-level off call --'
139139
```
140140

141-
_Where `UNIONVISOR_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-9'}).current} />_
141+
_Where `UNIONVISOR_VERSION` is <FunctionResult result={chainVersion({chainId: 'union-testnet-10'}).current} />_
142142

143143
:::note
144144

@@ -158,7 +158,7 @@ A minimal Docker Compose file for Unionvisor looks like this:
158158
```yaml
159159
services:
160160
node:
161-
image: ghcr.io/unionlabs/bundle-testnet-9:$UNIONVISOR_VERSION
161+
image: ghcr.io/unionlabs/bundle-testnet-10:$UNIONVISOR_VERSION
162162
volumes:
163163
- ~/.unionvisor:/.unionvisor
164164
- /tmp:/tmp

docs/src/content/docs/joining-testnet/upgrade-history.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,14 @@ import { Badge } from "@astrojs/starlight/components";
88

99
Here you can find records of Union network binary upgrades.
1010

11+
## union-testnet-10
12+
13+
The network `union-testnet-10` has had no binary upgrades since its genesis.
14+
1115
## union-testnet-9
1216

17+
<Badge text="Deprecated" variant="caution" />
18+
1319
The network `union-testnet-9` has had no binary upgrades since its genesis.
1420

1521
| Upgrade | Height |

versions/versions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,10 @@
3333
"versions": ["v1.0.0"],
3434
"current": "v1.0.0",
3535
"seeds": ""
36+
},
37+
"union-testnet-10": {
38+
"versions": ["v1.0.0"],
39+
"current": "v1.0.0",
40+
"seeds": ""
3641
}
3742
}

0 commit comments

Comments
 (0)