@web3/buzz

Swarm JavaScript API

Usage no npm install needed!

<script type="module">
  import web3Buzz from 'https://cdn.skypack.dev/@web3/buzz';
</script>

README

🏗 Only raw text uploads/downloads supported for now, work on the full API is in progress.

Install

npm install @web3/buzz

Usage

import Buzz from '@web3/buzz'

// instantiate Buzz class with Swarm node provider
const buzz = new Buzz({ provider: 'http://localhost:8500' })

// upload raw text
buzz.upload('buzz')

// download raw text
buzz.download('f070f4f87c0018a4026ff2c14895e9ef525e81c4cf4d768e1bf658e570927a13')

Swarm URI schemes

Swarm version 1.8.0 introduced a set of 'long' URI schemes, which replaced the deprecated 'short' URI schemes. This library uses the long schemes by default but support for the short schemes can be toggled with the schemeType property:

const buzz = new Buzz({ provider: '...', schemeType: 'SHORT' })

Contributing

Setup

npm install

Build

npm run build

Test

npm test

Credits

  • Logo: Bee by alican from the Noun Project