Swarm Core
Framework-agnostic TypeScript primitives for the Swarm decentralised storage network: typed byte wrappers, content-addressed and single-owner chunks, the Mantaray manifest trie, Reed-Solomon erasure coding, encryption, and postage stamp signing.
No network I/O — this library only builds and parses Swarm's on-disk/on-wire data structures. Talking to a Bee node is left to the consumer (e.g. bee-js).
Install
npm install @ethersphere/core-sdk
Ships as both ESM and CommonJS, with full TypeScript types. Import from the subpath you need:
import { Bytes, Reference } from '@ethersphere/core-sdk/bytes'
import { makeContentAddressedChunk } from '@ethersphere/core-sdk/chunk'
Quick example
import { makeContentAddressedChunk } from '@ethersphere/core-sdk/chunk'
const chunk = makeContentAddressedChunk('Hello, Swarm!')
console.log(chunk.address.toHex())
What's included
| Subpath | Contents |
|---|---|
@ethersphere/core-sdk/bytes | Bytes and typed wrappers (Reference, BatchId, EthAddress, PrivateKey, PublicKey, Signature, Span, Topic, Identifier, FeedIndex, PeerAddress, TransactionId) plus low-level encoding helpers (hex/base32/base64, concat, slice, integer packing) |
@ethersphere/core-sdk/crypto | Keccak-256, ECDSA sign/recover/verify, public/private key derivation |
@ethersphere/core-sdk/chunk | Content Addressed Chunks (CAC), Single Owner Chunks (SOC/SOC replicas), the BMT chunk hash, and ChunkSplitter/ChunkJoiner for building and reconstructing chunk trees |
@ethersphere/core-sdk/mantaray | MantarayNode — the manifest trie used for directory/collection uploads |
@ethersphere/core-sdk/erasure-coding | Reed-Solomon parity, redundancy-level tables, and the batching logic used to add parity chunks to a stream |
@ethersphere/core-sdk/encryption | Chunk-level stream cipher and XOR helpers |
@ethersphere/core-sdk/bps | BPS-lite live pub/sub (SWIP-74/87): session topics and chunk ids, signed DATA/AUTH/ROSTER/EOS chunks, WebSocket frame codecs, roster payloads, and BpsPosition for resuming a subscription |
@ethersphere/core-sdk/stamper | Postage stamp signing (Stamper, stamp()) and effective-capacity math |
Every subpath is also re-exported from the package root (@ethersphere/core-sdk), so import { Bytes } from '@ethersphere/core-sdk' works too.
Development
pnpm install
pnpm test # vitest
pnpm typecheck
pnpm format:check
pnpm build # esbuild (ESM + CJS) + tsc (.d.ts)
pnpm bench # perf-sensitive functions, checked against a stored baseline
Requires Node.js 22+.