Configuration

Configuration file is a file that contains the necessary information for the project to run. The configuration file is named infinit.config.yaml and is located in the root directory of the project.

The user can freely define the configuration file based on the project requirements. The configuration file must contain the following information:

project_name (string): The name of the project.
protocol_module (string): The module that will be used for the project.
chain_info (object): The chain information that will be used for the project.
- name (string): The name of the chain.
- short_name (string): The short name of the chain.
- network_id (number): The network ID.
- native_currency (object): The native currency information.
  - name (string): The name of the native currency.
  - symbol (string): The symbol of the native currency.
  - decimals (number): The number of decimals for the native currency.
- block_explorer (object, optional): The block explorer information. (Currently, only Etherscan/Etherscan forks are supported)
  - name (string): The name of the block explorer.
  - url (string): The URL of the block explorer.
  - api_url (string): The API URL of the block explorer.
  - api_key (string): The API key for the block explorer.
- rpc_url (string): The RPC URL of the chain.

Example Configuration File

infinit.config.yaml

# yaml-language-server: $schema=../node_modules/@infinit-xyz/cli/dist/schemas/config/config.schema.json
 
project_name: my-first-project
protocol_module: uniswap-v3
chain_info:
  name: Ethereum
  short_name: eth
  network_id: 1
  native_currency:
    name: Ether
    symbol: ETH
    decimals: 18
  block_explorer:
    name: Etherscan
    url: https://etherscan.io
    api_url: https://api.etherscan.io
    api_key: ABCDEF1234567890
  rpc_url: https://rpc.ankr.com/eth

Module Registry