-
Notifications
You must be signed in to change notification settings - Fork 88
Produce a 'getting started' guide #45
Changes from 15 commits
378238b
a35bceb
0649f69
65005de
72cabda
d832e82
ed2dd1c
611d09b
385a393
762aa99
467165b
8fb4850
70dc405
d5fc8c9
8913f64
86ab2c2
9cfe385
9f55ef1
831dcec
4b3cc87
f74ae3d
aab1a7c
fbf5cae
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,239 @@ | ||
= Getting Started with Bisq | ||
:toc: left | ||
:sectanchors: | ||
:imagesdir: images | ||
:!figure-caption: | ||
:btc-deposit: 0.01 | ||
:btc-deposit-plus-fees: 0.011 | ||
|
||
COMING SOON. Subscribe to https://github.com/bisq-network/bisq-docs/issues/37[bisq-network/bisq-docs#37] for updates. | ||
Bisq is built on some https://bisq.network/philosophy/[serious principles^] and some https://github.com/bisq-network[seriously impressive code^], but it's surprisingly approachable. This guide will help you get up & running quickly. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
In this guide, we're going to assume you want to buy bitcoin in exchange for a national currency, since that's how most people get started with Bisq. Specifically, we'll walk through the steps to buy bitcoin with US dollars, using a popular payment method called _Zelle_. Keep in mind, though, that Bisq offers support for trading all national currencies and dozens of different cryptocurrencies and tokens—the only constraint is that one side of each Bisq trade must always be bitcoin. | ||
|
||
== Download & install | ||
|
||
To run Bisq, download and install it from https://bisq.network/downloads/[the Bisq downloads page^]. _Optional:_ before installing, verify the signatures of the downloaded file (https://www.torproject.org/docs/verifying-signatures.html.en[instructions here^]) to be sure the file you downloaded is genuine. | ||
|
||
[NOTE] | ||
.Why do I need to download software? Why can't I just trade on your website? | ||
==== | ||
Unlike most exchanges, Bisq doesn't a centralized server for making and taking offers, so trading on a website isn't possible. | ||
|
||
Instead, Bisq manages offers to trade using a peer-to-peer network—a global network of people who are also running Bisq on their own computers. | ||
|
||
This is good news for users, because centralized services are easy to monitor, block and shut down, while peer-to-peer networks like BitTorrent, Bitcoin and Bisq are difficult to surveil, censor and hack. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added this line in 8913f64. Feedback welcome. Seems like a good opportunity to drive home why Bisq does things this way, why it's valuable to go through the "extra work" of not being able to just trade on a website. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Initially this seemed to make the admonition a bit longer than I'd prefer, but considering it makes perhaps the most important point on the page, I think it's worth it. Great addition. |
||
|
||
This means that if you want to use the Bisq Network, you've got to download and run the software too! | ||
==== | ||
|
||
Once the installer is finished, go ahead and open Bisq. It'll take a few moments to open as it connects to Tor and syncs up with Bisq's peer-to-peer trading network. | ||
|
||
When that's done, feel free to have a look around. You can browse existing offers to buy and sell bitcoin. The first screen you see should look something like this: | ||
|
||
_**TODO**: SCREENSHOT, possibly with boxes and arrows pointing to offers to buy vs offers to sell, to help the reader understand the offer book they're looking at._ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
== Configure a national currency account | ||
|
||
Since we're looking to buy bitcoin, let's take a look at the `Buy BTC` screen. You should see a list of offers, but you'll notice all the orange `Take offer` buttons are disabled: | ||
|
||
.Before configuring a payment account: all offers are disabled. | ||
image::before-adding-fiat-account.png[Offers disabled before configuring national currency account] | ||
|
||
That's because we haven't yet configured a way to pay for the bitcoin we want to buy. So let's set up a payment method. Bisq works with many different payment methods, so you can choose those you already have access to and are most comfortable using. Keep in mind that payment methods determine: | ||
|
||
* which offers you can take right now (e.g., in the image above, Zelle has many existing offers, so if we set up Zelle, we could immediately take any of those offers) | ||
* how quickly a trade can be completed (e.g., a bank transfer will go through quicker than a money order sent by mail; see https://bisq.network/faq/#5[details here^]) | ||
|
||
[NOTE] | ||
.What if there are no existing offers for the payment method I want to use? | ||
==== | ||
If you don't see any offers for the payment method you want to use, consider checking back later. A Bisq offer is only available while the user making the offer is online and running Bisq, so you'll see offers come and go as Bisq users around the world go online and offline throughout the day. | ||
|
||
You can also easily create your own buy offer with the `Create new offer to buy BTC with USD` button at bottom-right, but we won't go into those details here. | ||
==== | ||
|
||
[NOTE] | ||
.Where is my payment account data stored? | ||
==== | ||
On your computer *only* (i.e., the computer on which Bisq is installed). Only your trading partner (and your arbitrator, if there's a dispute) will ever see your payment details. | ||
==== | ||
|
||
In this tutorial, we're going to configure a Zelle account. You can adapt the instructions that follow to any payment method you choose. | ||
|
||
Go to the `Account` screen and click `Add new account`. Select `Zelle` from the dropdown and enter your details. | ||
|
||
You'll need to enter *your full name* as registered with your Zelle account as well as the *email address or mobile phone number* linked to your Zelle account. | ||
|
||
.Configuring a Zelle account. | ||
image::configure-fiat-account.png[Configuring a national currency account] | ||
|
||
You don't need to edit the `Salt` field. You can keep the `Account name` unchanged or change it however you like: this is an internal label that only you will ever see, so there's no right or wrong value for it. | ||
|
||
IMPORTANT: It's *crucial* the information you enter here is correct. Your trading partner can only acknowledge your payment if it's from the account detailed here. Once you've created an account, you cannot edit its information (if you need to make a change, you'll have to delete and add the account again). | ||
|
||
Once you're done, hit the `Save new account` button and go back to the `Buy BTC` screen. Offers requiring the payment method you just configured should now be enabled: | ||
|
||
.After configuring a payment account: we picked Zelle, so Zelle offers are now enabled. | ||
image::after-adding-fiat-account.png[Configuring a national currency account] | ||
|
||
== Fund your Bisq wallet | ||
|
||
There's just one more thing to do before we can trade with Bisq: we need to send enough bitcoin to our Bisq wallet to cover a security deposit as well as trading and mining fees. | ||
|
||
To prevent fraud, Bisq requires both buyers and sellers to post a security deposit in bitcoin for every trade. On the buyer's side, this amount is usually {btc-deposit} BTC, plus with a trading fee and mining fees for the Bitcoin transactions involved in each trade. | ||
|
||
As of this writing, that means you'll need {btc-deposit-plus-fees} BTC. | ||
|
||
If you don't already own this much bitcoin, you'll need to obtain it. How? You've got options. Friends and family are often the best option—simply buy a small amount of bitcoin directly and in person from someone you trust. Otherwise, you can try a local bitcoin ATM (many don't require ID for small transactions), vouchers, or bitcoin meetups/events. | ||
|
||
[WARNING] | ||
.How about getting bitcoin through a centralized exchange like Coinbase? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rex4539 and @m52go, I changed this back from 'platform' to 'exchange', and you'll see in the paragraph below I use the phrase "platforms and exchanges". I agree with your point @rex4539 that Coinbase is not technically an exchange, but most readers are going to be most familiar with the phrase "centralized (bitcoin) exchange", and I think invoking that here is good from a purely pragmatic perspective. |
||
==== | ||
Most centralized platforms and exchanges (like Coinbase, Binance, Kraken, etc) track your personal information, putting you at risk by tying your identity to the bitcoin you buy and sell there. And because Bitcoin transactions are public and easily traceable, this means that potentially _all_ of your future transactions involving those bitcoin can be traced back to you. | ||
|
||
Bisq is built from the ground up to avoid this privacy fiasco, so we strongly recommend avoiding centralized exchanges and to get your first bitcoin through one of the other channels mentioned above. | ||
==== | ||
|
||
Once you've gotten enough bitcoin for your security deposit and fees, you can move it into Bisq's built-in wallet. This isn't strictly required, but it'll make trading more convenient since the security deposit & fees you need to accept an offer will be readily available when making or taking an offer. | ||
|
||
IMPORTANT: Make sure to password-protect your Bisq client and to write down the _seed words_ for your Bisq wallet. Seed words will allow you to recover the funds in your wallet in case of disaster. You'll find them in the `Wallet seed` section of the `Account` screen. Don't worry, we'll remind you about this again at the end of this tutorial so you don't forget. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See the TODO at bottom about this. |
||
|
||
To send bitcoin to your Bisq wallet, go to the `Funds` screen and click the `Receive` tab. Send your 0.011 BTC to one of the addresses listed there. | ||
|
||
.You can send your security deposit to an address listed here (yours will be different from the one in this image). | ||
image::fund-bisq-wallet.png[Fund your Bisq wallet] | ||
|
||
If you'd rather not hold any bitcoin in your Bisq wallet, that's fine, but you'll need to transfer your security deposit & fees manually when you take an offer (more on this below). | ||
|
||
== Take an offer | ||
|
||
:figure-caption: Figure | ||
|
||
Now that we've gotten setup out of the way, let's trade! | ||
|
||
=== 1. Select an offer | ||
|
||
[.float-group] | ||
-- | ||
[.right.text-center] | ||
.Select an offer you like. | ||
image::select-an-offer.png[Select an offer,400,400] | ||
|
||
Back in the `Buy BTC` screen, click the orange `Take Offer` button for the offer you'd like to take. | ||
|
||
-- | ||
|
||
=== 2. Send deposit to trade wallet | ||
|
||
[.float-group] | ||
-- | ||
[.right.text-center] | ||
.Send this much bitcoin to this address. | ||
image::deposit-details.png[Deposit details,400,400] | ||
|
||
When taking an offer, Bisq creates a special trade wallet to hold your security deposit and fees. This wallet will be used to pay your _taker fee transaction,_ and will then be used to transfer your security deposit into a _multisig escrow transaction_ together with the seller's security deposit and the bitcoin being traded. | ||
|
||
Your security deposit will be returned to you and you'll receive the bitcoin being traded once both you and the seller have completed your ends of the deal. | ||
|
||
Bisq will tell you the address of the trade wallet and exactly how much to send it. | ||
|
||
* If you already have enough bitcoin in your Bisq wallet, click `Transfer funds from Bisq wallet` and the funds will automatically transfer to the trade wallet. | ||
* If not, go ahead and send the amount required (`Funds needed`) to the specified address (`Trade wallet address`). See Figure 2. | ||
-- | ||
|
||
[NOTE] | ||
.A multisig escrow transaction? How does that work? | ||
==== | ||
Bisq never takes custody of users' bitcoin or national currency funds—indeed there is no way it could, because Bisq is just software, not a company. The "escrow transaction" mentioned above is a _smart contract_—specifically a 2-of-3 multisignature Bitcoin transaction involving you, the seller, and a https://bisq.network/faq/#8[bonded arbitrator^]. More details are https://bisq.network/faq/#18[here^] and you can read more about multisig wallets https://en.bitcoin.it/wiki/Multisignature[here^]. | ||
==== | ||
|
||
=== 3. Confirm trade | ||
|
||
Once you've funded your trade wallet, you'll see a `Review: Take offer to buy bitcoin` button appear. | ||
|
||
Click it, and Bisq will then show you all the details of the offer you're about to take. | ||
|
||
.Look over these details carefully. | ||
image::confirm-deal.png[Confirm deal details] | ||
|
||
*Make sure these details are correct.* After you confirm these details, there's no backing out—you must follow through (or risk losing your deposit). | ||
|
||
If it all looks good, go ahead and hit `Confirm: Take offer to buy bitcoin`. | ||
|
||
Your trade has now officially begun! | ||
|
||
=== 4. Send payment | ||
|
||
[.float-group] | ||
-- | ||
|
||
[.right.text-center] | ||
.Payment details pop-up. | ||
image::seller-payment-details.png[Seller payment details,400,400] | ||
|
||
Now that you've taken an offer, it's almost time to pay the seller. | ||
|
||
First, before showing you the seller's payment details, Bisq will wait for the Bitcoin network to confirm the trade's transactions. On average, this takes 10 minutes. | ||
|
||
Then, you'll see a pop-up with the seller's details. Go ahead and pay the seller through the agreed payment method. | ||
|
||
[NOTE] | ||
.Confirmations? | ||
==== | ||
Each confirmation makes a bitcoin transaction exponentially harder to reverse. You can wait for as many confirmations as you like before sending payment—just note the remaining time indicator. The seller must _receive_ your payment before that timer runs out. | ||
|
||
.Make sure the seller receives your payment before this timer runs out. | ||
image::remaining-time-to-pay.png[Send payment quickly] | ||
|
||
Learn more about confirmations https://en.bitcoin.it/wiki/Confirmation[here^]. | ||
==== | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The friends and family bit is great here. Bitcoin ATMs and meetups, vouchers are good too. I think I'd drop the "Satoshi Square" bit, as this is basically a historical footnote now. I'd drop LB as they're now more aggressively forcing KYC. And I'd drop the airdrop because it's unlikely to be a helpful route for most readers. Basically, I'd really promote the family and friends approach. Emphasize how Bisq is peer-to-peer all the way down. You don't have to say a lot to this effect, but rather just make it the most prominent option. I'd drop or rework the bit about centralized exchanges. The "if you're interested in Bisq, chances are..." bit is pretty cryptic for the uninitiated. If anything, I would move that chunk to a [WARNING] section below the [NOTE] section and expressly warn people NOT to use centralized exchanges to purchase their first bitcoin, and to explain that the reason for this is that most centralized exchanges track your personal information and therefore put you at risk by tying your identity to your bitcoin. Your call, you can just drop it, and this might be too much to try to pull off in a quick sidebar, but it would be valuable if we can get a concise warning to this effect out there. |
||
|
||
-- | ||
|
||
=== 5. Mark payment as sent | ||
|
||
[.float-group] | ||
-- | ||
|
||
[.right.text-center] | ||
.Mark payment as sent. | ||
image::mark-payment-sent.png[Mark payment as sent,400,400] | ||
|
||
Once you've sent your payment, be sure to mark the payment as sent in Bisq by clicking the `Payment started` button. | ||
|
||
It's easy to forget this step, but remember: Bisq doesn't integrate with national currency payment methods in any way—so Bisq won't know you've sent your payment until you say so. | ||
|
||
When you click `Payment started`, the seller will receive a notification that lets them know the payment is on the way. They'll be on the lookout for it now. | ||
|
||
-- | ||
|
||
=== 6. Complete trade | ||
|
||
[.float-group] | ||
-- | ||
|
||
[.right.text-center] | ||
.Trade complete. | ||
image::complete-trade.png[Complete trade,400,400] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Image is missing. |
||
|
||
When the seller receives your payment, they'll mark it as received in Bisq. Bisq will then complete the trade by releasing the bitcoin being traded to you along with your security deposit. | ||
|
||
You can keep your new bitcoin in your built-in Bisq wallet by clicking `Move Funds to Bisq Wallet` or send it elsewhere by clicking `Withdraw to External Wallet`. | ||
|
||
-- | ||
|
||
Congratulations. You've just completed your first trade on Bisq! | ||
|
||
== Next steps | ||
|
||
_**TODO**: Remind the user to password-protect their Bisq client and to secure their seed words._ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
== Get help | ||
|
||
If you get stuck, reach out! There's a community of people to help you on the https://bisq.community/[Bisq forum^], the https://www.reddit.com/r/bisq/[/r/bisq subreddit^], and the https://bisq.network/slack-invite[Bisq Slack team^]. | ||
|
||
== Stay in touch | ||
|
||
If Bitcoin's motto is "be your own bank" then Bisq's motto is "be your own exchange." It's an exciting concept, it's growing fast, and it's something you'll want to follow. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agree, same basic tone comments as above. This strays from the mark of helping a fellow (perhaps newly born) cypherpunk find their way through the software, to something more didactic, even slightly condescending (though I'm sure you did not mean for it to land that way). It's definitely good that we point users at the best ways to stay in touch, and even good that we let them know that Bisq is still growing. The motto stuff was a bit of an experiment in the Phase Zero doc. I still generally like it, and there might be a place for it in this doc, but I think it's slightly out of place here in the |
||
|
||
Get Bisq updates on https://twitter.com/bisq_network[Twitter^], https://www.facebook.com/bisqnetwork/[Facebook^], and https://www.youtube.com/c/bisq-network[YouTube^]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seriously impressive code
is very tongue-in-cheek.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is. Readers are free to agree or disagree, but the bigger point here is that they can make up their own mind...i.e., click the link, check out the code, and decide for themselves (i.e., edgy way to convey this is an open-source project).
Ultimately it's about tone. If folks would prefer tone to go in a different direction, it's a discussion we should have.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that "seriously impressive code" is a bit off, tone-wise. This is something that others can say, but that I'd prefer we do not say in our own official documentation. I like what you're attempting to do in this paragraph, getting the reader excited about the principles and technical foundation, while letting them know that "using Bisq won't hurt" but I'd say take another swing at it. It may not be necessary at all to assume that the reader needs Bisq to be "surprisingly approachable", really. You've done a good job in the doc of detailing what matters and leaving out what doesn't. For example, you just tell the reader to go to the downloads page, get the app and install it. You don't do screenshots there, etc, and treat them like children. Anyone who's going to use Bisq should know perfectly well how to handle that kind of stuff; explaining it would be tone-deaf at best, an insult at worst. So I'd say keep striking that tone: one in which you assume the reader is woke AF about Bitcoin, but possibly still a bit new to the space, and wants to get off to a strong start buying and hodling. They've heard about Bisq, gotten that it's the way to go, and are reading this now here to get the straight no-fluff from us on how to use it. Doesn't mean the doc can't also be friendly and a pleasure to read. It's both of those and should stay that way.