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

fix: regenerate doc

Browse Source
This commit is contained in:
getlarge 2021-03-09 07:17:06 +01:00
parent ad7763f76c
commit e76c6227f8
No known key found for this signature in database
GPG Key ID: E4E13243600F9566
2 changed files with 115 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

227
API.md
View File

@ -1,9 +1,3 @@
<!---
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
--->
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
@ -23,36 +17,36 @@ Code is Apache-2.0 and docs are CC-BY-4.0
- [Parameters][13]
- [listTransactions][14]
- [Parameters][15]
- [listVotes][16]
- [postTransaction][16]
- [Parameters][17]
- [postTransaction][18]
- [postTransactionSync][18]
- [Parameters][19]
- [postTransactionSync][20]
- [postTransactionAsync][20]
- [Parameters][21]
- [postTransactionAsync][22]
- [postTransactionCommit][22]
- [Parameters][23]
- [postTransactionCommit][24]
- [searchAssets][24]
- [Parameters][25]
- [searchAssets][26]
- [searchMetadata][26]
- [Parameters][27]
- [searchMetadata][28]
- [Parameters][29]
- [Transaction][30]
- [serializeTransactionIntoCanonicalString][31]
- [Transaction][28]
- [serializeTransactionIntoCanonicalString][29]
- [Parameters][30]
- [makeCreateTransaction][31]
- [Parameters][32]
- [makeCreateTransaction][33]
- [makeEd25519Condition][33]
- [Parameters][34]
- [makeEd25519Condition][35]
- [makeOutput][35]
- [Parameters][36]
- [makeOutput][37]
- [makeSha256Condition][37]
- [Parameters][38]
- [makeSha256Condition][39]
- [makeThresholdCondition][39]
- [Parameters][40]
- [makeThresholdCondition][41]
- [makeTransferTransaction][41]
- [Parameters][42]
- [makeTransferTransaction][43]
- [signTransaction][43]
- [Parameters][44]
- [signTransaction][45]
- [delegateSignTransaction][45]
- [Parameters][46]
- [ccJsonLoad][47]
- [Parameters][48]
@ -61,7 +55,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
## Ed25519Keypair
[src/Ed25519Keypair.js:12-17][51]
[src/Ed25519Keypair.js:16-21][51]
Type: [Object][52]
@ -76,18 +70,17 @@ Type: [Object][52]
## Connection
[src/connection.js:8-178][55]
Base connection
[src/connection.js:21-201][55]
### Parameters
- `path`
- `headers` (optional, default `{}`)
- `nodes`
- `headers` **[Object][52]** Common headers for every request (optional, default `{}`)
- `timeout` **float** Optional timeout in secs (optional, default `DEFAULT_TIMEOUT`)
### getBlock
[src/connection.js:45-51][56]
[src/connection.js:79-85][56]
#### Parameters
@ -95,7 +88,7 @@ Base connection
### getTransaction
[src/connection.js:56-62][57]
[src/connection.js:90-96][57]
#### Parameters
@ -103,7 +96,7 @@ Base connection
### listBlocks
[src/connection.js:68-74][58]
[src/connection.js:102-108][58]
#### Parameters
@ -112,7 +105,7 @@ Base connection
### listOutputs
[src/connection.js:80-92][59]
[src/connection.js:114-126][59]
#### Parameters
@ -121,24 +114,16 @@ Base connection
### listTransactions
[src/connection.js:98-105][60]
[src/connection.js:132-139][60]
#### Parameters
- `assetId`
- `operation`
### listVotes
[src/connection.js:110-116][61]
#### Parameters
- `blockId`
### postTransaction
[src/connection.js:121-123][62]
[src/connection.js:144-146][61]
#### Parameters
@ -146,7 +131,7 @@ Base connection
### postTransactionSync
[src/connection.js:128-133][63]
[src/connection.js:151-156][62]
#### Parameters
@ -154,7 +139,7 @@ Base connection
### postTransactionAsync
[src/connection.js:139-144][64]
[src/connection.js:162-167][63]
#### Parameters
@ -162,7 +147,7 @@ Base connection
### postTransactionCommit
[src/connection.js:150-155][65]
[src/connection.js:173-178][64]
#### Parameters
@ -170,7 +155,7 @@ Base connection
### searchAssets
[src/connection.js:160-166][66]
[src/connection.js:183-189][65]
#### Parameters
@ -178,7 +163,7 @@ Base connection
### searchMetadata
[src/connection.js:171-177][67]
[src/connection.js:194-200][66]
#### Parameters
@ -186,13 +171,13 @@ Base connection
## Transaction
[src/transaction.js:12-254][68]
[src/transaction.js:16-284][67]
Construct Transactions
### serializeTransactionIntoCanonicalString
[src/transaction.js:18-25][69]
[src/transaction.js:22-29][68]
Canonically serializes a transaction into a string by sorting the keys
@ -205,7 +190,7 @@ Returns **[string][54]** a canonically serialized Transaction
### makeCreateTransaction
[src/transaction.js:76-83][70]
[src/transaction.js:80-87][69]
Generate a `CREATE` transaction holding the `asset`, `metadata`, and `outputs`, to be signed by
the `issuers`.
@ -214,12 +199,12 @@ the `issuers`.
- `asset` **[Object][52]** Created asset's data
- `metadata` **[Object][52]** Metadata for the Transaction
- `outputs` **[Array][71]&lt;[Object][52]>** Array of Output objects to add to the Transaction.
- `outputs` **[Array][70]&lt;[Object][52]>** Array of Output objects to add to the Transaction.
Think of these as the recipients of the asset after the transaction.
For `CREATE` Transactions, this should usually just be a list of
Outputs wrapping Ed25519 Conditions generated from the issuers' public
keys (so that the issuers are the recipients of the created asset).
- `issuers` **...[Array][71]&lt;[string][54]>** Public key of one or more issuers to the asset being created by this
- `issuers` **...[Array][70]&lt;[string][54]>** Public key of one or more issuers to the asset being created by this
Transaction.
Note: Each of the private keys corresponding to the given public
keys MUST be used later (and in the same order) when signing the
@ -230,7 +215,7 @@ Returns **[Object][52]** Unsigned transaction -- make sure to call signTransacti
### makeEd25519Condition
[src/transaction.js:92-103][72]
[src/transaction.js:96-107][71]
Create an Ed25519 Cryptocondition from an Ed25519 public key
to put into an Output of a Transaction
@ -238,13 +223,13 @@ to put into an Output of a Transaction
#### Parameters
- `publicKey` **[string][54]** base58 encoded Ed25519 public key for the recipient of the Transaction
- `json` **[boolean][73]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
- `json` **[boolean][72]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
Returns **[Object][52]** Ed25519 Condition (that will need to wrapped in an Output)
### makeOutput
[src/transaction.js:113-133][74]
[src/transaction.js:117-137][73]
Create an Output from a Condition.
Note: Assumes the given Condition was generated from a
@ -259,34 +244,34 @@ Returns **[Object][52]** An Output usable in a Transaction
### makeSha256Condition
[src/transaction.js:141-149][75]
[src/transaction.js:145-153][74]
Create a Preimage-Sha256 Cryptocondition from a secret to put into an Output of a Transaction
#### Parameters
- `preimage` **[string][54]** Preimage to be hashed and wrapped in a crypto-condition
- `json` **[boolean][73]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
- `json` **[boolean][72]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
Returns **[Object][52]** Preimage-Sha256 Condition (that will need to wrapped in an Output)
### makeThresholdCondition
[src/transaction.js:158-172][76]
[src/transaction.js:162-176][75]
Create an Sha256 Threshold Cryptocondition from threshold to put into an Output of a Transaction
#### Parameters
- `threshold` **[number][77]**
- `subconditions` **[Array][71]** (optional, default `[]`)
- `json` **[boolean][73]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
- `threshold` **[number][76]**
- `subconditions` **[Array][70]** (optional, default `[]`)
- `json` **[boolean][72]** If true returns a json object otherwise a crypto-condition type (optional, default `true`)
Returns **[Object][52]** Sha256 Threshold Condition (that will need to wrapped in an Output)
### makeTransferTransaction
[src/transaction.js:195-216][78]
[src/transaction.js:199-220][77]
Generate a `TRANSFER` transaction holding the `asset`, `metadata`, and `outputs`, that fulfills
the `fulfilledOutputs` of `unspentTransaction`.
@ -294,7 +279,7 @@ the `fulfilledOutputs` of `unspentTransaction`.
#### Parameters
- `unspentOutputs`
- `outputs` **[Array][71]&lt;[Object][52]>** Array of Output objects to add to the Transaction.
- `outputs` **[Array][70]&lt;[Object][52]>** Array of Output objects to add to the Transaction.
Think of these as the recipients of the asset after the transaction.
For `TRANSFER` Transactions, this should usually just be a list of
Outputs wrapping Ed25519 Conditions generated from the public keys of
@ -302,7 +287,7 @@ the `fulfilledOutputs` of `unspentTransaction`.
- `metadata` **[Object][52]** Metadata for the Transaction
- `unspentTransaction` **[Object][52]** Previous Transaction you have control over (i.e. can fulfill
its Output Condition)
- `OutputIndices` **...[number][77]** Indices of the Outputs in `unspentTransaction` that this
- `OutputIndices` **...[number][76]** Indices of the Outputs in `unspentTransaction` that this
Transaction fulfills.
Note that listed public keys listed must be used (and in
the same order) to sign the Transaction
@ -313,7 +298,7 @@ Returns **[Object][52]** Unsigned transaction -- make sure to call signTransacti
### signTransaction
[src/transaction.js:229-253][79]
[src/transaction.js:233-257][78]
Sign the given `transaction` with the given `privateKey`s, returning a new copy of `transaction`
that's been signed.
@ -329,9 +314,23 @@ an exercise for the user.
Returns **[Object][52]** The signed version of `transaction`.
### delegateSignTransaction
[src/transaction.js:266-283][79]
Delegate signing of the given `transaction` returning a new copy of `transaction`
that's been signed.
#### Parameters
- `transaction` **[Object][52]** Transaction to sign. `transaction` is not modified.
- `signFn` **[Function][80]** Function signing the transaction, expected to return the fulfillment.
Returns **[Object][52]** The signed version of `transaction`.
## ccJsonLoad
[src/utils/ccJsonLoad.js:10-40][80]
[src/utils/ccJsonLoad.js:14-44][81]
Loads a crypto-condition class (Fulfillment or Condition) from a BigchainDB JSON object
@ -343,7 +342,7 @@ Returns **cc.Condition** Ed25519 Condition (that will need to wrapped in an Outp
## ccJsonify
[src/utils/ccJsonify.js:8-61][81]
[src/utils/ccJsonify.js:12-65][82]
Serializes a crypto-condition class (Condition or Fulfillment) into a BigchainDB-compatible JSON
@ -383,65 +382,65 @@ Returns **[Object][52]** Ed25519 Condition (that will need to wrapped in an Outp
[15]: #parameters-6
[16]: #listvotes
[16]: #posttransaction
[17]: #parameters-7
[18]: #posttransaction
[18]: #posttransactionsync
[19]: #parameters-8
[20]: #posttransactionsync
[20]: #posttransactionasync
[21]: #parameters-9
[22]: #posttransactionasync
[22]: #posttransactioncommit
[23]: #parameters-10
[24]: #posttransactioncommit
[24]: #searchassets
[25]: #parameters-11
[26]: #searchassets
[26]: #searchmetadata
[27]: #parameters-12
[28]: #searchmetadata
[28]: #transaction
[29]: #parameters-13
[29]: #serializetransactionintocanonicalstring
[30]: #transaction
[30]: #parameters-13
[31]: #serializetransactionintocanonicalstring
[31]: #makecreatetransaction
[32]: #parameters-14
[33]: #makecreatetransaction
[33]: #makeed25519condition
[34]: #parameters-15
[35]: #makeed25519condition
[35]: #makeoutput
[36]: #parameters-16
[37]: #makeoutput
[37]: #makesha256condition
[38]: #parameters-17
[39]: #makesha256condition
[39]: #makethresholdcondition
[40]: #parameters-18
[41]: #makethresholdcondition
[41]: #maketransfertransaction
[42]: #parameters-19
[43]: #maketransfertransaction
[43]: #signtransaction
[44]: #parameters-20
[45]: #signtransaction
[45]: #delegatesigntransaction
[46]: #parameters-21
@ -453,7 +452,7 @@ Returns **[Object][52]** Ed25519 Condition (that will need to wrapped in an Outp
[50]: #parameters-23
[51]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/Ed25519Keypair.js#L12-L17 "Source code on GitHub"
[51]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/Ed25519Keypair.js#L16-L21 "Source code on GitHub"
[52]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
@ -461,56 +460,58 @@ Returns **[Object][52]** Ed25519 Condition (that will need to wrapped in an Outp
[54]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[55]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L8-L178 "Source code on GitHub"
[55]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L21-L201 "Source code on GitHub"
[56]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L45-L51 "Source code on GitHub"
[56]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L79-L85 "Source code on GitHub"
[57]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L56-L62 "Source code on GitHub"
[57]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L90-L96 "Source code on GitHub"
[58]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L68-L74 "Source code on GitHub"
[58]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L102-L108 "Source code on GitHub"
[59]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L80-L92 "Source code on GitHub"
[59]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L114-L126 "Source code on GitHub"
[60]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L98-L105 "Source code on GitHub"
[60]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L132-L139 "Source code on GitHub"
[61]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L110-L116 "Source code on GitHub"
[61]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L144-L146 "Source code on GitHub"
[62]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L121-L123 "Source code on GitHub"
[62]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L151-L156 "Source code on GitHub"
[63]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L128-L133 "Source code on GitHub"
[63]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L162-L167 "Source code on GitHub"
[64]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L139-L144 "Source code on GitHub"
[64]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L173-L178 "Source code on GitHub"
[65]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L150-L155 "Source code on GitHub"
[65]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L183-L189 "Source code on GitHub"
[66]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L160-L166 "Source code on GitHub"
[66]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/connection.js#L194-L200 "Source code on GitHub"
[67]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/connection.js#L171-L177 "Source code on GitHub"
[67]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L16-L284 "Source code on GitHub"
[68]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L12-L254 "Source code on GitHub"
[68]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L22-L29 "Source code on GitHub"
[69]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L18-L25 "Source code on GitHub"
[69]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L80-L87 "Source code on GitHub"
[70]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L76-L83 "Source code on GitHub"
[70]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[71]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[71]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L96-L107 "Source code on GitHub"
[72]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L92-L103 "Source code on GitHub"
[72]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[73]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[73]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L117-L137 "Source code on GitHub"
[74]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L113-L133 "Source code on GitHub"
[74]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L145-L153 "Source code on GitHub"
[75]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L141-L149 "Source code on GitHub"
[75]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L162-L176 "Source code on GitHub"
[76]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L158-L172 "Source code on GitHub"
[76]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[77]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[77]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L199-L220 "Source code on GitHub"
[78]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L195-L216 "Source code on GitHub"
[78]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L233-L257 "Source code on GitHub"
[79]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/transaction.js#L229-L253 "Source code on GitHub"
[79]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/transaction.js#L266-L283 "Source code on GitHub"
[80]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/utils/ccJsonLoad.js#L10-L40 "Source code on GitHub"
[80]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
[81]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6a637f33e21a9f43503ec51f923bfdad60c57458/src/utils/ccJsonify.js#L8-L61 "Source code on GitHub"
[81]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/utils/ccJsonLoad.js#L14-L44 "Source code on GitHub"
[82]: https://github.com/bigchaindb/js-bigchaindb-driver/blob/6dbafa8fad51ae945f854fa63b9a9be02d35198a/src/utils/ccJsonify.js#L12-L65 "Source code on GitHub"

2
RELEASE_PROCESS.md
View File

@ -34,7 +34,7 @@ We follow [BEP-1](https://github.com/bigchaindb/BEPs/tree/master/1), which is ou
If that fails, then get it working.
1. We use the [release-it](https://www.npmjs.com/package/release-it) package (from npm) to automate most of the release. Make sure you have a recent version.
1. Login to npm using your npm credentials, so you can publish a new [bigchaindb-driver](https://www.npmjs.com/package/bigchaindb-driver) package there. (The npm account must haver permission to do so).
1. Login to npm using your npm credentials, so you can publish a new [bigchaindb-driver](https://www.npmjs.com/package/bigchaindb-driver) package there. (The npm account must have permission to do so).
`npm login`