Skip to content

Commit

Permalink
feat: tabbed verifier onboarding instructions (#1015)
Browse files Browse the repository at this point in the history
  • Loading branch information
ffe9f8 authored Jun 26, 2024
1 parent 5e474e7 commit 44fca1c
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions src/pages/validator/amplifier/verifier-onboarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,24 @@ By running a **verifier** for a chain integration with Axelar's Amplifier, you w

A verifier uses `ampd`, an off-chain daemon responsible for voting and signing with the Amplifier protocol, and `tofnd`, a threshold cryptography library that `ampd` depends on.

There are two ways to set up and run a verifier:
There are three ways to set up and run a verifier:

- **Option 1: Binaries** -- This method requires you to install and run the `tofnd` and `ampd` binaries on your local machine.
- **Option 2: Docker** -- Use [Docker](https://docs.docker.com/engine/install/) to set up `tofnd` and `ampd`.
- **Option 1: Source** -- Clone and build directly from the GitHub source code.
- **Option 2: Binaries** -- This method requires you to install and run the `tofnd` and `ampd` binaries on your local machine.
- **Option 3: Docker** -- Use [Docker](https://docs.docker.com/engine/install/) to set up `tofnd` and `ampd`.

## Set up `tofnd`

`ampd` needs access to a locally running `tofnd` instance in order to onboard as a verifier or run the daemon. See the [tofnd repository](https://github.com/axelarnetwork/tofnd) for more information.

<tabs>

<tab-item title="Source">
Install `tofnd` from source by cloning and building the [`tofnd` repository](https://github.com/axelarnetwork/tofnd).
</tab-item>

<tab-item title="Binary">
Download the [`tofnd` binary](https://github.com/axelarnetwork/axelar-amplifier/releases/tag/ampd-v0.4.0) depending on the type of machine you have:
Download the [`tofnd` binary](https://github.com/axelarnetwork/tofnd/releases) depending on the type of machine you have:
- Linux: [`tofnd-linux-amd64-v0.10.5`](https://github.com/axelarnetwork/tofnd/releases/download/v0.10.5/tofnd-linux-amd64-v0.10.5)
- Apple Silicon Mac: [`tofnd-darwin-arm64-v0.10.5`](https://github.com/axelarnetwork/tofnd/releases/download/v0.10.5/tofnd-darwin-arm64-v0.10.5)
- Intel Mac: [`tofnd-darwin-amd64-v0.10.5`](https://github.com/axelarnetwork/tofnd/releases/download/v0.10.5/tofnd-darwin-amd64-v0.10.5)
Expand All @@ -39,7 +44,6 @@ docker run -p 50051:50051 --env MNEMONIC_CMD=auto --env NOPASSWORD=true -v tofnd
```

Leave this process running in the background, and perform additional commands in a new terminal window or shell.

</tab-item>

</tabs>
Expand All @@ -48,6 +52,10 @@ Leave this process running in the background, and perform additional commands in

<tabs>

<tab-item title="Source">
Install `ampd` from source by cloning and building the [`axelar-amplifier` repository](https://github.com/axelarnetwork/axelar-amplifier).
</tab-item>

<tab-item title="Binary">
Download the [`ampd` binary](https://github.com/axelarnetwork/axelar-amplifier/releases/tag/ampd-v0.4.0) depending on the type of machine you have:
- Linux: [`ampd-linux-amd64-v0.4.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.4.0/ampd-linux-amd64-v0.4.0)
Expand All @@ -60,18 +68,15 @@ From [Docker](https://hub.docker.com/r/axelarnet/axelar-ampd), pull and run the

```bash
docker pull axelarnet/axelar-ampd:v0.4.0
docker run axelarnet/axelar-ampd:v0.4.0 verifier-address
```
</tab-item>

<tab-item title="Source">
Install `ampd` from source by cloning and building the [`axelar-amplifier` repository](https://github.com/axelarnetwork/axelar-amplifier).
</tab-item>

</tabs>

## Add `ampd` to your `PATH`

This will allow you to begin commands with `ampd`.
This will allow you to begin commands with `ampd`. If you set up `ampd` through source or Docker, make sure to build a binary first.

1. Add a symbolic link named `ampd` to the `ampd` binary on your machine:

Expand Down Expand Up @@ -153,6 +158,10 @@ You can choose a different location for `config.toml` and refer to your chosen l
ampd -config /home/me/devnet-verifiers.toml
```
<Callout>
If you get a transport error with an `ampd` command, make sure that you have `tofnd` running in the background.
</Callout>
## Fund your wallet
Prior to running the `ampd` daemon, you will need to set up your wallet with devnet funds.
Expand Down

0 comments on commit 44fca1c

Please sign in to comment.