Register with Kalypso
Welcome to the Register with Kalypso guide. This tutorial will walk you through the steps to register as an operator, ensuring you can seamlessly integrate with the Kalypso Marketplace.
đ Prerequisitesâ
Before you begin, ensure that you have completed the following:
- Completed the Set Up the Machine guide.
- Started the prover as outlined in the Run the Prover guide.
âšī¸ Why: Completing these prerequisites ensures that your environment is correctly configured and that the prover is running, which are essential for successful registration with Kalypso.
đ Register as an Operatorâ
Follow these steps to register as an operator with Kalypso:
1. Create .env
Fileâ
Start by creating a .env
file in the root directory of your project. This file will store the necessary environment variables required for registration.
touch .env
âšī¸ Why: The .env
file holds sensitive information and configuration settings needed for the registration process. Keeping this information in a separate file enhances security and manageability.
2. Configure Environment Variablesâ
Open the .env
file in your preferred text editor and add the following contents:
RPC_URL=<<l2_rpc_url>>
PRIVATE_KEY=<<private_key_of_GENERATOR_ADDRESS>>
REWARD_ADDRESS=<<reward_address>>
PROOF_GENERATION_COST=<<proof_generator_cost_in_USDC_without_decimals>>
DISPLAY_NAME="Your fancy name, or leave blank"
DESCRIPTION="Tell us something about yourself, or leave blank"
WEBSITE="if you have a website, or leave blank"
TWITTER="if you have Twitter, or leave blank"
OPERATOR_COMMISSION=<<100000000000000000_for_10_percent>>
env variable | Notes |
---|---|
RPC_URL | Mainnet: Arbitrum One Rpc URL Betanet/Stagenet: Arbitrum Sepolia Rpc URL |
PRIVATE_KEY | Private key corresponding to GENERATOR_ADDRESS |
REWARD_ADDRESS | Reward Address where all the rewards tokens are accrued. It is recommended that this address to be a secure address like ledger/multisig |
OPERATOR_COMMISSION | This value represents the percentage of KALYPSO_POINTS allocated to the Kalypso operator. It is expressed in a fixed-point format where 1000000000000000000 equals 100%.For example, a commission value of 1000000000000000000 indicates that 100% of the KALYPSO_POINTS is allocated to the Kalypso Operator. The remaining percentage, calculated as (100 - commission) , is distributed to the vault operator and the transmitter. Kalypso operators must set this value in consultation with the vault operator. Setting an unreasonable commission may result in the vault operator denying the symbiotic stake to the Kalypso operator, which can prevent job assignments. Note: The entire PROOF_GENERATION_COST is allocated solely to the Kalypso operator. |
â ī¸ Ensure All Variables Are Declared:
Please ensure that you have properly configured the following variables in your .env
file:
- RPC_URL: The RPC URL of the Arbitrum Sepolia Network.
- PRIVATE_KEY: Your operator's private key used to sign transactions.
- REWARD_ADDRESS: The address where rewards will be sent.
- PROOF_GENERATION_COST: The cost associated with generating proofs, specified in USDC without decimals.
- DISPLAY_NAME: (Optional) A fancy name for your operator.
- DESCRIPTION: (Optional) A brief description about yourself or your operation.
- WEBSITE: (Optional) Your website URL.
- TWITTER: (Optional) Your Twitter handle.
- OPERATOR_COMMISSION: Operator Commission.
Warning: You cannot register twice with the same operator. Attempting to do so will result in an error.
âšī¸ Why: Proper configuration of environment variables is crucial for the registration process. These variables ensure that your operator is correctly identified and can interact securely with the Kalypso network.
3. Register and Join the Marketplaceâ
With the .env
file configured, execute the following command to register your operator and join the Kalypso Marketplace:
./start.sh register-join
âšī¸ Why: Running this command initiates the registration process, sending your operator's details to the Kalypso network and adding you to the marketplace. This step is essential to start participating and earning rewards within the ecosystem.
You can do the same registration and joining the market operation via direct smart contract interactionâ
- mainnet
- betanet
- stagenet
You will need to invoke Register and JoinMarketplace
You will need to invoke Register and JoinMarketplace
You will need to invoke Register and JoinMarketplace
đ Next Stepsâ
Once the registration process is complete, proceed to request stake from Symbiotic to begin your operations as a Hardware Operator.
âšī¸ Why: Requesting stake is necessary to secure your position in the network and to enable the generation of proofs, which are integral to the functioning of the Kalypso ecosystem.
If you encounter any issues or have questions, feel free to reach out to our Telegram channel for assistance.