Categorygithub.com/athanorlabs/atomic-swap
module
0.4.3
Repository: https://github.com/athanorlabs/atomic-swap.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

ETH-XMR Atomic Swaps

This is an implementation of ETH-XMR atomic swaps, currently in beta. It currently consists of swapd and swapcli binaries, the swap daemon and swap CLI tool respectively, which allow for nodes to discover each other over the p2p network, to query nodes for their current available offers, and the ability to make and take swap offers and perform the swap protocol. The swapd program has a JSON-RPC endpoint which the user can use to interact with it. swapcli is a command-line utility that interacts with swapd by performing RPC calls.

Swap instructions

Trying it on mainnet

To try the swap on Ethereum and Monero mainnet, follow the instructions here.

Trying it on Monero's stagenet and Ethereum's Sepolia testnet

To try the swap on Stagenet/Sepolia, follow the instructions here.

Trying it locally

To try the swap locally with two nodes (maker and taker) on a development environment, follow the instructions here.

Protocol

Please see the protocol documentation for how it works.

Additional documentation

Developer instructions

Please see the developer docs.

RPC API

The swap process comes with a HTTP JSON-RPC API as well as a Websockets API. You can find the documentation here.

Contributions

If you'd like to contribute, feel free to fork the repo and make a pull request. Please make sure the CI is passing - you can run make build, make lint, and make test to make sure the checks pass locally. Please note that any contributions you make will be licensed under LGPLv3.

Contact

Donations

The work on this project has been funded previously by community grants. It is currently not funded; if you'd like to donate, you can do so at the following address:

  • XMR 8AYdE4Tzq3rQYh7QNHfHz8HqcgT9kcTcHMcRHL1LhVtqYwah27zwPYGdesBgK5PATvGBAd4BC1t2NfrqKQqDguybQrC1tZb
  • ETH 0x39D3b8cc9D08fD83360dDaCFe054b7D6e7f2cA08

GPLv3 Disclaimer

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

# Packages

Package bootnode is responsible for assembling, running and cleanly shutting down a swap bootnode.
Package cliutil provides utility functions intended for sharing by the main packages of multiple executables.
No description provided by the author
Package coins provides types, conversions and exchange calculations for dealing with cryptocurrency coin and ERC20 token representations.
Package common is for miscellaneous constants, types and interfaces used by many packages.
Package crypto is for cryptographic code used by both Monero and Ethereum.
Package daemon is responsible for assembling, running and cleanly shutting down the swap daemon (swapd) and its numerous subcomponents.
Package db implements the APIs for interacting with our disk persisted key-value store.
Package dleq provides a sub-api built on top of the go-dleq package for our atomic swaps.
Package contracts is for go bindings generated from Solidity contracts as well as some utility functions for working with the contracts.
Package monero provides client libraries for working with wallet files and interacting with a monero node.
Package net adds swap-specific functionality to go-p2p-net/Host, in particular the swap messages for querying and initiation.
Package pricefeed implements routines to retrieve on-chain price feeds from chainlink's decentralized oracle network.
Package protocol has functions that are used by both the maker and taker during execution of the swap.
Package relayer provides libraries for creating and validating relay requests and responses.
Package rpc provides the HTTP server for incoming JSON-RPC and websocket requests to swapd from the local host.
Package rpcclient provides client libraries for interacting with a local swapd instance using the JSON-RPC remote procedure call protocol.
No description provided by the author