bigchaindb/js-bigchaindb-driver
1
0
Fork 0
mirror of https://github.com/bigchaindb/js-bigchaindb-driver.git synced 2024-11-22 09:46:58 +01:00
Code Releases Activity

Merge branch 'update-readme'

Browse Source
This commit is contained in:
vrde 2017-06-26 17:28:56 +02:00
commit 96cd7e0383
No known key found for this signature in database
GPG Key ID: 6581C7C39B3D397D
1 changed files with 36 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -33,46 +33,40 @@ npm install bigchaindb-driver
### Example: Create a transaction ### Example: Create a transaction
```js ```js
import * as driver from 'bigchaindb-driver' const driver = require('bigchaindb-driver')
// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/) // BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
const API_PATH = 'http://localhost:9984/api/v1/' const API_PATH = 'http://localhost:9984/api/v1/'
// Create a new user with a public-private key pair // Create a new keypair.
// (or a whole bunch of them, nobody's counting)
const alice = new driver.Ed25519Keypair() const alice = new driver.Ed25519Keypair()
// Construct a transaction payload // Construct a transaction payload
// `driver.Transaction.makeCreateTransaction()`: create a new asset
// `driver.Transaction.makeTransferTransaction()`: transfer an existing asset
const tx = driver.Transaction.makeCreateTransaction( const tx = driver.Transaction.makeCreateTransaction(
{ assetMessage: 'My very own asset...' }, // Define the asset to store, in this example it is the current temperature
{ metaDataMessage: 'wrapped in a transaction' }, // (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 // A transaction needs an output
// `driver.Transaction.makeOutput()`: requires a crypto-condition
// `driver.Transaction.makeEd25519Condition()`: simple public key output
[ driver.Transaction.makeOutput( [ driver.Transaction.makeOutput(
driver.Transaction.makeEd25519Condition(alice.publicKey)) driver.Transaction.makeEd25519Condition(alice.publicKey))
], ],
alice.publicKey alice.publicKey
) )
// Optional: You've got everything you need, except for an asset // Sign the transaction with private keys
// 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) const txSigned = driver.Transaction.signTransaction(tx, alice.privateKey)
// Send the transaction off to BigchainDB // Send the transaction off to BigchainDB
let conn = new driver.Connection(API_PATH) const conn = new driver.Connection(API_PATH)
conn.postTransaction(txSigned) conn.postTransaction(txSigned)
.then(() => conn.getStatus(txSigned.id)) .then(() => conn.pollStatusAndFetchTransaction(txSigned.id))
.then((res) => console.log('Transaction status:', res.status)) .then(retrievedTx => console.log('Transaction', retrievedTx.id, 'successfully posted.'))
``` ```
## Use a pre-built image (browser only) ## Use a pre-built image (browser only)
@ -82,54 +76,54 @@ conn.postTransaction(txSigned)
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>HTML5 boilerplate – all you really need…</title> <title>BigchainDB boilerplate</title>
<!-- Adjust version to your needs --> <!-- Adjust version to your needs -->
<script src="https://unpkg.com/bigchaindb-driver@0.1.1/dist/browser/bigchaindb-driver.window.min.js"></script> <script src="https://unpkg.com/bigchaindb-driver@0.2.0/dist/browser/bigchaindb-driver.window.min.js"></script>
<script>
<script>
// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/) // BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
const API_PATH = 'http://localhost:9984/api/v1/' const API_PATH = 'http://localhost:9984/api/v1/'
// Create a new user with a public-private key pair // Create a new keypair.
// (or a whole bunch of them, nobody's counting)
const alice = new BigchainDB.Ed25519Keypair() const alice = new BigchainDB.Ed25519Keypair()
// Construct a transaction payload // Construct a transaction payload
// `BigchainDB.Transaction.makeCreateTransaction()`: create a new asset
// `BigchainDB.Transaction.makeTransferTransaction()`: transfer an existing asset
const tx = BigchainDB.Transaction.makeCreateTransaction( const tx = BigchainDB.Transaction.makeCreateTransaction(
{ assetMessage: 'My very own asset...' }, // Define the asset to store, in this example it is the current temperature
{ metaDataMessage: 'wrapped in a transaction' }, // (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 // A transaction needs an output
// `BigchainDB.Transaction.makeOutput()`: requires a crypto-condition
// `BigchainDB.Transaction.makeEd25519Condition()`: simple public key output
[ BigchainDB.Transaction.makeOutput( [ BigchainDB.Transaction.makeOutput(
BigchainDB.Transaction.makeEd25519Condition(alice.publicKey)) BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))
], ],
alice.publicKey alice.publicKey
) )
// Optional: You've got everything you need, except for an asset // Sign the transaction with private keys
// 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) const txSigned = BigchainDB.Transaction.signTransaction(tx, alice.privateKey)
// Send the transaction off to BigchainDB // Send the transaction off to BigchainDB
let conn = new BigchainDB.Connection(API_PATH) let conn = new BigchainDB.Connection(API_PATH)
conn.postTransaction(txSigned) conn.postTransaction(txSigned)
.then(() => conn.getStatus(txSigned.id)) .then(() => conn.pollStatusAndFetchTransaction(txSigned.id))
.then((res) => console.log('Transaction status:', res.status)) .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 // Check console for the transaction's status
</script> </script>
</head> </head>
<body id="home"> <body id="home">
<h1>Hello BigchainDB</h1> <h1>Hello BigchainDB</h1>
<p>Your transaction id is: <a id="lastTransaction" target="_blank"><em>processing</em></a></p>
</body> </body>
</html> </html>
``` ```