Skip to main content
Version: Devnet - Playground

eIBC client

eIBC allows anyone to fulfill user withdrawal requests from RollApps based on their own preferences and risk profile. Operators running an eIBC client can choose which RollApps to fulfill orders for, which tokens to fulfill, and what fee to charge for each fulfillment. eIBC client by default also validates the rollapp to reduce fulfillment of potentially malicious transfers. You can read more about eIBC here.

This section outlines the process for setting up and running an eIBC client.

Requirements​

note

This guide assumes you've already setup your environment and initialized your rollapp.

Hardware Requirements​

  • A Linux or macOS operating system
  • At least 4GB of RAM
  • At least 10GB of free disk space
  • 1 CPU core
  • At least 10 Mbps bandwidth

Setup eIBC Client​

Validate Docker access​

Before starting make sure your user have access to the docker daemon:

docker ps

If you see an error, please re-login to the docker group:

newgrp docker

In case this doesn't work, please go back to the setup environment section and make sure you completed all the steps.

Initialize eIBC client​

initializing eIBC client creates a whale account which exists on Dymension and needs to be funded with the appropriate denoms we would like to fulfill. DYM funding is mandatory to be able to pay for the transactions fee on chain. Let's start by initializing the eIBC client:

roller eibc init

After successful initialization, you’ll see a whale account address and mnemonic phrase. Save these securely.

Configure eIBC client​

Once the whale account is funded with the appropriate denoms we would like to fulfill, we can start whitelisting the rollapps and tokens we would like to operate.

info

In order to fulfill orders, we must whitelist both the rollapps and the tokens.

Whitelist RollApps​

First lets start by whitelisting the rollapp:

roller eibc fulfill rollapps set <rollapp_id> <fee-in-percentage>

Whitelist tokens​

Allows user to whitelist certain tokens they would like to fulfill. In order to get the denom representation of the token on the dymension hub you can head to the token registry and use the Base column to find the denom.

danger

For a token to appear in the token registry, at least one token must be sent to the Dymension hub and complete a finalization period.

Once you have obtained the denom, you can set the fee for token fulfillment:

roller eibc fulfill denoms set <denom-on-the-token-registry> <fee-in-percentage>
Important

Every configuration change requires a restart of the eIBC client.

Start eIBC client​

After configuring the eIBC client, you can start the process by running one of the following commands:

roller eibc start

View balances​

To view the balances associated with your eIBC client, you can check:

  • The balance of the main 'whale' account
  • The balance of individual 'bot' accounts
  • An aggregate balance, including all accounts and any pending eIBC rewards
roller eibc funds