kylefang/xlink-docs
1
0
Fork 0
mirror of https://github.com/Brotocol-xyz/xlink-docs.git synced 2026-01-12 14:54:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

update images paths

Browse Source
This commit is contained in:
Sofi Azcoaga
2025-01-15 12:52:23 -03:00
parent 5b16c31f9b
commit 38fc7ee42b
1 changed files with 33 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
developers/contracts/README.md
View File

@@ -1,82 +1,88 @@
# XLink Contracts Technical Documentation
XLink core functionalities are contained in contracts deployed within the Stacks blockchain network. Its main goal is to provide a bridging mechanism, allowing to transfer different tokens between Bitcoin or EVM-like chains and Stacks network. XLink also offers the user to possibility to add swaps to their bridging process. The purpose of this document is to give the reader a high-level overview of the different modules that constitute the XLink ecosystem and how some of the contracts interact.
XLink core functionalities are contained in contracts deployed within the Stacks blockchain network. Its main goal is to provide a bridging mechanism, allowing to transfer different tokens between Bitcoin or EVM-like chains and Stacks network. XLink also offers the user to possibility to add swaps to their bridging process. The purpose of this document is to give the reader a high-level overview of the different modules that constitute the XLink ecosystem and how some of the contracts interact.
## Main Features
## Main Features
The XLink ecosystem offers three main features that are implemented along different contracts. These are:
- The **bridging of BTC**: transferring BTC from the Bitcoin blockchain into the Stacks chain, where they will be represented as wrapped BTC (aBTC) and the other way around.
- The **bridging of BRC-20 assets**: transferring assets that comply with the BRC-20 standard from the Bitcoin chain into the Stacks chain and back.
- The **bridging of EVM-like blockchain's assets**: this feature allows the transferring of assets back and forth between Stacks and several different blockchains that function based on the Ethereum Virtual Machine.
The XLink ecosystem offers three main features that are implemented along different contracts. These are:
- The **bridging of BTC**: transferring BTC from the Bitcoin blockchain into the Stacks chain, where they will be represented as wrapped BTC (aBTC) and the other way around.
- The **bridging of BRC-20 assets**: transferring assets that comply with the BRC-20 standard from the Bitcoin chain into the Stacks chain and back.
- The **bridging of EVM-like blockchain's assets**: this feature allows the transferring of assets back and forth between Stacks and several different blockchains that function based on the Ethereum Virtual Machine.
### BTC Bridge (Bitcoin BTC ↔ Stacks aBTC)
![This is a simplified representation on the BTC Bridge main goal.](https://hackmd.io/_uploads/S1Yr1mEvkl.png)
*To see more information on this contract see the [auxiliary contracts section](#Auxiliary-Contracts).
![This is a simplified representation on the BTC Bridge main goal.](../../.gitbook/assets/glue-docs/btc-bridge.png)
\*To see more information on this contract see the [auxiliary contracts section](#Auxiliary-Contracts).
#### BTC Peg-In Endpoint
- Contract name: `btc-peg-in-endpoint-v2-03`
- [Complete technical documentation](btc-peg-in-endpoint-v2-03.md)
This endpoint is the responsible for managing the bridging of BTC from Bitcoin chain into Stacks chain as wrapped BTC (aBTC).
This endpoint is the responsible for managing the bridging of BTC from Bitcoin chain into Stacks chain as wrapped BTC (aBTC).
#### BTC Peg-Out Endpoint
- Contract name: `btc-peg-out-endpoint-v2-01`
- [Complete technical documentation](btc-peg-out-endpoint-v2-01.md)
This endpoint is the responsible for managing the bridging of Stacks' aBTC back into Bitcoin BTC.
This endpoint is the responsible for managing the bridging of Stacks' aBTC back into Bitcoin BTC.
### Meta Bridge (Bitcoin BRC-20 ↔ Stacks SIP-010)
![This is a simplified representation on the Meta Bridge main goal. ](https://hackmd.io/_uploads/By1wEWEwJl.png)
![This is a simplified representation on the Meta Bridge main goal.](../../.gitbook/assets/glue-docs/meta-bridge.png)
&ast;To see more information on these contracts see the [auxiliary contracts section](#Auxiliary-Contracts).</small>
\*To see more information on these contracts see the [auxiliary contracts section](#Auxiliary-Contracts).</small>
#### Meta Peg-In Endpoint
- Contract name: `meta-peg-in-endpoint-v2-02`
- [Complete technical documentation](meta-peg-in-endpoint-v2-02.md)
This endpoint main responsibility the bridging of assets in the Bitcoin chain that follow the BRC-20 standard into the Stacks chain as a specific token that complies with the SIP-010 standard.
This endpoint main responsibility the bridging of assets in the Bitcoin chain that follow the BRC-20 standard into the Stacks chain as a specific token that complies with the SIP-010 standard.
> **Observation**: when BRC-20 tokens are transferred to Stacks chain, the user may also opt to perform a swap to obtain a different token than the original one. In this case, the module delegates to the Cross Bridge Module the responsibility to execute the exchange.
> **Observation**: when BRC-20 tokens are transferred to Stacks chain, the user may also opt to perform a swap to obtain a different token than the original one. In this case, the module delegates to the Cross Bridge Module the responsibility to execute the exchange.
#### Meta Peg-Out Endpoint
- Contract name: `meta-peg-out-endpoint-v2-03`
- [Complete technical documentation](meta-peg-out-endpoint-v2-03.md)
This endpoint is responsible for managing the bridging of different tokens from Stacks and back to Bitcoin blockchain, aiming to turn them into BRC-20 assets.
This endpoint is responsible for managing the bridging of different tokens from Stacks and back to Bitcoin blockchain, aiming to turn them into BRC-20 assets.
### Cross Bridge (EVM Chains' Tokens &harr; Stacks' SIP-010)
![This is a simplified representation on the Cross Bridge main goal.](https://hackmd.io/_uploads/Byk91mNv1g.png)
![This is a simplified representation on the Cross Bridge main goal.](../../.gitbook/assets/glue-docs/cross-bridge.png)
&ast;To see more information on these contracts see the [auxiliary contracts section](#Auxiliary-Contracts).</small>
\*To see more information on these contracts see the [auxiliary contracts section](#Auxiliary-Contracts).</small>
#### Cross Peg-In Endpoint
- Contract name: `cross-peg-in-endpoint-v2-03`
- [Complete technical documentation](cross-peg-in-endpoint-v2-03.md)
This endpoint is responsible for managing the transfer of assets from other EVM-like blockchains into the Stacks chain.
This endpoint is responsible for managing the transfer of assets from other EVM-like blockchains into the Stacks chain.
#### Cross Peg-Out Endpoint
- Contract name: `cross-peg-out-endpoint-v2-01`
- [Complete technical documentation](cross-peg-out-endpoint-v2-01.md)
This endpoint is responsible for managing the transfer of SIP-010 bridged tokens from the Stacks network to EVM-like blockchains. Sometimes, it also involves swapping to other tokens as the part of the peg-in process.
This endpoint is responsible for managing the transfer of SIP-010 bridged tokens from the Stacks network to EVM-like blockchains. Sometimes, it also involves swapping to other tokens as the part of the peg-in process.
### Auxiliary Contracts
These contracts do not include the implementation of any core functionality but they serve as a support for other contracts to facilitate calculations and common storage management.
These contracts do not include the implementation of any core functionality but they serve as a support for other contracts to facilitate calculations and common storage management.
- **BTC Bridge Registry**: when a user wants to bridge BTC from Bitcoin chain into Stacks' aBTC or the other way around, this contract keeps record of the generated orders and their statuses, allowing those who interact with it to consult a bridging operation validity and update the records as well. Its current version can be found at `btc-bridge-registry-v2-02`.
- **Meta Bridge Registry**: this registry contains information about the approved tokens for bridging. It allows other modules to validate whether the BRC-20 token can be bridged into Stacks. The last version in use can be found at `meta-bridge-registry-v2-03` file.
- **Cross Bridge Registry**: this registry allows other contracts to validate, among other things, if a specific token (from an EVM-like chain) can be bridge into Stacks. It also keeps record of the created bridging orders and their statuses. The current used version can be found at `cross-bridge-registry-v2-01` file.
- **Meta Bridge Registry**: this registry contains information about the approved tokens for bridging. It allows other modules to validate whether the BRC-20 token can be bridged into Stacks. The last version in use can be found at `meta-bridge-registry-v2-03` file.
- **Cross Bridge Registry**: this registry allows other contracts to validate, among other things, if a specific token (from an EVM-like chain) can be bridge into Stacks. It also keeps record of the created bridging orders and their statuses. The current used version can be found at `cross-bridge-registry-v2-01` file.
- **Cross Router**: this contract is used to verify that a route between two tokens that gives as an output at least the expected minimum amount when swapping exists. It can, certainly, include intermediate exchanges to reach the desired token, meaning that if a user wants to swap token A to obtain token C, there may be some intermediate swaps needed such as `token A -> token B -> token C`(this is related to the existance or not of pools that includes the tokens of interest). Currently, it can be found at `cross-router-v2-02` file.
- **Bridge Common**: this contract provides common helper functions to all the others. This auxiliary functions facilitate order creation, transaction decoding, and cross-chain routing validations. Its implementation can be found at `bridge-common-v2-02` file.
- **Clarity Bitcoin**: this contract contains auxiliary functions that allows its user to interpretate Bitcoin transactions and their content from a buffer. It can be found at `clarity-bitcoin-v1-07` file.
- **Bridge Common**: this contract provides common helper functions to all the others. This auxiliary functions facilitate order creation, transaction decoding, and cross-chain routing validations. Its implementation can be found at `bridge-common-v2-02` file.
- **Clarity Bitcoin**: this contract contains auxiliary functions that allows its user to interpretate Bitcoin transactions and their content from a buffer. It can be found at `clarity-bitcoin-v1-07` file.
## Governance
## Governance
At the top of the on-chain architecture is the XLink DAO, accounting for XLink's governance in a rule-based, modular and flexible manner. Built upon Marvin Janssen's ExecutorDAO project, it operates based on the following core principles:
@@ -84,13 +90,8 @@ At the top of the on-chain architecture is the XLink DAO, accounting for XLink's
- The core executes, the extensions give form.
- Ownership control happens via sending context.
For technical details on the ExecutorDAO, refer to the project's [README.md](https://github.com/MarvinJanssen/executor-dao#readme).
For technical details on the ExecutorDAO, refer to the project's [README.md](https://github.com/MarvinJanssen/executor-dao#readme).
## XLink Staking
XLink also offers users the possibility to stake their tokens. To see detailed information on how the staking protocol works refer to [xlink-staking](xlink-staking.md).
XLink also offers users the possibility to stake their tokens. To see detailed information on how the staking protocol works refer to [xlink-staking](xlink-staking.md).