psf/bch-dex
1
0
Fork 0
mirror of https://github.com/Permissionless-Software-Foundation/bch-dex.git synced 2026-09-21 16:52:00 -07:00
Code Issues Packages Projects Releases Wiki Activity

Editing dev docs

Browse Source
This commit is contained in:
Chris Troutner
2022-03-11 12:52:08 -08:00
parent ad744e807f
commit afebdc5448
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev-docs/README.md
+3 -3
View File
@@ -28,12 +28,12 @@ The workflow of a token trade has three parts:
2. **Take** - A second user, known as a *Taker*, will *take* the *Offer* by issues a *Counter Offer* 2. **Take** - A second user, known as a *Taker*, will *take* the *Offer* by issues a *Counter Offer*
3. **Accept** - The original *Maker* checks the *Counter Offer* and *Accepts* it by signing and then broadcasting the transaction. 3. **Accept** - The original *Maker* checks the *Counter Offer* and *Accepts* it by signing and then broadcasting the transaction.
Trade done in this way are both *trustless* and *atomic*: Trades done in this way are both *trustless* and *atomic*:
- **Trustless** - This means that neither party needs to trust the other. The Maker gets to review the Counter Offer before broadcasting it. The Maker can not alter the Counter Offer after the Taker has signed it. - **Trustless** - This means that neither party needs to trust the other. The *Maker* gets to review the *Counter Offer* before broadcasting it. The *Maker* can not alter the *Counter Offer* after the *Taker* has signed it.
- **Atomic** - The trade happens in a single transaction. There is no middle-state where the trade can get stuck. It either happens or doesn't, it's state is binary and atomic. - **Atomic** - The trade happens in a single transaction. There is no middle-state where the trade can get stuck. It either happens or doesn't, it's state is binary and atomic.
Specific *Entities* are defined in the [specification](./specification.md), but here is a brief summary: Specific *Entities* are defined in the [specification](./specification.md), but here is a brief summary:
- **Order** represents the Maker side of the trade. This entity is tracked internal to `bch-dex` and is used to track tokens set aside for sale. - **Order** represents the *Maker* side of the trade. This entity is internal to `bch-dex`. It is used to track tokens set aside for sale and managed by the wallet controlled by `bch-dex`.
- **Offer** contains most of the same information as an **Order**, but is external to `bch-dex`. This is data submitted to the P2WDB and visible to all users on the network. - **Offer** contains most of the same information as an **Order**, but is external to `bch-dex`. This is data submitted to the P2WDB and visible to all users on the network.
- **Counter Offer** is generated by a *Taker*, in order to take the other side of the trade. It contains a partially-signed transaction, ready for review by the *Maker*. - **Counter Offer** is generated by a *Taker*, in order to take the other side of the trade. It contains a partially-signed transaction, ready for review by the *Maker*.