diff --git a/docs/developer-docs/.spelling b/docs/developer-docs/.spelling index 7c8eeacfd..c7cc4c53a 100644 --- a/docs/developer-docs/.spelling +++ b/docs/developer-docs/.spelling @@ -249,4 +249,6 @@ webhooks wardenprotocol.org SDK-based backend -frontend \ No newline at end of file +frontend +Evmos +Chiado \ No newline at end of file diff --git a/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md b/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md index 0187aa711..ceb106301 100644 --- a/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md +++ b/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md @@ -9,7 +9,7 @@ sidebar_position: 2 To become a **Keychain operator**, you need to create and configure a Keychain entity on-chain, as shown in this guide. :::tip -In the steps below, you'll interact with 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. +In the steps below, you'll interact with a [local chain](/operate-a-node/run-a-local-chain). 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. ::: :::tip @@ -193,6 +193,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). \ No newline at end of file diff --git a/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md b/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md index b509defb1..1e0b5ca74 100644 --- a/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md +++ b/docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md @@ -14,7 +14,7 @@ Learn more: - To learn more about key and signature requests, see [Request flow](/learn/request-flow). :::tip -In this guide, you'll interact with a [local chain](/operate-a-node/run-a-local-chain) and create key and signature requests using [node commands](/operate-a-node/node-commands). Alternatively, you can [Join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista) and take the same steps but create requests using [SpaceWard](https://help.wardenprotocol.org). +In this guide, you'll interact with a [local chain](/operate-a-node/run-a-local-chain) and create key and signature requests using [node commands](/operate-a-node/node-commands). Alternatively, you can [Join Chiado](/operate-a-node/chiado-testnet/join-chiado) and take the same steps but create requests using [SpaceWard](https://help.wardenprotocol.org). ::: ## Prerequisites @@ -24,7 +24,6 @@ Before you start, complete the following prerequisites: - [Run a local chain](/operate-a-node/run-a-local-chain). If you used [manual configuration](/operate-a-node/run-a-local-chain#option-2-configure-manually), make sure you [created a Space](/operate-a-node/run-a-local-chain#5-add-more-settings). - [Create a Keychain](create-a-keychain). You can skip it if you used our [`just` script](/operate-a-node/run-a-local-chain#option-1-run-a-just-script) to run the node. - ## 1. Install CLIChain To install CLIChain, navigate to the `wardenprotocol` directory and run this: diff --git a/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md b/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md index 400b5b0f6..159f743d4 100644 --- a/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md +++ b/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md @@ -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 diff --git a/docs/developer-docs/docs/build-an-app/examples-of-oapps.md b/docs/developer-docs/docs/build-an-app/examples-of-oapps.md index fd435b19c..ff3cda7e0 100644 --- a/docs/developer-docs/docs/build-an-app/examples-of-oapps.md +++ b/docs/developer-docs/docs/build-an-app/examples-of-oapps.md @@ -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 diff --git a/docs/developer-docs/docs/learn/glossary.md b/docs/developer-docs/docs/learn/glossary.md index 8d352adb2..58abe5c4b 100644 --- a/docs/developer-docs/docs/learn/glossary.md +++ b/docs/developer-docs/docs/learn/glossary.md @@ -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). --- @@ -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). --- diff --git a/docs/developer-docs/docs/operate-a-node/buenavista-testnet/_category_.json b/docs/developer-docs/docs/operate-a-node/buenavista-testnet/_category_.json index 41d6cbd96..9daee40b4 100644 --- a/docs/developer-docs/docs/operate-a-node/buenavista-testnet/_category_.json +++ b/docs/developer-docs/docs/operate-a-node/buenavista-testnet/_category_.json @@ -1,8 +1,8 @@ { - "position": 3, + "position": 4, "label": "Buenavista testnet", "collapsible": true, - "collapsed": false, + "collapsed": true, "link": { "type": "generated-index", "title": "Networks" diff --git a/docs/developer-docs/docs/operate-a-node/buenavista-testnet/join-buenavista.md b/docs/developer-docs/docs/operate-a-node/buenavista-testnet/join-buenavista.md index c391029e6..a47239087 100644 --- a/docs/developer-docs/docs/operate-a-node/buenavista-testnet/join-buenavista.md +++ b/docs/developer-docs/docs/operate-a-node/buenavista-testnet/join-buenavista.md @@ -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 | @@ -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) diff --git a/docs/developer-docs/docs/operate-a-node/chiado-testnet/_category_.json b/docs/developer-docs/docs/operate-a-node/chiado-testnet/_category_.json new file mode 100644 index 000000000..f4b8e374e --- /dev/null +++ b/docs/developer-docs/docs/operate-a-node/chiado-testnet/_category_.json @@ -0,0 +1,11 @@ +{ + "position": 3, + "label": "Chiado testnet", + "collapsible": true, + "collapsed": false, + "link": { + "type": "generated-index", + "title": "Chiado testnet" + }, + "customProps": {} +} \ No newline at end of file diff --git a/docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md b/docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md new file mode 100644 index 000000000..ed0b07dee --- /dev/null +++ b/docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md @@ -0,0 +1,127 @@ +--- +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.1 | + +## 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.1 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 + ``` + + + +## 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 + ``` +## 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. diff --git a/docs/developer-docs/docs/operate-a-node/create-a-validator.md b/docs/developer-docs/docs/operate-a-node/create-a-validator.md index a1db95c7c..9f52bfebf 100644 --- a/docs/developer-docs/docs/operate-a-node/create-a-validator.md +++ b/docs/developer-docs/docs/operate-a-node/create-a-validator.md @@ -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 @@ -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: @@ -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): @@ -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", @@ -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** @@ -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. \ No newline at end of file diff --git a/docs/developer-docs/docs/operate-a-node/delegation-plan.md b/docs/developer-docs/docs/operate-a-node/delegation-plan.md index a0b9e3d03..647ca798d 100644 --- a/docs/developer-docs/docs/operate-a-node/delegation-plan.md +++ b/docs/developer-docs/docs/operate-a-node/delegation-plan.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 --- # Delegation plan @@ -10,9 +10,9 @@ 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 @@ -20,10 +20,10 @@ Validators are evaluated based on a combination of positive and negative metrics 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 diff --git a/docs/developer-docs/docs/operate-a-node/introduction.md b/docs/developer-docs/docs/operate-a-node/introduction.md index 2b0b50937..775a62306 100644 --- a/docs/developer-docs/docs/operate-a-node/introduction.md +++ b/docs/developer-docs/docs/operate-a-node/introduction.md @@ -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). 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). diff --git a/docs/developer-docs/docs/operate-a-node/node-api-reference.md b/docs/developer-docs/docs/operate-a-node/node-api-reference.md index f5de968f2..b1973d48d 100644 --- a/docs/developer-docs/docs/operate-a-node/node-api-reference.md +++ b/docs/developer-docs/docs/operate-a-node/node-api-reference.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # Node API reference diff --git a/docs/developer-docs/docs/operate-a-node/node-commands.md b/docs/developer-docs/docs/operate-a-node/node-commands.md index aa7c15b6b..bdfc3dda2 100644 --- a/docs/developer-docs/docs/operate-a-node/node-commands.md +++ b/docs/developer-docs/docs/operate-a-node/node-commands.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 --- # Node commands @@ -28,7 +28,7 @@ For example, to check the node status, run the example below using the preferred ```bash wardend status \ - --node https://rpc.buenavista.wardenprotocol.org:443 + --node https://rpc.chiado.wardenprotocol.org:443 ``` :::tip @@ -75,14 +75,14 @@ Here are some of the available `wardend query warden` subcommands with examples: ```bash wardend query warden keychains \ - --node https://rpc.buenavista.wardenprotocol.org:443 + --node https://rpc.chiado.wardenprotocol.org:443 ``` - `spaces`: This command returns a list of your [Spaces](/learn/glossary#space). ```bash wardend query warden spaces\ - --node https://rpc.buenavista.wardenprotocol.org:443 + --node https://rpc.chiado.wardenprotocol.org:443 ``` ### `keys`: Manage keys @@ -143,8 +143,8 @@ For example, the `warden` command allows you to initiate [Warden](/learn/warden- wardend tx warden new-keychain \ --description 'my-description' \ --from my-key-name \ - --chain-id buenavista-1 \ - --node https://rpc.buenavista.wardenprotocol.org:443 + --chain-id chiado_10010-1 \ + --node https://rpc.chiado.wardenprotocol.org:443 ``` - `new-space`: This command creates a new [Space](/learn/glossary#space). It requires specifying your key name and the chain ID. @@ -152,6 +152,6 @@ For example, the `warden` command allows you to initiate [Warden](/learn/warden- ```bash wardend tx warden new-space \ --from my-key-name \ - --chain-id buenavista-1 \ - --node https://rpc.buenavista.wardenprotocol.org:443 + --chain-id chiado_10010-1 \ + --node https://rpc.chiado.wardenprotocol.org:443 ``` \ No newline at end of file diff --git a/docs/developer-docs/docs/operate-a-node/operate-skip-connect.md b/docs/developer-docs/docs/operate-a-node/operate-skip-connect.md index abb497f12..80c8536a5 100644 --- a/docs/developer-docs/docs/operate-a-node/operate-skip-connect.md +++ b/docs/developer-docs/docs/operate-a-node/operate-skip-connect.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- # Operate Skip:Connect @@ -59,7 +59,3 @@ client_timeout = "2s" # the oracle and the app. metrics_enabled = "true" ``` - -## 4. What's next? - -You're all set! Connect will be available on [Warden version v0.4.0](buenavista-testnet/upgrade/v0.4.0). \ No newline at end of file