Skip to content

Commit

Permalink
change ecsda -> ecdsa (#1051)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ffe9f8
ffe9f8 authored Jul 18, 2024
1 parent 2a30ead commit 58a70a2
Showing 1 changed file with 73 additions and 53 deletions.
126 changes: 73 additions & 53 deletions src/pages/validator/amplifier/verifier-onboarding.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Become an Amplifier Verifier

import { Callout } from "/src/components/callout"
import { Callout } from "/src/components/callout";

<Callout>
The Axelar Virtual Machine (AVM) and Amplifier are currently under active development, so these instructions are likely to change. Please check back frequently for updates.
The Axelar Virtual Machine (AVM) and Amplifier are currently under active
development, so these instructions are likely to change. Please check back
frequently for updates.
</Callout>

By running a **verifier** for a chain integration with Axelar's Amplifier, you will be responsible for voting on the validity of transactions on the Axelar network and signing command batches for a given chain.
Expand Down Expand Up @@ -41,6 +43,7 @@ Create a default mneumonic and configuration in `~/.tofnd/`, then back it up and
tofnd -m create
mv ~/.tofnd/export ~/.tofnd/export-new-location
```

</tab-item>

<tab-item title="Binary">
Expand All @@ -54,6 +57,7 @@ Create a default mneumonic and configuration in `~/.tofnd/`, then back it up and
~/Downloads/tofnd*-v1.0.1 -m create
mv ~/.tofnd/export ~/.tofnd/export-new-location
```

</tab-item>

<tab-item title="Docker">
Expand All @@ -74,14 +78,19 @@ 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).
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.6.0) depending on the type of machine you have:
- Linux: [`ampd-linux-amd64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-linux-amd64-v0.6.0)
- Apple Silicon Mac: [`ampd-darwin-arm64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-darwin-arm64-v0.6.0)
- Intel Mac: [`ampd-darwin-amd64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-darwin-amd64-v0.6.0)
Download the [`ampd`
binary](https://github.com/axelarnetwork/axelar-amplifier/releases/tag/ampd-v0.6.0)
depending on the type of machine you have: - Linux:
[`ampd-linux-amd64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-linux-amd64-v0.6.0)
- Apple Silicon Mac:
[`ampd-darwin-arm64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-darwin-arm64-v0.6.0)
- Intel Mac:
[`ampd-darwin-amd64-v0.6.0`](https://github.com/axelarnetwork/axelar-amplifier/releases/download/ampd-v0.6.0/ampd-darwin-amd64-v0.6.0)
</tab-item>

<tab-item title="Docker">
Expand All @@ -91,6 +100,7 @@ From [Docker](https://hub.docker.com/r/axelarnet/axelar-ampd), pull and run the
docker pull axelarnet/axelar-ampd:v0.6.0
docker run axelarnet/axelar-ampd:v0.6.0 verifier-address
```

</tab-item>

</tabs>
Expand All @@ -107,45 +117,48 @@ This will allow you to begin commands with `ampd`. If you set up `ampd` through
```bash
sudo ln -s ~/Downloads/ampd-*-v0.6.0 /usr/local/bin/ampd
```

1. Make the binary executable:

```bash
chmod a+x ~/Downloads/ampd-*-v0.6.0
```
```bash
chmod a+x ~/Downloads/ampd-*-v0.6.0
```

1. Restart your terminal.

1. Run `ampd --version` to make sure that the right version of `ampd` is being used. It should be `ampd 0.6.0`.

</tab-item>

<tab-item title="<code>bash</code> alias">
<Callout>
Replace `ampd-darwin-arm64-v0.6.0` with the [`ampd` binary you downloaded](/validator/amplifier/verifier-onboarding#set-up-ampd).
</Callout>
<Callout>
Replace `ampd-darwin-arm64-v0.6.0` with the [`ampd` binary you downloaded](/validator/amplifier/verifier-onboarding#set-up-ampd).
</Callout>

1. Add an alias to `ampd` at the end of the `.bashrc` file on your machine:

```bash
echo "ampd=~/Downloads/ampd-darwin-arm64-v0.6.0" >> ~/.bashrc
```
```bash
echo "ampd=~/Downloads/ampd-darwin-arm64-v0.6.0" >> ~/.bashrc
```

1. Save and close the file.

1. Reload the file to apply all changes:

```bash
source ~/.bashrc
```
```bash
source ~/.bashrc
```

1. Restart your terminal.

1. Run `ampd --version` to make sure that the right version of `ampd` was installed on your machine. It should be `ampd 0.6.0`.

</tab-item>

<tab-item title="<code>zsh</code> alias">
<Callout>
Replace `ampd-darwin-arm64-v0.6.0` with the [`ampd` binary you downloaded](/validator/amplifier/verifier-onboarding#set-up-ampd).
</Callout>
<Callout>
Replace `ampd-darwin-arm64-v0.6.0` with the [`ampd` binary you downloaded](/validator/amplifier/verifier-onboarding#set-up-ampd).
</Callout>
1. Add an alias to `ampd` at the end of the `.zshrc` file on your machine:

```bash
Expand All @@ -156,13 +169,14 @@ Replace `ampd-darwin-arm64-v0.6.0` with the [`ampd` binary you downloaded](/vali

1. Reload the file to apply all changes:

```bash
source ~/.zshrc
```
```bash
source ~/.zshrc
```

1. Restart your terminal.

1. Run `ampd --version` to make sure that the right version of `ampd` was installed on your machine. It should be `ampd 0.6.0`.

</tab-item>

</tabs>
Expand Down Expand Up @@ -219,7 +233,8 @@ The following is an example `config.toml` file for the verifier devnet:
See the [`ampd` README](https://github.com/axelarnetwork/axelar-amplifier/blob/main/ampd/README.md) on GitHub for instructions on formatting a `config` file for your own projects.

<Callout>
If you get a transport error with an `ampd` command, make sure that you have `tofnd` running in the background.
If you get a transport error with an `ampd` command, make sure that you have
`tofnd` running in the background.
</Callout>

## Fund your wallet
Expand All @@ -228,57 +243,62 @@ Prior to running the `ampd` daemon, you will need to set up your wallet with dev

1. Determine your verifier address:

```bash
ampd verifier-address
```
```bash
ampd verifier-address
```

<Callout>
If you get a security warning while trying to run `ampd` on an Apple Silicon Mac, you can disable the [gatekeeper](https://support.apple.com/guide/security/gatekeeper-and-runtime-protection-sec5599b66df/web) for a single binary with `sudo xattr -d com.apple.quarantine ~/Downloads/ampd-darwin-arm64-v0.6.0` or disable gatekeeper globally with `sudo spctl --master-disable`.
</Callout>
<Callout>
If you get a security warning while trying to run `ampd` on an Apple
Silicon Mac, you can disable the
[gatekeeper](https://support.apple.com/guide/security/gatekeeper-and-runtime-protection-sec5599b66df/web)
for a single binary with `sudo xattr -d com.apple.quarantine
~/Downloads/ampd-darwin-arm64-v0.6.0` or disable gatekeeper globally with
`sudo spctl --master-disable`.
</Callout>

1. Fund your verifier address.

1. Join the [Axelar Discord](https://discord.com/invite/axelar).
1. Get the Developer Role.
1. Go to the [#faucet channel](https://discord.com/channels/770814806105128977/1002423218772136056/1217885883152334918) and submit a request with your account to get 100 test tokens:
1. Join the [Axelar Discord](https://discord.com/invite/axelar).
1. Get the Developer Role.
1. Go to the [#faucet channel](https://discord.com/channels/770814806105128977/1002423218772136056/1217885883152334918) and submit a request with your account to get 100 test tokens:

```bash
!faucet devnet-verifiers [my verifier address]
```
```bash
!faucet devnet-verifiers [my verifier address]
```

## Activate and run the verifier

1. Bond your verifier:

```bash
ampd bond-verifier validators 100 uverifiers
```
```bash
ampd bond-verifier validators 100 uverifiers
```

Bonded verifiers will stay bonded until they unbond or are removed by governance.
Bonded verifiers will stay bonded until they unbond or are removed by governance.

1. Register your public key with `ecsda` or `ed25519`:
1. Register your public key with `ecdsa` or `ed25519`:

```bash
ampd register-public-key ecsda
```
```bash
ampd register-public-key ecdsa
```

1. Register support for desired chains, enabling `ampd` to participate in voting and signing for your supported chains.

```bash
ampd register-chain-support validators avalanche ehereum-sepolia
```
```bash
ampd register-chain-support validators avalanche ehereum-sepolia
```

Multiple chain names can be passed, separated by a space (`ampd register-chain-support [service name] [chains]...`). Note that any chain you want to support here must be configured in your ampd `config.toml` file.
Multiple chain names can be passed, separated by a space (`ampd register-chain-support [service name] [chains]...`). Note that any chain you want to support here must be configured in your ampd `config.toml` file.

1. Authorize your verifier.

This is dependent on the environment, and can be done via governance, or by the network operators.
This is dependent on the environment, and can be done via governance, or by the network operators.

For devnet, fill out the [Amplifier Verifier Onboarding Form](https://docs.google.com/forms/d/e/1FAIpQLSfQQhk292yT9j8sJF5ARRIE8PpI3LjuFc8rr7xZW7posSLtJA/viewform) for your address to be whitelisted.
For devnet, fill out the [Amplifier Verifier Onboarding Form](https://docs.google.com/forms/d/e/1FAIpQLSfQQhk292yT9j8sJF5ARRIE8PpI3LjuFc8rr7xZW7posSLtJA/viewform) for your address to be whitelisted.

1. Run the `ampd` daemon.

Running `ampd` without any command will run the daemon. A state file will be created if it doesn't yet exist. Its default location is `~/.ampd/state.json`, which can be overridden by passing `--state [path]`.
Running `ampd` without any command will run the daemon. A state file will be created if it doesn't yet exist. Its default location is `~/.ampd/state.json`, which can be overridden by passing `--state [path]`.
## Productionizing
Expand Down

0 comments on commit 58a70a2

Please sign in to comment.