Skip to content

efs-project/content

Repository files navigation

EFS Content

Curated datasets for Ethereum File System.

This repository is the portable content source for EFS demos and chain deployments. The goal is simple: keep useful, imagination-sparking files in a structure that can be pinned to IPFS, deployed to EFS on any supported chain, and enriched over time with names, descriptions, sizes, tags, provenance, and license metadata.

Current Datasets

Dataset Anchor Files Bytes Description
Web Games /games 15 365441 Single-file HTML5 games, playable in a sandboxed iframe.
Crypto Whitepapers /whitepapers 40 14474579 Major cryptocurrency whitepapers and reference notes.
Ethereum Standards /standards 10 245523 Landmark EIPs/ERCs, public domain under CC0.
Cypherpunk Canon /cypherpunk 2 9707 Founding texts of the cypherpunk movement.

catalog.json is the machine-readable table of contents. Each dataset folder owns its own manifest.json, README.md, and source files.

Layout

datasets/<dataset>/
  README.md       Human overview and curation notes.
  manifest.json  Chain-neutral seed manifest.
  *              Files to pin and deploy.

deployments/
  README.md      Where chain-specific deployment outputs will live.

manifest.schema.json
catalog.json
scripts/validate-manifests.mjs

Dataset files stay beside their manifest for now. That keeps the current seeder path-compatible and avoids churn.

Manifests

Manifests intentionally preserve the current EFS seeder shape:

  • dataset: stable dataset id.
  • title: human display title.
  • anchorPath: EFS root path for the dataset.
  • description: one-sentence dataset overview.
  • defaults: optional defaults such as contentType and license.
  • files[]: deployable files, each with at least path.

Richer fields are additive. Prefer these names as the metadata grows:

  • title for human display names.
  • description for item summaries.
  • tags for browsing and filtering.
  • authors, rightsHolder, license, and licenseUrl for rights metadata.
  • source for upstream provenance.
  • mirrors for content-addressed or deployable retrieval URIs such as ipfs://, ar://, or web3://.
  • deployments for chain-specific EFS attestations, kept out of source manifests when possible.

Run the structural validator before deployment:

npm run validate

Validation checks manifest shape, local files, catalog consistency, and the same path-safety rules used by the current seeder. It does not yet certify that every third-party item has complete rights metadata.

Deployment

Deploy from the contracts repo using the dataset manifest path:

cd ../contracts
yarn hardhat:seed:dataset --manifest ../content/datasets/web-games/manifest.json --execute --pin --network sepolia

The seeder pins local bytes, writes IPFS mirrors, records content type/hash/size, and tags files. Deployment receipts should be committed under deployments/<chain-id>/ so source manifests stay chain-neutral.

License

This is a mixed-license content collection.

EFS-authored manifests, catalog metadata, dataset READMEs, curation notes, and original summaries are dedicated to the public domain under CC0-1.0 unless a file says otherwise.

EFS-authored software or scripts are MIT licensed and should carry an MIT SPDX header.

Third-party works are not relicensed by EFS. Each file keeps its original license or distribution terms. See LICENSE and NOTICE.md.

About

Sample content uploaded to EFS instances

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors