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
Official BigchainDB JavaScript driver for Node.js and the browser
421 Commits 93 Branches 18 Tags 9.7 MiB
JavaScript 98.6%
Shell 1.1%
Dockerfile 0.3%
b6a1a13bf8
Go to file
Matthias Kretschmann b6a1a13bf8
bump Node.js version, build current and last version
2018-05-11 15:40:34 +02:00
.ci remove driver container 2018-03-29 19:18:27 +02:00
.vscode Fix note to top of readme 2018-01-23 17:12:19 +01:00
compose merge 2018-03-29 19:02:46 +02:00
docs text improvement in readme 2018-04-04 10:44:15 +02:00
examples Change localhost to test network 2018-05-11 10:36:01 +02:00
media Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
src update endpoints 2018-03-21 11:30:54 +01:00
test test Sha256Condition 2018-04-04 10:16:39 +02:00
.babelrc npm updates 2018-03-29 18:58:55 +02:00
.eslintignore Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
.eslintrc.json Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
.gitignore Merge pull request #125 from bigchaindb/transfer-multiple-inputs-rebase 2017-12-20 12:53:04 +01:00
.npmignore Release 3.1.1 2017-11-27 17:07:34 +01:00
.travis.yml bump Node.js version, build current and last version 2018-05-11 15:40:34 +02:00
API.md Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
CODE_OF_CONDUCT.md Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
CONTRIBUTING.rst Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
docker-compose.yml test passing 2018-03-29 18:57:12 +02:00
LICENSE Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00
package.json Merge branch 'master' into greenkeeper/sinon-5.0.0 2018-04-03 08:23:41 +02:00
README.md Fix BigchainDB version compatibility 2018-04-19 12:26:49 +02:00
webpack.config.js npm updates 2018-03-29 18:58:55 +02:00
yarn.lock Tried to change permissions of all files to 664 2017-09-22 10:15:02 +02:00

README.md

js-bigchaindb-driver

Official JavaScript driver for BigchainDB with some naive helpers to get you on your way making transactions in Node.js and the browser.

Join the chat at https://gitter.im/bigchaindb/js-bigchaindb-driver npm codecov js ascribe Build Status Greenkeeper badge

Compatibility

BigchainDB Server BigchainDB JavaScript Driver
0.10 0.1.x
1.0.0 0.3.x
1.3.x 3.x.x
>= 2.0.0 4.x.x

Breaking changes

  • Version 4.0 of BigchainDB JavaScript Driver makes the driver compatible with BigchainDB 2.0. There are new functions for sending off transactions along with other changes. Check older versions
  • Version 3.2 of BigchainDB JavaScript Driver introduces a new way of creating transfer transactions. Check older versions

Contents

Installation and Usage with package managers (npm/yarn)

npm install bigchaindb-driver

Example: Create a transaction

const driver = require('bigchaindb-driver')

// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
const API_PATH = 'http://localhost:9984/api/v1/'

// Create a new keypair.
const alice = new driver.Ed25519Keypair()

// Construct a transaction payload
const tx = driver.Transaction.makeCreateTransaction(
    // Define the asset to store, in this example it is the current temperature
    // (in Celsius) for the city of Berlin.
    { city: 'Berlin, DE', temperature: 22, datetime: new Date().toString() },

    // Metadata contains information about the transaction itself
    // (can be `null` if not needed)
    { what: 'My first BigchainDB transaction' },

    // A transaction needs an output
    [ driver.Transaction.makeOutput(
            driver.Transaction.makeEd25519Condition(alice.publicKey))
    ],
    alice.publicKey
)

// Sign the transaction with private keys
const txSigned = driver.Transaction.signTransaction(tx, alice.privateKey)

// Send the transaction off to BigchainDB
const conn = new driver.Connection(API_PATH)

conn.postTransactionCommit(txSigned)
    .then(retrievedTx => console.log('Transaction', retrievedTx.id, 'successfully posted.'))

Use a pre-built image (browser only)

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <title>BigchainDB boilerplate</title>
        <!-- Adjust version to your needs -->
        <script src="https://unpkg.com/bigchaindb-driver@4.0.0/dist/browser/bigchaindb-driver.window.min.js"></script>

        <script>
            // BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
            const API_PATH = 'http://localhost:9984/api/v1/'

            // Create a new keypair.
            const alice = new BigchainDB.Ed25519Keypair()

            // Construct a transaction payload
            const tx = BigchainDB.Transaction.makeCreateTransaction(
                // Define the asset to store, in this example it is the current temperature
                // (in Celsius) for the city of Berlin.
                { city: 'Berlin, DE', temperature: 22, datetime: new Date().toString() },

                // Metadata contains information about the transaction itself
                // (can be `null` if not needed)
                { what: 'My first BigchainDB transaction' },

                // A transaction needs an output
                [ BigchainDB.Transaction.makeOutput(
                        BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))
                ],
                alice.publicKey
            )

            // Sign the transaction with private keys
            const txSigned = BigchainDB.Transaction.signTransaction(tx, alice.privateKey)

            // Send the transaction off to BigchainDB
            let conn = new BigchainDB.Connection(API_PATH)

            conn.postTransactionCommit(txSigned)
                .then(res => {
                    const elem = document.getElementById('lastTransaction')
                    elem.href = API_PATH + 'transactions/' + txSigned.id
                    elem.innerText = txSigned.id
                    console.log('Transaction', txSigned.id, 'accepted')
                })
            // Check console for the transaction's status
        </script>
    </head>
    <body id="home">
        <h1>Hello BigchainDB</h1>
        <p>Your transaction id is: <a id="lastTransaction" target="_blank"><em>processing</em></a></p>
    </body>
</html>

BigchainDB Documentation

Speed Optimizations

This implementation plays "safe" by using JS-native (or downgradable) libraries for its crypto-related functions to keep compatibilities with the browser. If you do want some more speed, feel free to explore the following:

Authors

License

Copyright 2017 BigchainDB GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.