Skip to content

Commit

Permalink
release: update readme (#463)
Browse files Browse the repository at this point in the history
  • Loading branch information
noot authored May 4, 2023
1 parent 8f566b6 commit a2e7897
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# ETH-XMR Atomic Swaps

This is a WIP implementation of ETH-XMR atomic swaps, currently in the pre-production development phase. It currently consists of `swapd` and `swapcli` binaries, the swap daemon and swap CLI tool respectively, which allow for peers to discover each other over the network, query peers 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.
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.

## Protocol
## Swap instructions

Please see the [protocol documentation](docs/protocol.md) for how it works.
### Trying it on mainnet

## Swap instructions
To try the swap on Ethereum and Monero mainnet, follow the instructions [here](./docs/mainnet.md).

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

To try the swap on Stagenet/Sepolia, follow the instructions [here](./docs/stagenet.md).

### Trying it locally

To try the swap locally with two nodes (maker and taker) on a development environment, follow the instructions [here](./docs/local.md).

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

To try the swap on Stagenet/Sepolia, follow the instructions [here](./docs/stagenet.md).
Please see the [protocol documentation](docs/protocol.md) for how it works.

## Additional documentation

Expand Down

0 comments on commit a2e7897

Please sign in to comment.