From fb867b441b81bc5918c7caddf71985b3d1166cd0 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 9 Jun 2018 12:59:56 +0200 Subject: [PATCH 01/39] Add initial entries to 'Glossary' doc --- glossary.adoc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 glossary.adoc diff --git a/glossary.adoc b/glossary.adoc new file mode 100644 index 0000000..9ed7293 --- /dev/null +++ b/glossary.adoc @@ -0,0 +1,19 @@ += Glossary + +fiat:: + +buyer:: + +seller:: + +maker:: + +taker:: + +offer:: + +trade:: + +dispute:: + +payment method:: From bd4f07ffa3f128c82f16b6b63b87148e7f55a374 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 9 Jun 2018 13:29:09 +0200 Subject: [PATCH 02/39] Add 'Glossary' entry to index --- glossary.adoc | 12 ++++++++++++ index.adoc | 1 + 2 files changed, 13 insertions(+) diff --git a/glossary.adoc b/glossary.adoc index 9ed7293..43d714a 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,5 +1,17 @@ = Glossary +== National currency + +=== Altcoin + +=== Trade + +== Offer + +== Maker + +== Taker + fiat:: buyer:: diff --git a/index.adoc b/index.adoc index 0a94584..da6ecca 100644 --- a/index.adoc +++ b/index.adoc @@ -25,6 +25,7 @@ Docs without hyperlinks haven't been written yet. If you want to write one, <> — _Get familiar with commonly-used Bisq terminology_ === Features From dbfe1f381f683ead8ff4c2a63d9603142702cc34 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 12 Jun 2018 21:00:26 +0200 Subject: [PATCH 03/39] Continue fleshing out 'Glossary' This was the result of a lot of experimentation with formats for the Glossary in the context of building out the Payment Methods doc. In the end, the best is to structure it just like any other doc, i.e. no special `term:: definition` syntax, as it breaks expectations like ability to anchor link to the terms. It was also an excercise in developing the tersest and most digestible format possible. What's coming together here is inspired by @evoskuil's work at https://github.com/libbitcoin/libbitcoin/wiki/Glossary. In any case it remains very much a work in progress, but one worth committing at this point. --- glossary.adoc | 170 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 155 insertions(+), 15 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 43d714a..e4b697f 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,31 +1,171 @@ -= Glossary += Bisq Glossary +// inspired by https://github.com/libbitcoin/libbitcoin/wiki/Glossary -== National currency -=== Altcoin +== Actors + +=== User +A person who uses <> in the pursuit of their economic self-interest. + +=== Contributor +A person who improves <> in the pursuit of their economic self-interest. + +=== Maker +A <> who creates an <>. + +=== Taker +A <> who accepts an <>. + +=== Trader +A <> contractually bound to complete a given <>. Sometimes referred to as _party_ or _counterparty_. + +=== Buyer +A <> who buys another's bitcoin in exchange for their own <>. + +=== Seller +A <> who sells their own bitcoin in exchange for another's <>. + +=== Stakeholder +A <> who TODO + +=== Bonded Contributor +A <> who TODO + +=== Arbitrator +A <> and <> selected to settle a trade <>. + +=== Operator +A <> who operates a <>. + +=== Maintainer +A <> who maintains a <> + + +== Transactions === Trade +The act of exchanging (buying or selling) bitcoin for other property. + +=== Dispute +The process of <> and <> working with an <> to resolve a problem with a <>. Also known as _Arbitration_. + + +=== Repository + + +== Objects + +=== Component +Software that performs a specific function. See <>. + +=== Bisq +The system of <> that work together to make . Also referred to as the _Bisq Network_. + +=== Offer +An expression of intent to <>, including all necessary details such as <> and <>. + +=== Offer Book +A map of all open <>s, keyed by <>. + + +== Components + +=== Critical components + +==== Bisq Desktop + +==== Bisq Core + +==== Bisq P2P + +==== Trusted components + +===== Bisq Seednode + +===== Bisq Pricenode + +===== Bisq Bitcoin Node + +=== Non-critical components + +==== Bisq Website + +==== Bisq Markets Website + +==== Bisq Markets API + + + + + +=== Property +An object rightfully possessed by a person. Presently, the specific types of property that may be traded on Bisq are <> currencies and <> assets. + +=== Asset +Definition of asset. + +=== Currency +def + +=== Bitcoin +def + +=== Fiat (currency) +def + +=== Crypto (currency) +def + +=== Depth +The amount of bitcoin currently available for trading in a given market. + +=== Spread +// tag::spread[] +The difference between the best (lowest-priced) <<./glossary#offer, offer>> to sell and the best (highest-priced) <<./glossary#offer, offer>> to buy, divided by the market price and expressed as a percentage. +// end::spread[] +[NOTE] +.Example +==== +If the best <> to sell BTC is **1,050 USD** and the best offer to buy BTC is for **950 USD** and the current market price is **1,000 USD**, then the BTC/USD market spread is `((1050-950)/1000)*100)` or **10%**. +==== +[TIP] +.Putting spreads to use +==== +Spreads indicate different kinds of opportunities in a market. A 0% spread indicates an opportunity to trade at the market price. A positive spread (as in the example above) indicates an opportunity to make a better offer and get it taken more quickly. A negative spread indicates an opportunity to take an underpriced offer and profit from it. See <<./glossary.adoc#arbitrage, arbitrage>>. +==== + +=== Market +The trade between a certain pair of assets. As in "the BTC/USD and BTC/XMR markets". + +=== Volume +The amount of a given number of units traded in a given time period. -== Offer +=== Price +and fixed vs distance from market price -== Maker -== Taker -fiat:: +=== Payment Method +// tag::payment-method[] +The means by which a <<./glossary#buyer, buyer>> pays a <<./glossary#seller, seller>> for their bitcoin when settling a <<./glossary#trade, trade>>. Each Bisq trade <<./glossary#offer, offer>> specifies the payment method to be used, and both buyer and seller must have access to that payment method to complete the trade. <<./glossary#national-currency, National currency>> payment methods range widely from traditional bank transfers, to money orders by mail, to more modern services like Revolut and Uphold. Cryptocurrency (or <<./glossary#altcoin, altcoin>>) payment methods require transferring payment over a specific altcoin blockchain. +// end::payment-method[] +See: <>. -buyer:: +=== Account -seller:: +=== Security Deposit +def -maker:: +=== Multisig Escrow +def -taker:: +=== Deposit Transaction +def -offer:: +=== Mining Fee +def -trade:: +=== Trading Fee +def -dispute:: -payment method:: From 4688e72941e05969834eecc79b811c91fcf42bb7 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 13 Jun 2018 19:07:58 +0200 Subject: [PATCH 04/39] WIP --- glossary.adoc | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index e4b697f..1cf0628 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -49,28 +49,32 @@ The act of exchanging (buying or selling) bitcoin for other property. === Dispute The process of <> and <> working with an <> to resolve a problem with a <>. Also known as _Arbitration_. +=== Offer +An expression of intent to <>, including all necessary details such as <> and <>. -=== Repository +=== Offer Book +A map of all open <>s, keyed by <>. -== Objects -=== Component -Software that performs a specific function. See <>. + +== System === Bisq The system of <> that work together to make . Also referred to as the _Bisq Network_. -=== Offer -An expression of intent to <>, including all necessary details such as <> and <>. +=== Component -=== Offer Book -A map of all open <>s, keyed by <>. +== Components + +=== Component +Software that performs a specific function. See <>. +=== Critical component -== Components +=== Ancillary component -=== Critical components +=== Trusted component ==== Bisq Desktop @@ -96,6 +100,8 @@ A map of all open <>s, keyed by <>. +=== Repository + === Property From 0884c24aba27dcaacfb48e8ab0a3f32a990da8bc Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 18 Jun 2018 06:28:04 +0200 Subject: [PATCH 05/39] Save WIP --- glossary.adoc | 188 +++++++++++++++++++++++++++++++++++--------------- index.adoc | 2 +- 2 files changed, 133 insertions(+), 57 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 1cf0628..2b673aa 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,14 +1,44 @@ = Bisq Glossary // inspired by https://github.com/libbitcoin/libbitcoin/wiki/Glossary - -== Actors +== Fundamentals === User -A person who uses <> in the pursuit of their economic self-interest. +A person who uses <>. === Contributor -A person who improves <> in the pursuit of their economic self-interest. +A person who improves <>. + +=== Bisq +//// +A peer-to-peer Bitcoin foreign exchange network. Aka _Bisq Network_. + +A peer-to-peer Bitcoin trading network. Aka _Bisq Network_. + +A peer-to-peer Bitcoin exchange network. Aka _Bisq Network_. + +A peer-to-peer bitcoin exchange network. Aka _Bisq Network_. + +A peer-to-peer Bitcoin asset exchange network. Aka _Bisq Network_. + +A peer-to-peer exchange network for Bitcoin. Aka _Bisq Network_. + +A peer-to-peer Bitcoin <> exchange network. Aka _Bisq Network_. + +A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. +//// +A peer-to-peer <> exchange network. Aka _Bisq Network_. + +=== Asset +Property divisible into and transferrable as fungible <>. + +> The US dollar and bitcoin are assets. + +[[units, Units]] +=== Unit +The atomic transferable value of an <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#unit] + +> The penny is the US dollar unit. The satoshi is the bitcoin unit. === Maker A <> who creates an <>. @@ -16,17 +46,70 @@ A <> who creates an <>. === Taker A <> who accepts an <>. +=== Offer +An expression of intent to <> with certain <>. + +=== Bid +An <> to buy bitcoin. + +=== Ask +An <> to sell bitcoin. + +=== Trade +(v.) To exchange bitcoin for another <>. + +(n.) The exchange of bitcoin for another <>. + +=== Terms +The requirements to <>, including <>, <>, <> and <>. + +// > The terms specified that the buyer would purchase 0.625 BTC from the seller at a price of 6425.89 USD via the Zelle payment network. + +=== Settle +To complete payment of an <> owed. + +=== Amount +A number of <>. + +=== Trade Amount +The <> of bitcoin to be traded. + +> The trade amount is `0.625 BTC` (62,500,000 satoshis) + +=== Price +The <> of an <> expected in exchange for one bitcoin. Aka _Exchange Rate_. + +=== Market Price +A moving average of a given <>. +//Aka _Spot Price_. + +> The market price on June 16th at 16:12 CET was `6,401.39 USD/BTC` according to BitcoinAverage. + +=== Trade Price +The <> agreed on in a given <>, which may differ from the <>. + +> The trade price was `6,529.42 USD/BTC` – 2% above the market price. + +=== Payment Amount +The <> multiplied by the <>. + +> The payment amount was `4,000.87 USD` (0.625 BTC * 6,401.39 USD/BTC) + +=== Payment Method +The means with which the <> will <>. See <>. + +> The payment method was `SEPA transfer`. + === Trader -A <> contractually bound to complete a given <>. Sometimes referred to as _party_ or _counterparty_. +A <> bound by contract to <>. Aka _Counterparty_. === Buyer -A <> who buys another's bitcoin in exchange for their own <>. +A <> who buys another's bitcoin in exchange for their own <>. === Seller -A <> who sells their own bitcoin in exchange for another's <>. +A <> who sells their own bitcoin in exchange for another's <>. === Stakeholder -A <> who TODO +A <> who <> <> and is eligible to <>. === Bonded Contributor A <> who TODO @@ -38,24 +121,41 @@ A <> and <> selected to settle a trade <>. A <> who operates a <>. === Maintainer -A <> who maintains a <> +A <> who maintains a <>. +=== Attacker +A person who attempts to damage <>. -== Transactions +=== Scammer +A dishonest <> who attempts to defraud others of their property. Aka _Fraudster_. -=== Trade -The act of exchanging (buying or selling) bitcoin for other property. -=== Dispute -The process of <> and <> working with an <> to resolve a problem with a <>. Also known as _Arbitration_. +== ??? -=== Offer -An expression of intent to <>, including all necessary details such as <> and <>. +=== BSQ +Bisq's Bitcoin-based utility token that owners can trade for bitcoin, spend on trading fees, vote, bond, and earn. +[NOTE] +.BSQ the token vs BSQ the system +==== +TODO +==== -=== Offer Book -A map of all open <>s, keyed by <>. +=== Compensation + +=== Voting + +=== Own +A person controlling certain <>. + + + +== Trading +=== Dispute +The process of <> and <> working with an <> to resolve a problem with a <>. Aka _Arbitration_. +=== Offer Book +A map of all open <>, keyed by <>. == System @@ -63,10 +163,6 @@ A map of all open <>s, keyed by <>. === Bisq The system of <> that work together to make . Also referred to as the _Bisq Network_. -=== Component - -== Components - === Component Software that performs a specific function. See <>. @@ -76,27 +172,23 @@ Software that performs a specific function. See <>. === Trusted component -==== Bisq Desktop +=== Bisq Desktop -==== Bisq Core +=== Bisq Core -==== Bisq P2P +=== Bisq P2P -==== Trusted components +=== Bisq Seednode -===== Bisq Seednode +=== Bisq Pricenode -===== Bisq Pricenode +=== Bisq Bitcoin Node -===== Bisq Bitcoin Node +=== Bisq Website -=== Non-critical components +=== Bisq Markets Website -==== Bisq Website - -==== Bisq Markets Website - -==== Bisq Markets API +=== Bisq Markets API @@ -104,26 +196,20 @@ Software that performs a specific function. See <>. -=== Property -An object rightfully possessed by a person. Presently, the specific types of property that may be traded on Bisq are <> currencies and <> assets. - -=== Asset -Definition of asset. - === Currency def === Bitcoin def -=== Fiat (currency) -def +=== Fiat +A <> issued by a national authority. Aka _Fiat Currency, National Currency_. -=== Crypto (currency) -def +=== Crypto +A === Depth -The amount of bitcoin currently available for trading in a given market. +The amount of bitcoin available for <> in a given <>. === Spread // tag::spread[] @@ -146,16 +232,6 @@ The trade between a certain pair of assets. As in "the BTC/USD and BTC/XMR marke === Volume The amount of a given number of units traded in a given time period. -=== Price -and fixed vs distance from market price - - - -=== Payment Method -// tag::payment-method[] -The means by which a <<./glossary#buyer, buyer>> pays a <<./glossary#seller, seller>> for their bitcoin when settling a <<./glossary#trade, trade>>. Each Bisq trade <<./glossary#offer, offer>> specifies the payment method to be used, and both buyer and seller must have access to that payment method to complete the trade. <<./glossary#national-currency, National currency>> payment methods range widely from traditional bank transfers, to money orders by mail, to more modern services like Revolut and Uphold. Cryptocurrency (or <<./glossary#altcoin, altcoin>>) payment methods require transferring payment over a specific altcoin blockchain. -// end::payment-method[] -See: <>. === Account diff --git a/index.adoc b/index.adoc index da6ecca..7d5170d 100644 --- a/index.adoc +++ b/index.adoc @@ -25,7 +25,7 @@ Docs without hyperlinks haven't been written yet. If you want to write one, <> — _Get familiar with commonly-used Bisq terminology_ + * <> === Features From 35f66dd9e499b0a5f8246a83cc74d6e62e749153 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 18 Jun 2018 07:03:41 +0200 Subject: [PATCH 06/39] Save WIP --- glossary.adoc | 50 +++++++++++++++++++++++++++++++------------------- 1 file changed, 31 insertions(+), 19 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 2b673aa..5bf4f1b 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,5 +1,4 @@ = Bisq Glossary -// inspired by https://github.com/libbitcoin/libbitcoin/wiki/Glossary == Fundamentals @@ -27,7 +26,9 @@ A peer-to-peer Bitcoin <> exchange network. Aka _Bisq Network_. A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. //// -A peer-to-peer <> exchange network. Aka _Bisq Network_. +A peer-to-peer <> exchange network. + +Aka _Bisq Network_. === Asset Property divisible into and transferrable as fungible <>. @@ -73,34 +74,45 @@ A number of <>. === Trade Amount The <> of bitcoin to be traded. -> The trade amount is `0.625 BTC` (62,500,000 satoshis) +> The trade amount was `0.1 BTC` (1,000,000 satoshis) + +=== Trade Date +The date an <> is taken. + +> The trade date was `Nov 16th at 16:12 CET` === Price -The <> of an <> expected in exchange for one bitcoin. Aka _Exchange Rate_. +The <> of an <> expected in exchange for one bitcoin. + +Aka _Exchange Rate_. === Market Price A moving average of a given <>. //Aka _Spot Price_. -> The market price on June 16th at 16:12 CET was `6,401.39 USD/BTC` according to BitcoinAverage. +> The market price on Nov 16th at 16:12 CET was `1,000.00 USD/BTC` according to BitcoinAverage. === Trade Price -The <> agreed on in a given <>, which may differ from the <>. +The <> agreed on for a given <>, which may differ from the <>. -> The trade price was `6,529.42 USD/BTC` – 2% above the market price. +> The trade price was `1,010.00 USD/BTC` – 1% above the market price. === Payment Amount The <> multiplied by the <>. -> The payment amount was `4,000.87 USD` (0.625 BTC * 6,401.39 USD/BTC) +> The payment amount was `101.00 USD` (0.1 BTC * 1,010.00 USD/BTC) === Payment Method -The means with which the <> will <>. See <>. +The means with which the <> will <>. -> The payment method was `SEPA transfer`. +> The payment method was `Cash Deposit`. + +See <>. === Trader -A <> bound by contract to <>. Aka _Counterparty_. +A <> bound by contract to <>. + +Aka _Counterparty_. === Buyer A <> who buys another's bitcoin in exchange for their own <>. @@ -127,8 +139,9 @@ A <> who maintains a <>. A person who attempts to damage <>. === Scammer -A dishonest <> who attempts to defraud others of their property. Aka _Fraudster_. +A dishonest <> who attempts to defraud others of their property. +Aka _Fraudster_. == ??? @@ -147,12 +160,12 @@ TODO === Own A person controlling certain <>. - - == Trading === Dispute -The process of <> and <> working with an <> to resolve a problem with a <>. Aka _Arbitration_. +The process of <> and <> working with an <> to resolve a problem with a <>. + +Aka _Arbitration_. === Offer Book A map of all open <>, keyed by <>. @@ -203,7 +216,9 @@ def def === Fiat -A <> issued by a national authority. Aka _Fiat Currency, National Currency_. +A <> issued by a national authority. + +Aka _Fiat Currency, National Currency_. === Crypto A @@ -232,7 +247,6 @@ The trade between a certain pair of assets. As in "the BTC/USD and BTC/XMR marke === Volume The amount of a given number of units traded in a given time period. - === Account === Security Deposit @@ -249,5 +263,3 @@ def === Trading Fee def - - From 4f2111c82d1720dcf815e7b4ee5ba04ead5c4785 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 18 Jun 2018 09:15:52 +0200 Subject: [PATCH 07/39] Save WIP --- glossary.adoc | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 5bf4f1b..42b57dc 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,5 +1,6 @@ = Bisq Glossary + == Fundamentals === User @@ -57,13 +58,11 @@ An <> to buy bitcoin. An <> to sell bitcoin. === Trade -(v.) To exchange bitcoin for another <>. + -(n.) The exchange of bitcoin for another <>. +To exchange bitcoin for another <>. + +_noun:_ The exchange of bitcoin for another <>. -=== Terms -The requirements to <>, including <>, <>, <> and <>. - -// > The terms specified that the buyer would purchase 0.625 BTC from the seller at a price of 6425.89 USD via the Zelle payment network. +=== Trader +A <> bound by contract to <>. === Settle To complete payment of an <> owed. @@ -71,6 +70,25 @@ To complete payment of an <> owed. === Amount A number of <>. +=== Buyer +A <> who buys another's bitcoin in exchange for their own <>. + +=== Seller +A <> who sells their own bitcoin in exchange for another's <>. + +=== Arbitrator +A <> who works to resolve <>. + +=== Dispute + + +== Trading + +=== Terms +The requirements to <>, including <>, <>, <> and <>. + +// > The terms specified that the buyer would purchase 0.625 BTC from the seller at a price of 6425.89 USD via the Zelle payment network. + === Trade Amount The <> of bitcoin to be traded. @@ -109,16 +127,8 @@ The means with which the <> will <>. See <>. -=== Trader -A <> bound by contract to <>. -Aka _Counterparty_. - -=== Buyer -A <> who buys another's bitcoin in exchange for their own <>. - -=== Seller -A <> who sells their own bitcoin in exchange for another's <>. +== Contributing === Stakeholder A <> who <> <> and is eligible to <>. @@ -126,9 +136,6 @@ A <> who <> <> and is eligible to <>. === Bonded Contributor A <> who TODO -=== Arbitrator -A <> and <> selected to settle a trade <>. - === Operator A <> who operates a <>. @@ -143,7 +150,6 @@ A dishonest <> who attempts to defraud others of their property. Aka _Fraudster_. -== ??? === BSQ Bisq's Bitcoin-based utility token that owners can trade for bitcoin, spend on trading fees, vote, bond, and earn. From 1ad2be19e92e77f6a96918e6973cd753e2c121fa Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 18 Jun 2018 09:37:11 +0200 Subject: [PATCH 08/39] Save WIP --- glossary.adoc | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 42b57dc..451828e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -27,9 +27,7 @@ A peer-to-peer Bitcoin <> exchange network. Aka _Bisq Network_. A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. //// -A peer-to-peer <> exchange network. - -Aka _Bisq Network_. +A peer-to-peer <> exchange network. Aka _Bisq Network_. === Asset Property divisible into and transferrable as fungible <>. @@ -59,7 +57,7 @@ An <> to sell bitcoin. === Trade To exchange bitcoin for another <>. + -_noun:_ The exchange of bitcoin for another <>. +_n._ The exchange of bitcoin for another <>. === Trader A <> bound by contract to <>. @@ -77,9 +75,15 @@ A <> who buys another's bitcoin in exchange for their own <>. A <> who sells their own bitcoin in exchange for another's <>. === Arbitrator -A <> who works to resolve <>. +A <> who performs <>. + +=== Arbitration +The service of working with <> and <> to resolve a <>. === Dispute +A problem with a <>. + +> The seller opened a dispute after receiving less in payment than expected. == Trading @@ -166,13 +170,6 @@ TODO === Own A person controlling certain <>. -== Trading - -=== Dispute -The process of <> and <> working with an <> to resolve a problem with a <>. - -Aka _Arbitration_. - === Offer Book A map of all open <>, keyed by <>. From c486ce413b049352d2626b99091d7b9f7c6edd9e Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 18 Jun 2018 10:08:26 +0200 Subject: [PATCH 09/39] Save WIP --- glossary.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/glossary.adoc b/glossary.adoc index 451828e..e62eecf 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -83,8 +83,12 @@ The service of working with <> and <> to resolve a <>. === Dispute A problem with a <>. -> The seller opened a dispute after receiving less in payment than expected. +> The dispute was over the amount the buyer paid the seller. +=== Dispute Ticket +A request for <>. + +> The seller opened a dispute ticket after receiving too little in payment from the buyer. == Trading From 75996eeebdecf05b1c20703186085e2a3e3b824c Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 08:32:40 +0200 Subject: [PATCH 10/39] Save WIP --- glossary.adoc | 112 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 68 insertions(+), 44 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index e62eecf..d2faa53 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -40,20 +40,33 @@ The atomic transferable value of an <>.footnote:[Adapted from https://git > The penny is the US dollar unit. The satoshi is the bitcoin unit. -=== Maker -A <> who creates an <>. +=== Owner +A person controlling certain <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#owner] -=== Taker -A <> who accepts an <>. +=== Amount +A number of <>. -=== Offer -An expression of intent to <> with certain <>. +=== Price +The <> of an <> expected in exchange for one bitcoin. -=== Bid -An <> to buy bitcoin. +Aka _Exchange Rate_. + +=== Bitcoin +TODO + +=== BSQ +The <>-based colored coin that powers Bisq funding and governance. Aka _BSQ token_. Pronounced "Bee-Ess-Queue". + +> The BSQ token has five utilities: earning, trading, spending, voting and bonding. + +[NOTE] +.BSQ the token vs BSQ the system +==== +TODO +==== -=== Ask -An <> to sell bitcoin. + +== Trading === Trade To exchange bitcoin for another <>. + @@ -63,10 +76,7 @@ _n._ The exchange of bitcoin for another <>. A <> bound by contract to <>. === Settle -To complete payment of an <> owed. - -=== Amount -A number of <>. +To complete payment of an <>. === Buyer A <> who buys another's bitcoin in exchange for their own <>. @@ -90,13 +100,12 @@ A request for <>. > The seller opened a dispute ticket after receiving too little in payment from the buyer. -== Trading + +== Trade Terms === Terms The requirements to <>, including <>, <>, <> and <>. -// > The terms specified that the buyer would purchase 0.625 BTC from the seller at a price of 6425.89 USD via the Zelle payment network. - === Trade Amount The <> of bitcoin to be traded. @@ -107,11 +116,6 @@ The date an <> is taken. > The trade date was `Nov 16th at 16:12 CET` -=== Price -The <> of an <> expected in exchange for one bitcoin. - -Aka _Exchange Rate_. - === Market Price A moving average of a given <>. //Aka _Spot Price_. @@ -136,10 +140,32 @@ The means with which the <> will <>. See <>. +== Trade Details + + +== Offers + +=== Maker +A <> who creates an <>. + +=== Taker +A <> who accepts an <>. + +=== Offer +An expression of intent to <> with certain <>. + +=== Bid +An <> to buy bitcoin. + +=== Ask +An <> to sell bitcoin. + + + == Contributing === Stakeholder -A <> who <> <> and is eligible to <>. +An <> of <>. === Bonded Contributor A <> who TODO @@ -150,35 +176,15 @@ A <> who operates a <>. === Maintainer A <> who maintains a <>. -=== Attacker -A person who attempts to damage <>. - -=== Scammer -A dishonest <> who attempts to defraud others of their property. - -Aka _Fraudster_. - - -=== BSQ -Bisq's Bitcoin-based utility token that owners can trade for bitcoin, spend on trading fees, vote, bond, and earn. -[NOTE] -.BSQ the token vs BSQ the system -==== -TODO -==== - === Compensation === Voting -=== Own -A person controlling certain <>. - === Offer Book A map of all open <>, keyed by <>. -== System +== System / Components === Bisq The system of <> that work together to make . Also referred to as the _Bisq Network_. @@ -270,3 +276,21 @@ def === Trading Fee def + + +== Uncategorized + +=== Attacker +A person who attempts to damage <>. + +=== Scammer +A dishonest <> who attempts to defraud others of their <>. + +Aka _Fraudster_. + + +== Appendix: Notes and recommendations + + . Introduce 'Bid' and 'Ask' terms in the UI, API + . Normalize presentation of market pairs, such that BTC is always the denominator, e.g. USD/BTC = 6,500 USD / 1 BTC; XMR/BTC = n XMR / 1 BTC. + . i.e. do not flip things around for altcoin / crypto trades. They're just another payment method as far as Bisq is concened. In Bisq, BTC is money. It's half of every trade. It's the unit of account. All prices here are denominated in it. From 40e869b54eeab97fce61d8e0c55a142af6def0e0 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 08:54:55 +0200 Subject: [PATCH 11/39] Save WIP --- glossary.adoc | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index d2faa53..1066978 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -47,12 +47,19 @@ A person controlling certain <>.footnote:[Adapted from https://github.com A number of <>. === Price -The <> of an <> expected in exchange for one bitcoin. +The <> of an <> expected in exchange for one <>. Aka _Exchange Rate_. +=== bitcoin +The <> of account on the <> network. Aka _BTC_. + +> You have to spend bitcoin to transact on the Bitcoin network. Mining fees are access-to-the-network fees. + === Bitcoin -TODO +The concept of Bitcoin; the entire network itself.footnote:[Adapted from https://bitcoin.org/en/vocabulary#bitcoin] + +> I was learning about the Bitcoin protocol today. === BSQ The <>-based colored coin that powers Bisq funding and governance. Aka _BSQ token_. Pronounced "Bee-Ess-Queue". From 4a1b273724a16d995d5e29ab5ebd70c70118cc6c Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 09:03:53 +0200 Subject: [PATCH 12/39] Save WIP --- glossary.adoc | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 1066978..676a1f5 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -191,10 +191,7 @@ A <> who maintains a <>. A map of all open <>, keyed by <>. -== System / Components - -=== Bisq -The system of <> that work together to make . Also referred to as the _Bisq Network_. +== Network Components === Component Software that performs a specific function. See <>. @@ -224,16 +221,22 @@ Software that performs a specific function. See <>. === Bisq Markets API +== Network Infrastructure + +=== Infrastructure === Repository +== Uncategorized -=== Currency -def +=== Attacker +A person who attempts to damage <>. -=== Bitcoin -def +=== Scammer +A dishonest <> who attempts to defraud others of their <>. + +Aka _Fraudster_. === Fiat A <> issued by a national authority. @@ -285,17 +288,6 @@ def def -== Uncategorized - -=== Attacker -A person who attempts to damage <>. - -=== Scammer -A dishonest <> who attempts to defraud others of their <>. - -Aka _Fraudster_. - - == Appendix: Notes and recommendations . Introduce 'Bid' and 'Ask' terms in the UI, API From 75dc22338dfc4365c590fa36f92e4c8c2e70089a Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 09:41:14 +0200 Subject: [PATCH 13/39] Save WIP --- glossary.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 676a1f5..1b40478 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -76,20 +76,20 @@ TODO == Trading === Trade -To exchange bitcoin for another <>. + -_n._ The exchange of bitcoin for another <>. +To exchange <> for another <>. + +_n._ The exchange of <> for another <>. === Trader -A <> bound by contract to <>. +A <> who has agreed to <> one side of a <>. === Settle To complete payment of an <>. === Buyer -A <> who buys another's bitcoin in exchange for their own <>. +The <> who <> by sending their <> to the <>. === Seller -A <> who sells their own bitcoin in exchange for another's <>. +The <> who <> by releasing their <> to the <>. === Arbitrator A <> who performs <>. From 6174bf6120d64423282a1858c728deefb7aa8f11 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 10:23:01 +0200 Subject: [PATCH 14/39] Save WIP --- glossary.adoc | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 1b40478..ee626b5 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -108,31 +108,41 @@ A request for <>. > The seller opened a dispute ticket after receiving too little in payment from the buyer. +== Markets + +=== Market Price +A moving average of a given <>. +//Aka _Spot Price_. + +> The market price on Nov 16th at 16:12 CET was `1,000.00 USD/BTC` according to BitcoinAverage. + + == Trade Terms === Terms -The requirements to <>, including <>, <>, <> and <>. +The conditions to <> a trade, including <>, <>, <> and <>. === Trade Amount The <> of bitcoin to be traded. > The trade amount was `0.1 BTC` (1,000,000 satoshis) -=== Trade Date -The date an <> is taken. +=== Trade Price +The <> both <> have agreed to pay. -> The trade date was `Nov 16th at 16:12 CET` +> The trade price was `1,010.00 USD/BTC` -=== Market Price -A moving average of a given <>. -//Aka _Spot Price_. +==== Fixed Trade Price -> The market price on Nov 16th at 16:12 CET was `1,000.00 USD/BTC` according to BitcoinAverage. +A <> whose value is assigned at <> creation time. -=== Trade Price -The <> agreed on for a given <>, which may differ from the <>. +> This trade's price is fixed at 1,000 USD/BTC + +==== Floating Trade Price -> The trade price was `1,010.00 USD/BTC` – 1% above the market price. +A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. + +> This trade's price is set to float at 2% above market price === Payment Amount The <> multiplied by the <>. @@ -149,6 +159,11 @@ See <>. == Trade Details +=== Trade Date +The date an <> is taken. + +> The trade date was `Nov 16th at 16:12 CET` + == Offers From 8295fedf742fecf20c798011f25146fc14e49fdd Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 10:54:28 +0200 Subject: [PATCH 15/39] Save WIP --- glossary.adoc | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index ee626b5..1f34510 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -54,7 +54,7 @@ Aka _Exchange Rate_. === bitcoin The <> of account on the <> network. Aka _BTC_. -> You have to spend bitcoin to transact on the Bitcoin network. Mining fees are access-to-the-network fees. +> You have to spend bitcoin to transact on the Bitcoin network. === Bitcoin The concept of Bitcoin; the entire network itself.footnote:[Adapted from https://bitcoin.org/en/vocabulary#bitcoin] @@ -62,16 +62,12 @@ The concept of Bitcoin; the entire network itself.footnote:[Adapted from https:/ > I was learning about the Bitcoin protocol today. === BSQ -The <>-based colored coin that powers Bisq funding and governance. Aka _BSQ token_. Pronounced "Bee-Ess-Queue". +The <>-based colored coin that underpins Bisq funding and governance. Aka _BSQ token_. -> The BSQ token has five utilities: earning, trading, spending, voting and bonding. - -[NOTE] -.BSQ the token vs BSQ the system -==== -TODO -==== +> BSQ has five utilities: earning, trading, spending, voting and bonding. +=== BSQ (system) +The <> and consensus protocol that validate <> transactions. == Trading @@ -80,7 +76,7 @@ To exchange <> for another <>. + _n._ The exchange of <> for another <>. === Trader -A <> who has agreed to <> one side of a <>. +A <> who has agreed to <> in one side of a <>. === Settle To complete payment of an <>. From 7d10675a3f05f6b608aa0e3a4ad2bf9f321e020d Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 11:11:07 +0200 Subject: [PATCH 16/39] Save WIP --- glossary.adoc | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 1f34510..d06e61f 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -62,12 +62,12 @@ The concept of Bitcoin; the entire network itself.footnote:[Adapted from https:/ > I was learning about the Bitcoin protocol today. === BSQ -The <>-based colored coin that underpins Bisq funding and governance. Aka _BSQ token_. +The <>-based colored coin used in Bisq funding and governance transactions. Aka _BSQ token_. > BSQ has five utilities: earning, trading, spending, voting and bonding. === BSQ (system) -The <> and consensus protocol that validate <> transactions. +The <> and consensus protocol that validate <> transactions. == Trading @@ -116,39 +116,27 @@ A moving average of a given <>. == Trade Terms === Terms -The conditions to <> a trade, including <>, <>, <> and <>. +The conditions for <>, including <>, <>, <> and <>. === Trade Amount -The <> of bitcoin to be traded. +The <> of <> to be traded. -> The trade amount was `0.1 BTC` (1,000,000 satoshis) +> The trade amount is `0.1 BTC` (1,000,000 satoshis) === Trade Price The <> both <> have agreed to pay. -> The trade price was `1,010.00 USD/BTC` - -==== Fixed Trade Price - -A <> whose value is assigned at <> creation time. - -> This trade's price is fixed at 1,000 USD/BTC - -==== Floating Trade Price - -A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. - -> This trade's price is set to float at 2% above market price +> The trade price is `1,000.00 USD/BTC` === Payment Amount The <> multiplied by the <>. -> The payment amount was `101.00 USD` (0.1 BTC * 1,010.00 USD/BTC) +> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC) === Payment Method The means with which the <> will <>. -> The payment method was `Cash Deposit`. +> The payment method is `Cash Deposit`. See <>. @@ -178,6 +166,16 @@ An <> to buy bitcoin. === Ask An <> to sell bitcoin. +=== Fixed Trade Price +A <> whose value is assigned at <> creation time. + +> This trade's price is fixed at 1,000 USD/BTC + +=== Floating Trade Price +A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. + +> This trade's price is set to float at 2% above market price + == Contributing From af87c4ae090d67fb9da3b2be1a93442d8fe9d94d Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 12:34:36 +0200 Subject: [PATCH 17/39] Save WIP --- glossary.adoc | 111 ++++++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 53 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index d06e61f..e5c2005 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -46,11 +46,6 @@ A person controlling certain <>.footnote:[Adapted from https://github.com === Amount A number of <>. -=== Price -The <> of an <> expected in exchange for one <>. - -Aka _Exchange Rate_. - === bitcoin The <> of account on the <> network. Aka _BTC_. @@ -106,11 +101,45 @@ A request for <>. == Markets +=== Market +The trade between a certain pair of assets.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] + +> The USD/BTC market is very active. + +=== Price +The <> of an <> expected in exchange for one <>. + === Market Price -A moving average of a given <>. -//Aka _Spot Price_. +A moving average of <> in a given <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#price] Aka _Spot Price, Exchange Rate_. + +> The market price on March 27th 2017 at 12:00 CET was `1,000.00 USD/BTC` according to BitcoinAverage. + +=== Volume +The <> of <> traded over a given time period. + +> 24-hour volume was 4.23 BTC + +=== Depth +The <> of <> available for to buy or sell in a <>. + +> The sell side of the USD/BTC market has a depth of 1.25 BTC. + +=== Spread +The percentage difference between the best (lowest-priced) <> and the best (highest-priced) <> divided by the <>. + +> The spread in the USD/BTC market is 2% right now. + +[NOTE] +.Example +==== +If the best <> is **1,050 USD** and the best <> is **950 USD** and the <> is **1,000 USD**, then the BTC/USD market spread is `(1050-950)/1000` or **10%**. +==== -> The market price on Nov 16th at 16:12 CET was `1,000.00 USD/BTC` according to BitcoinAverage. +[TIP] +.Putting spreads to use +==== +Spreads indicate different kinds of opportunities in a market. A 0% spread indicates an opportunity to trade at the market price. A positive spread (as in the example above) indicates an opportunity to make a better offer and to profit when your offer is taken more quickly than others. A negative spread indicates an opportunity to take an underpriced offer and to acquire bitcoin at a discount. +==== == Trade Terms @@ -144,9 +173,9 @@ See <>. == Trade Details === Trade Date -The date an <> is taken. +The date an <> was taken. -> The trade date was `Nov 16th at 16:12 CET` +> The trade date is `March 27th 2017 at 12:00 CET` == Offers @@ -177,25 +206,6 @@ A <> whose value is assigned at <> acceptance time by multip > This trade's price is set to float at 2% above market price - -== Contributing - -=== Stakeholder -An <> of <>. - -=== Bonded Contributor -A <> who TODO - -=== Operator -A <> who operates a <>. - -=== Maintainer -A <> who maintains a <>. - -=== Compensation - -=== Voting - === Offer Book A map of all open <>, keyed by <>. @@ -237,6 +247,25 @@ Software that performs a specific function. See <>. === Repository +== Contributing + +=== Stakeholder +An <> of <>. + +=== Bonded Contributor +A <> who TODO + +=== Operator +A <> who operates a <>. + +=== Maintainer +A <> who maintains a <>. + +=== Compensation + +=== Voting + + == Uncategorized === Attacker @@ -255,30 +284,6 @@ Aka _Fiat Currency, National Currency_. === Crypto A -=== Depth -The amount of bitcoin available for <> in a given <>. - -=== Spread -// tag::spread[] -The difference between the best (lowest-priced) <<./glossary#offer, offer>> to sell and the best (highest-priced) <<./glossary#offer, offer>> to buy, divided by the market price and expressed as a percentage. -// end::spread[] -[NOTE] -.Example -==== -If the best <> to sell BTC is **1,050 USD** and the best offer to buy BTC is for **950 USD** and the current market price is **1,000 USD**, then the BTC/USD market spread is `((1050-950)/1000)*100)` or **10%**. -==== -[TIP] -.Putting spreads to use -==== -Spreads indicate different kinds of opportunities in a market. A 0% spread indicates an opportunity to trade at the market price. A positive spread (as in the example above) indicates an opportunity to make a better offer and get it taken more quickly. A negative spread indicates an opportunity to take an underpriced offer and profit from it. See <<./glossary.adoc#arbitrage, arbitrage>>. -==== - -=== Market -The trade between a certain pair of assets. As in "the BTC/USD and BTC/XMR markets". - -=== Volume -The amount of a given number of units traded in a given time period. - === Account === Security Deposit From fbf3eb4df05af0199bd1a24aebe93b76b9b1d753 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 14:46:50 +0200 Subject: [PATCH 18/39] Save WIP --- glossary.adoc | 124 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 80 insertions(+), 44 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index e5c2005..8fa2bb4 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -64,23 +64,23 @@ The <>-based colored coin used in Bisq funding and governance transacti === BSQ (system) The <> and consensus protocol that validate <> transactions. + == Trading === Trade -To exchange <> for another <>. + -_n._ The exchange of <> for another <>. +An exchange of <> for another <>. === Trader -A <> who has agreed to <> in one side of a <>. +A <> who has agreed to <> in a <>. === Settle To complete payment of an <>. === Buyer -The <> who <> by sending their <> to the <>. +The <> who will <> by sending their <> to the <>. === Seller -The <> who <> by releasing their <> to the <>. +The <> who will <> by releasing their <> to the <>. === Arbitrator A <> who performs <>. @@ -89,7 +89,7 @@ A <> who performs <>. The service of working with <> and <> to resolve a <>. === Dispute -A problem with a <>. +A problem during a <>. > The dispute was over the amount the buyer paid the seller. @@ -99,12 +99,30 @@ A request for <>. > The seller opened a dispute ticket after receiving too little in payment from the buyer. +== Offers + +=== Offer +An expression of intent to <> a <>. + +=== Maker +A <> who creates an <>. + +=== Taker +A <> who accepts an <>. + +=== Bid +An <> to buy <>. + +=== Ask +An <> to sell <>. + + == Markets === Market -The trade between a certain pair of assets.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] +The trade between a certain <> and <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] -> The USD/BTC market is very active. +> The USD/BTC market is among the most active. === Price The <> of an <> expected in exchange for one <>. @@ -141,11 +159,13 @@ If the best <> is **1,050 USD** and the best <> is **950 USD** and the Spreads indicate different kinds of opportunities in a market. A 0% spread indicates an opportunity to trade at the market price. A positive spread (as in the example above) indicates an opportunity to make a better offer and to profit when your offer is taken more quickly than others. A negative spread indicates an opportunity to take an underpriced offer and to acquire bitcoin at a discount. ==== +=== Offer Book +A visual representation of open <> in a given <>. + +[[terms, Terms]] == Trade Terms - -=== Terms -The conditions for <>, including <>, <>, <> and <>. +The required conditions to <> a <>. === Trade Amount The <> of <> to be traded. @@ -178,36 +198,31 @@ The date an <> was taken. > The trade date is `March 27th 2017 at 12:00 CET` -== Offers +== Portfolio -=== Maker -A <> who creates an <>. +=== Open Offer -=== Taker -A <> who accepts an <>. +=== Open Trade -=== Offer -An expression of intent to <> with certain <>. +=== Completed Trade -=== Bid -An <> to buy bitcoin. +=== Failed Trade -=== Ask -An <> to sell bitcoin. -=== Fixed Trade Price -A <> whose value is assigned at <> creation time. +== Wallet (Aka. Funds) -> This trade's price is fixed at 1,000 USD/BTC +=== Available Balance -=== Floating Trade Price -A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. +=== Reserved Balance -> This trade's price is set to float at 2% above market price +=== Locked Balance -=== Offer Book -A map of all open <>, keyed by <>. +== Payment Accounts + +=== Fiat Payment Accounts + +=== Crypto Payment Accounts == Network Components @@ -255,15 +270,24 @@ An <> of <>. === Bonded Contributor A <> who TODO +=== Bonding + +=== Compensation + +=== Voting + + +== Roles + === Operator A <> who operates a <>. === Maintainer A <> who maintains a <>. -=== Compensation +=== Moderator -=== Voting +=== Admin == Uncategorized @@ -272,38 +296,50 @@ A <> who maintains a <>. A person who attempts to damage <>. === Scammer -A dishonest <> who attempts to defraud others of their <>. - -Aka _Fraudster_. +A dishonest <> who attempts to defraud others of their <>. Aka _Fraudster_. === Fiat -A <> issued by a national authority. - -Aka _Fiat Currency, National Currency_. +A <> issued by a national authority. Aka _Fiat Currency, National Currency_. === Crypto -A === Account === Security Deposit -def === Multisig Escrow -def === Deposit Transaction -def === Mining Fee -def === Trading Fee -def + +=== Fixed Trade Price +A <> whose value is assigned at <> creation time. + +> This trade's price is fixed at 1,000 USD/BTC + +=== Floating Trade Price +A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. + +> This trade's price is set to float at 2% above market price == Appendix: Notes and recommendations . Introduce 'Bid' and 'Ask' terms in the UI, API . Normalize presentation of market pairs, such that BTC is always the denominator, e.g. USD/BTC = 6,500 USD / 1 BTC; XMR/BTC = n XMR / 1 BTC. + - UPDATE: kill the BTC entirely in most contexts. It's half of every trade. So just talk about Bisq's USD market, XMR market, etc. When displaying market prices, do it like this: `Market Price: 6552.50 USD/BTC`. Note how BTC is in the denominator here, as it should be. (currently we put it in the numerator of the market) . i.e. do not flip things around for altcoin / crypto trades. They're just another payment method as far as Bisq is concened. In Bisq, BTC is money. It's half of every trade. It's the unit of account. All prices here are denominated in it. + . Change `Market` to `Markets` in top nav + . Rename `Account` to `Payment Accounts` + - Rename `National Currency Accouts` to `Fiat Payment Accounts` + - Rename `National Currency Accouts` to `Crypto Payment Accounts` + - Extract `Arbitrator Selection`, `Wallet Password` and other tabs to `Settings` + . Rename `Funds` => `Wallet` + - Rename `Receive funds` to `Receive BTC` + - Rename `Send funds` to `Send BTC` + - Rename `Send funds` to `Send BTC` + - Rename `Reserved funds` to `Reserved Balance` + - Rename `Locked funds` to `Locked Balance` From 91fbbc29ea7bc73d5f181d29b34e5a656e211ae7 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 17:48:57 +0200 Subject: [PATCH 19/39] Save WIP --- glossary.adoc | 72 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 7 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 8fa2bb4..4e87eea 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -198,6 +198,13 @@ The date an <> was taken. > The trade date is `March 27th 2017 at 12:00 CET` +== Payment Accounts + +=== Fiat Payment Accounts + +=== Crypto Payment Accounts + + == Portfolio === Open Offer @@ -209,20 +216,71 @@ The date an <> was taken. === Failed Trade -== Wallet (Aka. Funds) +== Fees -=== Available Balance +=== Mining Fee -=== Reserved Balance +=== Trading Fee -=== Locked Balance +=== Maker Fee +=== Taker Fee -== Payment Accounts -=== Fiat Payment Accounts +== Fraud Protection -=== Crypto Payment Accounts +=== Security Deposit + +The <> of bitcoin each <> must place in <>. + +> The buyer's security deposit was 0.01 BTC; the seller's was 0.003 BTC. + +=== Per-Trade Limits + +=== Payment Account Maturity + +=== Payment Method Selection + + +== Escrow +The state of <> being held aside until <> complete <> + +=== Escrow Funds +The <> and the <> from each <>. + +=== Escrow Address +The <> where <> are <>. + +which any two of the <>, <> and <> must sign in order to be co + +=== Multisig Address +A <> address requiring multiple signatures to authorize a <> transaction. + +=== Deposit +The process of sending + +=== Payout + + +== Bitcoin Transactions + +=== Maker Fee Transaction + +=== Taker Fee Transaction + +=== Deposit Transaction + +=== Payout Transaction + + + +== Wallet (Aka. Funds) + +=== Available Balance + +=== Reserved Balance + +=== Locked Balance == Network Components From c5a9337a19d185635b3f0a6f37cad1b80e7c4cb8 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sat, 23 Jun 2018 18:08:33 +0200 Subject: [PATCH 20/39] Refine Fundamentals --- glossary.adoc | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 4e87eea..803987e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -3,11 +3,16 @@ == Fundamentals -=== User -A person who uses <>. +=== Asset +Property divisible into and transferrable as fungible <>. -=== Contributor -A person who improves <>. +> The US dollar and bitcoin are assets. + +[[units, Units]] +=== Unit +The atomic transferable value of an <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#unit] + +> The penny is the US dollar unit. The satoshi is the bitcoin unit. === Bisq //// @@ -29,16 +34,13 @@ A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. //// A peer-to-peer <> exchange network. Aka _Bisq Network_. -=== Asset -Property divisible into and transferrable as fungible <>. - -> The US dollar and bitcoin are assets. +> US dollars have been exchanged for bitcoin thousands of times using Bisq -[[units, Units]] -=== Unit -The atomic transferable value of an <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#unit] +=== User +A person who uses <>. -> The penny is the US dollar unit. The satoshi is the bitcoin unit. +=== Contributor +A person who improves <>. === Owner A person controlling certain <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#owner] @@ -56,14 +58,6 @@ The concept of Bitcoin; the entire network itself.footnote:[Adapted from https:/ > I was learning about the Bitcoin protocol today. -=== BSQ -The <>-based colored coin used in Bisq funding and governance transactions. Aka _BSQ token_. - -> BSQ has five utilities: earning, trading, spending, voting and bonding. - -=== BSQ (system) -The <> and consensus protocol that validate <> transactions. - == Trading @@ -383,6 +377,14 @@ A <> whose value is assigned at <> acceptance time by multip > This trade's price is set to float at 2% above market price +=== BSQ +The <>-based colored coin used in Bisq funding and governance transactions. Aka _BSQ token_. + +> BSQ has five utilities: earning, trading, spending, voting and bonding. + +=== BSQ (system) +The <> and consensus protocol that validate <> transactions. + == Appendix: Notes and recommendations From a10204793f359daab56c6507253678441f2c266c Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 06:39:50 +0200 Subject: [PATCH 21/39] Save WIP --- glossary.adoc | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/glossary.adoc b/glossary.adoc index 803987e..6e6a2b9 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -65,7 +65,7 @@ The concept of Bitcoin; the entire network itself.footnote:[Adapted from https:/ An exchange of <> for another <>. === Trader -A <> who has agreed to <> in a <>. +A <> who has agreed to <> one side of a <>. === Settle To complete payment of an <>. @@ -385,6 +385,16 @@ The <>-based colored coin used in Bisq funding and governance transacti === BSQ (system) The <> and consensus protocol that validate <> transactions. +=== Proposal + +=== Compensation Request + +=== Meritocracy + +=== Radical Transparency + +=== Work on What You Want + == Appendix: Notes and recommendations From 5f2fc3cba7eeff29dc09e50b5167d7d8d07a4ad5 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 08:38:29 +0200 Subject: [PATCH 22/39] Refine Settle and Escrow terms --- glossary.adoc | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 6e6a2b9..b48907e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -65,10 +65,10 @@ The concept of Bitcoin; the entire network itself.footnote:[Adapted from https:/ An exchange of <> for another <>. === Trader -A <> who has agreed to <> one side of a <>. +A <> who has agreed to <> in a <>. === Settle -To complete payment of an <>. +To complete payment. === Buyer The <> who will <> by sending their <> to the <>. @@ -96,7 +96,7 @@ A request for <>. == Offers === Offer -An expression of intent to <> a <>. +An expression of intent to engage in a <>. === Maker A <> who creates an <>. @@ -159,7 +159,7 @@ A visual representation of open <> in a given <>. [[terms, Terms]] == Trade Terms -The required conditions to <> a <>. +The conditions required to <> in a <>. === Trade Amount The <> of <> to be traded. @@ -237,23 +237,21 @@ The <> of bitcoin each <> must place in <>. == Escrow -The state of <> being held aside until <> complete <> -=== Escrow Funds +=== Escrow Amount The <> and the <> from each <>. === Escrow Address -The <> where <> are <>. - -which any two of the <>, <> and <> must sign in order to be co +A <> that requires two among the <>, <> and <> to sign. === Multisig Address -A <> address requiring multiple signatures to authorize a <> transaction. +A <> address requiring multiple signatures to authorize a transaction. -=== Deposit -The process of sending +=== Escrow Deposit +The process of sending the <> to the <> when a <> begins. -=== Payout +=== Escrow Payout +The process of sending the <> from the <> to its rightful <> when a <> completes. == Bitcoin Transactions @@ -262,9 +260,9 @@ The process of sending === Taker Fee Transaction -=== Deposit Transaction +=== Escrow Deposit Transaction -=== Payout Transaction +=== Escrow Payout Transaction From 64854c8081ffe3cdbbb1fab23f6b441c392185d7 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 11:22:23 +0200 Subject: [PATCH 23/39] Refine bitcoin/Bitcoin entries --- glossary.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index b48907e..f689da9 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -51,12 +51,12 @@ A number of <>. === bitcoin The <> of account on the <> network. Aka _BTC_. -> You have to spend bitcoin to transact on the Bitcoin network. +> I sent 0.011 bitcoin to a family member today === Bitcoin -The concept of Bitcoin; the entire network itself.footnote:[Adapted from https://bitcoin.org/en/vocabulary#bitcoin] +A peer-to-peer electronic cash system.footnote:[https://bitcoin.org/bitcoin.pdf] Aka _Bitcoin network_. -> I was learning about the Bitcoin protocol today. +> I've been studying the way the Bitcoin protocol works == Trading From 8e7770d74eb69bb2a88a4aa522be37273d6acbdc Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 11:23:27 +0200 Subject: [PATCH 24/39] Add recommendations --- glossary.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/glossary.adoc b/glossary.adoc index f689da9..ab3b8c5 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -411,3 +411,6 @@ The <> and consensus protocol that validate <> trans - Rename `Send funds` to `Send BTC` - Rename `Reserved funds` to `Reserved Balance` - Rename `Locked funds` to `Locked Balance` + . Rework `Asset` hierarchy to include fiat + - Use emoji flags for national currencies? + - Repackage to `bisq.{=>core}.asset`? (would reflect that physical separation of repo is for practical purposes, would allow nat'l / fiat currency implementations to live in bisq-core. From def4939c168e1e71dcc3fe6874e754054fbf0f57 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 11:24:05 +0200 Subject: [PATCH 25/39] Refine Trading section --- glossary.adoc | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index ab3b8c5..831a2e0 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -73,24 +73,30 @@ To complete payment. === Buyer The <> who will <> by sending their <> to the <>. +> Alice is the buyer. She will send 3,000 US dollars to Bob as payment for 0.5 of his bitcoin. + === Seller -The <> who will <> by releasing their <> to the <>. +The <> who will <> by sending their <> to the <>. + +> Bob is the seller. He will send 0.5 of his bitcoin to Alice after receiving her payment. === Arbitrator A <> who performs <>. +> Charlie is the arbitrator. He is standing by in case of dispute. + === Arbitration -The service of working with <> and <> to resolve a <>. +The service of working with <> and <> to resolve a <> === Dispute A problem during a <>. -> The dispute was over the amount the buyer paid the seller. +> The dispute was over the amount the buyer paid the seller === Dispute Ticket A request for <>. -> The seller opened a dispute ticket after receiving too little in payment from the buyer. +> The seller opened a dispute ticket after receiving too little in payment from the buyer == Offers From 72a12ac5d0372482616d8078a6c70f56846067f7 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 15:09:56 +0200 Subject: [PATCH 26/39] Move Trade Terms directly below Trading --- glossary.adoc | 62 +++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 831a2e0..03b6edf 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -48,6 +48,9 @@ A person controlling certain <>.footnote:[Adapted from https://github.com === Amount A number of <>. +=== Price +The <> of an <> expected in exchange for one <>. + === bitcoin The <> of account on the <> network. Aka _BTC_. @@ -99,10 +102,37 @@ A request for <>. > The seller opened a dispute ticket after receiving too little in payment from the buyer +[[terms, Terms]] +== Trade Terms +The conditions required to <>. + +=== Trade Amount +The <> of <> to be traded. + +> The trade amount is `0.1 BTC` (1,000,000 satoshis) + +=== Trade Price +The <> both <> have agreed to pay. + +> The trade price is `1,000.00 USD/BTC` + +=== Payment Amount +The <> multiplied by the <>. + +> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC) + +=== Payment Method +The means with which the <> will <>. + +> The payment method is `Cash Deposit`. + +See <>. + + == Offers === Offer -An expression of intent to engage in a <>. +An expression of intent to buy or sell <> with certain <>. === Maker A <> who creates an <>. @@ -124,9 +154,6 @@ The trade between a certain <> and <>.footnote:[Adapted from htt > The USD/BTC market is among the most active. -=== Price -The <> of an <> expected in exchange for one <>. - === Market Price A moving average of <> in a given <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#price] Aka _Spot Price, Exchange Rate_. @@ -163,33 +190,6 @@ Spreads indicate different kinds of opportunities in a market. A 0% spread indic A visual representation of open <> in a given <>. -[[terms, Terms]] -== Trade Terms -The conditions required to <> in a <>. - -=== Trade Amount -The <> of <> to be traded. - -> The trade amount is `0.1 BTC` (1,000,000 satoshis) - -=== Trade Price -The <> both <> have agreed to pay. - -> The trade price is `1,000.00 USD/BTC` - -=== Payment Amount -The <> multiplied by the <>. - -> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC) - -=== Payment Method -The means with which the <> will <>. - -> The payment method is `Cash Deposit`. - -See <>. - - == Trade Details === Trade Date From 782010dde88378199822436433315a630689a394 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 16:01:31 +0200 Subject: [PATCH 27/39] Refine Fundemantals --- glossary.adoc | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 03b6edf..4f2171e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -31,10 +31,12 @@ A peer-to-peer exchange network for Bitcoin. Aka _Bisq Network_. A peer-to-peer Bitcoin <> exchange network. Aka _Bisq Network_. A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. -//// + A peer-to-peer <> exchange network. Aka _Bisq Network_. +//// +A peer-to-peer <> exchange system. Aka _Bisq Network_. -> US dollars have been exchanged for bitcoin thousands of times using Bisq +> People regularly exchange US dollars for bitcoin using Bisq. === User A person who uses <>. @@ -91,15 +93,17 @@ A <> who performs <>. === Arbitration The service of working with <> and <> to resolve a <> +> Charlie has performed arbitration hundreds of times. + === Dispute A problem during a <>. -> The dispute was over the amount the buyer paid the seller +> The dispute is about the amount Alice paid Bob. === Dispute Ticket A request for <>. -> The seller opened a dispute ticket after receiving too little in payment from the buyer +> Bob opened a dispute ticket and explained to Charlie that he had received 10 dollars too few from Alice. [[terms, Terms]] From 464b3bff3c531cd57ca247dbdc0f9dff5d27bf8e Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 24 Jun 2018 16:01:46 +0200 Subject: [PATCH 28/39] Update Offer definition, move Maker and Taker down --- glossary.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 4f2171e..c554343 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -136,13 +136,7 @@ See <>. == Offers === Offer -An expression of intent to buy or sell <> with certain <>. - -=== Maker -A <> who creates an <>. - -=== Taker -A <> who accepts an <>. +A proposal to buy or sell <> under certain <>. === Bid An <> to buy <>. @@ -150,6 +144,12 @@ An <> to buy <>. === Ask An <> to sell <>. +=== Maker +A <> who creates an <>. + +=== Taker +A <> who accepts an <>. + == Markets From 98dac11d121a8300ab6620346528fe52a9852503 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 11:40:24 +0200 Subject: [PATCH 29/39] Refine Market definition and example --- glossary.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index c554343..6d1a868 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -154,9 +154,9 @@ A <> who accepts an <>. == Markets === Market -The trade between a certain <> and <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] +The trade between certain <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] -> The USD/BTC market is among the most active. +> Bisq's EUR/BTC market is the most active, followed by USD/BTC. === Market Price A moving average of <> in a given <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#price] Aka _Spot Price, Exchange Rate_. From dd49237d5da5abe792a04c1ed749a0a87a047dc1 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 11:45:46 +0200 Subject: [PATCH 30/39] Normalize punctuation Such that both definitions and examples always end in a period. --- glossary.adoc | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 6d1a868..f4bf53d 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -56,12 +56,12 @@ The <> of an <> expected in exchange for one <>. === bitcoin The <> of account on the <> network. Aka _BTC_. -> I sent 0.011 bitcoin to a family member today +> I sent 0.011 bitcoin to a family member today. === Bitcoin A peer-to-peer electronic cash system.footnote:[https://bitcoin.org/bitcoin.pdf] Aka _Bitcoin network_. -> I've been studying the way the Bitcoin protocol works +> I've been studying the way the Bitcoin protocol works. == Trading @@ -91,7 +91,7 @@ A <> who performs <>. > Charlie is the arbitrator. He is standing by in case of dispute. === Arbitration -The service of working with <> and <> to resolve a <> +The service of working with <> and <> to resolve a <>. > Charlie has performed arbitration hundreds of times. @@ -113,17 +113,17 @@ The conditions required to <>. === Trade Amount The <> of <> to be traded. -> The trade amount is `0.1 BTC` (1,000,000 satoshis) +> The trade amount is `0.1 BTC` (1,000,000 satoshis). === Trade Price The <> both <> have agreed to pay. -> The trade price is `1,000.00 USD/BTC` +> The trade price is `1,000.00 USD/BTC`. === Payment Amount The <> multiplied by the <>. -> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC) +> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC). === Payment Method The means with which the <> will <>. @@ -166,7 +166,7 @@ A moving average of <> in a given <>.footnote:[Adapted fr === Volume The <> of <> traded over a given time period. -> 24-hour volume was 4.23 BTC +> 24-hour volume was 4.23 BTC. === Depth The <> of <> available for to buy or sell in a <>. @@ -199,7 +199,7 @@ A visual representation of open <> in a given <>. === Trade Date The date an <> was taken. -> The trade date is `March 27th 2017 at 12:00 CET` +> The trade date is `March 27th 2017 at 12:00 CET`. == Payment Accounts @@ -378,12 +378,12 @@ A <> issued by a national authority. Aka _Fiat Currency, National Curr === Fixed Trade Price A <> whose value is assigned at <> creation time. -> This trade's price is fixed at 1,000 USD/BTC +> This trade's price is fixed at 1,000 USD/BTC. === Floating Trade Price A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. -> This trade's price is set to float at 2% above market price +> This trade's price is set to float at 2% above market price. === BSQ The <>-based colored coin used in Bisq funding and governance transactions. Aka _BSQ token_. From 68bcd62b4ae73999d0f84655df64cbaf0c5a8626 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 11:46:57 +0200 Subject: [PATCH 31/39] Add Maker and Taker examples --- glossary.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/glossary.adoc b/glossary.adoc index f4bf53d..9a4f48f 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -147,9 +147,13 @@ An <> to sell <>. === Maker A <> who creates an <>. +> Bob was the maker. It was his ask that Alice accepted. + === Taker A <> who accepts an <>. +> Alice was the taker. It was her first time using Bisq. + == Markets From 2d0bc5a7347dbb3a03c071e9fc39bca5b352507f Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 11:47:36 +0200 Subject: [PATCH 32/39] Refine Bisq example --- glossary.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glossary.adoc b/glossary.adoc index 9a4f48f..22ce99e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -36,7 +36,7 @@ A peer-to-peer <> exchange network. Aka _Bisq Network_. //// A peer-to-peer <> exchange system. Aka _Bisq Network_. -> People regularly exchange US dollars for bitcoin using Bisq. +> People use Bisq to exchange bitcoin with US dollars and other assets. === User A person who uses <>. From 6388feaabb4fdec4f540d8c4e1d43bb2be43bc71 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 12:22:20 +0200 Subject: [PATCH 33/39] Refine Settle definition and references I've been unable to find a single definition for Settle that works in all contexts without forcing awkward usage. It's a bit unfortunate to have to introduce the 'with object' variant here, but apparently necessary. --- glossary.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 22ce99e..f96ea01 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -70,10 +70,11 @@ A peer-to-peer electronic cash system.footnote:[https://bitcoin.org/bitcoin.pdf] An exchange of <> for another <>. === Trader -A <> who has agreed to <> in a <>. +A <> who has agreed to <> one side of a <>. === Settle -To complete payment. +To complete payment. + +_w. object:_ To complete payment for _object_. === Buyer The <> who will <> by sending their <> to the <>. @@ -108,7 +109,7 @@ A request for <>. [[terms, Terms]] == Trade Terms -The conditions required to <>. +The conditions required to <> both sides of a <>. === Trade Amount The <> of <> to be traded. From 207d1c4839bb43c32d8b2bf86e338d032ec0d7cb Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 12:50:14 +0200 Subject: [PATCH 34/39] Use [example] vs [quote] style in examples Previously, Markdown-style `> ` syntax was used to set off examples (a shortcut for Asciidoctor's `[quote]` style). This rendered poorly, however, with the quotes being too large and distracting from the definition. This change switches to the (aptly named) `[example]` style, which renders more appropriately. See https://asciidoctor.org/docs/user-manual/#style --- glossary.adoc | 81 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 54 insertions(+), 27 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index f96ea01..ecb5f4f 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -6,13 +6,15 @@ === Asset Property divisible into and transferrable as fungible <>. -> The US dollar and bitcoin are assets. +[example] +The US dollar and bitcoin are assets. [[units, Units]] === Unit The atomic transferable value of an <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#unit] -> The penny is the US dollar unit. The satoshi is the bitcoin unit. +[example] +The penny is the US dollar unit. The satoshi is the bitcoin unit. === Bisq //// @@ -36,7 +38,8 @@ A peer-to-peer <> exchange network. Aka _Bisq Network_. //// A peer-to-peer <> exchange system. Aka _Bisq Network_. -> People use Bisq to exchange bitcoin with US dollars and other assets. +[example] +People use Bisq to exchange bitcoin with US dollars and other assets. === User A person who uses <>. @@ -56,12 +59,14 @@ The <> of an <> expected in exchange for one <>. === bitcoin The <> of account on the <> network. Aka _BTC_. -> I sent 0.011 bitcoin to a family member today. +[example] +I sent 0.011 bitcoin to a family member today. === Bitcoin A peer-to-peer electronic cash system.footnote:[https://bitcoin.org/bitcoin.pdf] Aka _Bitcoin network_. -> I've been studying the way the Bitcoin protocol works. +[example] +I've been studying the way the Bitcoin protocol works. == Trading @@ -79,32 +84,38 @@ _w. object:_ To complete payment for _object_. === Buyer The <> who will <> by sending their <> to the <>. -> Alice is the buyer. She will send 3,000 US dollars to Bob as payment for 0.5 of his bitcoin. +[example] +Alice is the buyer. She will send 3,000 US dollars to Bob as payment for 0.5 of his bitcoin. === Seller The <> who will <> by sending their <> to the <>. -> Bob is the seller. He will send 0.5 of his bitcoin to Alice after receiving her payment. +[example] +Bob is the seller. He will send 0.5 of his bitcoin to Alice after receiving her payment. === Arbitrator A <> who performs <>. -> Charlie is the arbitrator. He is standing by in case of dispute. +[example] +Charlie is the arbitrator. He is standing by in case of dispute. === Arbitration The service of working with <> and <> to resolve a <>. -> Charlie has performed arbitration hundreds of times. +[example] +Charlie has performed arbitration hundreds of times. === Dispute A problem during a <>. -> The dispute is about the amount Alice paid Bob. +[example] +The dispute is about the amount Alice paid Bob. === Dispute Ticket A request for <>. -> Bob opened a dispute ticket and explained to Charlie that he had received 10 dollars too few from Alice. +[example] +Bob opened a dispute ticket and explained to Charlie that he had received 10 dollars too few from Alice. [[terms, Terms]] @@ -114,22 +125,26 @@ The conditions required to <> both sides of a <>. === Trade Amount The <> of <> to be traded. -> The trade amount is `0.1 BTC` (1,000,000 satoshis). +[example] +The trade amount is `0.1 BTC` (1,000,000 satoshis). === Trade Price The <> both <> have agreed to pay. -> The trade price is `1,000.00 USD/BTC`. +[example] +The trade price is `1,000.00 USD/BTC`. === Payment Amount The <> multiplied by the <>. -> The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC). +[example] +The payment amount is `100.00 USD` (0.1 BTC * 1,000.00 USD/BTC). === Payment Method The means with which the <> will <>. -> The payment method is `Cash Deposit`. +[example] +The payment method is `Cash Deposit`. See <>. @@ -148,12 +163,14 @@ An <> to sell <>. === Maker A <> who creates an <>. -> Bob was the maker. It was his ask that Alice accepted. +[example] +Bob was the maker. It was his ask that Alice accepted. === Taker A <> who accepts an <>. -> Alice was the taker. It was her first time using Bisq. +[example] +Alice was the taker. It was her first time using Bisq. == Markets @@ -161,27 +178,32 @@ A <> who accepts an <>. === Market The trade between certain <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#market] -> Bisq's EUR/BTC market is the most active, followed by USD/BTC. +[example] +Bisq's EUR/BTC market is the most active, followed by USD/BTC. === Market Price A moving average of <> in a given <>.footnote:[Adapted from https://github.com/libbitcoin/libbitcoin/wiki/Glossary#price] Aka _Spot Price, Exchange Rate_. -> The market price on March 27th 2017 at 12:00 CET was `1,000.00 USD/BTC` according to BitcoinAverage. +[example] +The market price on March 27th 2017 at 12:00 CET was `1,000.00 USD/BTC` according to BitcoinAverage. === Volume The <> of <> traded over a given time period. -> 24-hour volume was 4.23 BTC. +[example] +24-hour volume was 4.23 BTC. === Depth The <> of <> available for to buy or sell in a <>. -> The sell side of the USD/BTC market has a depth of 1.25 BTC. +[example] +The sell side of the USD/BTC market has a depth of 1.25 BTC. === Spread The percentage difference between the best (lowest-priced) <> and the best (highest-priced) <> divided by the <>. -> The spread in the USD/BTC market is 2% right now. +[example] +The spread in the USD/BTC market is 2% right now. [NOTE] .Example @@ -204,7 +226,8 @@ A visual representation of open <> in a given <>. === Trade Date The date an <> was taken. -> The trade date is `March 27th 2017 at 12:00 CET`. +[example] +The trade date is `March 27th 2017 at 12:00 CET`. == Payment Accounts @@ -242,7 +265,8 @@ The date an <> was taken. The <> of bitcoin each <> must place in <>. -> The buyer's security deposit was 0.01 BTC; the seller's was 0.003 BTC. +[example] +The buyer's security deposit was 0.01 BTC; the seller's was 0.003 BTC. === Per-Trade Limits @@ -383,17 +407,20 @@ A <> issued by a national authority. Aka _Fiat Currency, National Curr === Fixed Trade Price A <> whose value is assigned at <> creation time. -> This trade's price is fixed at 1,000 USD/BTC. +[example] +This trade's price is fixed at 1,000 USD/BTC. === Floating Trade Price A <> whose value is assigned at <> acceptance time by multiplying the <> by a `percent distance from market price` premium. -> This trade's price is set to float at 2% above market price. +[example] +This trade's price is set to float at 2% above market price. === BSQ The <>-based colored coin used in Bisq funding and governance transactions. Aka _BSQ token_. -> BSQ has five utilities: earning, trading, spending, voting and bonding. +[example] +BSQ has five utilities: earning, trading, spending, voting and bonding. === BSQ (system) The <> and consensus protocol that validate <> transactions. From a2bd85cb99b381c101e7cd943486d89fbfde2757 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 12:58:08 +0200 Subject: [PATCH 35/39] Remove 'See' references to docs not yet written --- glossary.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index ecb5f4f..3a3f91b 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -146,8 +146,6 @@ The means with which the <> will <>. [example] The payment method is `Cash Deposit`. -See <>. - == Offers @@ -317,7 +315,7 @@ The process of sending the <> from the <> to its == Network Components === Component -Software that performs a specific function. See <>. +Software that performs a specific function. === Critical component From 6356c47860260e53097e2204bfeba564d8daffa8 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 13:01:13 +0200 Subject: [PATCH 36/39] Remove draft Bisq definitions --- glossary.adoc | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/glossary.adoc b/glossary.adoc index 3a3f91b..dda7788 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -17,25 +17,6 @@ The atomic transferable value of an <>.footnote:[Adapted from https://git The penny is the US dollar unit. The satoshi is the bitcoin unit. === Bisq -//// -A peer-to-peer Bitcoin foreign exchange network. Aka _Bisq Network_. - -A peer-to-peer Bitcoin trading network. Aka _Bisq Network_. - -A peer-to-peer Bitcoin exchange network. Aka _Bisq Network_. - -A peer-to-peer bitcoin exchange network. Aka _Bisq Network_. - -A peer-to-peer Bitcoin asset exchange network. Aka _Bisq Network_. - -A peer-to-peer exchange network for Bitcoin. Aka _Bisq Network_. - -A peer-to-peer Bitcoin <> exchange network. Aka _Bisq Network_. - -A peer-to-peer <> exchange network for Bitcoin. Aka _Bisq Network_. - -A peer-to-peer <> exchange network. Aka _Bisq Network_. -//// A peer-to-peer <> exchange system. Aka _Bisq Network_. [example] From cf5f42793cee455019279abde67f752e38d555e9 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 19:17:22 +0200 Subject: [PATCH 37/39] Fix typo in Asset definition --- glossary.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glossary.adoc b/glossary.adoc index dda7788..a16b87e 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -4,7 +4,7 @@ == Fundamentals === Asset -Property divisible into and transferrable as fungible <>. +Property divisible into and transferable as fungible <>. [example] The US dollar and bitcoin are assets. From 7e8865f9b32f67938a156560f8faec18fa6968ac Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 26 Jun 2018 20:03:06 +0200 Subject: [PATCH 38/39] Customize [example] style in glossary docinfo Previously, [example] blocks rendered with a pale yellow that generally looks good, but is a bit too eye-catching for the purposes of this document. Asciidoctor's [sidebar] block style was closer to the mark, but the semantics of [example] are still desirable, as that's exactly what these blocks represent: example usages. So this change customizes [example] blocks to use the same background color as sidebar blocks, and only for this doc through the private docinfo mechanism [1]. It also customizes the coloration of `code` text, as the default coloration there is basically the same as the background, making the two wash out. [1]: https://asciidoctor.org/docs/user-manual/#docinfo-file --- glossary-docinfo.html | 8 ++++++++ glossary.adoc | 1 + 2 files changed, 9 insertions(+) create mode 100644 glossary-docinfo.html diff --git a/glossary-docinfo.html b/glossary-docinfo.html new file mode 100644 index 0000000..39c6fa5 --- /dev/null +++ b/glossary-docinfo.html @@ -0,0 +1,8 @@ + diff --git a/glossary.adoc b/glossary.adoc index a16b87e..e223f1c 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -1,4 +1,5 @@ = Bisq Glossary +:docinfo: private == Fundamentals From ba57889476e36794d2e245ca8ba9e2cd78b87897 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 27 Jun 2018 18:29:55 +0200 Subject: [PATCH 39/39] Add note to use Payment Method vs Trade Volume --- glossary.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/glossary.adoc b/glossary.adoc index e223f1c..3a5de93 100644 --- a/glossary.adoc +++ b/glossary.adoc @@ -436,3 +436,4 @@ The <> and consensus protocol that validate <> trans . Rework `Asset` hierarchy to include fiat - Use emoji flags for national currencies? - Repackage to `bisq.{=>core}.asset`? (would reflect that physical separation of repo is for practical purposes, would allow nat'l / fiat currency implementations to live in bisq-core. + . In Dispute Ticket `summary` e.g. when closing out a dispute ticket, and possibly elsewhere: Change `Trade volume` to <>.