BigchainDB Examples

🔥 This project won't be updated anymore and has been succeeded by Kyber, a full suite of BigchainDB components with examples, tutorials & burning experiments. Head on over for more up-to-date examples, more fun and way more midi-chlorians.

This repo contains examples and tutorials for BigchainDB.

Warning: These examples are for demonstration purposes and should not be used as-is for production

See the documentation:

• Installing
• Running
• Troubleshooting

Examples:

• On the Record
• Share Trader
• Interledger

Dependencies

The examples can be run via Docker (recommended), but, if you'd like, you can also run them locally with the following system dependencies:

• OS dependencies: see setup BigchainDB & RethinkDB
• python>=3.4
• node>=5.3 using nvm (recommended), or manually
• npm>=3.3 (should be installed with node)

Quick start

Docker

To run via Docker, set up your docker environment as necessary and:

$ make

Note: If using docker-machine, you'll have to run make with your docker-machine ip:

$ DOCKER_MACHINE_IP=$(docker-machine ip) make

The app will be available at http://localhost:33000 (replace localhost with your docker-machine ip as necessary).

Locally

If you'd like to run these examples locally (preferably in a virtualenv), you can do so using the handy CLI:

$ bigchaindb-examples --help

# Start everything
$ bigchaindb-examples start --init --all

# Reset everything
$ bigchaindb-examples reset-all

The app will be available at http://localhost:3000.

Example: "On the Record"

"On the Record" is a simple logging app, wrapped as a messaging board.

Use cases

• Immutable logging of data
• Notarization of data, text, emails

Functionality

Create assets

• with arbitrary payload
• and an unlimited amount

Retrieve assets

• that you currently own (like UTXO's)
• by searching the asset data/payload
• state indicator (in backlog vs. on bigchain)

What this app doesn't provide

• Proper user and key management
• Transfer of assets

Example: Share Trader

Share Trader is a simple share allocation and trade app. Each square represents an asset that can be traded amongst accounts.

Use cases

• Reservation of tickets, seats in a concert/transport, ...
• Trade of limited issued assets

Functionality

Create assets

• assets are created following a structured payload
• the amount is limited

Transfer assets

• easy transfer of assets between accounts by:
• clicking on an account first. This will give the assets for that account
• clicking on an asset of that account. Transfer actions will appear on the right side.

Retrieve assets

• that you currently own (like UTXO's)
• all assets on bigchain
• state indicator (blinks if asset has various owners)

What this app doesn't provide

• Proper user and key management
• Proper signing of transfers
• Proper search by payload

Example: Interledger

TODO

Acknowledgements:

Special thanks to the BigchainDB/ascribe.io team for their insights and code contributions:

@r-marques, @vrde, @ttmc, @rhsimplex, @SohKai, @sbellem, @TimDaub