Judecoin / unstoppableswap-gui

unstoppableswap-gui

UnstoppableSwap GUI

Graphical User Interface (GUI) For Trustless Cross-Chain JUDE<>BTC Atomic Swaps

Download . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Documentation
• Getting Started
• Development
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Acknowledgements

About The Project

Atomic swaps between BTC and JUDE have been one of the most discussed and anticipated developments in the field for quite some time.

While Farcaster is still working on the implementation of their protocol, the COMIT team has already delivered an MVP. Trustless cross-chain swaps are becoming a tangible reality. However, for atomic swaps to gain widespread and adopted, the user experience needs to be drastically improved. People shouldn't have to manually type commands into a terminal or understand the protocol at a technical level to participate. That's the problem this project aims to solve.

Make atomic swaps accessible to all!

Documentation

• How to swap on testnet

Built With

• COMIT Swap CLI
• React
• Redux
• Material UI

Getting Started

Please download the GUI from the release page. Choose your respective version (.dmg for Mac, .AppImage for Linux and .exe for Windows). You may need to manually allow the opening of the GUI on Mac OS.

Donate

We rely on generous donors like you to keep development moving forward. To bring Atomic Swaps to life, we need resources. If you have the possibility, please consider making a donation to the project. All funds will be used to support contributors and critical infrastructure.

If you interested in a partnership or want to support the project in a way that requires coordination with the contributors, contact @[e-mail] on Jude.

JUDE: 87jS4C7ngk9EHdqFFuxGFgg8AyH63dRUoULshWDybFJaP75UA89qsutG5B1L1QTc4w228nsqsv8EjhL7bz8fB3611Mh98mg
BTC: bc1q8hj4aq59fucrhz59rxpqnwgy8y6spxxvq4wcj2

Development

To get a local copy up and running follow these simple steps.

Prerequisites

Before proceeding you should install the following:

• node (v16)
• npm (probably bundled with your installation)

Installation

Clone the repository, install all dependencies using npm and start the GUI on testnet.

git clone --branch main https://github.com/judecoin/unstoppableswap-gui.git
cd unstoppableswap-gui
npm install

TESTNET=true npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.