Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoch05 committed Sep 24, 2024
1 parent eca2401 commit a0c98c1
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 7 deletions.
27 changes: 27 additions & 0 deletions docs/contract-addresses/mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
---

# Mainnet
The contract address can be found in configure files at https://github.com/helix-bridge/helixconf/tree/main/conf/mainnets.

## Ethereum

Expand Down Expand Up @@ -70,3 +71,29 @@ sidebar_position: 1
- chainId: 100
- LnDefaultBridge(v2): [0x94C614DAeFDbf151E1BB53d6A201ae5fF56A9337](https://gnosisscan.io/address/0x94C614DAeFDbf151E1BB53d6A201ae5fF56A9337)
- LnBridge(v3): [0xbA5D580B18b6436411562981e02c8A9aA1776D10](https://gnosisscan.io/address/0xbA5D580B18b6436411562981e02c8A9aA1776D10)

## zircuit

- chainId: 48900
- LnBridge(v3): [0xbA5D580B18b6436411562981e02c8A9aA1776D10](https://explorer.zircuit.com/address/0xbA5D580B18b6436411562981e02c8A9aA1776D10)

## blast

- chainId: 81457
- LnBridge(v3): [0xB180D7DcB5CC161C862aD60442FA37527546cAFC](https://blastscan.io/address/0xB180D7DcB5CC161C862aD60442FA37527546cAFC)

## Astar zkEvm

- chainId: 3776
- LnBridge(v3): [0xD476650e03a45E70202b0bcAfa04E1513920f83a](https://astar-zkevm.explorer.startale.com/address/0xD476650e03a45E70202b0bcAfa04E1513920f83a)

## Base

- chainId: 8453
- LnBridge(v3): [0xbA5D580B18b6436411562981e02c8A9aA1776D10](https://basescan.org/address/0xbA5D580B18b6436411562981e02c8A9aA1776D10)

## Moonbeam

- chainId: 1284
- LnBridge(v3): [0xbA5D580B18b6436411562981e02c8A9aA1776D10](https://moonscan.io/address/0xbA5D580B18b6436411562981e02c8A9aA1776D10)

15 changes: 15 additions & 0 deletions docs/contract-addresses/testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,18 @@ sidebar_position: 2

- chainId: 84532
- LnBridge(v3): [0x29D148A9e87C763292a33A55B9dBcAf44A194102](https://sepolia.basescan.org/address/0x29D148A9e87C763292a33A55B9dBcAf44A194102)

## Morph

- chainId: 2810
- LnBridge(v3): [0x5fc7BC9F21e5dAd364756CC92c43C1E553580107](https://explorer-holesky.morphl2.io/address/0x5fc7BC9F21e5dAd364756CC92c43C1E553580107)

## zircuit-sepolia

- chainId: 48899
- LnBridge(v3): [0x369642b7b9cf4eAc16b07797F77e1C0907Ea62c1](https://explorer.testnet.zircuit.com/address/0x369642b7b9cf4eAc16b07797F77e1C0907Ea62c1)

## bera

- chainId: 80084
- LnBridge(v3): [0x5fc7BC9F21e5dAd364756CC92c43C1E553580107](https://bartio.beratrail.io/address/0x5fc7BC9F21e5dAd364756CC92c43C1E553580107)
8 changes: 5 additions & 3 deletions docs/introduction/what-is-helix.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ slug: /

# What is Helix

Helix Bridge is a fully open-source and decentralized cross-chain asset bridge. It's built on top of common messaging bridges that already exist between chains, and provides secure, fast, and low-cost cross-chain functionality for users.
Helix Bridge is a fully open-source, non-custodial and decentralized cross-chain asset bridge. It's built on top of common messaging bridges that already exist between chains, and provides secure, fast, and low-cost cross-chain functionality for users.

## Features

- **Secure**

The protocol does not custody user assets, and there is no liquidity pool. During the transaction execution process, only the funds from uncompleted orders are temporarily locked in the protocol. These locked funds, referred to as in-flight assets, are relatively small in volume and have short lock-up periods. This approach makes the protocol safer in managing assets compared to custodial protocols.

Helix Bridge separates the underlying generic messages and the asset bridging, which helps to reduce risk.
Helix Bridge separates the underlying generic messages and the asset bridging, which helps to reduce risk.

While Helix's security does not entirely rely on generic messages, we take great care in selecting the generic message bridges we use. By combining the security of the generic message bridges with other security measures, we minimize the risk of security incidents.

Expand All @@ -30,5 +32,5 @@ Helix Bridge is a fully open-source and decentralized cross-chain asset bridge.
## Join The Community

- [Discord](https://discord.gg/6XyyNGugdE)
- [Twitter](https://twitter.com/helixbridges)
- [Twitter](https://twitter.com/helixofficialx)
- [Github](https://github.com/helix-bridge)
Binary file added docs/protocol/img/lnv3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 13 additions & 4 deletions docs/protocol/liquidity-node-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ To address this issue, we are introducing a new protocol version, v3, which elim

## Interactions

The diagram below illustrates three different flows in HelixBridge Lnv3, along with the asset transfer paths involved:

* [Green Line] The standard cross-chain process, where the user starts an order → the MM completes the order.
* [Red Line] An exception case, where the user starts an order → order timeout → the slasher completes the order and earns a reward.
* [Blue Line] The MM claims the locked liquidity assets.
![Lnv3](./img/lnv3.png)

### LnProvider Registration

The LnProvider stores its configuration information on the source chain and stakes a specific amount of penalty reserve, which can be shared across different paths.
Expand All @@ -37,11 +44,13 @@ The LnProvider stores its configuration information on the source chain and stak

Once the LnProvider sees the transfer event, it transfers the tokens to the user-specified account on the target chain and generates a transfer proof at the same time.

If the LnProvider did not complete the transfer within a specified timeout, the Slasher on the target chain transfers tokens to the user and sends a reverse message to the source chain, extracting the locked assets as per the second step.
### Slash

If the LnProvider did not complete the transfer within a specified timeout, the Slasher on the target chain transfers tokens to the user and sends a reverse message to the source chain, extracting the locked assets as per the second step.

A Slasher does not need to register. Any account including the user themselves is considered a Slasher as long as it completes the this.

> A Slasher does not need to register. Any account including the user themselves is considered a Slasher as long as it completes the this.
>
> Slashers play a crucial role throughout the entire cross-chain transaction cycle and assists in finalizing transactions when LnProvider is not functioning.
Slashers play a crucial role throughout the entire cross-chain transaction cycle and assists in finalizing transactions when LnProvider is not functioning. The slasher not only receives the equivalent assets transferred to the user but also earns the fees and the LnProvider's penalty collateral, completing the transaction loop.

### Liquidity Withdrawal by LnProvider

Expand Down
Binary file modified docs/user-guide/img/transfer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0c98c1

Please sign in to comment.