Relayer Guide

This guide will help you set up the IntellixShield Relayer using docker-compose and provide a comprehensive understanding of its architecture.

IntellixShield Relayer Setup Guide

1. Fetch the Code

   • Head to the IntellixShield Relayer's repository: Intellix Relayer Repo

2. Setting Things Up with Docker-compose:

   • Import files: Launch a tool called 'terminal' on your computer (where you can type in commands). Enter git clone https://github.com/intellixprotocol/relayer_program and press Enter. This command fetches our project and saves it on your computer.

   • Setting Up Environment Variables:

     • PRIVATE_KEY (Your Secret ID): Think of this as a highly confidential password to your digital wallet.

     • PUBLIC_KEY (Your Public ID): Consider this as your account number. It's visible to others and is the address that holds the required ITX amount. sharing this ID is harmless, it can't unlock your wallet funds.

   • Other Settings:

     • RPC_URL: Use a private or a public RPC like https://eth.llamarpc.com

     • NETWORKS: Supported networks are BSC, ETH, and Matic. (Use ETH as it's currently the only network supported by IntellixShield)

     • PORT_LOCAL: 7002

     • URL: The domain linked to your server for HTTPS (e.g., https://mydomain.com)

     • CONTRACTS: 0x7177176A9A10bfCEF0ed53a71aeC97dc4451D808

   • Before You Start: Ensure hold a minimum of 20,000 ITX tokens for 30 days or longer.

   • Ensure you have set your desired fee in the .env file.

   • The address you are using should have a minimum of 0.1 ETH at all times.

   • Check Docker: Docker should be active on your machine.

   • Run It: Enter docker-compose up -d to initiate.

Points to Remember:

• Relayers aren't responsible for the gas fee, which is subtracted from the transaction.

• Though the default fee is 3%, you can adjust it between 1% and 10%. Competitive rates are recommended to attract users.

• Relayer selection is not under our control. Users view an active relayer list when making a withdrawal, where each relayer indicates its fee and has an assigned score influenced by:

• ITX amount held.

• Transaction count facilitated.

• Time since initial deployment.

For a score of 10, it's a ratio of: 4 (from ITX amount held), 3 (from transaction count), and 3 (based on uptime).

Follow this guide to understand the IntellixShield relayer's operations. Always safeguard your secret ID (private keys).