divvy-rest/HISTORY.md

A RESTful API for submitting payments and monitoring accounts on the Divvy network.

## 1.4.0

#### Breaking Changes

+ `client_resource_id` cannot be reused anymore for failed transactions [3b4c1636](https://github.com/xdv/divvy-rest/commit/3b4c16368dbed8a96a125eee37018293bbad8d27)

+ Removed deprecated depoly/dev config [3eae89e7](https://github.com/xdv/divvy-rest/commit/3eae89e756ee3de3e80bcfe930badef65f76c436)

+ Move hash, ledger and state fields to be on root response object [fbc8840c](https://github.com/xdv/divvy-rest/commit/fbc8840c47685a15513ab2e68f3fff5df3c0c807)

***Deprecations***

+ In a future version of divvy-rest `issuer` will be renamed to `counterparty`

#### Changes

+ Add place and cancel order functionality [d80d198](https://github.com/xdv/divvy-rest/commit/d80d198e18f9c1f96adad8fba4be67b8ae26c4d5) and [274f5236](https://github.com/xdv/divvy-rest/commit/274f5236b8a3e879cacb3b64a62100c45cef6b93) and [a384c5d5](https://github.com/xdv/divvy-rest/commit/a384c5d5e7da20c64536dd04d90fc3757e01df85) and [e6a8c74a](https://github.com/xdv/divvy-rest/commit/e6a8c74a0f0e6ebd8814e78498ad775a4c654c37) and [bbf386ec](https://github.com/xdv/divvy-rest/commit/bbf386ecd7c9f076114f8a4560dc3c3faa673864)

+ Add orderbook functionality, get an orderbook for a currency pair [41905cb9](https://github.com/xdv/divvy-rest/commit/41905cb9e1d12a0fccfdf34018ce5f85ce093a58)

+ Allow a fixed fee to be set on a payment [aaa9efae](https://github.com/xdv/divvy-rest/commit/aaa9efae3d28cdb3b0184c50179e47c54677b060)

+ Make response objects consistent for payment history [159e53cb](https://github.com/xdv/divvy-rest/commit/159e53cb757e6dc5129a906cb39010f555a36e25)

+ Support paging behavior for balances and trustlines [6980ab7](https://github.com/xdv/divvy-rest/commit/6980ab7c844508caae5c62ee7202aa429d12ef0b) and [d5a153e3](https://github.com/xdv/divvy-rest/commit/d5a153e33a7bcb7246569ea91c9cdb2551142594)

+ Add code to allow divvyd in standalone mode and not having a recently closed ledger [3d45a81d](https://github.com/xdv/divvy-rest/commit/3d45a81dfa7358bca962d5e7baf5a8a856d0514c)

+ Support gzip compression[8dc2365d](https://github.com/xdv/divvy-rest/commit/8dc2365dd0acfdfd0849991e679e162a700a006e)

+ Set SendMax for difference source and destination issuers [e7726090](https://github.com/xdv/divvy-rest/commit/e77260907ee0876e1e948e72f02468026d201100)

+ Allow a `url_base` for status url's to be set from config [93ffb6c1](https://github.com/xdv/divvy-rest/commit/93ffb6c143e13281d5dc7478fecfa1f2a5a896dc)

+ Add query parameter for only showing frozen balances [a9b246bd](https://github.com/xdv/divvy-rest/commit/a9b246bdaa4aeb63f881ac467177059081c5c100)

+ Add cors allow methods [18e52a06](https://github.com/xdv/divvy-rest/commit/18e52a06a279b9f57f7b1152d1cc0ee6fff13595)

+ Increase default account_tx limit [a2ed905f](https://github.com/xdv/divvy-rest/commit/a2ed905f7f58655644a397447435af3373b60041)

+ Use the `divvy-lib-transactionparser` to compute transaction balance changes [8b900bf0](https://github.com/xdv/divvy-rest/commit/8b900bf04e852c34e43876676d6ab87112665f07)

+ Fix parameter discrepancy, `*_froze_line` -> `*_trustline_frozen` [2701c0b](https://github.com/xdv/divvy-rest/commit/2701c0b9ac481b4e9172b6faaf0d0a4821d6acb5) and [a8aeeec](https://github.com/xdv/divvy-rest/commit/a8aeeeced9b9f896608160a3d34aaedf00e3dc96)

+ Fix: allow trust line to be set to 0 [333bf320](https://github.com/xdv/divvy-rest/commit/333bf3204db2931a524ddfb1df872b1df3593314)

+ Add tests to show use of interest-bearing currencies [9c5412f](https://github.com/xdv/divvy-rest/commit/9c5412f3a0e1498e3108930d38da6157dc764e53)

+ Add configuration to allow self-signed certificates [3503049b](https://github.com/xdv/divvy-rest/commit/3503049bceb13551cfe1d31798fa316c4d32e57b)

+ Update divvy-lib which fixes several stability problems and improving transaction submission reliability, see [divvy-lib releases](https://github.com/xdv/divvy-lib/releases)


## 1.3.1

+ Add `validated` query parameter to POST payment, account settings and trustlines. When set to true this will force the request to wait until the transaction has been validated. [f2710f4b](https://github.com/xdv/divvy-rest/commit/f2710f4b78a8c1b9860f2876f6f051022241c641), [1ee9c9ff](https://github.com/xdv/divvy-rest/commit/1ee9c9ff06ada4a14955bf64ed42d7c3c75f5a3e), [f243fef9](https://github.com/xdv/divvy-rest/commit/f243fef9d28be86f593dae11a3fac7421115e5bf)

+ Add `/v1/transaction-fee` endpoint to retrieve the current fee that connected servers are charging. [212c0bfb](https://github.com/xdv/divvy-rest/commit/212c0bfbcde887db9e9842ef43af062b5ab77598) and [afaa381b](https://github.com/xdv/divvy-rest/commit/afaa381bb5f9a4fdd50f1e35cb1d7990b4926833)

+ [Support `last_ledger_sequence` in POST payments, sets the last ledger this payment can be included in.](https://github.com/xdv/divvy-rest/commit/7ed11a94de0e7e6fd52adfdf64763d110ce13353)

+ [Support `max_fee` in POST payments. This will set the maximum fee the user will pay when posting a payment.](https://github.com/xdv/divvy-rest/commit/7bc6a892c42d628534c5d7529c76b7feb17e3b3c)

+ [Add config entry to configure `max_transaction_fee`. This allows you to set the maximum fee you're willing to pay for any transaction.](https://github.com/xdv/divvy-rest/commit/6667719614ce90a25f377473762f26a6b28aaa25) [Documented changes](https://github.com/xdv/divvy-rest/blob/develop/docs/server-configuration.md)
 
+ [Save unsubmitted transactions to database](https://github.com/xdv/divvy-rest/commit/860dccef01bef51238142e7a4d7287d4f09ed268)



## 1.3.0

#### Added features

+ Freeze support ([pull 167](https://github.com/xdv/divvy-rest/pull/167) and [pull 178](https://github.com/xdv/divvy-rest/pull/178))

+ Memo field support ([pull 154](https://github.com/xdv/divvy-rest/pull/154)) 

+ Add `destination_amount_submitted` and `source_amount_submitted` to Payment ([0d3599b](https://github.com/xdv/divvy-rest/commit/0d3599b4057c5cb884eade6bc11c978f8770c943) and [67134e3](https://github.com/xdv/divvy-rest/commit/67134e3ef57b808fc193f2f62579c5681aeb49cc))

+ New endpoint to generate an address/secret pair, `/wallet/new`

+ Expose `router` and `remote` as `DivvyRestPlugin` to use as a plugin for other modules

+ Log all connected servers, add reconnect to servers on SIGHUP


#### Breaking changes

+ Endpoints renamed and removed ([6802423](https://github.com/xdv/divvy-rest/commit/6802423245d8eff7a8b35248c8c261db62422dfb)):
    - **new** `/v1/accounts/new` -> `v1/wallet/new`
    - **removed** `/v1/tx/{:hash}`
    - **removed** `/v1/transaction/{:hash}`
    - use `/v1/transactions/{:hash}` to get a transaction by hash
    - **removed** `/v1/payments`
    - use `/v1/accounts/{address}/payments` to submit a payment    

+ New configuration, you will have to change your config file. [Documented changes](https://github.com/xdv/divvy-rest/blob/develop/docs/server-configuration.md)

+ Refactored response and error handling, improves consistency of response messages. **The response and error message format has changed.**

+ New database interface, support for sqlite in memory or persistent through config path in `config.json`

+ Deprecated Postgres support. Support sqlite only


#### Changes

+ Add protection against POODLE ([cb4f12c](https://github.com/xdv/divvy-rest/commit/cb4f12c72f2a7c756651ada49c0cb68454e75587))

+ Fix: always set issuer on `destination_amount` for path results ([1b0c731](https://github.com/xdv/divvy-rest/commit/1b0c73162c2c52469e147f99f72ea4d0f94e3132))

+ Transitioned to Express4

+ Centralize connection checking, improves consistency of connected responses

+ Centralize logging using winston, timestamps on all logs

+ New test-suite

+ Tied api version to major package version and added package version to index page `/` or `/v1`

+ Update divvy-lib which fixes several stability problems and crashes

+ Code refactor and cleanup


#### Fixes

+ Fix: improper SetFlag/ClearFlag collision error message ([d26ec5e](https://github.com/xdv/divvy-rest/commit/d26ec5eeb459d41e27415d9e827f34e32116c234))

+ Fix: `tec` transaction errors represented as success, resulting in false positives ([d14c51c](https://github.com/xdv/divvy-rest/commit/d14c51c2064efd9cc13b0e81742a6488f50c3d98)) 

+ Fix: issue where forcible server connectivity check would cause permanent server disconnect

+ Fix: show index page while hitting root `/`

+ Fix: issue with notification parsing

+ Fix: check and validate issuer upon payment

+ Fix: database reset on startup

+ Fix: Check tx.meta exists before accessing

+ Fix: Allow browser-based client to make POST to divvy-rest server

+ Fix: Occasional crash on getting payments for account




## 1.2.5

+ Fix: Check that tx.meta exists before accessing

+ Fix: Case where divvy-rest would crash when divvyd could not be connected to




## 1.2.4

+ Change rconsole logging from stderr to stdout

+ Add timestamps to HTTP(S) request logging

+ Fix database reset on startup


## 1.2.1
07/29/2014

#### Added Features
+ Enable invoiceID

#### Bug Fixes
+ Do not limit the amount of account transactions per ledger to 10,
  fixing the issue where no incoming transactions were ever notified.

## 1.2.0
07/16/2014

#### Added features
+ Return 502 Bad Gateway middleware when remote is not connected to divvyd.

#### Bug Fixes
+ 502 Middleware fixes the crash-on-startup bug when clients try to connect before
  divvy rest is connected to divvyd.


## 1.1.2
07/10/2014

#### Added features
+ Code climate integration badge
+ capistrano scripts for server deployment
+ new version of divvy-lib

#### Bug Fixes
+ Setting SendMax on payments
+ Fix broken outgoing payments endpoint

##1.1.1
06/18/2014

#### Added features
+ Add Istanbul code coverage tests
+ Refactor out express app object
+ Add a few integration tests using superagent

#### Bug Fixes
+ Return 500 instead of 200 on invalid divvy address


## 1.1.0
06/11/2014

####  Added features
+ Add exclude_failed option to getAccountTransactions (defaults to false)
+ Add protocol, host, and port (when applicable) to URLs returned to client
+ Coveralls for testing

**Internal Changes**
+ Add JsDoc comments to transactions.js, payments.js, and notifications.js
+ Centralize divvy-lib transaction submit and get functions in transactions.js
+ Significantly simplify getAccountTransactions logic and parameters set by recursive call
+ Test divvy-lib transaction functions
+ Test transaction submission to ensure transaction is saved to the database every time its state is changed
+ Test payment submission and retrieval
+ Test notifications
+ Move notification and payment formatter functions into notifications.js and payments.js, respectively
+ Replace hard-coded server connection timeout value with exported variable in server-lib.js

#### #Bug Fixes
+ Callback with error and entry for function to query database for transaction in getTransactionHelper
+ Prevent second HTTP response for error after transaction proposed event in submitTransaction function
+ Validate account in getTransaction
+ Attach client_resource_id in getTransaction so it is correctly returned to client
+ Strange pathfinding error message when no paths are found because of a lack of liquidity


## 1.0.2
06/10/2014

#### Fixed bugs:
+ GET /v1/accounts/{:account}/payments/{:hash} not responding


## 1.0.1
06/04/2014

#### Fixed bugs:
+ Client resource id now properly returned
+ XDV Pathfind bug
+ Pathfinding error message
+ missing invoide_id
+ normalize account settings
+ notification timestamp formatting

#### Added features:
+ Travis.yml for Continuous Integration
+ License
+ Tests for balances, trust lines
+ Add debug mode