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

added chiado updates #890

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
4 changes: 3 additions & 1 deletion docs/developer-docs/.spelling
Original file line number Diff line number Diff line change
Expand Up @@ -249,4 +249,6 @@ webhooks
wardenprotocol.org
SDK-based
backend
frontend
frontend
Evmos
Chiado
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To become a **Keychain operator**, you need to create and configure a Keychain e

1. Run a local chain as explained here: [Run a local chain](/operate-a-node/run-a-local-chain).

To become an actual Keychain operator, you need to [join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista) instead. However, we recommend running a local chain first to test your configuration.
To become an actual Keychain operator, you need to [join Chiado](/operate-a-node/chiado-testnet/join-chiado) instead. However, we recommend running a local chain first to test your configuration.

For the rest of this guide, we'll assume you have a running Warden Protocol node with a local account (key) that has a few [WARD tokens](/tokens/ward-token/ward). You'll use these tokens to fund the Keychain and its Writers.

Expand Down Expand Up @@ -152,6 +152,6 @@ To add a Keychain Writer, take these steps:

The next steps depend on your goals:

- To become an actual Keychain operator, [join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista) and create a Keychain there.
- To become an actual Keychain operator, [join Chiado](/operate-a-node/chiado-testnet/join-chiado) and create a Keychain there.
- To start fulfilling key and signature requests, follow this guide: [Fulfill requests from CLI](fulfill-requests-from-cli).
- To start building a Keychain service, follow [Build a Keychain app](../build-a-keychain-app).
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Learn more:

Before you start, complete the following prerequisites:

- [Run a local chain](/operate-a-node/run-a-local-chain) or [Join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista). Make sure the node is running.
- [Run a local chain](/operate-a-node/run-a-local-chain) or [Join Chiado](/operate-a-node/chiado-testnet/join-chiado). Make sure the node is running.
ijonele marked this conversation as resolved.
Show resolved Hide resolved
- Make sure you can request a new key – for example, from [SpaceWard](https://help.wardenprotocol.org/spaceward/manage-keys#request-a-key).
- [Create a Keychain](create-a-keychain).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ After you execute the WASM contract on Warden, it'll be able to burn tokens from

Note that this guide assumes you have a basic familiarity with Solidity and Rust and smart contract deployment.

:::tip
Axelar GMP will be soon available on our new testnet – [Chiado](/operate-a-node/chiado-testnet/join-chiado). Stay tuned in for updates!
:::

## 1. Deploy an EVM contract on Sepolia

### The contract overview
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/docs/build-an-app/examples-of-oapps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this section you'll find a full list of **Omnichain Applications** that are c

SpaceWard is our application functioning as the front-end interface for Warden:

- 👉 [Try SpaceWard](https://spaceward.buenavista.wardenprotocol.org)
- 👉 [Try SpaceWard](https://spaceward.chiado.wardenprotocol.org)
- 👉 [Visit SpaceWard docs](https://help.wardenprotocol.org)

## YieldWard
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-docs/docs/learn/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Learn more: [Key request flow](/learn/request-flow#key-request-flow)

## Key request fee

[Keychain](#keychain) operators can set fees in [WARD](#ward-token) for [key requests](#key-request). The Keychain collects fees to its [ID](#keychain-id), and then the Keychain operator can manage these funds. Key request fees are indicated in uWARD (0.000001 WARD).
[Keychain](#keychain) operators can set fees in [WARD](#ward-token) for [key requests](#key-request). The Keychain collects fees to its [ID](#keychain-id), and then the Keychain operator can manage these funds. Key request fees are indicated in aWARD (0.000000000000000001 WARD).

---

Expand Down Expand Up @@ -223,7 +223,7 @@ Learn more: [Signature request flow](/learn/request-flow#signature-request-flow)

## Signature request fee

[Keychain](#keychain) operators can set fees in [WARD](#ward-token) for [signature requests](#signature-request). The Keychain collects fees to its [ID](#keychain-id), and then the Keychain operator can manage these funds. Signature request fees are indicated in uWARD (0.000001 WARD).
[Keychain](#keychain) operators can set fees in [WARD](#ward-token) for [signature requests](#signature-request). The Keychain collects fees to its [ID](#keychain-id), and then the Keychain operator can manage these funds. Signature request fees are indicated in aWARD (0.000000000000000001 WARD).

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"position": 3,
"position": 4,
"label": "Buenavista testnet",
"collapsible": true,
"collapsed": false,
"collapsed": true,
"link": {
"type": "generated-index",
"title": "Networks"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,14 @@ import PersistentPeers from "@site/src/components/PersistentPeers";
This tutorial explains how to run the Warden binary, `wardend`, and join the **Buenavista testnet**:

- The chain ID in queries: `buenavista-1`
- Denomination: `uward` / 0.000001 WARD
- Endpoints: [networks repository > buenavista](https://github.com/warden-protocol/networks/tree/main/testnets/buenavista)
- The current `wardend` version: **v0.4.2**

:::warning
We're transitioning from Buenavista to our new and improved testnet, [Chiado](../chiado-testnet/join-chiado). For now, both networks are running simultaneously, but we're going to sunset Buenavista. Please make sure to transition all your testing and development processes to [Chiado](../chiado-testnet/join-chiado).
:::

## Version history

| Release | Upgrade block height | Upgrade date |
Expand Down Expand Up @@ -96,7 +101,7 @@ https://rpc.buenavista.wardenprotocol.org
1. From this RPC endpoint, you can get the trusted block height and hash:

```bash
export SNAP_RPC_SERVERS="https://rpc.buenavista.wardenprotocol.org:443,https://rpc.buenavista.wardenprotocol.org:443 "
export SNAP_RPC_SERVERS="https://rpc.buenavista.wardenprotocol.org:443,https://rpc.buenavista.wardenprotocol.org:443"
export LATEST_HEIGHT=$(curl -s "https://rpc.buenavista.wardenprotocol.org/block" | jq -r .result.block.header.height)
export BLOCK_HEIGHT=$((LATEST_HEIGHT - 2000))
export TRUST_HASH=$(curl -s "https://rpc.buenavista.wardenprotocol.org/block?height=$BLOCK_HEIGHT" | jq -r .result.block_id.hash)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"position": 3,
"label": "Chiado testnet",
"collapsible": true,
"collapsed": false,
"link": {
"type": "generated-index",
"title": "Chiado testnet"
},
"customProps": {}
}
126 changes: 126 additions & 0 deletions docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
sidebar_position: 1
---

import PersistentPeers from "@site/src/components/PersistentPeers";

# Join Chiado

## Overview

This tutorial explains how to run the Warden binary, `wardend`, and join the **Chiado testnet**:

- The chain ID in queries: `chiado_10010-1`
- Denomination: `award` / 0.000000000000000001 WARD
- Endpoints: [networks repository > chiado](https://github.com/warden-protocol/networks/tree/main/testnets/chiado)
- The current `wardend` version: **v0.5.0**

:::tip
Chiado is our new and improved testnet. Please make sure to transition all your testing and development processes here. Also note that on Chiado we've changed the denomination to `award`.
:::

## Version history

| Release |
| ------- |
| v0.5.0 |

## Prerequisites

- We recommend running public testnet nodes on machines with the following characteristics:

- at least 8 cores
- 32GB of RAM
- 300GB of disk space

- You also need to [install Go](https://golang.org/doc/install) 1.22.3 or later.

## 1. Install

To join Chiado, install `wardend` (the Warden binary) using the script below. There are two ways to do it:

### Option 1: Use the prebuilt binary

1. Download the binary for your platform from the [release page](https://github.com/warden-protocol/wardenprotocol/releases) and unzip it. The archive contains the `wardend` binary.

2. Initialize the chain home folder:

```bash
./wardend init my-chain-moniker
```

### Option 2: Use the source code

Build the `wardend` binary and initialize the chain home folder:

```bash
git clone --depth 1 --branch v0.5.0 https://github.com/warden-protocol/wardenprotocol
just wardend build

build/wardend init my-chain-moniker
```

## 2. Configure

To configure `wardend`, do the following:

1. Prepare the genesis file:

```bash
cd $HOME/.warden/config
rm genesis.json
wget https://chiado-genesis.s3.eu-west-1.amazonaws.com/genesis.json.tar.xz | tar -xJ
```

2. Set the mandatory configuration options: the minimum gas price and persistent peers.

```bash
sed -i 's/minimum-gas-prices = ""/minimum-gas-prices = "250000000000000award"/' app.toml
```

<PersistentPeers
chainInfoUrl='https://raw.githubusercontent.com/warden-protocol/networks/main/testnets/chiado/chain.json'
code={`sed -i 's/persistent_peers = ""/persistent_peers = "{{persistent_peers}}"/' config.toml`} />

## 3. Set up the state sync

:::tip
This step is recommended but optional.
:::

To speed up the initial sync, you can use the state sync feature. This will allow you to download the state at a specific height from a trusted node and after that only download the blocks from the network.

You'll need to use a [trusted RPC endpoint](https://github.com/warden-protocol/networks/blob/main/testnets/chiado/chain.json) – for example, the following:
```bash
https://rpc.chiado.wardenprotocol.org
```
1. From this RPC endpoint, you can get the trusted block height and hash:
```bash
export SNAP_RPC_SERVERS="https://rpc.chiado.wardenprotocol.org:443,https://rpc.chiado.wardenprotocol.org:443"
export LATEST_HEIGHT=$(curl -s "https://rpc.chiado.wardenprotocol.org/block" | jq -r .result.block.header.height)
export BLOCK_HEIGHT=$((LATEST_HEIGHT - 2000))
export TRUST_HASH=$(curl -s "https://rpc.chiado.wardenprotocol.org/block?height=$BLOCK_HEIGHT" | jq -r .result.block_id.hash)
```
2. Check that all variables have been set correctly:
```bash
echo $LATEST_HEIGHT $BLOCK_HEIGHT $TRUST_HASH
# output should be similar to:
# 70694 68694 6AF4938885598EA10C0BD493D267EF363B067101B6F81D1210B27EBE0B32FA2A
```
3. Add the state sync configuration to your `config.toml`:
```bash
sed -i.bak -E "s|^(enable[[:space:]]+=[[:space:]]+).*$|\1true| ; \
s|^(rpc_servers[[:space:]]+=[[:space:]]+).*$|\1\"$SNAP_RPC_SERVERS\"| ; \
s|^(trust_height[[:space:]]+=[[:space:]]+).*$|\1$BLOCK_HEIGHT| ; \
s|^(trust_hash[[:space:]]+=[[:space:]]+).*$|\1\"$TRUST_HASH\"|" $HOME/.warden/config/config.toml
```
ijonele marked this conversation as resolved.
Show resolved Hide resolved
## 4. Start the node
Now you can start the node using the following command:
```bash
wardend start
```
It'll connect to persistent peers provided and start downloading blocks. You can check the logs to see the progress.

## Next steps

If you want to create a validator in the testnet, follow the instructions in the [Create a validator](/operate-a-node/create-a-validator) section.
22 changes: 13 additions & 9 deletions docs/developer-docs/docs/operate-a-node/create-a-validator.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Create a validator

This is a simple step-by-step guide for setting up a validator on Buenavista testnet. It's not a guide on validator architecture or security features.
This is a simple step-by-step guide for setting up a validator on Chiado testnet. It's not a guide on validator architecture or security features.

:::tip
We're transitioning from [Buenavista](buenavista-testnet/join-buenavista) to our new and improved testnet, [Chiado](chiado-testnet/join-chiado). For now, both networks are running simultaneously, but we're going to sunset Buenavista. Please [join Chiado](chiado-testnet/join-chiado) and set up your validator here – then you can safely shut down your validators on Buenavista.
:::

## Prerequisites

The following instructions assume you have already set up a full-node and are synchronized to the latest block height. If you haven’t done so, please follow the [Join Buenavista](buenavista-testnet/join-buenavista) instructions.
The following instructions assume you have already set up a full-node and are synchronized to the latest block height. If you haven’t done so, please follow the [Join Chiado](chiado-testnet/join-chiado) instructions.

## 1. Create/restore a key pair

Expand Down Expand Up @@ -41,7 +45,7 @@ In the next steps, you'll register your new validator by submitting a `create-va
You can obtain testnet tokens from our **WARD faucet**:

```bash
curl -XPOST -d '{"address": "my-address"}' https://faucet.buenavista.wardenprotocol.org
curl -XPOST -d '{"address": "my-address"}' https://faucet.chiado.wardenprotocol.org
```

To verify your balance, use this command:
Expand All @@ -59,7 +63,7 @@ To create a validator and initialize it with a self-delegation, you need to crea
1. Obtain your validator public key by running the following command:

```bash
wardend comet show-validator
wardend tendermint show-validator
```

The output will be similar to this (with a different key):
Expand All @@ -73,7 +77,7 @@ To create a validator and initialize it with a self-delegation, you need to crea
```json
{
"pubkey": {"@type":"/cosmos.crypto.ed25519.PubKey","key":"lR1d7YBVK5jYijOfWVKRFoWCsS4dg3kagT7LB9GnG8I="},
"amount": "1000000uward",
"amount": "1000000000000000000award",
"moniker": "your validator human-readable name (moniker)",
"identity": "your validator identity signature",
"website": "(optional) your validator website",
Expand All @@ -93,8 +97,8 @@ To create a validator and initialize it with a self-delegation, you need to crea
```bash
wardend tx staking create-validator validator.json \
--from=my-key-name \
--chain-id=buenavista-1 \
--fees=500uward
--chain-id=chiado_10010-1 \
--fees=500000000000000award
```

**✏️ CAUTION**
Expand All @@ -117,7 +121,7 @@ There are certain files you need to backup to be able to restore your validator
Check if your validator is in the active set by running this command:

```bash
wardend query comet-validator-set | grep "$(wardend comet show-address)"
wardend query tendermint-validator-set | grep "$(wardend comet show-address)"
```

If the output is empty, your validator isn't in the active set.
10 changes: 5 additions & 5 deletions docs/developer-docs/docs/operate-a-node/delegation-plan.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---

# Delegation plan
Expand All @@ -10,20 +10,20 @@ The primary objective of this delegation plan is to promote a robust, secure, an

See the sections below to learn the details of the plan.

## Buenavista performance
## Testnet stage

During Buenavista, the Warden Protocol team will be running a series of exercises with validators. The aim of these exercises is to test and prepare for a future mainnet event where the team will be delegating a portion of its token supply to qualifying validators.
During the testnet stage, the Warden Protocol team will be running a series of exercises with validators. The aim of these exercises is to test and prepare for a future mainnet event where the team will be delegating a portion of its token supply to qualifying validators.

## Delegation criteria

Validators are evaluated based on a combination of positive and negative metrics. Each metric contributes to the validator's overall score, determining their eligibility and priority in the delegation process. This ensures that only the most reliable and active validators are chosen to maintain and secure the network.

These metrics are, to name a few:

- Activity, Community engagement, blog posts
- Activity, community engagement, blog posts
- Uptime
- Services provided
- Buenavista performance
- Testnet performance

## Amount of tokens

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/docs/operate-a-node/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This section explains how to run a node and become a validator.
Here are the main steps to take:

1. If you wish to run a local chain for testing purposes, follow this guide: [Run a local chain](run-a-local-chain).
2. To get started with our testnet, follow [Join Buenavista](buenavista-testnet/join-buenavista).
2. To get started with our testnet, follow [Join Chiado](chiado-testnet/join-chiado).
ijonele marked this conversation as resolved.
Show resolved Hide resolved
3. After joining the network, you can become a validator: [Create a validator](create-a-validator).
4. To run the oracle service integrated with Warden, follow [Operate Skip:Connect](operate-skip-connect).
4. To interact with a node, use the [Node API](node-api-reference) and [node commands](node-commands).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---

# Node API reference
Expand Down
Loading
Loading