Bitcoin Wiki - User contributions [en]

Prime API

2014-02-07T22:37:14Z

Qertoip:

==Introduction==

Prime API is based on JSON, delivered through HTTPS and is mostly REST-ful.

API URIs always start with a marker "/v1" to make the version explicit.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

==Public API==

Public API calls are available without authentication.

==Private API==

Private API calls require authentication via:
* Your personal API key and optionally
* IP address

Private API is '''off by default'''. You need to enable it in your profile.

You are expected to '''pass the API key as a HTTP header''':
Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe
...where the long string is of course your API key.

It is also possible to pass the API key as a request param:
?api_key=84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe
...although this is not recommended as sensitive data should not be passed in the URI.

===Get my deposit address===

GET /v1/prv/deposit_address/:currency_name.json
* '''currency_name''' - obligatory cryptocurrency name, i.e BTC, LTC

Example:
<source lang="bash">
curl -v --request GET http://localhost:3000/v1/prv/deposit_address/BTC.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe"
</source>

Response:
200 OK
<source lang="javascript">
{"address":"n2Ccn5em9gcQyBe2QvZnfzzXq8EZh1ncJj"}
</source>

Error response:
422 Unprocessable Entity
<source lang="javascript">
{"errors":{"currency_name":"is invalid"}}
</source>

===Get balances and user data===

GET /v1/prv/user.json

Example:
<source lang="bash">
curl -i --request GET http://localhost:3000/v1/prv/user.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe"
</source>

Response:
200 OK
<source lang="javascript">
{
"user": {
"username": "adalovelace",
"email": "adalovelace@bitcoinfoundation.org",
"balances": [
{
"available": "0.199",
"total": "0.199",
"currency_name": "BTC"
},
{
"available": "0.0",
"total": "0.0",
"currency_name": "PLN"
},
{
"available": "7.11",
"total": "7.11",
"currency_name": "LTC"
}
]
}
}
</source>
* '''available''' - the amount you can manage, i.e. to place a new offer
* '''total''' - the amount including funds reserved for offers, withdrawals, etc.

===Create a withdrawal request (of cryptocurrency)===

POST /v1/prv/withdrawal_request.json
* '''currency_name''' - obligatory name of the currency like BTC, LTC, PLN
* '''address''' - obligatory only for cryptocurrencies
* '''amount''' - obligatory
* '''otp''' - obligatory when user has set up a Google Authenticator One-Time-Passwords for withdrawals

Example:
<source lang="bash">
curl -i --request POST http://localhost:3000/v1/prv/withdrawal_requests.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRM6sLRdM" \
--data "currency_name=BTC&address=mm2SjeJ64vQokDjnkhvhcv9mGk1VfEJRsk&amount=0.03"
</source>

Response:
201 Created

Error response (missing or invalid OTP):
401 Unauthorized
<source lang="javascript">
{
"errors": {
"otp": "is invalid"
}
}
</source>

Error response (invalid params):
422 Unprocessable Entity
<source lang="javascript">
{
"errors": {
"currency_name": "is invalid",
"address": "is_invalid",
"amount": "is invalid"
}
}
</source>

==References==
<References />

Prime API

2014-02-07T21:58:46Z

Qertoip:

Prime API

2014-02-07T21:39:12Z

Qertoip:

Prime API

2014-02-07T21:36:08Z

Qertoip:

Prime API is based on JSON, delivered through HTTPS and is mostly REST-ful.

API URIs always start with a marker "/v1" to make the version explicit.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

==Public API==

Public API calls are available without authentication.

==Private API==

Private API calls require authentication via:
* Your personal API key and optionally
* IP address

Private API is '''off by default'''. You need to enable it in your profile.

===Get my deposit address===

GET /v1/prv/deposit_address/:currency_name.json

Example:
<source lang="bash">
curl -v --request GET http://localhost:3000/v1/prv/deposit_address/BTC.json --header "Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe"
</source>

Response:
<source lang="javascript">
{"address":"n2Ccn5em9gcQyBe2QvZnfzzXq8EZh1ncJj"}
</source>

Error response:
<source lang="javascript">
{"errors":{"currency_name":"is invalid"}}
</source>

Prime API

2014-02-07T21:20:03Z

Qertoip: /* Get my deposit address */

Prime API is based on JSON, delivered through HTTPS and is mostly REST-ful.

==Public API==

Public API calls are available without authentication.

==Private API==

Private API calls require authentication via:
* Your personal API key and optionally
* IP address

Private API is '''off by default'''. You need to enable it in your profile.

===Get my deposit address===

GET /v1/private/deposit_address/:currency_name.json

<source lang="bash">
curl -v --request GET http://localhost:3000/v1/private/deposit_address/BTC.json --header 'Authorization: PrimeExchange 84ffsOscok1Asbbqj28gcscv86M3nj4bRIamFaKe'
</source>

{"address":"n2Ccn5em9gcQyBe2QvZnfzzXq8EZh1ncJj"}

Prime API

2014-02-07T19:29:07Z

Qertoip: /* Private API */

Prime API

2014-02-07T18:24:47Z

Qertoip:

Prime API

2014-02-07T18:24:07Z

Qertoip: Created page with "Prime API is based on JSON, delivered through HTTPS and is mostly REST-ful. ==Public API== Public API calls are available without authentication. ==Private API== Private A..."

Prime

2014-02-07T17:57:02Z

Qertoip:

Commercially licensed high-end bitcoin exchange '''software'''.

==Advantages==

Prime claims to be developed with [http://en.wikipedia.org/wiki/Software_craftsmanship software craftsmanship] in mind. It strives for correctness, security, simplicity and source code beauty. No rush and careful engineering are considered more important than rich feature set and "time-to-market".

==Estimated Time of Arrival==

Prime is expected to be ready for purchase by the end of 2014.

==API==

[[Prime API|Prime API]] is a work in progress.

==Specification==

[[Prime Specification|Prime specification draft]] is a work in progress.

==History==

Development started on April 17, 2013.

==See Also==

* [[Buying bitcoins]]
* [[Selling bitcoins]]

==External Links==

==References==
<References />

[[Category:Exchanges]]
[[Category:EWallets]]

Prime

2013-12-15T13:40:38Z

Qertoip: /* Estimated Time of Arrival */

Commercially licensed high-end bitcoin exchange '''software'''.

==Advantages==

Prime claims to be developed with [http://en.wikipedia.org/wiki/Software_craftsmanship software craftsmanship] in mind. It strives for correctness, security, simplicity and source code beauty. No rush and careful engineering are considered more important than rich feature set and "time-to-market".

==Estimated Time of Arrival==

Prime is expected to be ready for purchase by the end of 2014.

==Specification==

[[Prime Specification|Prime specification draft]] is a work in progress.

==History==

Development started on April 17, 2013.

==See Also==

* [[Buying bitcoins]]
* [[Selling bitcoins]]

==External Links==

==References==
<References />

[[Category:Exchanges]]
[[Category:EWallets]]

Prime Specification

2013-04-20T22:35:44Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Withdrawal requests====
=====Pending=====
* Total fiat funds pending for withdrawal
* FIFO list of pending fiat withdrawals
** time waiting, name, address, IBAN, amount, [insert bank withdrawal transaction id here] and click [MARK AS FULFILLED] button, [CANCEL] button

=====Other=====
* list of fulfilled and cancelled withdrawals, by date of fulfillment
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====Hot wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Requirements===
* commandline tools: pg_dump, openssl (to use built-in db backups)

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T17:06:39Z

Qertoip: /* How wallets */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Withdrawal requests====
=====Pending=====
* Total fiat funds pending for withdrawal
* FIFO list of pending fiat withdrawals
** time waiting, name, address, IBAN, amount, [insert bank withdrawal transaction id here] and click [MARK AS FULFILLED] button, [CANCEL] button

=====Other=====
* list of fulfilled and cancelled withdrawals, by date of fulfillment
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====Hot wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T14:32:51Z

Qertoip: /* Pending */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Withdrawal requests====
=====Pending=====
* Total fiat funds pending for withdrawal
* FIFO list of pending fiat withdrawals
** time waiting, name, address, IBAN, amount, [insert bank withdrawal transaction id here] and click [MARK AS FULFILLED] button, [CANCEL] button

=====Other=====
* list of fulfilled and cancelled withdrawals, by date of fulfillment
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T14:27:24Z

Qertoip: /* Pending */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Withdrawal requests====
=====Pending=====
* FIFO list of pending withdrawals
** time waiting, name, address, IBAN, amount, [insert bank withdrawal transaction id here] and click [MARK AS FULFILLED] button, [CANCEL] button

=====Other=====
* list of fulfilled and cancelled withdrawals, by date of fulfillment
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T14:26:57Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Withdrawal requests====
=====Pending=====
* FIFO list of pending withdrawals, FIFO
** time waiting, name, address, IBAN, amount, [insert bank withdrawal transaction id here] and click [MARK AS FULFILLED] button, [CANCEL] button
=====Other=====
* list of fulfilled and cancelled withdrawals, by date of fulfillment
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T14:03:26Z

Qertoip: /* Financial */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial & Fees====
* Stats
** Total funds on the exchange
*** Total funds accumulated on the exchange for each fiat (calculated from a database)
*** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
** Number of buy and sell orders
** Number and volume of transactions
* Fee settings

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:51:58Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera
There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:50:02Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Disallow small value orders, see [[Prime Specification|Performance]] settings in admin panel
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for a signed-in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into a database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute. This isn't 100% accurate but this is acceptable.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:32:01Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Disallow small value orders (see [[Prime Specification|Performance]] Settings in Admin panel)
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for signed in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:31:04Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Disallow small value orders (see [[Prime_Specification|Performance]] Settings in Admin panel)
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for signed in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:30:37Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Disallow small value orders (see [[Performance]] Settings in Admin panel)
** Prevents order and transaction spam. Spammed order book is slow to match. Spammed transaction history can become to large to handle.
* Limit requests per minute for signed in user
** Further requests will be rejected with [http://tools.ietf.org/html/rfc6585#section-4 429 Too Many Requests]
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:18:44Z

Qertoip: /* Security */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to lose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Limit requests per minute for signed in user
** Further requests will be rejected
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:16:35Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Min. order value denominated in primary currency for each market (i.e. denominated in USD for USD/BTC market)
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Limit requests per minute for signed in user
** Further requests will be rejected
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:13:38Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)
* Settings
** Limit of requests per minute for signed-in user

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Limit requests per minute for signed in user
** Further requests will be rejected
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:10:49Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Limit requests per minute for signed in user
** Further requests will be rejected
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T13:10:01Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes

===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

===Performance===
* Allowed requests per minute for signed in user
** Further requests will be rejected
** Does not insert logs into database. Works buy incrementing user request_counter in scope of minute stored in request_counter_at. When current minute is larger than request_counter_at, it zeroes out request_counter and sets request_counter_at to the current minute.

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:11:32Z

Qertoip: /* Settings */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature, TODO: is it viable? what about left funds and common history?)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:10:30Z

Qertoip: /* User */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whatever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:09:12Z

Qertoip: /* Performance */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Hot
** Number of users online
** Number of transactions in last minute
** Job queue length
** Pending fiat withdrawals (number, volume and the longest waiting)
* Historical
** Number of transactions per hour chart (TODO: necessary in v1.0?)

====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:04:30Z

Qertoip: /* How wallets */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
* Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency

====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:04:10Z

Qertoip: /* Financial */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell orders
* Number and volume of transactions

====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:03:57Z

Qertoip: /* Users */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell offers
* Number and volume of transactions
====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open orders
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:03:36Z

Qertoip: /* Users */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell offers
* Number and volume of transactions
====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, sing-up date, sing-up IP, last sign-in date, last sign-in IP, number of sign-ins, number of open offers
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:01:47Z

Qertoip: /* Users */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell offers
* Number and volume of transactions
====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** one user per line, fields:
*** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, singed up at, singed up with IP, last sign in at, last signed in with IP, number of sign ins, number of open offers
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:01:17Z

Qertoip: /* Users */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell offers
* Number and volume of transactions
====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat (Excel, Calc, etc.)
** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, singed up at, singed up with IP, last sign in at, last signed in with IP, number of sign ins, number of open offers
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate

====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T12:00:39Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Dashboard====
* To be decided what goes on a dashboard
====Financial====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Number of buy and sell offers
* Number and volume of transactions
====How wallets====
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
====Users====
* Total number of registered users
* Export emails.csv (i.e. for mass mailing via external software)
* Generate comprehensive report users.csv
** designed to be open in a spreadsheat software (Excel, Calc, etc.)
** e-mail '''hash''', total balance BTC, total balance USD, ..., paid fees, number of transactions, transaction volume, singed up at, singed up with IP, last sign in at, last signed in with IP, number of sign ins, number of open offers
* Search user by e-mail, username, name, or e-mail hash (to look up users from the report)
** View user details
** Deactivate / Activate
** Impersonate
====Performance====
* Number of users being online
* Number of transactions per hour
* Job queue length
====Security====
* Shutdown the service
* Rollback to the point in time (TODO: define details)
** "Rollback wreaks havoc, causes some users and exchange to loose money and can be illegal in your jurisdiction. Rollback is irreversible. Rollback is a bad idea 99.999% of the time. Proceed only if you fully understand the consequences!!!"
** Rollback should not be available through the web app, only as a command line tool

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime

2013-04-20T09:36:19Z

Qertoip:

Commercially licensed high-end bitcoin exchange '''software'''.

==Advantages==

Prime claims to be developed with [http://en.wikipedia.org/wiki/Software_craftsmanship software craftsmanship] in mind. It strives for correctness, security, simplicity and source code beauty. No rush and careful engineering are considered more important than rich feature set and "time-to-market".

==Estimated Time of Arrival==

Prime is expected to be ready for purchase by the end of 2013.

==Specification==

[[Prime Specification|Prime specification draft]] is a work in progress.

==History==

Development started on April 17, 2013.

==See Also==

* [[Buying bitcoins]]
* [[Selling bitcoins]]

==External Links==

==References==
<References />

[[Category:Exchanges]]
[[Category:EWallets]]

Prime

2013-04-20T09:34:33Z

Qertoip:

Commercially licensed high-end bitcoin exchange '''software'''.

==Advantages==

Prime claims to be developed with [http://manifesto.softwarecraftsmanship.org software craftsmanship] in mind. It strives for correctness, security, simplicity and source code beauty. No rush and careful engineering are considered more important than rich feature set and "time-to-market".

==Estimated Time of Arrival==

Prime is expected to be ready for purchase by the end of 2013.

==Specification==

[[Prime Specification|Prime specification draft]] is a work in progress.

==History==

Development started on April 17, 2013.

==See Also==

* [[Buying bitcoins]]
* [[Selling bitcoins]]

==External Links==

==References==
<References />

[[Category:Exchanges]]
[[Category:EWallets]]

Prime

2013-04-20T09:31:01Z

Qertoip: /* Advantages */

Licensed high-end bitcoin exchange software.

==Advantages==

Prime claims to be developed with [http://manifesto.softwarecraftsmanship.org software craftsmanship] in mind. It strives for correctness, security, simplicity and source code beauty. No rush and careful engineering are considered more important than rich feature set and "time-to-market".

==Estimated Time of Arrival==

Prime is expected to be ready for purchase by the end of 2013.

==Specification==

[[Prime Specification|Prime specification draft]] is a work in progress.

==History==

Development started on April 17, 2013.

==See Also==

* [[Buying bitcoins]]
* [[Selling bitcoins]]

==External Links==

==References==
<References />

[[Category:Exchanges]]
[[Category:EWallets]]

Prime Specification

2013-04-20T09:29:26Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T09:29:08Z

Qertoip: /* Limitation of v1.0 */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration with bitcoin only.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T09:28:47Z

Qertoip: /* Limitation of v1.0 */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* While Prime is designed from ground up to support multiple cryptocurrencies, the first version will deliver integration only with bitcoin.
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T09:26:16Z

Qertoip: /* Open questions= */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions==
* Checking whether actual crypto and fiat balances cover values from a database (prevent fractional reserve)? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T09:25:12Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

==Limitation of v1.0==
* No support for multiple hot and cold wallets. Only one pair of hot/cold wallet will be supported.

==Open questions===
* Checking whether actual crypto and fiat balances match/cover values from a database? How to do it correctly (i.e. delays in transfers, etc)?

Prime Specification

2013-04-20T09:24:29Z

Qertoip: /* Stats */

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Total funds on the exchange
** Total funds accumulated on the exchange for each fiat (calculated from a database)
** Total funds accumulated on the exchange for each cryptocurrency (calculated from a database)
* Hot wallets
** Number and percentage of funds in a hot wallet (actual value taken from a bitcoind) for each cryptocurrency
* Number of users being online and total registered
* Number of buy and sell offers
* Number and volume of transactions

====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

Prime Specification

2013-04-20T00:30:25Z

Qertoip:

==Functional==

===User===

* sign up with e-mail activation and TOS acceptance
* sign in / out
* password reset
** reset link valid for 24h or one use whichever comes first

===Settings===

* change password
* change email
* configure two factor authentication
* on/off API
* reset API key
* configure email notifications (TODO: details)
* complete account removal (privacy feature)
* all changes require second method authentication (email confirmation or OTP)

===Dashboard===
* change market; market is a pair of currencies, i.e. USD/BTC, PLN/BTC

====Order book====
* live chart
* live table

====Last trades====
* live chart
* live table

===Account===

* Balances for the current market
* History
** every balance change must have a corresponding transaction
* Open orders
** cancel order

===Deposit===

====Bitcoins====
* generation of personal input address
** internal maintenance of user input addresses (every user has a list of input addresses)
* displaying address and instructions to the user
** funding user balance with incoming bitcoins
*** create entry in account history, remember bitcoin tx id

====Fiat====
* internal (LAN-only) API for custom scripts to bump fiat balance
** create entry in account history, remember fiat tx id

===Withdraw===

====Bitcoins====
* edit bitcoin output address
* confirm with e-mail link or Google Authenticator OTP
* displaying form to send bitcoins
** amount
** instructions and fee information
** send button with summary and confirmation
* mechanism to actually send bitcoins
** create entry in account history, remember bitcoin tx id

====Fiat====
* edit bank account details
* confirm with e-mail link or Google Authenticator OTP
* display form to send fiat
** amount
** instructions
** send button with summary and confirmation
* add FiatWithdrawal entry to the list of pending fiat withdrawal requests
** publish pending fiat withdrawals in internal API
** accept request to mark specific FiatWithdrawal as fulfilled
*** create entry in account history, remember fiat tx id(?)

===Buy/Sell===
* Display "Please be aware this is only approximation. Order book can change every second."
* Validate order value denominated in fiat is high enough
** This is to prevent order and transaction spam/DOS

====Buy bitcoins====
* Instant buy
** "I want to buy [____] BTC instantly."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting buy order with infinite price.
* Buy with price limit
** "I want to buy [____] BTC at price [____] USD/BTC."
** "You will spend about ____ USD and receive ____ BTC after fee. Average BTC price will be about ____ USD."
** "You need at least ____ USD at hand to submit this order."
** Validate user has enough funds to submit the order (assuming worst case scenario)
** Block funds
** Match with existing orders
** Smart defaults: max BTC user can buy, market price

====Sell bitcoins====
* Instant sell
** "I want to sell [____] BTC instantly."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Technically equals to submitting sell order with 0 price.
* Sell with price limit
** "I want to sell [____] BTC at price [____] USD/BTC."
** "You will receive about ____ USD after fee. Average BTC price will be about ____ USD."
** Validate user has enough funds to submit the order
** Block funds
** Match with existing orders
** Smart defaults: all BTC, market price

===Fees===
====Transaction fee====
Percentage and minimum fee denominated in fiat, like 0.6% min 0.01 USD. Taken from both sides of transaction from the output amount.
====Bitcoin withdrawal fee====
Percentage and minimum fee denominated in bitcoin, like 0% min 0.0005 BTC.
====Fiat withdrawal fee====
Percentage and minimum fee denominated in fiat, like 0% min 2 USD.

===Public API===
====Ticker====
TODO: design
====Trades====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].
====Order Book====
As explained on [http://bitcoincharts.com/about/exchanges/ bitcoincharts].

===Admin panel===
====Stats====
* Totals for every fiat and cryptocurrency
* Number of users online and total
* Number of buy and sell offers
* Number and volume of transactions
====Export====
* emails.csv
===Actions===
* Stop the service
===Rollback===

==Non functional==
===Supported browsers===
Prime example fronted is tested on the latest versions of:
* Chrome
* Firefox
* Internet Explorer 9
* Opera

There is nothing that prevents you from creating a Prime fronted that supports older browsers (see design).

===Correct use of HTTP protocol===
* Semantic use of HTTP methods GET, POST, PATCH, DELETE
* Correct HTTP status codes
===Take advantage of HTML5===
* Use HTML5 to the full extent possible
* Aim at HTML5 validity

Prime Specification

2013-04-20T00:11:44Z

Qertoip:

Prime Specification

2013-04-19T22:56:45Z

Qertoip:

Prime Specification

2013-04-19T22:52:11Z

Qertoip:

Prime Specification

2013-04-19T22:32:50Z

Qertoip: /* Settings */