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
6a637f33e2
js-bigchaindb-driver/API.md
Matthias Kretschmann 81ef5978b8
API docs & dev updates 
* new command: npm run doc, for generating the API.md file
* new command: npm run dev, for live watching webpack
* JSdoc: make all methods public by default, selectively make some private
* JSdoc: organize all methods under their class
* linting fixes
* package updates
2018-05-14 17:14:40 +02:00

13 KiB
Raw Blame History

Table of Contents

Ed25519Keypair

src/Ed25519Keypair.js:12-17

Type: Object

Parameters

  • seed Buffer? A seed that will be used as a key derivation function

Properties

Connection

src/connection.js:8-168

Base connection

Parameters

  • path
  • headers (optional, default {})

getBlock

src/connection.js:44-50

Parameters

  • blockHeight

getTransaction

src/connection.js:55-61

Parameters

  • transactionId

listBlocks

src/connection.js:67-73

Parameters

  • transactionId
  • status

listOutputs

src/connection.js:79-91

Parameters

  • publicKey
  • spent

listTransactions

src/connection.js:97-104

Parameters

  • assetId
  • operation

listVotes

src/connection.js:109-115

Parameters

  • blockId

postTransaction

src/connection.js:120-125

Parameters

  • transaction

postTransactionSync

src/connection.js:130-135

Parameters

  • transaction

postTransactionCommit

src/connection.js:140-145

Parameters

  • transaction

searchAssets

src/connection.js:150-156

Parameters

  • search

searchMetadata

src/connection.js:161-167

Parameters

  • search

Transaction

src/transaction.js:12-253

Construct Transactions

serializeTransactionIntoCanonicalString

src/transaction.js:18-25

Canonically serializes a transaction into a string by sorting the keys

Parameters

  • transaction
  • null Object (transaction)

Returns string a canonically serialized Transaction

makeCreateTransaction

src/transaction.js:76-83

Generate a CREATE transaction holding the asset, metadata, and outputs, to be signed by the issuers.

Parameters

  • asset Object Created asset's data
  • metadata Object Metadata for the Transaction
  • outputs Array<Object> 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<string> 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 Transaction (signTransaction()).

Returns Object Unsigned transaction -- make sure to call signTransaction() on it before sending it off!

makeEd25519Condition

src/transaction.js:92-103

Create an Ed25519 Cryptocondition from an Ed25519 public key to put into an Output of a Transaction

Parameters

  • publicKey string base58 encoded Ed25519 public key for the recipient of the Transaction
  • json boolean If true returns a json object otherwise a crypto-condition type (optional, default true)

Returns Object Ed25519 Condition (that will need to wrapped in an Output)

makeOutput

src/transaction.js:113-133

Create an Output from a Condition. Note: Assumes the given Condition was generated from a single public key (e.g. a Ed25519 Condition)

Parameters

  • condition Object Condition (e.g. a Ed25519 Condition from makeEd25519Condition())
  • amount string Amount of the output (optional, default '1')

Returns Object An Output usable in a Transaction

makeSha256Condition

src/transaction.js:141-149

Create a Preimage-Sha256 Cryptocondition from a secret to put into an Output of a Transaction

Parameters

  • preimage string Preimage to be hashed and wrapped in a crypto-condition
  • json boolean If true returns a json object otherwise a crypto-condition type (optional, default true)

Returns Object Preimage-Sha256 Condition (that will need to wrapped in an Output)

makeThresholdCondition

src/transaction.js:158-172

Create an Sha256 Threshold Cryptocondition from threshold to put into an Output of a Transaction

Parameters

  • threshold number
  • subconditions Array (optional, default [])
  • json boolean If true returns a json object otherwise a crypto-condition type (optional, default true)

Returns Object Sha256 Threshold Condition (that will need to wrapped in an Output)

makeTransferTransaction

src/transaction.js:195-216

Generate a TRANSFER transaction holding the asset, metadata, and outputs, that fulfills the fulfilledOutputs of unspentTransaction.

Parameters

  • unspentOutputs
  • outputs Array<Object> 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 the recipients.
  • metadata Object Metadata for the Transaction
  • unspentTransaction Object Previous Transaction you have control over (i.e. can fulfill its Output Condition)
  • OutputIndices ...number 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 (signTransaction()).

Returns Object Unsigned transaction -- make sure to call signTransaction() on it before sending it off!

signTransaction

src/transaction.js:229-252

Sign the given transaction with the given privateKeys, returning a new copy of transaction that's been signed. Note: Only generates Ed25519 Fulfillments. Thresholds and other types of Fulfillments are left as an exercise for the user.

Parameters

  • transaction Object Transaction to sign. transaction is not modified.
  • privateKeys ...string Private keys associated with the issuers of the transaction. Looped through to iteratively sign any Input Fulfillments found in the transaction.

Returns Object The signed version of transaction.

ccJsonLoad

src/utils/ccJsonLoad.js:10-40

Loads a crypto-condition class (Fulfillment or Condition) from a BigchainDB JSON object

Parameters

Returns cc.Condition Ed25519 Condition (that will need to wrapped in an Output)

ccJsonify

src/utils/ccJsonify.js:8-61

Serializes a crypto-condition class (Condition or Fulfillment) into a BigchainDB-compatible JSON

Parameters

  • fulfillment cc.Fulfillment base58 encoded Ed25519 public key for recipient of the Transaction

Returns Object Ed25519 Condition (that will need to wrapped in an Output)