arbundles

Arweave Bundles

A library for creating, editing, reading and verifying bundles.

Note: Gateways currently only index bundles up to 250mb. Creating bundles larger than this could lead to them not being indexed. The new gateway implementation will provide infinite bundle limits. If you wish to upload a transactions >250mb submit a standard transaction via arweave-js.

See ANS-104 for more details.

Installing the library

Using npm:

npm install arbundles

Using yarn:

yarn add arbundles

Creating bundles

import { bundleAndSignData } from "arbundles";

const dataItems = [
  { data: "some data" },
  { data: "some other data" },
];

const signer = new ArweaveSigner(jwk);

const bundle = await bundleAndSignData(dataItems, jwk);

It's as simple as that! All the binary encoding is handled for you.

Creating and using a DataItem

import { createData } from "arbundles";

const data = { data: "some data" };

const signer = new ArweaveSigner(jwk);

const dataItem = await createData(data, signer);

// Get owner in base64url encoded string
const owner = dataItem.owner;

// Sign a single DataItem 
await dataItem.sign(jwk);

assert(owner == jwk.n);

Get a DataItem in a bundle

const bundle = await bundleAndSignData(dataItems, jwk);

// Get by index
const byIndex = bundle.get(0);

// Get by transaction id
const byId = bundle.get("hKMMPNh_emBf8v_at1tFzNYACisyMQNcKzeeE1QE9p8");

// Get all DataItems
const all = bundle.items;

Submit a transaction

const bundle = await bundleAndSignData(dataItems, jwk);

// Convert bundle to Arweave transaction
const tx = await bundle.toTransaction(arweave, jwk);

// Add some more tags after creation.
tx.addTag('MyTag', 'value1');
tx.addTag('MyTag', 'value2');

await arweave.transactions.sign(tx, jwk);
await arweave.transactions.post(tx);

Parse a bundle binary

import { Bundle } from "arbundles";

const data = await arweave.transactions.getData("hKMMPNh_emBf8v_at1tFzNYACisyMQNcKzeeE1QE9p8");

const bundle = new Bundle(data);

File API

This API is experimental so avoid use in production. There's one issue that exists that may affect it's overall functionality and could lead to breaking changes.

The file API stores the items in the filesystem meaning you can bundle more items without hitting the NodeJS memory limit.

Docs coming soon...