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
183 Commits 93 Branches 18 Tags 9.7 MiB
JavaScript 98.6%
Shell 1.1%
Dockerfile 0.3%
886ed81f84
Go to file
tim 886ed81f84 Fix browser bundling for webpack
2017-06-23 11:00:22 +02:00
media cleanup all the readme things 2017-06-06 16:29:28 +02:00
src bump transaction version to 1.0 2017-06-22 16:17:43 +02:00
test tests for cryptoconditions 2017-06-22 16:13:59 +02:00
.babelrc Add few tests 2017-06-16 11:22:23 +02:00
.eslintignore Add codecovfefe 2017-06-21 13:17:00 +02:00
.eslintrc.json ignore yarn.lock 2017-04-26 15:58:19 +02:00
.gitignore Add codecovfefe 2017-06-21 13:17:00 +02:00
.npmignore npm package fixes 2017-06-13 20:19:02 +02:00
.travis.yml final 2017-06-21 15:27:02 +02:00
API.md Update API.md 2017-05-14 20:06:56 +02:00
CODE_OF_CONDUCT.md add Code of Conduct 2017-06-20 16:37:58 +02:00
CONTRIBUTING.rst license, authors, etc 2017-05-09 20:23:11 +02:00
LICENSE remove +x flag on LICENSE 2017-06-19 11:53:22 +02:00
package.json Fix browser bundling for webpack 2017-06-23 11:00:22 +02:00
README.md Adjust headings 2017-06-23 11:00:22 +02:00
webpack.config.js bundle => bigchaindb-driver 2017-06-23 11:00:22 +02:00
yarn.lock Add codecovfefe 2017-06-23 11:00:22 +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.

npm codecov js ascribe Build Status Greenkeeper badge

Compatibility

BigchainDB Server BigchainDB JavaScript Driver
0.10 0.1.0

Contents

Installation and Usage with package managers (npm/yarn)

npm install bigchaindb-driver

Example: Create a transaction

import * as driver from '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 user with a public-private key pair
// (or a whole bunch of them, nobody's counting)
const alice = new driver.Ed25519Keypair()

// Construct a transaction payload
// `driver.Transaction.makeCreateTransaction()`: create a new asset
// `driver.Transaction.makeTransferTransaction()`: transfer an existing asset
const tx = driver.Transaction.makeCreateTransaction(
    { assetMessage: 'My very own asset...' },
    { metaDataMessage: 'wrapped in a transaction' },
    // A transaction needs an output
    // `driver.Transaction.makeOutput()`: requires a crypto-condition
    // `driver.Transaction.makeEd25519Condition()`: simple public key output
    [ driver.Transaction.makeOutput(
            driver.Transaction.makeEd25519Condition(alice.publicKey))
    ],
    alice.publicKey
)

// Optional: You've got everything you need, except for an asset
// and metadata. Maybe define them here, any JSON-serializable object
// will do

// Ok, now that you have a transaction, you need to *sign* it
// cause, you know... cryptography and ¯\_(ツ)_/¯

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

// Send the transaction off to BigchainDB
let conn = new driver.Connection(API_PATH, { 'Content-Type': 'application/json' })

conn.postTransaction(txSigned)
    .then(() => conn.getStatus(txSigned.id))
    .then((res) => console.log('Transaction status:', res.status))

Use a pre-built image (browser only)

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <title>HTML5 boilerplate – all you really need…</title>
        <!-- Adjust version to your needs -->
        <script src="https://unpkg.com/bigchaindb-driver@0.1.1/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 user with a public-private key pair
            // (or a whole bunch of them, nobody's counting)
            const alice = new BigchainDB.Ed25519Keypair()

            // Construct a transaction payload
            // `BigchainDB.Transaction.makeCreateTransaction()`: create a new asset
            // `BigchainDB.Transaction.makeTransferTransaction()`: transfer an existing asset
            const tx = BigchainDB.Transaction.makeCreateTransaction(
                { assetMessage: 'My very own asset...' },
                { metaDataMessage: 'wrapped in a transaction' },
                // A transaction needs an output
                // `BigchainDB.Transaction.makeOutput()`: requires a crypto-condition
                // `BigchainDB.Transaction.makeEd25519Condition()`: simple public key output
                [ BigchainDB.Transaction.makeOutput(
                        BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))
                ],
                alice.publicKey
            )

            // Optional: You've got everything you need, except for an asset
            // and metadata. Maybe define them here, any JSON-serializable object
            // will do

            // Ok, now that you have a transaction, you need to *sign* it
            // cause, you know... cryptography and ¯\_(ツ)_/¯

            // Sign/fulfill 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, { 'Content-Type': 'application/json' })

            conn.postTransaction(txSigned)
                .then(() => conn.getStatus(txSigned.id))
                .then((res) => console.log('Transaction status:', res.status))
            // Check console for the transaction's status
        </script>
    </head>
    <body id="home">
    <h1>Hello BigchainDB</h1>
    </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.