@iota/bundle

@iota/bundle

Utilities for generating and signing bundles. A bundle in IOTA is an atomic set of transactions.

Installation

Install using npm:

npm install @iota/bundle

or using yarn:

yarn add @iota/bundle

API Reference

• bundle

  • ~createBundle(entries)

  • ~addEntry(transactions, entry)

  • ~addTrytes(transactions, fragments, [offset])

  • ~finalizeBundle(transactions)

bundle~createBundle(entries)

Param	Type	Description
entries	Array.<BundleEntry>	Entries of signle or multiple transactions with the same address

Creates a bunlde with given transaction entries.

Returns: Array.<Transaction> - List of transactions in the bundle

bundle~addEntry(transactions, entry)

Param	Type	Default	Description
transactions	Array.<Transaction>		List of transactions currently in the bundle
entry	object		Entry of single or multiple transactions with the same address
[entry.length]	number	1	Entry length, which indicates how many transactions in the bundle will occupy
[entry.address]	string		Address, defaults to all-9s
[entry.value]	number	0	Value to transfer in IOTAs
[entry.signatureMessageFragments]	Array.<string>		Array of signature message fragments trytes, defaults to all-9s
[entry.timestamp]	number		Transaction timestamp, defaults to Math.floor(Date.now() / 1000)
[entry.tag]	string		Optional Tag, defaults to null tag (all-9s)

Creates a bunlde with given transaction entries

Returns: Array.<Transaction> - Bundle

bundle~addTrytes(transactions, fragments, [offset])

Param	Type	Default	Description
transactions	Array.<Transaction>		Transactions in the bundle
fragments	Array.<Trytes>		Message signature fragments to add
[offset]	number	0	Optional offset to start appending signature message fragments

Adds a list of trytes in the bundle starting at offset

Returns: Array.<Transaction> - Transactions of finalized bundle

bundle~finalizeBundle(transactions)

Param	Type	Description
transactions	Array.<Transaction>	Transactions in the bundle

Finalizes the bundle by calculating the bundle hash

Returns: Array.<Transaction> - Transactions of finalized bundle