Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
kilrau authored Jun 9, 2020
2 parents 069f54a + 741d48f commit a45b41c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
4 changes: 2 additions & 2 deletions 02-peer-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,13 @@ The `NodeStateUpdate` message is used to tell a peer about a change in the node
The sender's list of trading pair symbols, constructed with the base currency first, followed by a '/' separator and the quote currency (e.g., [“LTC/BTC”, “DAI/BTC”])

`string connext_identifier = 3`
The sender's connext identifier (e.g. indra565S4X3vjBiZXTCGM8K5T3Shu2MLD5wrvi9fuDJmtVuw24kKiJ)
The sender's Connext identifier (e.g. `indra123abc`)

`map<string, string> lnd_pub_keys = 4`
The sender's list of LND public keys

`map<string, string> token_identifiers = 5`
Mapping between currency symbols to token identifiers such as LND chains or connext token contract address (e.g., { BTC: 'bitcoin-mainnet', LTC: 'litecoin-mainnet' })
Mapping between currency symbols and chain identifiers or ETH-ERC20 token contract addresses (e.g., { BTC: 'bitcoin-mainnet', LTC: 'litecoin-mainnet', ETH:,'0x0000000000000000000000000000000000000000' })

`map<string, LndUris> lnd_uris = 6`
Mapping between currency symbols to LND listening URIs (should be reachable from the internet e.g., { BTC: ['2w526cyown43ovsvsojdowheqmukbykrexzyccp6v6j4pm5ve3hjzrid.onion:9735'], LTC: '['lndltc.kilrau.com:9735', 'qiyibtczmuhutusmygvc2injxl7v4yfcodwj3pft63edycud5gr3giad.onion:10735']' })
Expand Down
2 changes: 1 addition & 1 deletion 04-swap-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Once an order match is found in the taker’s order book, the swap protocol should be initiated. The current swap protocol assumes that the taker and maker are connected via a payment channel network (e.g. the [Lightning](http://lightning.network/) or [connext Network](https://connext.network/)) with sufficient balance available for the swap. The following is the swap protocol's "happy" flow:
Once an order match is found in the taker’s order book, the swap protocol should be initiated. The current swap protocol assumes that the taker and maker are connected via a payment channel network (e.g. [Lightning](http://lightning.network/) or [Connext](https://connext.network/)) with sufficient balance available for the swap. The following is the swap protocol's "happy" flow:

1. Taker finds a match, e.g. buying 1 BTC for 10k DAI
2. Taker creates the private `r_preimage` and the public `r_hash` for the atomic swap
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![](/images/OpenDEX_Full_Transparent.png)

**OpenDEX is a global network for unstoppable P2P trading of cryptocurrencies and tokens.** It is built on top of the [Lightning](https://lightning.network/) and [connext](https://connext.network/) network and at its core, it is a set of open protocol specifications, called **BOLD**. BOLD stands for: Basis of L3 DEX. The naming is intentionally derived from [BOLT](https://github.com/lightningnetwork/lightning-rfc), the Lightning Network specifications and role model of OpenDEX. These specifications ensure that OpenDEX nodes remain compatible and users of different software implementations are able to trade with each other. **OpenDEX is not a company** or any other sort of legal entity, it is an open community of motivated individuals maintaining the BOLD specifications. OpenDEX was started because we believe there should be only one DEX, **one global trading network**, not hundreds. Find the slides from the first public announcement at #hcpp19 in Prague [here](201901005_hcpp19.pdf) and the video recording [here](https://www.youtube.com/watch?v=euSr9A6tI90).
**OpenDEX is a global network for unstoppable P2P trading of cryptocurrencies and tokens.** It is built on top of the [Lightning](https://lightning.network/) and [Connext](https://connext.network/) networks and at its core, it is a set of open protocol specifications, called **BOLD**. BOLD stands for: Basis of L3 DEX. The naming is intentionally derived from [BOLT](https://github.com/lightningnetwork/lightning-rfc), the Lightning Network specifications and role model of OpenDEX. These specifications ensure that OpenDEX nodes remain compatible and users of different software implementations are able to trade with each other. **OpenDEX is not a company** or any other sort of legal entity, it is an open community of motivated individuals maintaining the BOLD specifications. OpenDEX was started because we believe there should be only one DEX, **one global trading network**, not hundreds. Find the slides from the first public announcement at #hcpp19 in Prague [here](201901005_hcpp19.pdf) and the video recording [here](https://www.youtube.com/watch?v=euSr9A6tI90).

## Get Started
-> [Read the BOLD specifications](00-introduction.md)
Expand All @@ -20,15 +20,11 @@
* Direct, peer-to-peer trading.
* Order book locally aggregates orders from peers in the network.
* Own orders are matched locally with peer orders.
* Instant order settlement via atomic swaps on lightning/connext.
* Instant order settlement via atomic swaps on Lightning/Connext.
* User has complete control over private keys.
* [Tor](https://www.torproject.org/) by default preserves privacy.
* Supports individual traders, market makers, exchanges, anyone.

## Support & Community
* [Contribute](Contribute.md)
* Chat with us on [Discord](https://discord.gg/RnXFHpn)
* Open a BTC ⚡-channel with us:
```
03be58f20b39b40775ac06058bf94250575e8606c72b58f71baf6af35683acc879@yjpkcnfkn73xtnmunbxwhxdmcp25cjvqq4veoefdeapp7h7qtrfskfid.onion:9735
```

0 comments on commit a45b41c

Please sign in to comment.