@iota/bundle

Utilities for generating and signing bundles

Stats

StarsIssuesVersionUpdatedCreatedSize
@iota/bundle
1.0.0-beta.30a year ago3 years agoMinified + gzip package size for @iota/bundle in KB

Readme

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

Summary: Adds the given transaction entry to a bundle array.
Throws:

  • errors.ILLEGAL_TRANSACTION_BUFFER_LENGTH : Make sure that the bundle argument contains valid transaction trits
  • errors.ILLEGAL_SIGNATURE_OR_MESSAGE_LENGTH : Make sure that the entry.signatureOrMessage argument contains 6,561 trits
  • errors.ILLEGAL_ADDRESS_LENGTH : Make sure that the entry.address argument contains 243 trits
  • errors.ILLEGAL_VALUE_LENGTH : Make sure that the entry.value argument contains 6,561 trits
  • errors.ILLEGAL_ISSUANCE_TIMESTAMP_LENGTH : Make sure that the entry.timestamp argument contains 81 trits
Param Type Description
entry object Transaction entry object
entry.address Int8Array An address in trits
entry.value Int8Array An amount of IOTA tokens in trits
[entry.signatureOrMessage] Int8Array Signature fragments or a message in trits
[entry.issuanceTimestamp] Int8Array Unix epoch in trits
[entry.tag] Int8Array (deprecated)
bundle Int8Array Bundle array to which to add the entry object

Adds transaction trits in the given entry object to a given bundle array.

Related methods

See the converter package for methods that convert values to trits.

Returns: Int8Array - A copy of the original bundle that also includes the added entries.
Example

let bundle = new Int8Array();

bundle = Bundle.addEntry(bundle, {
 address: Converter.trytesToTrits(outputAddress),
 value: Converter.valueToTrits(value),
 issuanceTimestamp: Converter.valueToTrits(Math.floor(Date.now() / 1000));
});

bundle.finalizeBundle(bundle)

Summary: Generates a bundle hash.
Throws:

  • errors.ILLEGAL_TRANSACTION_BUFFER_LENGTH : Make sure that the bundle argument contains valid transaction trits
Param Type Description
bundle Int8Array Transaction trits

This method takes an array of transaction trits, generates the bundle hash, and adds it to each transaction.

Related methods

See the addEntry() method for creating new bundles.

Returns: Int8Array - Transaction trits that include a bundle hash
Example

const result = Bundle.finalizeBundle(bundle);

bundle.addSignatureOrMessage(bundle, signatureOrMessage, index)

Summary: Adds signature message fragments to transactions in a bundle.
Throws:

  • errors.ILLEGAL_TRANSACTION_BUFFER_LENGTH : Make sure that the bundle argument contains valid transaction trits
  • errors.ILLEGAL_TRANSACTION_INDEX : Make sure that the index argument is a number and that the bundle contains enough transactions
  • errors.ILLEGAL_SIGNATURE_OR_MESSAGE_LENGTH : Make sure that the signatureOrMessage argument contains at least 6,561 trits
Param Type Description
bundle Int8Array Transaction trits
signatureOrMessage Int8Array Signature or message to add to the bundle
index number Transaction index at which to start adding the signature or message

This method takes an array of transaction trits, and add the given message or signature to the transactions, starting from the given index.

If the signature or message is too long to fit in a single transaction, it is split across the next transaction in the bundle, starting from the given index.

Related methods

See the addEntry() method for creating new bundles.

Returns: Int8Array - Transaction trits that include a bundle hash.
Example

const signature = Converter.trytesToTrits('SIGNATURE...')
bundle.set(Bundle.addSignatureOrMessage(bundle, signature, 1));

bundle~createBundle([entries])

Summary: Creates a bundle array from the given transaction entries.

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

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.