bisq/README.md

52 lines
2.6 KiB
Markdown
Raw Normal View History

2014-04-11 15:01:44 +02:00
# bitsquare.io
2014-04-11 11:33:48 +02:00
Bitsquare is a P2P Fiat-BTC Exchange, extensible to a generic P2P trading platform (include commodities and
cryptocurrencies)
2014-05-19 19:54:29 +02:00
This is just a proof of concept prototype for demonstrating the basic workflow of the trader process.
It is not at all production code style (no tests, verifications missing, very limited use cases,...).
2014-04-11 11:33:48 +02:00
2014-04-11 15:01:44 +02:00
The project use Java 8 and Maven.
We use the bitcoinj library and TomP2P for DHT and messaging.
2014-04-11 15:01:44 +02:00
### Implemented (prototype level):
2014-05-19 19:54:29 +02:00
* Orderbook with filtering offers by amount, price, order type, trading account(buy, sell)
* Create offer
* Take offer
* Simple persistence
* bitcoinj integration
* Setup with account registration and tx with OP_RETURN + embedded and blinded bank account data
* Offer fee payment with a OP_RETURN tx and fees to miners
2014-05-07 13:32:05 +02:00
* Pay in to MS fund
2014-05-07 18:09:08 +02:00
* Payout from MS fund
2014-05-19 19:54:29 +02:00
* TomP2P as messaging lib integrated and basic use cases in msg screen implemented: orderbook, add order, remove order, peer interaction
* Payment process implemented with messaging for Offerer buy BTC case
* Hash of contract data embedded into tx (OP_RETURN)
2014-04-11 11:33:48 +02:00
2014-04-11 15:01:44 +02:00
### Next steps:
2014-05-19 19:54:29 +02:00
* Conceptual refinements
* Arbitrator integration concept
2014-05-07 13:32:05 +02:00
* Other trade variants (Buy BTC taker, Sell BTC offerer, Sell BTC offerer)
2014-05-19 19:54:29 +02:00
* Develop funding model
* Start development of production version
2014-04-11 11:33:48 +02:00
2014-04-11 15:01:44 +02:00
### Screenshots of basic screens:
2014-05-19 19:54:29 +02:00
* [Registration screen 1](https://github.com/bitsquare/bitsquare/tree/master/screenshots/registration_3.png)
* [Registration screen 2](https://github.com/bitsquare/bitsquare/tree/master/screenshots/registration_bank_account.png)
* [Orderbook screen 1](https://github.com/bitsquare/bitsquare/tree/master/screenshots/orderbook1.png)
* [Orderbook screen 2](https://github.com/bitsquare/bitsquare/tree/master/screenshots/orderbook2.png)
2014-05-19 19:54:29 +02:00
* [Create Offer screen](https://github.com/bitsquare/bitsquare/tree/master/screenshots/create_offer_2.png)
* [Take offer screen](https://github.com/bitsquare/bitsquare/tree/master/screenshots/take_offer.png)
* [Deposit tx screen](https://github.com/bitsquare/bitsquare/tree/master/screenshots/deposit_conf.png)
* [Check bank tx screen](https://github.com/bitsquare/bitsquare/tree/master/screenshots/bank_tx_inited.png)
* [Trade completed screen](https://github.com/bitsquare/bitsquare/tree/master/screenshots/trade_complete.png)
* [More screenshots](https://github.com/bitsquare/bitsquare/tree/master/screenshots)
2014-04-11 11:33:48 +02:00
2014-04-11 15:04:02 +02:00
2014-04-11 15:01:44 +02:00
### Links:
* Web: http://bitsquare.io
* Whitepaper: https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit?pli=1
* Overview: http://bitsquare.io/images/overview.png
* Discussion: https://bitcointalk.org/index.php?topic=462236