zkEVM Bridge UI

The zkEVM Bridge UI provides a simple user interface to bridge ETH and your favorite ERC-20 tokens from Ethereum to the Polygon zkEVM and back.

Development

Clone the repo:

git clone [email protected]:0xPolygonHermez/zkevm-bridge-ui.git

Move into the project directory:

cd zkevm-bridge-ui

Install project dependencies:

npm install

Finally, to be able to run the project, you need to create a .env file which should contain all the required environment variables.

If you want to create it from scratch, you can copy the .env.example and then override each environment variable by your own:

cp .env.example .env

If you want to see token prices converted to your local fiat currency in the UI you'll need to register here to obtain an API Key. Once you get it, you need to set the VITE_ENABLE_FIAT_EXCHANGE_RATES env var to true and fill this required env vars as well:

• VITE_FIAT_EXCHANGE_RATES_API_URL
• VITE_FIAT_EXCHANGE_RATES_API_KEY
• VITE_FIAT_EXCHANGE_RATES_ETHEREUM_USDC_ADDRESS

If you just want to omit fiat conversion you can just disable this feature by setting the VITE_ENABLE_FIAT_EXCHANGE_RATES env var to false.

Finally, to run the UI in development mode, you just need to run:

npm run dev

Docker image

A GitHub action is already configured to automatically generate and push images to DockerHub on updates to the develop and main branches.

To locally generate a Docker image of the zkEVM Bridge UI, you can just run the following command:

docker build . -t zkevm-bridge-ui:local

The Docker image won't build the UI until you run it, in order to be able to use dynamic environment variables and facilitate the deployment process. The env vars that you need to pass to the docker run cmd are the same as those in the .env.example file but without the VITE prefix.

Example:

docker run \
-e ETHEREUM_RPC_URL=http://localhost:8545 \
-e ETHEREUM_EXPLORER_URL=https://goerli.etherscan.io \
-e ETHEREUM_BRIDGE_CONTRACT_ADDRESS=0x0165878A594ca255338adfa4d48449f69242Eb8F \
-e ETHEREUM_FORCE_UPDATE_GLOBAL_EXIT_ROOT=true \
-e ETHEREUM_PROOF_OF_EFFICIENCY_CONTRACT_ADDRESS=0x8dA3b8020401851438eEe8bB434c57b54999935c \
-e POLYGON_ZK_EVM_RPC_URL=http://localhost:8123 \
-e POLYGON_ZK_EVM_EXPLORER_URL=http://localhost:4000 \
-e POLYGON_ZK_EVM_BRIDGE_CONTRACT_ADDRESS=0x9d98deabc42dd696deb9e40b4f1cab7ddbf55988 \
-e POLYGON_ZK_EVM_NETWORK_ID=1 \
-e BRIDGE_API_URL=http://localhost:8080 \
-e ENABLE_FIAT_EXCHANGE_RATES=false \
-e ENABLE_OUTDATED_NETWORK_MODAL=false \
-e ENABLE_DEPOSIT_WARNING=true \
-e ENABLE_REPORT_FORM=false \
-p 8080:80 zkevm-bridge-ui:local