Skip to content

generate-validator-api-key.md

Latest commit

 

History

History
54 lines (38 loc) · 2.63 KB

generate-validator-api-key.md

File metadata and controls

54 lines (38 loc) · 2.63 KB

Generate coordinator API key for the conversation server

Coordinators need an API key to access the conversation server. The server provides full conversations that coordinators tag for ground truth and split into windows used to query workers (fractal data mining). Follow the steps below to generate your key.

Get your hotkey and coldkey information

To get your coldkey name, run your network CLI (e.g. btcli wallet list), which lists coldkeys and hotkeys. Note the coldkey and hotkey names associated with your coordinator.

Run the generation script

From the top-level directory of this repository, run:

Main network:

python scripts/get_validator_api_key.py

Test network:

python scripts/get_validator_api_key.py test

You will be prompted for: subnet netuid (default 33; use 138 for testnet), credentials path, and coldkey and hotkey names from the step above.

The script checks your credentials against the network metagraph to confirm you are a coordinator, checks minimum stake, and signs a transaction from your hotkey. On success you should see:

COLDKEY <coldkey address> is registered on subnet: COLDKEY:<coldkey address>, IS VALIDATOR:True, TOTAL STAKE:<stake>
Signing message...
Signature is valid
Signed. Get API key...
Got API key, writing to file...

API key successfully generated and stored in file: readyai_api_data.json
    Place this json file in your coordinator execution directory.

You can then retrieve conversations from the conversation server. For issues, see Troubleshooting below.

Troubleshooting

Common errors and fixes:

  • Coldkey not registered on subnet — Confirm the coldkey is registered on the specified subnet (metagraph).
  • Unstaked / not enough stake — Your coldkey must have a hotkey with the minimum required stake to get a coordinator API key.
  • Not Validator / no vpermit — The coldkey must have a vpermit on one of its hotkeys. Confirm coldkey and hotkey.
  • Total stake less than minimum — Ensure the hotkey has the minimum required stake.
  • scalecodec not installed — Install the package used to decode SS58 addresses (see project requirements).
  • Error posting to URL — Check connectivity and network; try again or contact support.
  • Error getting message / Keygen Error — Network or encryption error. Confirm required packages are installed and credentials are correct.
  • Error loading coldkey — Confirm coldkey path and that the coldkey is stored locally.
  • Signature is not valid — Confirm required packages and coldkey information; ensure coldkey is stored locally.

For further help, see the project’s community or support channel.