diff --git a/README.md b/README.md index d2d1cd2..0ce90b2 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,11 @@ | BigchainDB Server | BigchainDB JavaScript Driver | | ----------------- |------------------------------| | `0.10` | `0.1.x` | -| `>= 1.0.0` | `0.3.x` | +| `1.0.0` | `0.3.x` | +| `>= 1.3.0` | `>= 3.1.x` | +## Breaking changes +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) ## Contents diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 36d4f5c..50095ad 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -34,3 +34,21 @@ Compatibility Matrix +-----------------------+----------------------------------+ | ``1.0`` | ``0.3.x`` | +-----------------------+----------------------------------+ +| ``1.3`` | ``3.1.x`` | ++-----------------------+----------------------------------+ + + +Older versions +-------------------- +For versions below 3.2, the transfer transaction is like this: + +.. code-block:: js + + const createTranfer = BigchainDB.Transaction.makeTransferTransaction( + txCreated, + metadata, [BigchainDB.Transaction.makeOutput( + BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))], + 0 + ) + + const signedTransfer = BigchainDB.Transaction.signTransaction(createTranfer, keypair.privateKey)