2018-08-10 12:49:26 +02:00
|
|
|
<!---
|
|
|
|
Copyright BigchainDB GmbH and BigchainDB contributors
|
|
|
|
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
|
|
|
Code is Apache-2.0 and docs are CC-BY-4.0
|
|
|
|
--->
|
|
|
|
|
2018-01-23 17:12:19 +01:00
|
|
|
# Quick Notes
|
|
|
|
`dotenv` is listed as a dependencies in `package.json`.
|
|
|
|
If you want to use this, add a `.env` file to the root of this project (same level as this `README.md` file)
|
|
|
|
and replace the variables to fit your specific config.
|
|
|
|
|
|
|
|
```
|
2018-05-11 10:36:01 +02:00
|
|
|
BIGCHAINDB_API_PATH=https://test.bigchaindb.com/api/v1/
|
2018-01-23 17:12:19 +01:00
|
|
|
BIGCHAINDB_APP_ID=<your-app-id>
|
|
|
|
BIGCHAINDB_APP_KEY=<your-app-key>
|
|
|
|
```
|
|
|
|
|
2018-01-20 14:25:15 +01:00
|
|
|
# Usage
|
2018-01-20 16:41:05 +01:00
|
|
|
`npm install` -> Installs all required dependencies to run these examples.
|
|
|
|
|
|
|
|
## Different Examples
|
|
|
|
**Basic Usage**: Create asset and transfer it to new owner.
|
|
|
|
-> `npm start`
|
|
|
|
|
2018-01-20 22:19:23 +01:00
|
|
|
**Async/Await Basic Usage**: Basic usage example rewritten with async/await.
|
|
|
|
-> `npm run basic-async`
|
|
|
|
|
2018-01-20 16:41:05 +01:00
|
|
|
**Querying for Assets**: Query for assetdata or metadata.
|
|
|
|
-> `npm run query-assets`
|
|
|
|
|
2018-01-20 22:19:23 +01:00
|
|
|
**Seed/Keypair Functionality**: Create keypair with bip39 library.
|
|
|
|
-> `npm run seed-func`
|