Skip to content

Commit e745b59

Browse files
author
manolodewiner
committed
Breaking changes docs added
1 parent ebf5f6a commit e745b59

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
| BigchainDB Server | BigchainDB JavaScript Driver |
1616
| ----------------- |------------------------------|
1717
| `0.10` | `0.1.x` |
18-
| `>= 1.0.0` | `0.3.x` |
18+
| `1.0.0` | `0.3.x` |
19+
| `>= 1.3.0` | `>= 3.1.x` |
1920

21+
## Breaking changes
22+
Version 3.2 of BigchainDB JavaScript Driver introduces a new way of creating transfer transactions. Check [older versions](https://docs.bigchaindb.com/projects/js-driver/en/latest/readme.html#features)
2023

2124
## Contents
2225

docs/source/readme.rst

+18
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,21 @@ Compatibility Matrix
3434
+-----------------------+----------------------------------+
3535
| ``1.0`` | ``0.3.x`` |
3636
+-----------------------+----------------------------------+
37+
| ``1.3`` | ``3.1.x`` |
38+
+-----------------------+----------------------------------+
39+
40+
41+
Older versions
42+
--------------------
43+
For versions below 3.2, the transfer transaction is like this:
44+
45+
.. code-block:: js
46+
47+
const createTranfer = BigchainDB.Transaction.makeTransferTransaction(
48+
txCreated,
49+
metadata, [BigchainDB.Transaction.makeOutput(
50+
BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))],
51+
0
52+
)
53+
54+
const signedTransfer = BigchainDB.Transaction.signTransaction(createTranfer, keypair.privateKey)

0 commit comments

Comments
 (0)