The developer SDK for the Ethereum File System (EFS) — an on-chain filesystem built on EAS attestations.
Status: scaffold. Repo structure, toolchain, and public API shapes are in place; implementations land next. How it works:
docs/specs/overview.md. Decisions:docs/adr/. (Cross-cutting design rationale lives in the EFS planning vault, internal.)
| Package | npm | For |
|---|---|---|
packages/sdk |
@efs/sdk |
TypeScript — apps, scripts, agents reading/writing EFS off-chain. viem-native. |
packages/solidity |
@efs/solidity |
Solidity — a compile-in library so your own contract can read/write EFS. |
npm i @efs/sdk viem # TypeScript SDK
npm i @efs/solidity # Solidity library (compile-in)packages/
sdk/ TypeScript SDK (tsup, viem, vitest)
solidity/ Solidity library (Foundry, ships .sol source)
examples/ runnable consumers (foundry / hardhat / ts)
docs/adr/ architecture decision records (this repo's decisions)
The cross-cutting design lives in the planning vault; this repo holds the code and its per-repo ADRs. See AGENTS.md for the boundary rule.
pnpm install
pnpm build # turbo: builds both packages
pnpm test # turbo: vitest + forge test
pnpm typecheck
pnpm lint # biomeRequires pnpm 9+, Node 20+, and Foundry (for the Solidity package).
See CONTRIBUTING.md. Every change to a published package needs a Changeset.