mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2025-12-01 13:04:48 -05:00
feat: Maker avatar (#205)
- GUI: Changed terminology from "swap providers" to "makers" - GUI: For each maker, we now display a unique deterministically generated avatar derived from the maker's public key
This commit is contained in:
binarybaron
GitHub
parent
23d22b5792
commit
b2e74df37e
36 changed files with 511 additions and 429 deletions
|
|
@ -1,22 +1,22 @@
|
|||
import { useState, useEffect } from "react";
|
||||
import { Table, Td, Th, Tr } from 'nextra/components'
|
||||
|
||||
export default function SwapProviderTable() {
|
||||
export default function SwapMakerTable() {
|
||||
function satsToBtc(sats) {
|
||||
return sats / 100000000;
|
||||
}
|
||||
|
||||
async function getProviders() {
|
||||
async function getMakers() {
|
||||
const response = await fetch("https://api.unstoppableswap.net/api/list");
|
||||
const data = await response.json();
|
||||
return data;
|
||||
}
|
||||
|
||||
const [providers, setProviders] = useState([]);
|
||||
const [makers, setMakers] = useState([]);
|
||||
|
||||
useEffect(() => {
|
||||
getProviders().then((data) => {
|
||||
setProviders(data);
|
||||
getMakers().then((data) => {
|
||||
setMakers(data);
|
||||
});
|
||||
}, []);
|
||||
|
||||
|
|
@ -38,16 +38,16 @@ export default function SwapProviderTable() {
|
|||
</Tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{providers.map((provider) => (
|
||||
<Tr key={provider.peerId}>
|
||||
{makers.map((maker) => (
|
||||
<Tr key={maker.peerId}>
|
||||
<Td>
|
||||
{provider.testnet ? "Testnet" : "Mainnet"}
|
||||
{maker.testnet ? "Testnet" : "Mainnet"}
|
||||
</Td>
|
||||
<Td>{provider.multiAddr}</Td>
|
||||
<Td>{provider.peerId}</Td>
|
||||
<Td>{satsToBtc(provider.minSwapAmount)} BTC</Td>
|
||||
<Td>{satsToBtc(provider.maxSwapAmount)} BTC</Td>
|
||||
<Td>{satsToBtc(provider.price)} XMR/BTC</Td>
|
||||
<Td>{maker.multiAddr}</Td>
|
||||
<Td>{maker.peerId}</Td>
|
||||
<Td>{satsToBtc(maker.minSwapAmount)} BTC</Td>
|
||||
<Td>{satsToBtc(maker.maxSwapAmount)} BTC</Td>
|
||||
<Td>{satsToBtc(maker.price)} XMR/BTC</Td>
|
||||
</Tr>
|
||||
))}
|
||||
</tbody>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"first_swap": "Complete your first swap",
|
||||
"market_maker_discovery": "Swap Provider discovery",
|
||||
"market_maker_discovery": "Maker discovery",
|
||||
"refund_punish": "Cancel, Refund and Punish explained"
|
||||
}
|
||||
|
|
@ -16,16 +16,16 @@ import { Steps } from 'nextra/components'
|
|||
|
||||
## Performing the swap
|
||||
<Steps>
|
||||
### Choose a _Swap Provider_ to swap with
|
||||
### Choose a _maker_ to swap with
|
||||
|
||||
In the bottom of the screen you can see the currently selected _Swap Provider_.
|
||||
In the bottom of the screen you can see the currently selected _maker_.
|
||||
This is who you'll send your Bitcoin to and who you'll receive the Monero from.
|
||||
You can change the _Swap Provider_ by clicking on the arrow and selecting a different _Swap Provider_ from the list.
|
||||
You can change the _maker_ by clicking on the arrow and selecting a different _maker_ from the list.
|
||||
|
||||
import { Callout } from 'nextra/components'
|
||||
|
||||
<Callout type="info">
|
||||
Different _Swap Providers_ offer different exchange rates and differing amounts of liquidity. You may want to choose the _Swap Provider_ that best suits your needs.
|
||||
Different _makers_ offer different exchange rates and differing amounts of liquidity. You may want to choose the _maker_ that best suits your needs.
|
||||
</Callout>
|
||||
|
||||
You can use the input field to calculate the approximate amount of Monero you'll receive for a given amount of Bitcoin.
|
||||
|
|
@ -39,7 +39,7 @@ This is only used as a reference for you to get a rough idea of how much Monero
|
|||
|
||||
### Start the Swap
|
||||
|
||||
Once you've selected a _Swap Provider_, you can start the swap by clicking the `Swap` button.
|
||||
Once you've selected a _maker_, you can start the swap by clicking the `Swap` button.
|
||||
This will open a new window where you need to enter two addresses:
|
||||
|
||||
1. the Monero address you want to receive the Monero to
|
||||
|
|
@ -54,7 +54,7 @@ After pressing the <img src="/start_swap_button.png" style={{
|
|||
display: "inline-block",
|
||||
// center vertically
|
||||
verticalAlign: "middle",
|
||||
}}/> button, you'll be shown an offer by the _Swap Provider_. This includes:
|
||||
}}/> button, you'll be shown an offer by the _maker_. This includes:
|
||||
|
||||
- the exchange rate (how much Bitcoin they demand for 1 Monero)
|
||||
- the minimum and maximum amounts you can swap
|
||||
|
|
@ -88,10 +88,10 @@ The swap will go through four stages:
|
|||
1. **Locking the Bitcoin**:
|
||||
Your Bitcoin is locked in a 2-of-2 multisig address.
|
||||
|
||||
2. **_Swap Provider_ locks the Monero**:
|
||||
2. **_Maker_ locks the Monero**:
|
||||
The other party locks their Monero as well.
|
||||
|
||||
3. **_Swap Provider_ redeems _Bitcoin_**:
|
||||
3. **_Maker_ redeems _Bitcoin_**:
|
||||
The other party redeems the Bitcoin.
|
||||
|
||||
4. **Redeeming the Monero**:
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
# _Swap Provider_ discovery
|
||||
# _Maker_ discovery
|
||||
|
||||
A _Swap Provider_ is a service run by a pseudonymous entity that offers to sell Monero in exchange for Bitcoin. To swap your Bitcoin for Monero you need to connect to a one of these _Swap Providers_.
|
||||
The different ways to discover _Swap Providers_ are described below.
|
||||
A _maker_ is a service run by a pseudonymous entity that offers to sell Monero in exchange for Bitcoin. To swap your Bitcoin for Monero you need to connect to a one of these _makers_.
|
||||
The different ways to discover _makers_ are described below.
|
||||
|
||||
There are two ways to discover _Swap Providers_:
|
||||
There are two ways to discover _makers_:
|
||||
|
||||
1. **Public Registry**: Community volunteers maintain a list of _Swap Providers_ that is provided to the GUI and is kept up to date automatically. This list is displayed in the GUI by default. The _Public Registry_ also stores additional information about the _Swap Providers_ such as their uptime and age, and makes it available to the GUI.
|
||||
2. **Rendezvous**: The GUI can discover Swap Providers using the [_Rendezvous_ protocol](https://docs.libp2p.io/concepts/discovery-routing/rendezvous/). This protocol enables the GUI to find providers that register themselves at a _Rendezvous Point_. The GUI can query these points to get a list of registered providers. _Rendezvous Points_ are operated by community volunteers, and anyone can run one. The GUI can connect to various _Rendezvous Points_ to discover different _Swap Providers_.
|
||||
1. **Public Registry**: Community volunteers maintain a list of _makers_ that is provided to the GUI and is kept up to date automatically. This list is displayed in the GUI by default. The _Public Registry_ also stores additional information about the _makers_ such as their uptime and age, and makes it available to the GUI.
|
||||
2. **Rendezvous**: The GUI can discover makers using the [_Rendezvous_ protocol](https://docs.libp2p.io/concepts/discovery-routing/rendezvous/). This protocol enables the GUI to find makers that register themselves at a _Rendezvous Point_. The GUI can query these points to get a list of registered makers. _Rendezvous Points_ are operated by community volunteers, and anyone can run one. The GUI can connect to various _Rendezvous Points_ to discover different _makers_.
|
||||
|
||||
## _Public Registry_
|
||||
|
||||
The providers from the registry are displayed in the GUI. If you want to connect to them directly without the GUI choose one from the table below.
|
||||
The makers from the registry are displayed in the GUI. If you want to connect to them directly without the GUI choose one from the table below.
|
||||
|
||||
import SwapProviderTable from "../../components/SwapProviderTable";
|
||||
|
||||
|
|
@ -19,9 +19,9 @@ import SwapProviderTable from "../../components/SwapProviderTable";
|
|||
<SwapProviderTable />
|
||||
</div>
|
||||
|
||||
## How to discover _Swap Providers_ via _Rendezvous_
|
||||
## How to discover _makers_ via _Rendezvous_
|
||||
|
||||
1. Open the _Swap Provider_ list by clicking the right-facing arrow in the widget on the _Swap_ tab.
|
||||
1. Open the _maker_ list by clicking the right-facing arrow in the widget on the _Swap_ tab.
|
||||
|
||||
<img src="/rendezvous_1.png" />
|
||||
|
||||
|
|
@ -30,14 +30,14 @@ import SwapProviderTable from "../../components/SwapProviderTable";
|
|||
display: "inline-block",
|
||||
// center vertically
|
||||
verticalAlign: "middle",
|
||||
}}/> button to open the _Discover swap providers_ dialog. Enter the _Multiaddress_ of the _Rendezvous Point_ you want to connect to. You can also choose one of the predined ones from the list below the Textfield. Click the _Connect_ button to connect to the rendezvous point.
|
||||
}}/> button to open the _Discover makers_ dialog. Enter the _Multiaddress_ of the _Rendezvous Point_ you want to connect to. You can also choose one of the predined ones from the list below the Textfield. Click the _Connect_ button to connect to the rendezvous point.
|
||||
<img src="/rendezvous_2.png" />
|
||||
|
||||
## How to add a _Swap Provider_ to the _Public Registry_
|
||||
## How to add a _maker_ to the _Public Registry_
|
||||
|
||||
If you know of a _Swap Provider_ that is not yet in the _Public Registry_, you can submit it manually. Here's how you can do it:
|
||||
If you know of a _maker_ that is not yet in the _Public Registry_, you can submit it manually. Here's how you can do it:
|
||||
|
||||
1. Open the _Swap Provider_ list by clicking the right-facing arrow in the widget on the _Swap_ tab.
|
||||
1. Open the _maker_ list by clicking the right-facing arrow in the widget on the _Swap_ tab.
|
||||
|
||||
<img src="/rendezvous_1.png" />
|
||||
|
||||
|
|
@ -46,5 +46,5 @@ If you know of a _Swap Provider_ that is not yet in the _Public Registry_, you c
|
|||
display: "inline-block",
|
||||
// center vertically
|
||||
verticalAlign: "middle",
|
||||
}}/> button. Enter the _Multiaddress_ of the _Swap Provider_ as well as the _Peer ID_ of the provider. Click the _Submit_ button to submit the provider to the _Public Registry_.
|
||||
}}/> button. Enter the _Multiaddress_ of the _maker_ as well as the _Peer ID_ of the provider. Click the _Submit_ button to submit the provider to the _Public Registry_.
|
||||
<img src="/public_registry.png" />
|
||||
|
|
|
|||
|
|
@ -8,17 +8,17 @@ We have chosen to include a fairly technical explanation here. However, the GUI
|
|||
|
||||
## Cancel
|
||||
|
||||
If the _Swap Provider_ has not been able to redeem the Bitcoin within 12 hours (72 Bitcoin blocks) from the start of the swap, the swap will be cancelled.
|
||||
This is done by either you or the _Swap Provider_ publishing a special Bitcoin transaction called the `Bitcoin Cancel Transaction`.
|
||||
If the _maker_ has not been able to redeem the Bitcoin within 12 hours (72 Bitcoin blocks) from the start of the swap, the swap will be cancelled.
|
||||
This is done by either you or the _maker_ publishing a special Bitcoin transaction called the `Bitcoin Cancel Transaction`.
|
||||
As soon as this transaction is included in the Bitcoin blockchain, the swap is locked in a state where only the [_Refund_](#refund) and [_Punish_](#punish) paths can be activated. The _Happy Path_ path where you redeem the Monero is no longer possible.
|
||||
|
||||
## Refund
|
||||
|
||||
As soon as the swap is cancelled, you can refund your Bitcoin. This is done by publishing the `Bitcoin Refund Transaction` on the Bitcoin blockchain.
|
||||
If this is done within 24 hours (144 Bitcoin blocks) from the inclusion of the `Bitcoin Cancel Transaction`, you will get your Bitcoin back.
|
||||
If you do not refund your Bitcoin within this time frame, the _Swap Provider_ can punish you. This is a security measure to ensure that you do not cancel the swap and then refuse to refund your Bitcoin which would result in the _Swap Provider_ losing their Monero.
|
||||
If you do not refund your Bitcoin within this time frame, the _maker_ can punish you. This is a security measure to ensure that you do not cancel the swap and then refuse to refund your Bitcoin which would result in the _maker_ losing their Monero.
|
||||
|
||||
## Punish
|
||||
|
||||
If you do not refund your Bitcoin within 24 hours (144 Bitcoin blocks) from the inclusion of the `Bitcoin Cancel Transaction`, the _Swap Provider_ will _punish_ you. This will result in the _Swap Provider_ taking your Bitcoin as a penalty for not refunding it in time.
|
||||
Even if this state is reached and the _Swap Provider_ has punished you, there's still hope to redeem the Monero. The _Swap Provider_ can choose to allow you to redeem the Monero by transmitting a secret key to you. This however is at the discretion of the _Swap Provider_ and they are not obligated to do so.
|
||||
If you do not refund your Bitcoin within 24 hours (144 Bitcoin blocks) from the inclusion of the `Bitcoin Cancel Transaction`, the _maker_ will _punish_ you. This will result in the _maker_ taking your Bitcoin as a penalty for not refunding it in time.
|
||||
Even if this state is reached and the _maker_ has punished you, there's still hope to redeem the Monero. The _maker_ can choose to allow you to redeem the Monero by transmitting a secret key to you. This however is at the discretion of the _maker_ and they are not obligated to do so.
|
||||
Loading…
Add table
Add a link
Reference in a new issue