@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(entry, bundle)

  • ~finalizeBundle(bundle)

  • ~addSignatureOrMessage(bundle, signatureOrMessage, index)

  • ~valueSum(bundle, offset, length)

bundle~createBundle([entries])

Param	Type	Default	Description
[entries]	Array.<BundleEntry>	[]	Entries of single or multiple transactions with the same address

Creates a bundle with given transaction entries.

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

bundle~addEntry(entry, bundle)

Param	Type	Description
entry	object	Entry of a single or multiple transactions with the same address.
entry.address	Int8Array	Address.
entry.value	Int8Array	Value to transfer in iotas.
[entry.signatureOrMessage]	Int8Array	Signature or message fragment(s).
[entry.timestamp]	Int8Array	Issuance timestamp (in seconds).
[entry.tag]	Int8Array	Optional Tag, Deprecated.
bundle	Int8Array	Bundle buffer.

Adds given transaction entry to a bundle.

Returns: Int8Array - Bundle copy with new entries.

bundle~finalizeBundle(bundle)

Param	Type	Description
bundle	Int8Array	Bundle transaction trits

Finalizes a bundle by calculating the bundle hash.

Returns: Int8Array - List of transactions in the finalized bundle

bundle~addSignatureOrMessage(bundle, signatureOrMessage, index)

Param	Type	Description
bundle	Int8Array	Bundle buffer.
signatureOrMessage	Int8Array	Signature or message to add.
index	number	Transaction index as entry point for signature or message fragments.

Adds signature message fragments to transactions in a bundle starting at offset.

Returns: Int8Array - List of transactions in the updated bundle

bundle~valueSum(bundle, offset, length)

Param	Type	Description
bundle	Int8Array	Bundle buffer.
offset	number	Offset from the start of the bundle buffer.
length	number	Length of transactions in which values should be summed.

Sums up transaction values in a bundle starting at offset.

Returns: number - Total value of 'length' transactions in the bundle starting at offset.