bigchaindb/js-bigchaindb-driver
1
0
Fork 0
mirror of https://github.com/bigchaindb/js-bigchaindb-driver.git synced 2024-11-22 01:36:56 +01:00
Code Releases Activity
e745b5948d
js-bigchaindb-driver/docs/source
History
manolodewiner e745b5948d Breaking changes docs added
2017-12-19 16:56:16 +01:00
..
.conf.py.swp Moved docs from personal repo to official js Driver repo 2017-11-23 10:00:40 +01:00
advanced.rst docs updated to new makeTransferTransaction format 2017-11-23 10:03:23 +01:00
conf.py Seed Functionality integrated in docs 2017-09-28 13:15:40 +02:00
index.rst Moved docs from personal repo to official js Driver repo 2017-11-23 10:00:40 +01:00
quickstart.rst Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
readme.rst Breaking changes docs added 2017-12-19 16:56:16 +01:00
usage.rst merge master 2017-11-27 15:36:34 +01:00

readme.rst 

BigchainDB JavaScript Driver
============================

.. image:: https://img.shields.io/npm/v/bigchaindb-driver.svg
			:target: https://www.npmjs.com/package/bigchaindb-driver

.. image:: https://codecov.io/gh/bigchaindb/js-bigchaindb-driver/branch/master/graph/badge.svg
			:target: https://codecov.io/gh/bigchaindb/js-bigchaindb-driver

.. image:: https://img.shields.io/badge/js-ascribe-39BA91.svg
			:target: https://github.com/ascribe/javascript

.. image:: https://travis-ci.org/bigchaindb/js-bigchaindb-driver.svg?branch=master
			:target: https://travis-ci.org/bigchaindb/js-bigchaindb-driver

.. image:: https://badges.greenkeeper.io/bigchaindb/js-bigchaindb-driver.svg
			:target: https://greenkeeper.io/

Features
--------

* Support for preparing, fulfilling, and sending transactions to a BigchainDB
  node.
* Retrieval of transactions by id.
* Getting status of a transaction by id.

Compatibility Matrix
--------------------

+-----------------------+----------------------------------+
| **BigchainDB Server** | **BigchainDB Javascript Driver** |
+=======================+==================================+
| ``0.10``              | ``0.1.x``                        |
+-----------------------+----------------------------------+
| ``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)