Skip to content

Latest commit

 

History

History
353 lines (244 loc) · 13.7 KB

registered.md

File metadata and controls

353 lines (244 loc) · 13.7 KB
Raw

Registered block producer onboarding

A registered block producer is a Cardano stake pool operator (SPO) that desires to process and validate transaction blocks on the partner chain. A registered block producer will use the partner chains toolkit (as well as other tools) to contribute to the validity of the partner chain ledger and, in turn, secure it.

Order of Operations

  1. Become a Cardano SPO
  2. Install partner chains dependencies
    1. Cardano node v10.1.2
      1. Ogmios v6.9.0
      2. Kupo - v2.9.0
      3. Cardano DB Sync v13.5.0.2 (PostgreSQL v15.3)
    2. Download the partner chain node v1.0
  3. Run the generate-keys wizard
  4. Obtain chain parameters from the chain builder
  5. Register for the partner chain
  6. Run the partner chain node
  7. Optional: deregister from the partner chain

NOTE

This guide is currently aimed at the preview testnet only. In most cardano-node operations, this can be set with --testnet-magic 2. If you need to set up an SPO, be sure it's set up on preview.

1. Become a Cardano SPO on preview

Cardano SPO keys are necessary to register as a partner chain validator. The installation for a Cardano SPO is out of the scope of this guide. Refer to the Cardano course handbook for documentation and video instruction.

Once you have the Cardano SPO keys, you are ready to continue with this guide.

2. Install partner chain dependencies

To run the partner chains stack, several dependencies need to be installed on the Cardano node.

Ogmios, Kupo and DB Sync are essential to enable registration communication with the main chain (Cardano).

2.1 Cardano node dependencies

The following tools are required for running a Cardano node.

NOTE

Be mindful of file paths in the instruction sets below. Your cardano-node may have slightly different paths for certain files. Replace file paths below with the paths relevant to your node.

2.1.1 Ogmios - v6.9.0

Ogmios is a lightweight bridge interface for cardano-node. It offers a WebSocket API that enables local clients to speak to the main chain via JSON/RPC.

It is recommended to install Ogmios via pre-built binaries.

You can also build from source, though it requires a significant number of dependencies.

  1. Obtain the binary
  2. Change the file to an executable: sudo chmod +x /home/ubuntu/ogmios
  3. Add executable to PATH: sudo mv ogmios /usr/local/bin
  4. Run Ogmios as a service:
sudo tee /etc/systemd/system/ogmios.service > /dev/null <<EOF
[Unit]
Description=Ogmios Service
After=network.target

[Service]
User=ubuntu
Type=simple
ExecStart=/usr/local/bin/ogmios \
  --host=0.0.0.0 \
  --node-config=/home/ubuntu/preview/configs/config.json \
  --node-socket=/home/ubuntu/preview/node.socket
Restart=on-failure

[Install]
WantedBy=multi-user.target
EOF

sudo systemctl daemon-reload && \
sudo systemctl enable ogmios.service && \
sudo systemctl start ogmios.service
  1. Observe logs
journalctl -fu ogmios.service

For further instructions, please see Ogmios.

2.1.2 Kupo - v2.9.0

Kupo is a fast, lightweight and configurable chain indexer for Cardano.

You may find it convenient to install Kupo via pre-built binaries as well. You can also build Kupo from source.

  1. Obtain the binary
  2. Just the Kupo binary is needed, not the SQLite3
  3. Change the file to an executable: chmod +x /home/ubuntu/kupo
  4. Add executable to PATH sudo mv kup /usr/local/bin
  5. Create a working directory: mkdir ~/kupo
  6. Run Kupo as a service:
sudo tee /etc/systemd/system/kupo.service > /dev/null <<'EOF'
[Unit]
Description=Kupo Service
After=network.target

[Service]
User=ubuntu
Type=simple
Environment="HOME=/home/ubuntu"
ExecStart=/usr/local/bin/kupo \
  --node-socket $HOME/preview/node.socket \
  --node-config $HOME/preview/configs/config.json \
  --since origin \
  --defer-db-indexes \
  --match "*" \
  --workdir $HOME/kupo
Restart=on-failure

[Install]
WantedBy=multi-user.target
EOF

sudo systemctl daemon-reload && \
sudo systemctl enable kupo.service && \
sudo systemctl start kupo.service

Please refer to Kupo for detailed instructions.

2.1.3 Cardano DB Sync v13.5.0.2

The partner chain needs DB Sync on a cardano-node to observe Cardano's state.

A critical note on Cardano DB Sync!

Before starting the partner chain node, and during normal operations, it is essential that the DB Sync component is fully synchronized. Running the node with lagging or not fully synced DB Sync will result in consensus errors, decreased peer reputation, and possibly a temporary ban by network peers. Sync time depends on hardware and network conditions, but here are approximate estimations for each network:

Sync time required

  • Preview: a few hours
  • Pre-production: usually ranges from several hours to a day
  • Mainnet: two or more days.

Typical error message if db-sync is behind:

💔 Verification failed for block 0x151ed479f5766f8dc56fa3626329baa77292d5a692cf7fb9d24e743ae57fe71c received from (12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp): "Main chain state e04eea9347162cd773a3505692d0aaee3d49b2c61f21a5b8a95f3d5711a63961 referenced in imported block at slot 286497345 with timestamp 1718984070000 not found"

In this case, it's best to stop the partner chain node and make sure DB Sync is healthy and synchronized before restarting the node.

  1. Download the binary and add it to the PATH
  2. Set up PostgreSQL server:
sudo apt install postgresql postgresql-contrib
sudo systemctl start postgresql.service

Enter shell as default postgres user: sudo -i -u postgres

Enter the postgres CLI: psql

Create User: CREATE USER ubuntu WITH PASSWORD 'XXXXXXXXXXXXX';

Change role permissions: ALTER ROLE ubuntu WITH SUPERUSER; ALTER ROLE ubuntu WITH CREATEDB;

Verify user is created and has role permissions: \du

Create database: CREATE DATABASE cexplorer;

Verify the database is created: \l

Sample correct return:

List of databases
   Name    |  Owner   | Encoding | Collate |  Ctype  |   Access privileges
-----------+----------+----------+---------+---------+-----------------------
 cexplorer | postgres | UTF8     | C.UTF-8 | C.UTF-8 |
 postgres  | postgres | UTF8     | C.UTF-8 | C.UTF-8 |
 template0 | postgres | UTF8     | C.UTF-8 | C.UTF-8 | =c/postgres          +
           |          |          |         |         | postgres=CTc/postgres
 template1 | postgres | UTF8     | C.UTF-8 | C.UTF-8 | =c/postgres          +
           |          |          |         |         | postgres=CTc/postgres
(4 rows)

If any command fails, restart postgres service: sudo systemctl restart postgresql.service

This check should return empty. It will be filled with db sync relations: PGPASSFILE=~/cardano-db-sync/config/pgpass-preview ./postgresql-setup.sh --check

  1. Run DB Sync as a service
sudo tee /etc/systemd/system/cardano-db-sync.service > /dev/null <<EOF
[Unit]
Description=Cardano DB Sync Service
After=network.target

[Service]
Environment=PGPASSFILE=/home/ubuntu/cardano-db-sync/config/pgpass-preview
ExecStart=/usr/local/bin/cardano-db-sync --config /home/ubuntu/testnet/configs/db-sync-config.json --socket-path /home/ubuntu/testnet/node.socket --state-dir /home/ubuntu/testnet/db-sync/ledger-state --schema-dir /home/ubuntu/cardano-db-sync/schema/
User=ubuntu
Restart=on-failure

[Install]
WantedBy=multi-user.target
EOF

Enable and start service:

sudo systemctl daemon-reload && \
sudo systemctl enable cardano-db-sync.service && \
sudo systemctl start cardano-db-sync.service
  1. Observe logs
journalctl -fu cardano-db-sync.service

WARNING

Ensure that the node is synced with the network to 100% as well as Kupo and DB Sync before continuing beyond this point. On preview network, it is roughly 24 hours before sync is complete.

2.2 Download the Partner Chains node

  1. Download the Partner Chains node from the official repository

3. Run the generate-keys wizard

The generate-keys wizard is designed to simplify the process of getting started with a partner chains node. This is the initial step for network participants who do not yet have keys.

The generate-keys wizard will generate necessary keys and save them to your node’s keystore. The following keys will be created:

  1. ECDSA cross-chain key
  2. ED25519 Grandpa key
  3. SR25519 Aura key

If these keys already exist in the node’s keystore, you will be asked to overwrite existing keys. The wizard will also generate a network key for your node if needed.

  1. To start the wizard, run the following command in the node repository: ./partner-chains-cli generate-keys
  2. Input the node base path. It is saved in partner-chains-cli-resources-config.json

Now the wizard will output partner-chains-public-keys.json containing three keys:

{
	"sidechain_pub_key": "0x<key>",
	"aura_pub_key": "0x<key>",
	"grandpa_pub_key": "0x<key>"
}

4. Obtain chain parameters

Obtaining the chain parameters needs to be done manually.

Contact the chain builder and request the chain-spec.json file and the partner-chains-cli-chain-config.json file.

5. Register for the partner chain

Registration is a three-step process, with the second step executed on the 'cold' machine, so there are three wizards.

Register-1 wizard

The register-1 wizard obtains the registration UTXO.

  1. Start the wizard: ./partner-chains-cli register1
  2. Follow the steps when prompted by the wizard

The wizard derives a payment address from the payment verification key and queries Ogmios for the UTXOs of the derived address. It filters the UTXOs, retains only the ones without assets, and presents them to you, together with their lovelace balance, as a table. Use the up and down arrow keys to choose a row and press enter to select it.

NOTE

You must not spend the selected UTXO, because it needs to be consumed later in the registration process.

Finally, the wizard outputs the command for obtaining signatures. You use this command in the next step (register-2 wizard). You must run it on a newly prepared machine with the main chain cold signing key.

Register-2 wizard

The register-2 wizard obtains signatures for the registration message. It only requires the partner-chain-cli binary executable to be installed on the 'cold' machine.

  1. Follow the steps when prompted by the wizard

The wizard outputs the final command to be input to the register-3 wizard.

Register-3 wizard

The register-3 wizard executes the registration command. Be sure to have the chain-spec.json file present before continuing.

  1. Follow the steps when prompted by the wizard

The wizard will give you the option of displaying the registration status. If you choose to display it, the wizard informs you that it will query the DB Sync PostgreSQL for the user registration status, and output it for the epoch that is two epochs ahead of the current one.

6. Run the partner chain node

The start-node wizard is used to start a partner chain node. Make sure that cardano-node is running with DB Sync running and fully synced. You will need to provide a link to postgreSQL server running with DB Sync as part of starting the node.

  1. Start the wizard: ./partner-chains-cli start-node.
  2. The wizard checks if all required keys are present. If not, it reminds you to the run the generate-keys wizard first, and exits.
  3. If the chain-spec file is not present, you should obtain it from the governance authority.
  4. The wizard checks the partner-chains-cli-chain-config.json file. If it is missing or invalid, you should obtain it from the governance authority.
  5. If the db_sync_postgres_connection_string is missing from the partner-chain-cli-resources-config.json file, the wizard prompts for it using the default value postgresql://postgres-user:postgres-password@localhost:5432/cexplorer.
  6. The wizard outputs all relevant parameters and asks if they are correct. If not, you should edit the partner-chains-cli-chain-config.json and/or partner-chain-cli-resources-config.json files and run the wizard again.

The wizard sets the required environment variables and starts the node.

Registration is effective after 1-2 Cardano epochs. After the waiting period, the partner chain node is registered on the partner chain and is a selection option for the consensus committee.

7. Optional: deregister from the partner chain

To deregister from the list of block producer candidates, you need to run the deregister wizard.

  1. Start the wizard: ./partner-chains-cli deregister.
  2. The wizard checks the partner-chains-cli-chain-config.json file.
  3. The wizard prompts for the payment verification key file used during registration.
  4. The wizard prompts for the cold verification key matching the cold signing key used during registration.
  5. The wizard prompts for ogmios and kupo addresses.
  6. The wizard executes the deregistration command. The change will be effective after two Cardano epochs boundaries.

NOTE

The configuration of the chain is stored in the file partner-chains-cli-chain-config.json. This file needs to remain identical with other nodes in the network.

NOTE Information about the resources used by each node is stored in the file partner-chain-cli-resources-config.json. This file should be present on every node in the network, but its contents are specific to each node.