# swarm-lowlevel > Utilities for the Swarm decentralized cloud storage system Latest version **0.8.9** (published 2020-08-07) · GPL-3.0-or-later license · 0 weekly downloads ## Install ```sh npm install swarm-lowlevel pnpm add swarm-lowlevel yarn add swarm-lowlevel bun add swarm-lowlevel ``` Provides the commands `bmthash`, `swarmhash`, `eth-genkey`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.8.9 | | Published | 2020-08-07 | | First published | 2019-08-20 | | Weekly downloads | 0 | | License | GPL-3.0-or-later | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 4 | | Unpacked size | 70.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Louis Holbrook | | Maintainers | lash | | Keywords | swarm, ethereum, decentralized, storage | ## Links - npm: https://www.npmjs.com/package/swarm-lowlevel - Repository: https://gitlab.com/nolash/swarm-lowlevel-js - Homepage: https://gitlab.com/nolash/swarm-lowlevel-js#readme - Issues: https://gitlab.com/nolash/swarm-lowlevel-js/issues - npm.io page: https://npm.io/package/swarm-lowlevel ## Dependencies (4) - [mocha](https://npm.io/package/mocha.md) ^7.2.0 - [keccak](https://npm.io/package/keccak.md) ^2.0.0 - [secp256k1](https://npm.io/package/secp256k1.md) ^3.7.1 - [big-integer](https://npm.io/package/big-integer.md) ^1.6.48 ## Alternatives - [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads - [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads - [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads - [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads - [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads ## Recent versions - 0.8.9 (latest) — 2020-08-07 - 0.8.8 — 2020-07-26 - 0.8.7 — 2020-07-26 - 0.8.6 — 2020-07-26 - 0.8.5 — 2020-07-25 - 0.8.4 — 2020-07-23 - 0.8.3 — 2020-07-23 - 0.8.2 — 2020-07-23 - 0.8.1 — 2020-07-23 - 0.8.0 — 2020-07-23 - 0.7.0 — 2020-06-10 - 0.6.0 — 2020-06-09 - 0.5.6 — 2020-05-07 - 0.5.5 — 2020-04-26 - 0.5.4 — 2020-04-26 - … 25 more at https://npm.io/package/swarm-lowlevel/versions ## README # swarm-lowlevel Utilities for Swarm the decentralized cloud storage system. Please refer to the SEE ALSO section to read more about the concepts involved in this module. Currently the module offers tooling for: * BMT hasher * File splitter (previously file hasher) * File joiner * SOC In absence of friendly instructions please refer to the `example` directory and tests for hints on what this is and how to use it. I've run it successfully with [Swarm v0.4.3](https://github.com/ethersphere/swarm/tree/v0.4.3) There is also an executable in `tools` that generates a random private key and writes it to a binary file along with its public key and ethereum address. The _resulting files_ are named after the latter. ## INSTALL `npm install swarm-lowlevel` The script `check.sh` checks file checksums and signatures. My GPG key is [0826EDA1702D1E87C6E2875121D2E7BB88C2A746](http://keys.gnupg.net/pks/lookup?op=vindex&fingerprint=on&search=0x21D2E7BB88C2A746). Potential key authenticators: * https://holbrook.no/louis_dev_pub.asc * https://gitlab.com/nolash (see profile) * https://github.com/nolash (see profile) ## USAGE ### BMT HASHER ``` let swarm = require('swarm-lowlevel') let bh = new swarm.bmtHasher() let data = Buffer.from('foo'); bh.reset(data.length); bh.setSpan(data.length); bh.update(data); let bmthash = bh.digest(data); console.debug('bmt hash', bmthash) --- > bmt hash ``` ### FILE HASHER ``` let swarm = require('swarm-lowlevel') let fh = new swarm.fileSplitter(console.debug); let data = Buffer.from('foo'); let swarmhash = fh.split(data) console.debug('file hash', swarmhash) --- > { > level: 0, > index: 0, > reference: , > data: > } > > file hash ``` ### FILE JOINER ``` let swarm = require('swarm-lowlevel') yourCustomChunkGetter.prototype.get = function(chunk) { console.debug('chunk', chunk); } let getter = new yourCustomChunkGetter(...); let j = new joiner.Joiner(getter, process.stdout.write); let hashOfFoo = '2387e8e7d8a48c2a9339c97c1dc3461a9a7aa07e994c5cb8b38fd7c1b3e6ea48'; j.join(hashOfFoo); ``` ### SOC ``` let swarm = require('swarm-lowlevel'); let hashOfFoo = '2387e8e7d8a48c2a9339c97c1dc3461a9a7aa07e994c5cb8b38fd7c1b3e6ea48'; let signer = new swarm.unsafeWallet(); let soc_ch = undefined; let cb = function(ch) { soc_ch = ch; console.debug(ch); } let soc = swarm.socFromData(hashOfFoo, Buffer.from('there can be only one'), signer, cb); soc.sign(); let soc_recovered = swarm.socFromSocChunk(soc_ch); let chunk = soc_recovered.getChunk(); console.debug(String.fromCharCode.apply(null, chunk.data)); soc = new swarm.soc(hashOfFoo, chunk, undefined); chunk = soc.getChunk(); console.debug(String.fromCharCode.apply(null, chunk.data)); > { > level: 0, > index: 0, > span: undefined, > reference: , > data: Uint8Array(126) [ > 35, 135, 232, 231, 216, 164, 140, 42, 147, 57, 201, 124, > 29, 195, 70, 26, 154, 122, 160, 126, 153, 76, 92, 184, > 179, 143, 215, 193, 179, 230, 234, 72, 31, 79, 57, 178, > 202, 206, 205, 187, 0, 190, 170, 130, 95, 109, 8, 168, > 134, 144, 24, 18, 224, 146, 198, 107, 238, 3, 79, 162, > 179, 148, 177, 64, 11, 18, 254, 25, 18, 126, 216, 176, > 116, 126, 60, 77, 34, 127, 47, 206, 155, 183, 60, 137, > 43, 109, 68, 176, 129, 85, 254, 126, 77, 33, 83, 14, > 30, 21, 0, 0, > ... 26 more items > ] > } > from soc: there can be only one > from chunk: there can be only one ``` ## SEE ALSO * https://swarm.ethereum.org * https://swarm-guide.readthedocs.io * https://github.com/ethersphere/swarm ## LICENSE GPLv3 --- _Source: https://npm.io/package/swarm-lowlevel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._