Skip to content

ViewBlock/arbundles

 
 

Repository files navigation

ANS-104 Bundles

If you want to use Bundlr Network head over to this repo

A low level 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, createData } from "arbundles";

const dataItems = [createData("some data"), createData("some other data")];

const signer = new ArweaveSigner(jwk);

const bundle = await bundleAndSignData(dataItems, jwk);

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...

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.6%
  • Other 0.4%