bigchaindb
/
js-bigchaindb-driver
mirror of https://github.com/bigchaindb/js-bigchaindb-driver.git
1
0
Fork 0
Code Releases Activity

reformat docs

This commit is contained in:
manolodewiner 2018-03-29 11:40:14 +02:00
parent 51ffdfe0b9
commit 5a96c7fdbe
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/readme.rst
View File

@ -44,24 +44,25 @@ Compatibility Matrix
Older versions
--------------------
#### Versions 4.x.x
**Versions 4.x.x**
As part of the changes in the BigchainDB 2.0 server, some endpoint were
modified. In order to be consistent with them, the JS driver does not have
anymore the `pollStatusAndFetchTransaction()` method as there are three
anymore the ``pollStatusAndFetchTransaction()`` method as there are three
different ways of posting a transaction.
- `async` using the `postTransaction`: the response will return immediately and not wait to see if the transaction is valid.
- `sync` using the `postTransactionSync`: the response will return after the transaction is validated.
- `commit` using the `postTransactionCommit`: the response will return after the transaction is committed to a block.
- *async* using the ``postTransaction``: the response will return immediately and not wait to see if the transaction is valid.
- *sync* using the ``postTransactionSync``: the response will return after the transaction is validated.
- *commit* using the ``postTransactionCommit``: the response will return after the transaction is committed to a block.
By default in the docs we will use the `postTransactionCommit` as is way of
By default in the docs we will use the ``postTransactionCommit`` as is way of
being sure that the transaction is validated and commited to a block, so
there will not be any issue if you try to transfer the asset immediately.
#### Versions 3.2.x
**Versions 3.2.x **
For versions below 3.2, a transfer transaction looked like: