Skip to content

across-protocol/exclusive-relayer-configs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Exclusive Relayer Configuration Repository

This public repository hosts configuration files for relayer exclusivity within the Across protocol. Relayers can add or update config files that define specific parameters and values used to select exclusive relayers for bridge fills.

Project Prerequisites

  • nodejs
  • yarn

Installation

1 Clone the repo

git clone https://github.com/your-username/exclusive-relayer-config.git
cd exclusive-relayer-config

2 Install packages

yarn install

Adding a new File

To add a new relayer configuration, you need to create a file inside the /configs directory.

📝 File Naming

The file must be named in the following format:

  • {{relayer-address}}.json

Config File Structure

Each config file must include the following fields:

  • minExclusivityPeriod: The minimum time (in seconds) that a relayer will have exclusive fill rights on a deposit.
  • minProfitThreshold: The minimum profit margin required for a relayer to be eligible for exclusivity.
  • balanceMultiplier: Scaling factor to apply to the relayer's balance before determinig whether it has sufficient funds to make a fill..
  • maxFillSize: The maximum USD value of a fill that the relayer requests exclusivity for.
  • originChainIds: The set of origin chains where the relayer wishes to be considered for exclusivity.

Example:

// 0x123abc123abc.json
{
  "minExclusivityPeriod": 5,
  "minProfitThreshold": 0.00005,
  "balanceMultiplier": 0.25,
  "maxFillSize": 2500,
  "originChainIds": [1, 10, 137, 324, 690, 1135, 8453, 34443, 42161, 59144, 81457, 534352, 7777777]
}

🧪 Validation (optional)

Before submitting your configuration, it's recommended to ensure that the file is correctly formatted by running the validation script. This step is optional but helps catch formatting errors early.

yarn validate-configs

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published