Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add more information to the README.md file
Browse files Browse the repository at this point in the history
brayansdt committed Feb 15, 2024
1 parent 8fc9593 commit 2741beb
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions contracts/bridge/x/v4/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# Immutable X Contracts

The immutable x v4 contracts provide functionality for enabling immutable-x users to off-ramp assets from the StarkEx network to Ethereum network.
From v4 onwards, Starkex changed the deposit, withdrawal and registration flows to be more efficient and more trustless, and this contract acts as a wrapper around the StarkEx contract to provide a more user-friendly interface.

# Status

Contract audits:

| Description | Date |Version Audited | Link to Report |
|-------------|------------------|-----------------|----------------|
| None | - | - | - |


## Immutable Contract Addresses

| Environment/Network | Core (StarkEx Bridge) Contract | User Registration Contract |
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **Sandbox (Sepolia)** | [0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98](https://sepolia.etherscan.io/address/0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98) | TBD |
| **Production (Mainnet)** | [0x5fdcca53617f4d2b9134b29090c87d01058e27e9](https://etherscan.io/address/0x5FDCCA53617f4d2b9134B29090C87D01058e27e9) | TBD |
| Environment/Network | Core (StarkEx Bridge) Contract | User Registration Contract |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **Dev (Sepolia)** | [0x590c809bd5ff50dcb39e4320b60139b29b880174](https://sepolia.etherscan.io/address/0x590c809bd5ff50dcb39e4320b60139b29b880174) | [0x36011226BEcA9714ce4D985090b3AFc30BC3FCAa](https://sepolia.etherscan.io/address/0x36011226BEcA9714ce4D985090b3AFc30BC3FCAa) |
| **Sandbox (Sepolia)** | [0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98](https://sepolia.etherscan.io/address/0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98) | TBD |
| **Production (Mainnet)** | [0x5fdcca53617f4d2b9134b29090c87d01058e27e9](https://etherscan.io/address/0x5FDCCA53617f4d2b9134B29090C87D01058e27e9) | TBD |

## RegistrationV4

This contract is a wrapper around the StarkEx contract to provide a more user-friendly interface for executing multiple StarkEx transactions at once.

## CoreV4

This contract is an interface for the StarkEx Core contract v4 version.
It is used to interact with the StarkEx Core contract from the Registration contract.
The Core contract is used to register and withdraw users and assets from the StarkEx system.

0 comments on commit 2741beb

Please sign in to comment.