Overview

The Apybara engineering team has developed a validator registry that enables validators to add useful information about themselves, such as name, website and logo.

This guide will outline the steps for validators to update their details on the registry.

Pre-requisites

• Install Make
• Install Go 1.21.0 or higher
• Install SnarkOS. The cli requires the snarkos to be on the environment path to execute the programs.
• Make sure that the validator has enough funds to pay for the transaction

Installation

• Clone the avr-cli repo

  git clone [<https://github.com/Apybara/avr-cli.git>](<https://github.com/Apybara/avr-cli.git>)

• Build with make build or go build -o avr-cli

Contents of the validator registry

Aleo programs cannot store strings, therefore we have created a cli to help with the conversion process. The cli has some built-in field converter that converts all string literal inputs to numeric big integer field value.

The av_registry.aleo has the following Validator parameter on its transition function. The name, website_url, logo_url, and description are all field that can only accept a 251 numeric value (256 including the field text).

// The 'Validator' registry mapping
    mapping registry : address => Validator;

    // The 'Message' registry mapping
    struct Validator {
        validator_address: address,
        name: field,
        website_url: field,
        logo_url: field,
        description: field,
    }

Register your validator

Please note that name, description, website-url and logo-url must each be 32 characters max.

./aleo-cli register-my-validator --name="aleo node" --description="aleo validator node" --website_url="<https://aleo.org>" --logo_url="<https://aleo.org>" --validator=aleo1rt3vjrusjvd6wje97efl3ra78k0d6f4c3zn8avuym0qwkl4njv9shhmfsk --private-key=<validator private key>`

You’ll get an output like so:

Executing command with the following fields: validator_address: aleo1va45ntdetjvageve84q3fy3rr6yuagwnup3es4cka6gjpkxdmgyqd2665r name: 2706523836038410324778055705711153604386042705714223408479field website_url: 210954531318722040580453042701123555276703729560871656109168699027345270111field logo_url: 11419556465387333341574179597237566363874370190453764857321447646559field description: 177384893725714191679704876879917305435398508210841834411847647238634497375field

📦 Creating execution transaction for 'av_registry.aleo/register_validator'...

✅ Created execution transaction for 'av_registry.aleo/register_validator'
✅ Successfully broadcast execution at1v45ytsmwpmwdp2hza2jwdc7zf2gy2rygsxnv9tmswzeytec685xseclhka ('avr123456789.aleo/register_validator') to <https://aleo-node.staking.xyz/testnet3/transaction/broadcast>.
at1v45ytsmwpmwdp2hza2jwdc7zf2gy2rygsxnv9tmswzeytec685xseclhka

Successfully registered validator