Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 6.13 KB

README.md

File metadata and controls

110 lines (80 loc) · 6.13 KB
Raw

OpenSSF Scorecard CodeQL RSK Logo

Runes Mock Bridge

This project is an open-source proof of concept implementing a Runes Mock Bridge. The primary goal is to allow users to etch (and eventually mint) Runes on the Bitcoin network and create a 1:1 representation of these Runes as ERC1155 tokens (Non fungible initially) on the Rootstock (RSK) network, manage the runes in the RSK network, and then take it back to BTC.

Table of Contents

Overview

The Runes Mock Bridge consists of various processes:

  1. Etching Runes on Bitcoin: Users can etch Runes containing data entered through a form. A signer instantiated on Rootstock signs the transaction, creating the Rune without the user needing to sign any transactions directly.
  2. Creating ERC1155 Representation on RSK: Once a Rune is etched on Bitcoin, the system calls an ERC1155 function to mint the Rune on the RSK network. The token's information is based on the user's input for the Rune. The user receives the specified amount of tokens in a "premine" specified during the Rune creation.
  3. Transfer, manage, and interact with RSK runes representation : Users can transfer, manage, and interact with the ERC1155 representation of the Rune on the RSK network.
  4. Redeeming Runes: Users can redeem the ERC1155 tokens on RSK to etch the Rune back on Bitcoin. The system freezes the ERC1155 tokens and sends the Rune back to the user's Bitcoin address.

Project Structure

Descripción de la imagen

Technologies Used

Installation

To clone and run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/rsksmart/rsk-runes.git
cd rsk-runes

  2. Install dependencies:

    yarn
or
npm install

  3. Configure environment variables: Create a .env file in the root directory and add necessary environment variables. Example:

    RSK_PROVIDER_URL="https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID"
PRIVATE_KEY="your-private-key"
NEXT_PUBLIC_APP_PK='your-private-key'
NEXT_PUBLIC_RPC_URL='your rsk rpc url'
NEXT_PUBLIC_EXPLORER_URL=https://blockstream.info/testnet/tx
NEXT_PUBLIC_RSK_EXPLORER_URL=https://explorer.testnet.rootstock.io/tx
NEXT_PUBLIC_CONTRACT_ADDRESS='your erc1155 contract address'
NEXT_PUBLIC_TAPROOT_ADDRESS='your taproot address'
NEXT_PUBLIC_WIF='your wif key'

  4. Run the development server:

    yarn dev
or
npm run dev

Usage

  1. Access the application: Open http://localhost:3000 in your browser.
  2. Etch a Rune: Navigate to the Etch tab, fill out the form, and submit to etch a Rune on Bitcoin.
  3. View ERC20 Representation: After etching, view the ERC1155 token details on the Last Etch tab.

Future Development

  • Minting Runes: The minting functionality is under development and will be available in future releases.
  • Fungible Tokens on RSK: The project will support the creation of fungible tokens on the RSK network.

Contributing

We welcome contributions from the community. Please fork the repository and submit pull requests with your changes. Ensure your code adheres to the project's main objective.

Support

For any questions or support, please open an issue on the repository or reach out to the maintainers.

Disclaimer

The software provided in this GitHub repository is offered “as is,” without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

  • Testing: The software has not undergone testing of any kind, and its functionality, accuracy, reliability, and suitability for any purpose are not guaranteed.
  • Use at Your Own Risk: The user assumes all risks associated with the use of this software. The author(s) of this software shall not be held liable for any damages, including but not limited to direct, indirect, incidental, special, consequential, or punitive damages arising out of the use of or inability to use this software, even if advised of the possibility of such damages.
  • No Liability: The author(s) of this software are not liable for any loss or damage, including without limitation, any loss of profits, business interruption, loss of information or data, or other pecuniary loss arising out of the use of or inability to use this software.
  • Sole Responsibility: The user acknowledges that they are solely responsible for the outcome of the use of this software, including any decisions made or actions taken based on the software’s output or functionality.
  • No Endorsement: Mention of any specific product, service, or organization does not constitute or imply endorsement by the author(s) of this software.
  • Modification and Distribution: This software may be modified and distributed under the terms of the license provided with the software. By modifying or distributing this software, you agree to be bound by the terms of the license.
  • Assumption of Risk: By using this software, the user acknowledges and agrees that they have read, understood, and accepted the terms of this disclaimer and assumes all risks associated with the use of this software.