From 3570a129dc6645ee10ef5fa8d957f480abe7ddec Mon Sep 17 00:00:00 2001 From: James Carnley Date: Tue, 27 Oct 2026 17:03:13 -0500 Subject: [PATCH 01/16] whitepapers: fix facts, remove internal notes, make every card consistent Ahead of the Devcon demo, an audit found public cards carrying internal review notes ("FLAGGED FOR JAMES", "pending James's decision", "FLAG (mild)"), wrong facts, and conversion junk. - Facts: Algorand now credits Gilad, Hemo, Micali, Vlachos and Zeldovich (SOSP 2017), with Chen & Micali as related work. Avalanche's titles and authors match the two hosted 2020 PDFs. XRP's card says the paper "argues" fault tolerance and notes the 2018 Chase & MacBrough analysis. Dead source links replaced; sources named for Polygon and Polkadot. - Litecoin, Dogecoin, TRON and BNB are now neutral, sourced explainer cards (no whitepaper, or a link to the official one) instead of placeholder or flagged notes. - matic-whitepaper.md: anchors, empty headings, raw math and a broken image removed; prose unchanged. cosmos-whitepaper.md: provenance header only. - Every card: title, facts list (project, paper, authors, year, source, the file it describes), short summary. Licence lines dropped: the owner hosts whitepapers without a licence field. - manifest: public `flagged`/`link-only` tags removed; proof-of-stake tagged consistently. Each fact was checked against the hosted PDF, the upstream copy (sha256-compared) or Wikipedia/Wikidata. `npm run validate` passes. Co-authored-by: Claude Opus 5.5 --- datasets/crypto-whitepapers/ADDRESSES.md | 108 ++++------ datasets/crypto-whitepapers/README.md | 63 +++--- datasets/crypto-whitepapers/algorand.md | 29 +-- datasets/crypto-whitepapers/avalanche.md | 38 ++-- datasets/crypto-whitepapers/binance-bnb.md | 36 ++-- datasets/crypto-whitepapers/bitcoin.md | 26 +-- datasets/crypto-whitepapers/cardano.md | 29 +-- datasets/crypto-whitepapers/chainlink.md | 28 +-- .../crypto-whitepapers/cosmos-whitepaper.md | 2 + datasets/crypto-whitepapers/cosmos.md | 25 ++- datasets/crypto-whitepapers/dogecoin.md | 24 +-- datasets/crypto-whitepapers/ethereum.md | 29 +-- datasets/crypto-whitepapers/filecoin.md | 28 +-- datasets/crypto-whitepapers/litecoin.md | 26 +-- datasets/crypto-whitepapers/manifest.json | 46 ++-- .../crypto-whitepapers/matic-whitepaper.md | 204 +++++++++--------- datasets/crypto-whitepapers/monero.md | 34 +-- datasets/crypto-whitepapers/polkadot.md | 30 +-- datasets/crypto-whitepapers/polygon.md | 40 ++-- datasets/crypto-whitepapers/solana.md | 25 ++- datasets/crypto-whitepapers/tezos.md | 30 +-- datasets/crypto-whitepapers/tron.md | 43 ++-- datasets/crypto-whitepapers/uniswap.md | 31 +-- datasets/crypto-whitepapers/xrp-ripple.md | 30 +-- datasets/crypto-whitepapers/zcash.md | 31 ++- 25 files changed, 503 insertions(+), 532 deletions(-) diff --git a/datasets/crypto-whitepapers/ADDRESSES.md b/datasets/crypto-whitepapers/ADDRESSES.md index cb9f3f0..99516c6 100644 --- a/datasets/crypto-whitepapers/ADDRESSES.md +++ b/datasets/crypto-whitepapers/ADDRESSES.md @@ -1,67 +1,41 @@ -# Existing IPFS / Arweave Addresses — EFS Mirror Research - -Companion to `README.md`. Goal: for each whitepaper in this dataset, find whether a -**canonical, publicly-pinned IPFS CID and/or Arweave address already exists**, so EFS can point -a MIRROR at existing content instead of self-hosting. - -## Method & honesty rules - -- A CID is only recorded here if it was **found published somewhere** AND I **verified the gateway - actually resolves to the right document** (size / sha256 match against the local PDF where one exists). -- CIDs were **not** computed locally and assumed to match a published one — chunking/CID-version - differences make that unreliable. No guessed CIDs. -- Where nothing verifiable was found, the row is marked **"needs self-pin"** (we pin it ourselves later). -- Confidence reflects how sure I am the address is the *same, correct* whitepaper (not a random re-upload). - -Research date: 2026-06-10. Gateways checked: `ipfs.io`, `dweb.link`, `w3s.link`. - -## Summary - -- **Verified existing IPFS CID: 1** — Bitcoin (byte-identical, very high confidence). -- **Verified existing Arweave address: 0.** -- **Needs self-pin: all others** (~18 documents across ~16 coins with real papers). -- No widely-published, per-document canonical CID/TxID surfaced for any non-Bitcoin paper. Most are - served only from project HTTP sites. (ethereum.org's *whole site* is mirrored to IPFS via the - `ethereum.eth` ENS contenthash, but no canonical per-PDF CID is published — so none is recorded here.) - -## Table - -| Coin | PDF present | IPFS CID + gateway (verified) | Arweave TxID + URL | Source | Confidence | Notes | -|---|---|---|---|---|---|---| -| **Bitcoin** | y | `QmRA3NWM82ZGynMbYzAgYTSXCVM14Wx1RZ8fKP42G6gjgj` — https://ipfs.io/ipfs/QmRA3NWM82ZGynMbYzAgYTSXCVM14Wx1RZ8fKP42G6gjgj (also resolves on dweb.link, w3s.link) | none found | bitcoin-dot-org/Bitcoin.org GitHub issue #3696; this CID is the well-known one also embedded in macOS | **Very high** | **VERIFIED byte-identical to local `bitcoin.pdf`** (184,292 bytes; sha256 `b1674191…f4f553`) across 3 gateways. Best mirror candidate. | -| Litecoin | no (none exists) | — | — | — | n/a | No whitepaper ever existed (2011 Bitcoin/scrypt fork). Nothing to mirror. | -| Dogecoin | no (none exists) | — | — | — | n/a | No whitepaper ever existed (2013 joke coin). Nothing to mirror. | -| Ethereum | y | needs self-pin | needs self-pin | ethereum.org serves PDF over HTTP only; site is on IPFS via `ethereum.eth` ENS contenthash but no canonical per-PDF CID published | n/a | Did not record a guessed CID. Self-pin the local `ethereum-whitepaper-2014.pdf`. | -| Cardano (Ouroboros) | y | needs self-pin | needs self-pin | IACR ePrint 2016/889 (HTTP) | n/a | Academic preprint; no published CID/TxID found. | -| Solana | y | needs self-pin | needs self-pin | solana.com / allcryptowhitepapers (HTTP) | n/a | No published CID/TxID found. | -| Algorand | y | needs self-pin | needs self-pin | IACR ePrint 2017/454 (HTTP) | n/a | Academic preprint; none found. | -| Tezos (whitepaper + position paper) | y (both) | needs self-pin | needs self-pin | tezos.com (HTTP) | n/a | Two PDFs; none found. | -| Polygon (Matic litepaper) | y | needs self-pin | needs self-pin | github.com/maticnetwork/whitepaper | n/a | None found. | -| Tron | **no — flagged** | — | — | — | n/a | Link-only in dataset (plagiarism controversy, pulled from official site). Do not source/mirror. | -| Monero (CryptoNote v2) | y | needs self-pin | needs self-pin | universally mirrored (web.archive, Zenodo CC-BY copy); no single canonical CID/TxID found | n/a | Many HTTP mirrors but no authoritative pinned CID surfaced. | -| Zcash (Zerocash) | y | needs self-pin | needs self-pin | zerocash-project.org author preprint (HTTP) | n/a | None found. (Local file is the author extended version, per README.) | -| Polkadot | y | needs self-pin | needs self-pin | Web3 Foundation (HTTP) | n/a | None found. | -| Cosmos | y (markdown only) | needs self-pin | needs self-pin | github.com/cosmos/cosmos | n/a | No PDF in dataset; markdown only. Nothing to mirror unless we pin the md. | -| Avalanche (consensus + platform) | y (both) | needs self-pin | needs self-pin | arXiv 1906.08936 + Ava Labs (HTTP) | n/a | None found. | -| Chainlink | y | needs self-pin | needs self-pin | research.chain.link (HTTP) | n/a | None found. | -| Uniswap (v2-core + v3-core) | y (both) | needs self-pin | needs self-pin | uniswap.org (HTTP) | n/a | None found. | -| Filecoin | y | needs self-pin | needs self-pin | filecoin.io/filecoin.pdf (Protocol Labs, CC-BY) | n/a | Ironically IPFS-native project, but no canonical per-PDF CID published/verifiable. Strong self-pin candidate (CC-BY). | -| XRP (Ripple) | y | needs self-pin | needs self-pin | ripple.com (HTTP) | n/a | None found. | -| BNB (Binance) | **no — flagged** | — | — | — | n/a | Link-only in dataset (commercial doc, no open license). Do not source/mirror. | - -## Coins with NO real whitepaper - -- **Litecoin** — 2011 Bitcoin/scrypt fork; no formal paper. -- **Dogecoin** — 2013 meme coin; no whitepaper ever written. - -## Link-only / flagged (do not mirror without James's review) - -- **Tron** — whitepaper pulled from official site amid plagiarism controversy; dataset is link+note only. -- **BNB / Binance** — commercial exchange doc, no stated open license; dataset is link+note only. - -## Recommendation - -Only **Bitcoin** can be mirrored against an existing, verified public pin today. Everything else -should be **self-pinned** by EFS from the local PDFs (the high-value, clearly-licensed ones first: -Bitcoin already covered, then Ethereum CC-BY, Filecoin CC-BY). After self-pinning, the resulting -CIDs can be recorded back into this file. +# Existing IPFS / Arweave addresses + +Companion to `README.md`. For each paper in this dataset, this records whether a published, publicly pinned +IPFS CID or Arweave address already exists, so EFS can point a mirror at existing content instead of +pinning it again. + +## Method + +- A CID is recorded only if it was found published somewhere **and** the gateway copy was checked to be + byte-identical (size and sha256) to the local file. +- CIDs were not computed locally and assumed to match a published one, since chunking and CID-version + differences make that unreliable. +- Anything without a verified published address is marked **needs self-pin**. + +Research date: 2026-06-10 (gateways `ipfs.io`, `dweb.link`, `w3s.link`). The Bitcoin CID was re-checked on +2026-10-27 via `gateway.pinata.cloud`, `4everland.io` and `ipfs.filebase.io`; `ipfs.io`, `dweb.link` and +`w3s.link` no longer serve files directly. + +## Results + +| Project | Local file(s) | Existing address | Notes | +|---|---|---|---| +| Bitcoin | `bitcoin.pdf` | `ipfs://QmRA3NWM82ZGynMbYzAgYTSXCVM14Wx1RZ8fKP42G6gjgj` | Byte-identical to the local file (184,292 bytes; sha256 `b1674191…f4f553`). CID referenced in bitcoin-dot-org/Bitcoin.org GitHub issue #3696. (Separately, a copy of the paper shipped as a sample PDF in macOS 10.14 to 13.3.) | +| Ethereum | `ethereum-whitepaper-2014.pdf` | needs self-pin | ethereum.org is served on IPFS as a whole site via the `ethereum.eth` ENS contenthash, but no per-PDF CID is published. | +| Cardano | `ouroboros.pdf` | needs self-pin | | +| Solana | `solana.pdf` | needs self-pin | | +| Algorand | `algorand.pdf` | needs self-pin | | +| Tezos | `tezos-whitepaper.pdf`, `tezos-position-paper.pdf` | needs self-pin | | +| Polygon | `matic-litepaper.pdf`, `matic-whitepaper.md` | needs self-pin | | +| Monero | `cryptonote.pdf` | needs self-pin | Widely mirrored over HTTP, but no authoritative CID found. | +| Zcash | `zerocash.pdf` | needs self-pin | | +| Polkadot | `polkadot.pdf` | needs self-pin | | +| Cosmos | `cosmos-whitepaper.md` | needs self-pin | | +| Avalanche | `avalanche-consensus.pdf`, `avalanche-platform.pdf` | needs self-pin | | +| Chainlink | `chainlink-whitepaper-v1.pdf` | needs self-pin | | +| Uniswap | `uniswap-v2-core.pdf`, `uniswap-v3-core.pdf` | needs self-pin | | +| Filecoin | `filecoin.pdf` | needs self-pin | No per-PDF CID published, despite the project being IPFS-native. | +| XRP Ledger | `ripple-consensus-whitepaper.pdf` | needs self-pin | | + +No verified Arweave addresses were found. Litecoin, Dogecoin, TRON and BNB have cards only, so there is no +paper file to mirror. After self-pinning, record the resulting CIDs here. diff --git a/datasets/crypto-whitepapers/README.md b/datasets/crypto-whitepapers/README.md index 94f2339..c387d38 100644 --- a/datasets/crypto-whitepapers/README.md +++ b/datasets/crypto-whitepapers/README.md @@ -1,37 +1,36 @@ -# Crypto Whitepapers — EFS reference dataset +# Crypto Whitepapers -A flat collection of major-cryptocurrency whitepapers, assembled as a reference dataset for the EFS (Ethereum File System) OnionDAO hackathon. +A flat collection of major cryptocurrency whitepapers for EFS (Ethereum File System). Each project has a +short markdown card (paper title, authors, year, canonical source, which file it describes, and a summary) +and, where a whitepaper exists, a copy of the paper itself. -**Modeled the EFS way: flat files + tags, not folders.** Every whitepaper is one item (a stable identity); its category is a **tag**, not a location. A paper can carry many tags (and, in EFS, different curators/lenses can tag it differently) — so "is XRP a *payment* coin or *interoperability*?" is answered by tags, not by which single folder it's trapped in. On EFS this becomes: each PDF/markdown = a DATA placed at a stable anchor, with TAG edges for categories. +Files are kept flat and categorised with tags in `manifest.json` (for example `proof-of-stake`, `privacy`, +`defi`) rather than folders, so one paper can belong to several categories. On EFS each file becomes an +item at a stable anchor, with its tags attached. -Retrieval addresses (IPFS CID / Arweave) for seeding onto EFS: see [`ADDRESSES.md`](./ADDRESSES.md). +Retrieval addresses (IPFS CIDs) for seeding onto EFS: see [`ADDRESSES.md`](./ADDRESSES.md). -## Manifest +| Project | Card | Paper file(s) | Tags | +|---|---|---|---| +| Bitcoin | `bitcoin.md` | `bitcoin.pdf` | store-of-value, payment, foundational | +| Ethereum | `ethereum.md` | `ethereum-whitepaper-2014.pdf` | smart-contract-platform, proof-of-stake, foundational | +| Solana | `solana.md` | `solana.pdf` | smart-contract-platform, proof-of-stake | +| XRP Ledger | `xrp-ripple.md` | `ripple-consensus-whitepaper.pdf` | payment | +| Cardano | `cardano.md` | `ouroboros.pdf` | smart-contract-platform, proof-of-stake | +| Polkadot | `polkadot.md` | `polkadot.pdf` | interoperability, proof-of-stake | +| Avalanche | `avalanche.md` | `avalanche-consensus.pdf`, `avalanche-platform.pdf` | smart-contract-platform, proof-of-stake | +| Cosmos | `cosmos.md` | `cosmos-whitepaper.md` | interoperability, proof-of-stake | +| Algorand | `algorand.md` | `algorand.pdf` | smart-contract-platform, proof-of-stake | +| Tezos | `tezos.md` | `tezos-whitepaper.pdf`, `tezos-position-paper.pdf` | smart-contract-platform, proof-of-stake | +| Polygon | `polygon.md` | `matic-whitepaper.md`, `matic-litepaper.pdf` | smart-contract-platform, scaling, proof-of-stake | +| Chainlink | `chainlink.md` | `chainlink-whitepaper-v1.pdf` | oracle | +| Uniswap | `uniswap.md` | `uniswap-v2-core.pdf`, `uniswap-v3-core.pdf` | defi | +| Filecoin | `filecoin.md` | `filecoin.pdf` | storage | +| Monero | `monero.md` | `cryptonote.pdf` | privacy | +| Zcash | `zcash.md` | `zerocash.pdf` | privacy | +| Litecoin | `litecoin.md` | none (no whitepaper) | payment | +| Dogecoin | `dogecoin.md` | none (no whitepaper) | payment | +| TRON | `tron.md` | none (official whitepaper linked) | smart-contract-platform, proof-of-stake | +| BNB | `binance-bnb.md` | none (official whitepaper linked) | smart-contract-platform, proof-of-stake | -Each coin has a markdown page (summary, authors, year, source, license) and — where a real whitepaper exists and is redistributable — the PDF. - -| Coin | Markdown | PDF | Tags | Notes | -|---|---|---|---|---| -| Bitcoin | `bitcoin.md` | `bitcoin.pdf` | store-of-value, payment | canonical; public IPFS CID exists | -| Ethereum | `ethereum.md` | `ethereum-whitepaper-2014.pdf` | smart-contract-platform | | -| Solana | `solana.md` | `solana.pdf` | smart-contract-platform | | -| XRP / Ripple | `xrp-ripple.md` | `ripple-consensus-whitepaper.pdf` | payment | | -| Cardano | `cardano.md` | `ouroboros.pdf` | smart-contract-platform, proof-of-stake | Ouroboros paper | -| Polkadot | `polkadot.md` | `polkadot.pdf` | interoperability | | -| Avalanche | `avalanche.md` | `avalanche-consensus.pdf`, `avalanche-platform.pdf` | interoperability | | -| Cosmos | `cosmos.md`, `cosmos-whitepaper.md` | — | interoperability | | -| Algorand | `algorand.md` | `algorand.pdf` | smart-contract-platform | | -| Tezos | `tezos.md` | `tezos-whitepaper.pdf`, `tezos-position-paper.pdf` | smart-contract-platform | | -| Polygon | `polygon.md`, `matic-whitepaper.md` | `matic-litepaper.pdf` | smart-contract-platform, scaling | | -| Chainlink | `chainlink.md` | `chainlink-whitepaper-v1.pdf` | oracle | | -| Uniswap | `uniswap.md` | `uniswap-v2-core.pdf`, `uniswap-v3-core.pdf` | defi | | -| Filecoin | `filecoin.md` | `filecoin.pdf` | storage | | -| Monero | `monero.md` | `cryptonote.pdf` | privacy | CryptoNote paper | -| Zcash | `zcash.md` | `zerocash.pdf` | privacy | Zerocash preprint | -| Litecoin | `litecoin.md` | — | store-of-value, payment | no real whitepaper (Bitcoin fork) | -| Dogecoin | `dogecoin.md` | — | store-of-value, payment | no real whitepaper | -| Tron | `tron.md` | — | smart-contract-platform | link-only — plagiarism flag, review before use | -| BNB / Binance | `binance-bnb.md` | — | exchange-chain | link-only — no open license | - -## License note -Most papers are freely redistributable (Bitcoin freely distributable; Ethereum CC-BY; academic preprints from arXiv/IACR). PDFs intentionally omitted where the license is restrictive/unclear (Tron, BNB) — markdown + source link only. See each markdown page for per-item license status. +Each card records where its paper came from. EFS does not own or relicense these works. diff --git a/datasets/crypto-whitepapers/algorand.md b/datasets/crypto-whitepapers/algorand.md index ff6d5a2..d3c1685 100644 --- a/datasets/crypto-whitepapers/algorand.md +++ b/datasets/crypto-whitepapers/algorand.md @@ -1,20 +1,23 @@ # Algorand -- **Title:** Algorand: Scaling Byzantine Agreements for Cryptocurrencies - **Project:** Algorand -- **Author(s):** Jing Chen, Silvio Micali (foundational theory); related work by Gilad et al. -- **Year:** 2017 (IACR ePrint 2017/454) +- **Paper:** *Algorand: Scaling Byzantine Agreements for Cryptocurrencies* +- **Authors:** Yossi Gilad, Rotem Hemo, Silvio Micali, Georgios Vlachos, Nickolai Zeldovich (MIT CSAIL) +- **Year:** 2017 (SOSP 2017; IACR ePrint 2017/454) - **Canonical source:** https://eprint.iacr.org/2017/454 -- **License / distribution:** Academic preprint on the IACR Cryptology ePrint Archive; freely available. - Included as an academic preprint. -- **File:** `algorand.pdf` (fetched and validated) +- **File in this folder:** `algorand.pdf` (the ePrint revision of 24 September 2017) +- **Related work:** Jing Chen and Silvio Micali's earlier theory paper, *Algorand* (2016, + https://arxiv.org/abs/1607.01341), introduced the underlying ideas. ## Summary -Algorand, originated by Turing Award winner Silvio Micali, is a pure proof-of-stake protocol that aims to -reach consensus with both high speed and strong security while avoiding forks. Its key idea is -**cryptographic sortition**: in each round a small committee of users is selected secretly and at random, -weighted by stake, using verifiable random functions, so that participants prove their own selection only -after the fact. This lets the network run a Byzantine agreement that scales to many users, confirms blocks -quickly, and resists attackers who cannot predict or target the committee in advance. The result is a -permissionless ledger with negligible forking probability and low computational cost. +This paper presents Algorand as a cryptocurrency that confirms transactions in about a minute while scaling +to many users, and in which users never see conflicting confirmed transactions, even if some are malicious +or the network is temporarily partitioned. It uses a new Byzantine Agreement protocol run by a small +committee. Committee members are chosen by **cryptographic sortition**: each user privately checks, using a +verifiable random function weighted by stake, whether they have been selected, and includes a proof of that +selection in their messages. + +Because participants keep no private state apart from their keys, they can be replaced after every message, +which protects against attacks on known committee members. Silvio Micali, a Turing Award winner and MIT +professor, founded Algorand in 2017, and its main network launched in June 2019. diff --git a/datasets/crypto-whitepapers/avalanche.md b/datasets/crypto-whitepapers/avalanche.md index 4a81ed5..fedf369 100644 --- a/datasets/crypto-whitepapers/avalanche.md +++ b/datasets/crypto-whitepapers/avalanche.md @@ -1,23 +1,27 @@ # Avalanche -- **Title:** Snowflake to Avalanche: A Novel Metastable Consensus Protocol Family for Cryptocurrencies - (consensus); plus the Ava Labs Avalanche Platform whitepaper - **Project:** Avalanche (Ava Labs) -- **Author(s):** Team Rocket (pseudonymous, consensus paper); Ava Labs (platform paper) -- **Year:** 2018–2020 (consensus paper 2018; arXiv 1906.08936, 2019; platform paper 2020) -- **Canonical source:** https://arxiv.org/abs/1906.08936 (consensus); - https://www.avalabs.org/whitepapers (platform) -- **License / distribution:** Consensus paper hosted on arXiv (freely available preprint); platform paper - freely published by Ava Labs. Included as freely-distributed documents. -- **Files:** `avalanche-consensus.pdf` (arXiv), `avalanche-platform.pdf` (Ava Labs) — both fetched and validated +- **Papers:** + - *Scalable and Probabilistic Leaderless BFT Consensus through Metastability*: Team Rocket, Maofan Yin, + Kevin Sekniqi, Robbert van Renesse, Emin Gün Sirer (Cornell University). arXiv:1906.08936v2, 2020. + - *Avalanche Platform*: Kevin Sekniqi, Daniel Laine, Stephen Buttolph, Emin Gün Sirer. 30 June 2020. +- **Year:** 2020 (the consensus protocol was first described by the pseudonymous "Team Rocket" in 2018) +- **Canonical sources:** https://arxiv.org/abs/1906.08936 (consensus paper); + https://assets.website-files.com/5d80307810123f5ffbb34d6e/6008d7bbf8b10d1eb01e7e16_Avalanche%20Platform%20Whitepaper.pdf + (platform paper, as published by Ava Labs) +- **Files in this folder:** `avalanche-consensus.pdf` (arXiv v2, byte-identical) and `avalanche-platform.pdf` + (byte-identical to the Ava Labs copy) ## Summary -Avalanche introduced a new family of **leaderless, metastable consensus protocols** — Slush, Snowflake, -Snowball, and Avalanche — based on repeated randomized sub-sampling of the network: each node repeatedly -queries small random samples of peers and shifts its preference toward the majority answer, rapidly driving -the whole network to an irreversible decision with high probability. This achieves Byzantine-fault-tolerant -agreement that is highly scalable and quick to finalize without a leader or proof-of-work, while gracefully -tolerating large numbers of participants. The Avalanche platform paper builds a multi-chain network (the -X-Chain, P-Chain, and C-Chain) on this consensus, supporting custom subnets and EVM-compatible smart -contracts. +The consensus paper introduces the **Snow** family of leaderless Byzantine-fault-tolerant protocols (Slush, +Snowflake, Snowball and Avalanche). Each node repeatedly asks a small random sample of other nodes for their +preference and shifts towards the majority answer. This quickly tips the whole network into agreement with +high probability, without a leader and without proof-of-work, and no node has to process more than a +logarithmic amount of data per decision. The paper reports about 3,400 transactions per second in a large +deployment. + +The platform paper describes the first release of the Avalanche network (codenamed "Borealis"). It splits +the system into chains, execution environments and validator sets called **subnets**, where each subnet +validates one or more blockchains and the AVAX token secures the network. Avalanche's mainnet launched in +September 2020. diff --git a/datasets/crypto-whitepapers/binance-bnb.md b/datasets/crypto-whitepapers/binance-bnb.md index bef562b..67d7966 100644 --- a/datasets/crypto-whitepapers/binance-bnb.md +++ b/datasets/crypto-whitepapers/binance-bnb.md @@ -1,22 +1,22 @@ -# BNB (Binance) — FLAGGED (PDF intentionally NOT included) +# BNB (BNB Chain) -- **Title:** Binance Exchange Whitepaper (v1.1) -- **Project:** Binance / BNB -- **Author(s):** Binance -- **Year:** 2017 (released ~June 2017, ahead of the BNB ICO) -- **Canonical source:** Originally distributed by Binance for its 2017 ICO. (Third-party mirrors exist; - Binance's current authoritative research page is https://www.binance.com/en/research/projects/bnb.) -- **License / distribution:** **UNCLEAR / RESTRICTIVE — FLAGGED FOR JAMES.** This is a commercial exchange - document with no stated open/redistribution license. Per the dataset's "when in doubt, link don't copy" - rule, the PDF is **not** included. -- **File:** **none — intentionally omitted pending James's decision.** +- **Project:** BNB and BNB Smart Chain (formerly Binance Smart Chain) +- **Paper:** *BNB Smart Chain* whitepaper (undated; maintained by BNB Chain) +- **Author:** BNB Chain (no individual authors listed) +- **Year:** BNB launched in 2017; BNB Smart Chain launched on 1 September 2020 +- **Canonical source:** https://github.com/bnb-chain/whitepaper +- **File in this folder:** this card only (the whitepaper is linked above) ## Summary -BNB launched in 2017 as the native token of the Binance cryptocurrency exchange via an ICO that sold 100 -million tokens. The original document is an exchange/ICO whitepaper describing BNB's utility (trading-fee -discounts, etc.) and a planned periodic **coin burn** reducing supply over time, rather than a novel -protocol design — BNB began as an ERC-20 token before migrating to Binance's own chains (Binance Chain / -BNB Smart Chain). It is included in this dataset for completeness as a major asset, but its whitepaper is a -corporate document of uncertain redistribution status, so only this summary and the canonical pointer are -provided. +BNB was launched in July 2017 by the Binance cryptocurrency exchange, founded that year by Changpeng Zhao +and Yi He. It began as a token on Ethereum used to pay fees on the exchange, and Binance raised about +$15 million selling it in an initial coin offering. In 2019 BNB moved to Binance's own Binance Chain, and in +September 2020 Binance launched Binance Smart Chain, an Ethereum-compatible chain built from go-ethereum. +Both chains were renamed under the BNB Chain brand in 2022. + +The whitepaper describes BNB Smart Chain's **Proof of Staked Authority** consensus, which combines +delegated proof-of-stake with proof-of-authority: BNB holders stake to elect a small set of validators, +which take turns producing blocks. It also covers EVM compatibility, staking and governance, and a mechanism +that burns part of each block's gas fees. The original Binance Chain (later BNB Beacon Chain) was shut down +in December 2024 after its functions were merged into BNB Smart Chain. diff --git a/datasets/crypto-whitepapers/bitcoin.md b/datasets/crypto-whitepapers/bitcoin.md index ca40685..67f923b 100644 --- a/datasets/crypto-whitepapers/bitcoin.md +++ b/datasets/crypto-whitepapers/bitcoin.md @@ -1,21 +1,21 @@ # Bitcoin -- **Title:** Bitcoin: A Peer-to-Peer Electronic Cash System - **Project:** Bitcoin -- **Author(s):** Satoshi Nakamoto (pseudonym) +- **Paper:** *Bitcoin: A Peer-to-Peer Electronic Cash System* +- **Author:** Satoshi Nakamoto (pseudonym) - **Year:** 2008 - **Canonical source:** https://bitcoin.org/bitcoin.pdf -- **License / distribution:** Clean. Published openly on bitcoin.org; the paper is freely distributable - and the surrounding software is MIT-licensed. Universally mirrored. Safe to redistribute. -- **File:** `bitcoin.pdf` (9 pages, fetched and validated) +- **File in this folder:** `bitcoin.pdf` (9 pages; byte-identical to the bitcoin.org copy) ## Summary -Bitcoin introduced the first practical decentralized digital currency, allowing online payments to be -sent directly between parties without going through a financial institution. Its core contribution is a -solution to the double-spending problem using a peer-to-peer network that timestamps transactions into an -ongoing chain of hash-based proof-of-work, forming a record that cannot be changed without redoing the -work. The longest chain serves both as proof of the sequence of events and as proof that it came from the -largest pool of CPU power, so honest nodes controlling a majority of compute outpace attackers. New coins -are introduced as an incentive for nodes to support the network (mining). The paper laid the foundation -for essentially the entire cryptocurrency field. +The Bitcoin whitepaper describes the first practical decentralized digital currency: online payments sent +directly between parties without a financial institution in the middle. Its core contribution is a solution +to the double-spending problem using a peer-to-peer network that timestamps transactions into an ongoing +chain of hash-based proof-of-work. The longest chain serves both as the record of what happened and as proof +that it came from the largest pool of CPU power, so as long as honest nodes control most of that power they +outpace attackers. + +New coins are issued as a reward to the nodes that do this work (mining), which gives them an incentive to +keep the network honest. The network launched in January 2009, and the nine-page paper became the starting +point for the whole cryptocurrency field. diff --git a/datasets/crypto-whitepapers/cardano.md b/datasets/crypto-whitepapers/cardano.md index 21ccc7f..7b90324 100644 --- a/datasets/crypto-whitepapers/cardano.md +++ b/datasets/crypto-whitepapers/cardano.md @@ -1,20 +1,21 @@ # Cardano (Ouroboros) -- **Title:** Ouroboros: A Provably Secure Proof-of-Stake Blockchain Protocol -- **Project:** Cardano (consensus protocol underlying it) -- **Author(s):** Aggelos Kiayias, Alexander Russell, Bernardo David, Roman Oliynykov -- **Year:** 2016 (IACR ePrint 2016/889; also CRYPTO 2017) +- **Project:** Cardano +- **Paper:** *Ouroboros: A Provably Secure Proof-of-Stake Blockchain Protocol* +- **Authors:** Aggelos Kiayias, Alexander Russell, Bernardo David, Roman Oliynykov +- **Year:** 2016 (IACR ePrint 2016/889; published at CRYPTO 2017) - **Canonical source:** https://eprint.iacr.org/2016/889 -- **License / distribution:** Academic preprint hosted on the IACR Cryptology ePrint Archive; freely - available for download. Included as an academic preprint. -- **File:** `ouroboros.pdf` (fetched and validated) +- **File in this folder:** `ouroboros.pdf` (the ePrint revision of 20 July 2019) ## Summary -Ouroboros is the proof-of-stake consensus protocol that underpins Cardano, and it was the first PoS -protocol to come with a rigorous, peer-reviewed security proof. Instead of mining, the protocol divides -time into epochs and slots and uses a secure, verifiable coin-flipping procedure to elect slot leaders in -proportion to stake, who then produce blocks. The paper proves that, under an honest-majority-of-stake -assumption, the protocol achieves the same persistence and liveness guarantees as proof-of-work without its -energy cost. Cardano itself is a layered smart-contract platform built on this foundation; note that the -file here is the underlying consensus paper rather than a product brochure. +Ouroboros is the proof-of-stake consensus protocol that underpins Cardano. The paper describes it as the +first blockchain protocol based on proof of stake with rigorous security guarantees. Instead of mining, time +is divided into epochs and slots, and a secure multiparty coin-flipping procedure elects a slot leader for +each slot in proportion to stake; that leader produces the block. The paper proves that, if a majority of +stake is honest, the protocol achieves persistence and liveness comparable to Bitcoin's, and it adds a +reward scheme under which honest behaviour is an approximate Nash equilibrium. + +Cardano, developed by IOHK (co-founded by Charles Hoskinson), launched in September 2017 and added smart +contracts in September 2021. This file is the underlying research paper rather than a Cardano-branded +overview. diff --git a/datasets/crypto-whitepapers/chainlink.md b/datasets/crypto-whitepapers/chainlink.md index 49c5ab6..02b2deb 100644 --- a/datasets/crypto-whitepapers/chainlink.md +++ b/datasets/crypto-whitepapers/chainlink.md @@ -1,21 +1,21 @@ # Chainlink -- **Title:** ChainLink: A Decentralized Oracle Network (v1.0) - **Project:** Chainlink -- **Author(s):** Steve Ellis, Ari Juels, Sergey Nazarov -- **Year:** 2017 (September 4, 2017) +- **Paper:** *ChainLink: A Decentralized Oracle Network* (v1.0) +- **Authors:** Steve Ellis, Ari Juels, Sergey Nazarov +- **Year:** 2017 (dated 4 September 2017) - **Canonical source:** https://research.chain.link/whitepaper-v1.pdf -- **License / distribution:** Freely published via research.chain.link. Included as a freely-distributed - project whitepaper. -- **File:** `chainlink-whitepaper-v1.pdf` (fetched and validated) +- **File in this folder:** `chainlink-whitepaper-v1.pdf` (byte-identical to the research.chain.link copy) ## Summary -Smart contracts cannot natively access external data (prices, events, APIs) or off-chain computation, and a -single centralized oracle reintroduces a single point of failure. Chainlink's whitepaper proposes a -**decentralized oracle network**: many independent oracle nodes retrieve and report data, with on-chain and -off-chain components, an aggregation mechanism, and a **reputation/penalty system** to incentivize honest, -reliable reporting. By sourcing answers from multiple independent providers and aggregating them, the system -delivers tamper-resistant data feeds to contracts. Chainlink became the dominant oracle infrastructure for -DeFi and beyond; a later "Chainlink 2.0" whitepaper expands the vision to decentralized off-chain -computation. +Smart contracts cannot fetch outside data (prices, events, web APIs) on their own, and relying on a single +centralized "oracle" to supply it brings back a single point of failure. The Chainlink whitepaper proposes a +**decentralized oracle network**: many independent nodes retrieve and report data, and their answers are +aggregated, either by an on-chain contract or by a more efficient off-chain consensus mechanism. A +reputation system and security monitoring help users choose reliable providers, and the LINK token pays node +operators. + +Chainlink became widely used to supply price feeds and other data to decentralized-finance applications. A +second whitepaper, *Chainlink 2.0: Next Steps in the Evolution of Decentralized Oracle Networks*, followed in +April 2021. diff --git a/datasets/crypto-whitepapers/cosmos-whitepaper.md b/datasets/crypto-whitepapers/cosmos-whitepaper.md index 7572ed6..fb65b2d 100644 --- a/datasets/crypto-whitepapers/cosmos-whitepaper.md +++ b/datasets/crypto-whitepapers/cosmos-whitepaper.md @@ -1,3 +1,5 @@ +> Full text of *Cosmos: A Network of Distributed Ledgers* (Jae Kwon and Ethan Buchman, 2016), copied verbatim from `WHITEPAPER.md` in https://github.com/cosmos/cosmos, where it is published as Markdown. + # Cosmos **A Network of Distributed Ledgers** diff --git a/datasets/crypto-whitepapers/cosmos.md b/datasets/crypto-whitepapers/cosmos.md index 3d293f7..c066948 100644 --- a/datasets/crypto-whitepapers/cosmos.md +++ b/datasets/crypto-whitepapers/cosmos.md @@ -1,20 +1,19 @@ # Cosmos -- **Title:** Cosmos: A Network of Distributed Ledgers - **Project:** Cosmos (Tendermint / Interchain Foundation) -- **Author(s):** Jae Kwon, Ethan Buchman +- **Paper:** *Cosmos: A Network of Distributed Ledgers* +- **Authors:** Jae Kwon, Ethan Buchman - **Year:** 2016 -- **Canonical source:** https://github.com/cosmos/cosmos (and https://cosmos.network/resources/whitepaper) -- **License / distribution:** Open-source repository content from the Cosmos project; freely available. - Included as the project's own published whitepaper. (Distributed as Markdown in the repo.) -- **File:** `cosmos-whitepaper.md` (fetched from the project's GitHub repo) +- **Canonical source:** https://github.com/cosmos/cosmos/blob/master/WHITEPAPER.md +- **File in this folder:** `cosmos-whitepaper.md` (the full text, identical to `WHITEPAPER.md` in the + Cosmos repository, where the whitepaper is published as Markdown) ## Summary -Cosmos describes an "Internet of Blockchains": a network of independent, application-specific chains -("zones") that can interoperate through a central **Hub** using the **Inter-Blockchain Communication (IBC)** -protocol. Its foundation is **Tendermint**, a Byzantine-fault-tolerant proof-of-stake consensus engine that -provides fast finality and is decoupled from the application layer via the ABCI interface, so developers can -build chains without re-implementing consensus and networking. Rather than forcing everything onto one -chain, Cosmos envisions many sovereign chains exchanging tokens and data. It is included here as Markdown, -which doubles as a clean demonstration of EFS's "markdown file" support. +Cosmos describes a network of independent blockchains ("zones") that connect to a central **Hub** and +exchange tokens and data through the **Inter-Blockchain Communication (IBC)** protocol, instead of putting +every application on one chain. Its foundation is **Tendermint**, a Byzantine-fault-tolerant +proof-of-stake consensus engine with fast finality. Tendermint is separated from the application through +an interface called ABCI, so developers can build a chain without re-implementing consensus and networking. + +The Cosmos Hub, the first chain in the network, launched in 2019, with ATOM as its staking token. diff --git a/datasets/crypto-whitepapers/dogecoin.md b/datasets/crypto-whitepapers/dogecoin.md index 6c73ee9..a1ee55c 100644 --- a/datasets/crypto-whitepapers/dogecoin.md +++ b/datasets/crypto-whitepapers/dogecoin.md @@ -1,18 +1,18 @@ # Dogecoin -- **Title:** (no whitepaper exists) - **Project:** Dogecoin -- **Author(s):** Billy Markus and Jackson Palmer -- **Year:** 2013 (launched December 6, 2013) -- **Canonical source:** https://dogecoin.com -- **License / distribution:** N/A — there is no whitepaper to license. -- **File:** none — **flagged: no whitepaper exists** (created as a joke; this is accurate) +- **Paper:** none; Dogecoin was released as software without a whitepaper +- **Creators:** Billy Markus and Jackson Palmer +- **Year:** 2013 (launched 6 December 2013) +- **Official site:** https://dogecoin.com +- **File in this folder:** this card only ## Summary -Dogecoin was created in late 2013 by software engineers Billy Markus and Jackson Palmer as a deliberate -joke, parodying the speculative frenzy around cryptocurrencies and built around the popular "Doge" Shiba -Inu meme. Technically it derives from Luckycoin/Litecoin (scrypt-based proof-of-work) but it arrived with -no whitepaper, no roadmap, and no grand technical claims — its identity is a "fun and friendly internet -currency." Despite (or because of) its origins it became one of the most widely held cryptocurrencies. It -is included here specifically to flag, honestly, that no whitepaper has ever existed for it. +Dogecoin was created by software engineers Billy Markus and Jackson Palmer as a light-hearted +cryptocurrency themed on the "Doge" Shiba Inu internet meme. Markus based its code on Luckycoin and +Litecoin, so it uses a **scrypt** proof-of-work like Litecoin, but with one-minute blocks. + +Unlike Bitcoin and Litecoin, Dogecoin has no supply cap. A planned limit of 100 billion coins was dropped in +2014, and the block reward is now a fixed 10,000 DOGE, which adds about 5 billion coins a year. Since 2014, +Dogecoin has been merge-mined with Litecoin, so the same mining work can secure both chains. diff --git a/datasets/crypto-whitepapers/ethereum.md b/datasets/crypto-whitepapers/ethereum.md index b7e4e1b..3c03999 100644 --- a/datasets/crypto-whitepapers/ethereum.md +++ b/datasets/crypto-whitepapers/ethereum.md @@ -1,21 +1,22 @@ # Ethereum -- **Title:** Ethereum: A Next-Generation Smart Contract and Decentralized Application Platform - **Project:** Ethereum -- **Author(s):** Vitalik Buterin -- **Year:** 2014 (originally circulated late 2013) +- **Paper:** *Ethereum: A Next-Generation Smart Contract and Decentralized Application Platform* +- **Author:** Vitalik Buterin +- **Year:** 2014 (first circulated in late 2013) - **Canonical source:** https://ethereum.org/en/whitepaper/ -- **License / distribution:** Clean. Published via ethereum.org and the original Ethereum wiki under a - Creative Commons Attribution (CC-BY) license; freely redistributable with attribution. -- **File:** `ethereum-whitepaper-2014.pdf` (fetched and validated) +- **File in this folder:** `ethereum-whitepaper-2014.pdf` (the PDF edition published by ethereum.org; + byte-identical to https://ethereum.org/content/whitepaper/whitepaper-pdf/Ethereum_Whitepaper_-_Buterin_2014.pdf) ## Summary -The Ethereum whitepaper proposed a blockchain with a built-in Turing-complete programming language, -letting anyone write smart contracts and decentralized applications that define their own rules for -ownership, transaction formats, and state transitions. Where Bitcoin's scripting is intentionally limited, -Ethereum generalizes the blockchain into a global state machine: accounts hold code and storage, and -transactions trigger deterministic computation paid for in "gas." This made possible tokens, DAOs, -financial instruments, and applications far beyond payments. ethereum.org notes the 2014 paper predates the -live network and no longer reflects current Ethereum, but it remains the foundational vision document for -the entire smart-contract ecosystem. +The Ethereum whitepaper proposes a blockchain with a built-in Turing-complete programming language, so that +anyone can write smart contracts and decentralized applications with their own rules for ownership, +transaction formats and state transitions. Where Bitcoin's scripting is deliberately limited, Ethereum turns +the blockchain into a general-purpose state machine: accounts hold code and storage, and transactions +trigger deterministic computation paid for in "gas". The paper sketches applications such as tokens, +financial contracts, decentralized autonomous organizations and name registries. + +The network went live on 30 July 2015 using proof-of-work, and switched to proof-of-stake in "The Merge" on +15 September 2022. ethereum.org notes that the 2014 paper predates the live network and no longer +describes how Ethereum works today, but it remains the founding document of the smart-contract ecosystem. diff --git a/datasets/crypto-whitepapers/filecoin.md b/datasets/crypto-whitepapers/filecoin.md index e494088..3f57404 100644 --- a/datasets/crypto-whitepapers/filecoin.md +++ b/datasets/crypto-whitepapers/filecoin.md @@ -1,21 +1,21 @@ # Filecoin -- **Title:** Filecoin: A Decentralized Storage Network - **Project:** Filecoin (Protocol Labs) -- **Author(s):** Protocol Labs (Juan Benet et al.) -- **Year:** 2017 (July 2017) -- **Canonical source:** https://filecoin.io/filecoin.pdf -- **License / distribution:** Freely published by Protocol Labs; the Filecoin/IPFS papers are released under - a Creative Commons license. Included as a freely-distributed project whitepaper. -- **File:** `filecoin.pdf` (36 pages; fetched and validated — content confirmed as the Filecoin DSN paper) +- **Paper:** *Filecoin: A Decentralized Storage Network* +- **Author:** Protocol Labs +- **Year:** 2017 (dated 19 July 2017; an earlier Filecoin paper appeared in 2014) +- **Canonical source:** https://research.protocol.ai/publications/filecoin-a-decentralized-storage-network/ +- **File in this folder:** `filecoin.pdf` (36 pages; same text as the Protocol Labs copy, in a + recompressed PDF) ## Summary Filecoin is a decentralized storage network that turns cloud storage into an open market. Clients pay -storage and retrieval miners to store and serve files; miners earn the FIL token and prove they are doing -the job honestly. Its core cryptographic contributions are **Proof-of-Replication (PoRep)**, which proves a -miner has stored a unique physical copy of the client's data, and **Proof-of-Spacetime (PoSt)**, which -proves the data continued to be stored over a period of time. These proofs let the blockchain verify storage -without trusting the miner, and the network's useful work (storing real data) doubles as its consensus -security. Filecoin is built on top of IPFS content addressing. (Notably, its papers are the ones Tron was -accused of plagiarizing — see `../smart-contract-platforms/tron.md`.) +storage miners to keep their data and retrieval miners to serve it, and miners earn the network's token +(also called Filecoin) for doing so. A miner's mining power is proportional to the storage it actively +provides, so the network's "work" is useful in itself. + +The paper's main cryptographic contributions are **Proof-of-Replication**, which proves that a miner has +stored a unique physical copy of a client's data, and **Proof-of-Spacetime**, which proves that the data +stayed stored over time. These proofs let the blockchain check storage without trusting the miner. +Filecoin is designed to work alongside IPFS, Protocol Labs' content-addressed file system. diff --git a/datasets/crypto-whitepapers/litecoin.md b/datasets/crypto-whitepapers/litecoin.md index 848f75b..7ae01b3 100644 --- a/datasets/crypto-whitepapers/litecoin.md +++ b/datasets/crypto-whitepapers/litecoin.md @@ -1,18 +1,20 @@ # Litecoin -- **Title:** (no formal whitepaper exists) - **Project:** Litecoin -- **Author(s):** Charlie Lee -- **Year:** 2011 (network launch October 2011) -- **Canonical source:** https://litecoin.org -- **License / distribution:** N/A — there is no whitepaper to license. -- **File:** none — **flagged: no whitepaper exists** (this is accurate, not a fetch failure) +- **Paper:** none; Litecoin was released as software without a whitepaper +- **Creator:** Charlie Lee +- **Year:** 2011 (first released on GitHub on 7 October 2011) +- **Official site:** https://litecoin.org +- **File in this folder:** this card only ## Summary -Litecoin was created by Charlie Lee in 2011 as a fork of the Bitcoin Core client. It was never accompanied -by a formal academic-style whitepaper; instead it was released as open-source software with a design that -deliberately mirrors Bitcoin while changing a few parameters: a faster ~2.5-minute block time, a larger -maximum coin supply (84 million), and the **scrypt** hashing algorithm in place of SHA-256 (intended at the -time to be more resistant to specialized ASIC mining). It is often described as "silver to Bitcoin's gold." -Because no whitepaper was ever written, this entry exists to document that fact rather than to host a file. +Litecoin was created by Charlie Lee, a former Google engineer, as a fork of Bitcoin's code. It keeps +Bitcoin's overall design (a proof-of-work blockchain with a fixed supply) but changes a few parameters: +blocks arrive every 2.5 minutes instead of 10, the maximum supply is 84 million coins instead of 21 million, +and mining uses the **scrypt** hash function instead of SHA-256. The block reward started at 50 LTC and +halves every 840,000 blocks. + +Because there is no Litecoin whitepaper, its design is defined by its code and Bitcoin's paper. Dogecoin +has been merge-mined with Litecoin since 2014, and in May 2022 Litecoin activated the MimbleWimble Extension +Blocks (MWEB) upgrade, which adds optional confidential transactions. diff --git a/datasets/crypto-whitepapers/manifest.json b/datasets/crypto-whitepapers/manifest.json index 133c9f8..0054d30 100644 --- a/datasets/crypto-whitepapers/manifest.json +++ b/datasets/crypto-whitepapers/manifest.json @@ -7,29 +7,29 @@ "files": [ { "path": "bitcoin.md", "name": "bitcoin.md", "contentType": "text/markdown", "tags": ["store-of-value", "payment", "foundational"] }, { "path": "bitcoin.pdf", "name": "bitcoin.pdf", "contentType": "application/pdf", "tags": ["store-of-value", "payment", "foundational"] }, - { "path": "ethereum.md", "name": "ethereum.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "foundational"] }, - { "path": "ethereum-whitepaper-2014.pdf", "name": "ethereum-whitepaper-2014.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "foundational"] }, - { "path": "solana.md", "name": "solana.md", "contentType": "text/markdown", "tags": ["smart-contract-platform"] }, - { "path": "solana.pdf", "name": "solana.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform"] }, + { "path": "ethereum.md", "name": "ethereum.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake", "foundational"] }, + { "path": "ethereum-whitepaper-2014.pdf", "name": "ethereum-whitepaper-2014.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake", "foundational"] }, + { "path": "solana.md", "name": "solana.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "solana.pdf", "name": "solana.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, { "path": "xrp-ripple.md", "name": "xrp-ripple.md", "contentType": "text/markdown", "tags": ["payment"] }, { "path": "ripple-consensus-whitepaper.pdf", "name": "ripple-consensus-whitepaper.pdf", "contentType": "application/pdf", "tags": ["payment"] }, { "path": "cardano.md", "name": "cardano.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, { "path": "ouroboros.pdf", "name": "ouroboros.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, - { "path": "polkadot.md", "name": "polkadot.md", "contentType": "text/markdown", "tags": ["interoperability"] }, - { "path": "polkadot.pdf", "name": "polkadot.pdf", "contentType": "application/pdf", "tags": ["interoperability"] }, - { "path": "avalanche.md", "name": "avalanche.md", "contentType": "text/markdown", "tags": ["interoperability"] }, - { "path": "avalanche-consensus.pdf", "name": "avalanche-consensus.pdf", "contentType": "application/pdf", "tags": ["interoperability", "consensus"] }, - { "path": "avalanche-platform.pdf", "name": "avalanche-platform.pdf", "contentType": "application/pdf", "tags": ["interoperability", "platform"] }, - { "path": "cosmos.md", "name": "cosmos.md", "contentType": "text/markdown", "tags": ["interoperability"] }, - { "path": "cosmos-whitepaper.md", "name": "cosmos-whitepaper.md", "contentType": "text/markdown", "tags": ["interoperability"] }, - { "path": "algorand.md", "name": "algorand.md", "contentType": "text/markdown", "tags": ["smart-contract-platform"] }, - { "path": "algorand.pdf", "name": "algorand.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform"] }, - { "path": "tezos.md", "name": "tezos.md", "contentType": "text/markdown", "tags": ["smart-contract-platform"] }, - { "path": "tezos-whitepaper.pdf", "name": "tezos-whitepaper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform"] }, - { "path": "tezos-position-paper.pdf", "name": "tezos-position-paper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform"] }, - { "path": "polygon.md", "name": "polygon.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "scaling"] }, - { "path": "matic-whitepaper.md", "name": "matic-whitepaper.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "scaling"] }, - { "path": "matic-litepaper.pdf", "name": "matic-litepaper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "scaling"] }, + { "path": "polkadot.md", "name": "polkadot.md", "contentType": "text/markdown", "tags": ["interoperability", "proof-of-stake"] }, + { "path": "polkadot.pdf", "name": "polkadot.pdf", "contentType": "application/pdf", "tags": ["interoperability", "proof-of-stake"] }, + { "path": "avalanche.md", "name": "avalanche.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "avalanche-consensus.pdf", "name": "avalanche-consensus.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "avalanche-platform.pdf", "name": "avalanche-platform.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "cosmos.md", "name": "cosmos.md", "contentType": "text/markdown", "tags": ["interoperability", "proof-of-stake"] }, + { "path": "cosmos-whitepaper.md", "name": "cosmos-whitepaper.md", "contentType": "text/markdown", "tags": ["interoperability", "proof-of-stake"] }, + { "path": "algorand.md", "name": "algorand.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "algorand.pdf", "name": "algorand.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "tezos.md", "name": "tezos.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "tezos-whitepaper.pdf", "name": "tezos-whitepaper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "tezos-position-paper.pdf", "name": "tezos-position-paper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "polygon.md", "name": "polygon.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "scaling", "proof-of-stake"] }, + { "path": "matic-whitepaper.md", "name": "matic-whitepaper.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "scaling", "proof-of-stake"] }, + { "path": "matic-litepaper.pdf", "name": "matic-litepaper.pdf", "contentType": "application/pdf", "tags": ["smart-contract-platform", "scaling", "proof-of-stake"] }, { "path": "chainlink.md", "name": "chainlink.md", "contentType": "text/markdown", "tags": ["oracle"] }, { "path": "chainlink-whitepaper-v1.pdf", "name": "chainlink-whitepaper-v1.pdf", "contentType": "application/pdf", "tags": ["oracle"] }, { "path": "uniswap.md", "name": "uniswap.md", "contentType": "text/markdown", "tags": ["defi"] }, @@ -41,9 +41,9 @@ { "path": "cryptonote.pdf", "name": "cryptonote.pdf", "contentType": "application/pdf", "tags": ["privacy"] }, { "path": "zcash.md", "name": "zcash.md", "contentType": "text/markdown", "tags": ["privacy"] }, { "path": "zerocash.pdf", "name": "zerocash.pdf", "contentType": "application/pdf", "tags": ["privacy"] }, - { "path": "litecoin.md", "name": "litecoin.md", "contentType": "text/markdown", "tags": ["store-of-value", "payment"] }, - { "path": "dogecoin.md", "name": "dogecoin.md", "contentType": "text/markdown", "tags": ["store-of-value", "payment"] }, - { "path": "tron.md", "name": "tron.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "link-only", "flagged"] }, - { "path": "binance-bnb.md", "name": "binance-bnb.md", "contentType": "text/markdown", "tags": ["exchange-chain", "link-only", "flagged"] } + { "path": "litecoin.md", "name": "litecoin.md", "contentType": "text/markdown", "tags": ["payment"] }, + { "path": "dogecoin.md", "name": "dogecoin.md", "contentType": "text/markdown", "tags": ["payment"] }, + { "path": "tron.md", "name": "tron.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] }, + { "path": "binance-bnb.md", "name": "binance-bnb.md", "contentType": "text/markdown", "tags": ["smart-contract-platform", "proof-of-stake"] } ] } diff --git a/datasets/crypto-whitepapers/matic-whitepaper.md b/datasets/crypto-whitepapers/matic-whitepaper.md index ef8d0c6..88626d2 100644 --- a/datasets/crypto-whitepapers/matic-whitepaper.md +++ b/datasets/crypto-whitepapers/matic-whitepaper.md @@ -1,69 +1,61 @@ -# {#whitepaper} +> This is a converted copy of the Matic Whitepaper v1.1, taken from the `README.md` of +> https://github.com/maticnetwork/whitepaper, with its formatting cleaned up. The text is unchanged. -
-

Matic Whitepaper

-
+# Matic Whitepaper -
- [Whitepaper Version 1.1]

- Jaynti Kanani <jdkanani@matic.network>
- Sandeep Nailwal <sandeep@matic.network>
- Anurag Arjun <anurag@matic.network>
-
+Whitepaper Version 1.1 -# {#Abstract} -
-

Abstract

-
+- Jaynti Kanani (jdkanani@matic.network) +- Sandeep Nailwal (sandeep@matic.network) +- Anurag Arjun (anurag@matic.network) + +## Abstract -
Smart contract platforms and cryptocurrencies have captured mass attention but still have not been able to achieve mass adoption due to scalability and user experience issues. Even on Ethereum, which is the most widely used smart contracts platform, there have not been many examples of DApps which have seen mass adoption. There have been a few cases where one or the other particular application temporarily succeeded in achieving a significant user base, but it led to crippling of the entire network during the high network load times. Essentially this means that even the most advanced and widely used platforms are not ready for mass adoption yet. -

+ On the other hand, there are a few smart contract platforms which boast of higher transaction throughput, but they compromise on decentralization in order to improve transaction speeds. Also, many of the upcoming solutions propose developing their own blockchains, neglecting the billions of dollars of market cap that DApps and other projects have already created on platforms like Ethereum and others. More importantly, they neglect the massive developer community and developer ecosystem that currently exists on platforms like Ethereum. -

-Matic Network strives to solve the scalability and usability issues, while not compromising on decentralization and leveraging the existing developer community and ecosystem. It is an ​off/side chain scaling solution for existing platforms to provide scalability and superior user experience to DApps/user functionalities. -

-The Matic development team has chosen Ethereum as the first platform to showcase its scalability and already has a working implementation for Ethereum on Kovan Testnet. It is expected to allow near-instant transfers, exchange and conversion of digital assets (e.g. crypto tokens) and cryptocurrencies in the future. The Matic Network is an adapted implementation of the Plasma framework for Ethereum to start with, but the “vision” of the Matic development team is to provide off/side chain scaling solutions for blockchains in general. Matic foundation intends to provide Matic wallet, payment APIs & SDKs, products, identity solutions and other enabling solutions that will allow developers to design, implement and migrate DApps built on base platforms like Ethereum. One of the key pillars that form the basis of Matic Network’s ideology is the improvement of user experience, this area is poorly developed for Blockchain applications as of now. The Matic Development team has already built high quality user experience Mobile/Web browser libraries which will enable businesses to create real world end user applications on a large scale. The development roadmap of the Matic Network also includes supporting cross-chain transfers and third-party Decentralized exchanges, liquidity pools etc. -
-# Why Matic? {#whymatic} +**Matic Network strives to solve the scalability and usability issues, while not compromising on decentralization and leveraging the existing developer community and ecosystem. It is an off/side chain scaling solution for existing platforms to provide scalability and superior user experience to DApps/user functionalities.** + +**The Matic development team has chosen Ethereum as the first platform to showcase its scalability and already has a working implementation for Ethereum on Kovan Testnet.** It is expected to allow near-instant transfers, exchange and conversion of digital assets (e.g. crypto tokens) and cryptocurrencies in the future. The Matic Network is an adapted implementation of the Plasma framework for Ethereum to start with, but the “vision” of the Matic development team is to provide off/side chain scaling solutions for blockchains in general. Matic foundation intends to provide Matic wallet, payment APIs & SDKs, products, identity solutions and other enabling solutions that will allow developers to design, implement and migrate DApps built on base platforms like Ethereum. One of the key pillars that form the basis of Matic Network’s ideology is the improvement of user experience, this area is poorly developed for Blockchain applications as of now. The Matic Development team has already built high quality user experience Mobile/Web browser libraries which will enable businesses to create real world end user applications on a large scale. The development roadmap of the Matic Network also includes supporting cross-chain transfers and third-party Decentralized exchanges, liquidity pools etc. + +## Why Matic? Decentralized Apps are being proposed in large numbers, but the current blockchain ecosystem is not prepared to scale to match the demands of end user applications with mass adoption. Moreover the user experience of DApps is very poor and in no way conducive for average users. Slow block confirmations, high transaction fees, low scalability and poor user experience are some of the key roadblocks for the mass adoption of blockchain applications. The following section explains the problems prevailing in the current blockchain ecosystem and how the Matic Network intends to solve them. **Detailed technical specification are provided in the further sections of the white paper.** -### Slow Transactions {#slowt} +### Slow Transactions -Blockchain transactions are typically very slow and have a very limited throughput. Most PoW ([Proof-of-Work](https://en.wikipedia.org/wiki/Proof-of-work_system)) based blockchain protocols have a limit on the block size and it takes a certain amount of time to generate a block. Each transaction also has to wait for multiple block confirmations due to potential chain re-organizations.
+Blockchain transactions are typically very slow and have a very limited throughput. Most PoW ([Proof-of-Work](https://en.wikipedia.org/wiki/Proof-of-work_system)) based blockchain protocols have a limit on the block size and it takes a certain amount of time to generate a block. Each transaction also has to wait for multiple block confirmations due to potential chain re-organizations. -PoS ([Proof-of-Stake](https://github.com/ethereum/wiki/wiki/Proof-of-Stake-FAQs#what-is-proof-of-stake)) based blockchains try to counter these limitations using a staking mechanism, but the blockchains that are able to achieve high throughput with PoS are able to do so at the cost of decentralization. These limitations are often a necessary condition for public blockchains to ensure security and decentralization where a block needs to be propagated through the network and validated by all the nodes to achieve finality.
+PoS ([Proof-of-Stake](https://github.com/ethereum/wiki/wiki/Proof-of-Stake-FAQs#what-is-proof-of-stake)) based blockchains try to counter these limitations using a staking mechanism, but the blockchains that are able to achieve high throughput with PoS are able to do so at the cost of decentralization. These limitations are often a necessary condition for public blockchains to ensure security and decentralization where a block needs to be propagated through the network and validated by all the nodes to achieve finality. The Matic Network solves this problem by using a high throughput blockchain with consensus provided by a selected set of Block Producers, chosen for every checkpoint by a set of Stakers. It then uses a Proof Of Stake layer to **validate the blocks and publish periodic proofs (merkle roots) of the blocks produced by the Block Producers to the Ethereum mainchain. This helps in achieving high level of decentralization while maintaining an extremely fast (< 2 seconds) block confirmation times.** +### Low Transaction Throughput -### Low Transaction Throughput {#ltt} +Public blockchains have to maintain a certain amount of time lag between the production of adjacent blocks so as to ensure ample time for block propagation. Also, the block size needs to be small so as to ensure quick propagation of the block through the network. This entails that the number of transactions in a particular block need to be fairly limited. -Public blockchains have to maintain a certain amount of time lag between the production of adjacent blocks so as to ensure ample time for block propagation. Also, the block size needs to be small so as to ensure quick propagation of the block through the network. This entails that the number of transactions in a particular block need to be fairly limited.
+The Matic Network solves this problem by using a **Block Producer layer to produce the blocks.** Block Producers enable the system to produce blocks at a very fast rate. The system ensures decentralization using PoS checkpoints which are pushed to the Mainchain (Ethereum serves as the mainchain for a start).**This enables The Matic Network to theoretically achieve up to 2^16 transactions per second on a single side chain.** -The Matic Network solves this problem by using a **Block Producer layer to produce the blocks.** Block Producers enable the system to produce blocks at a very fast rate. The system ensures decentralization using PoS checkpoints which are pushed to the Mainchain (Ethereum serves as the mainchain for a start).**This enables The Matic Network to theoretically achieve up to $$2^{16}$$ transactions per second on a single side chain.** +### Scalability -### Scalability {#scalability} - -As discussed in the previous section, The Matic Network easily achieves a theoretical speed of up to $$2^{16}$$ transactions per second on a single side chain. **In future, The Matic Network is expected to be able to easily add more side chains horizontally to increase the total number of transactions on the Matic Chain while using the same decentralized PoS layer.** +As discussed in the previous section, The Matic Network easily achieves a theoretical speed of up to 2^16 transactions per second on a single side chain. **In future, The Matic Network is expected to be able to easily add more side chains horizontally to increase the total number of transactions on the Matic Chain while using the same decentralized PoS layer.** Theoretically the Matic Network has the capacity for millions of transactions per second with the usage of multiple side chains. Also, the mechanism to do so has already been demonstrated with the first Matic proof-of-concept with the first Matic side-chain and new chains can be added in due course of time. -### Size of Blockchain {#sob} +### Size of Blockchain -Each block on the blockchain and/or compute state in case of a smart contract based blockchain must be validated by multiple nodes. Each node has to manage a copy of the state and the blocks. While the chain increases in size as the days go by, maintaining and validating the whole blockchain becomes difficult and results in fewer full nodes in public blockchains, which poses a risk for decentralization.
+Each block on the blockchain and/or compute state in case of a smart contract based blockchain must be validated by multiple nodes. Each node has to manage a copy of the state and the blocks. While the chain increases in size as the days go by, maintaining and validating the whole blockchain becomes difficult and results in fewer full nodes in public blockchains, which poses a risk for decentralization. For the Matic Network, the primary layer which provides decentralization may choose to store only the blocks of Matic Chain from the previous checkpoint to the next checkpoint. All previous transaction/block proofs have been submitted to the mainchain. **This enables extremely low fidelity PoS nodes which can be run in very low-cost machines with low storage. In future, The Matic Network intends to enable mobile device based PoS miners too.** -### Multiple micropayment channels with other off-chain solutions {#loooong} +### Multiple micropayment channels with other off-chain solutions Some payment channel solutions have proposed solutions to solve the problem of micro-payments. However, the process of opening and managing channels with multiple DApps or users is complex. Additionally, the speed and convenience of mediated payments over channels is still up for debate. Since **The Matic Network uses a state-based architecture on an EVM (Ethereum Virtual Machine), it does not require payment channels to be opened between two parties. In fact, any valid Ethereum address is a valid Matic Address and a receiver does not need to be on the Matic chain to receive payment. They would only need to have a Matic Wallet when they want to retrieve the payments on the main chain or spend it in the ecosystem on the Matic Network.** -### High Transaction Fees {#htf} +### High Transaction Fees With the rapid growth of the blockchain ecosystem, new crypto assets are increasingly being created, transferred, and sold, often involving multiple crypto tokens. Also, most decentralized apps have their own token and economy. Paying tokens for the services or doing any kind of transaction on blockchains requires on-chain transfers. Every blockchain has a transaction cost structure. For example, Ethereum charges gas fees on each transaction. @@ -71,20 +63,19 @@ The amount of fees is an important factor to incentivize validators and prevent **The Matic Network enables low cost transactions through achieving economies of scale by doing a large number of transactions on the Block Producer layer which ensures low cost, and then subsequently batching the proofs of the Matic blocks using the Merkle root of the blocks** to a highly decentralized mainchain (for ex. Ethereum) using a decentralized layer of PoS Stakers. -### Poor Usability {#pf} +### Poor Usability User interactions on DApps are often poor compared to their centralized counterparts. For the Decentralization revolution to achieve mass adoption, the user experience of DApps has to be on par with, if not better than, their centralized counterparts. The Matic Development team is expected to work on various Mobile and Web browser integration tools and is pioneering protocols in this domain. It intends to build a ubiquitous mobile/browser app, which will act as a secured interaction layer for blockchain interactions. The Matic Development team will be publishing the designs and prototypes of these soon. +## Introducing the Matic Network -# Introducing the Matic Network {#imn} - -As discussed in brief in the section above, the Matic Network aims to solve the problems faced by the blockchain ecosystem through building a decentralized platform using an adapted version of [Plasma](https://plasma.io/) framework. This provides for fast and extremely low cost transactions with finality on a mainchain. The current working Testnet and alpha-Mainnet of the Matic Network works with Ethereum as a mainchain.
+As discussed in brief in the section above, the Matic Network aims to solve the problems faced by the blockchain ecosystem through building a decentralized platform using an adapted version of [Plasma](https://plasma.io/) framework. This provides for fast and extremely low cost transactions with finality on a mainchain. The current working Testnet and alpha-Mainnet of the Matic Network works with Ethereum as a mainchain. The Matic Development team is also building a product ecosystem including user friendly mobile apps, desktop wallets and browser extensions which will provide a seamless experience for all users. It is envisaged that users will be able to pay, transfer or hold crypto assets without worrying about the complexity of the underlying system. -# Architecture {#architecture} +## Architecture Since the Matic Network's core focus is on mass user adoption, it is ideal that a deep dive into the Matic Network's technical architecture should start from a user journey. @@ -92,7 +83,7 @@ When a user is transferring ETH or ERC20 tokens on the Ethereum network, they ha Moreover, during peak loads, a large number of transactions clog the Ethereum network and gas fees increase on each transaction in order to obtain faster confirmations. The Matic Network is proposed as a solution to overcome these problems. -Here is how the Matic Network will function:
+Here is how the Matic Network will function: 1. A user deposits a cryptographic asset in the Matic contract on the mainchain (currently implemented with Ethereum blockchain only). 2. Once deposited, tokens get confirmed on the main chain, tokens will appear on the Matic Chain using Matic Deposit bridge (technical details explained in a dedicated section below). @@ -104,7 +95,7 @@ The Matic Development Team has already created a demo version, available at: htt We expect the alpha version of the mainnet to go live very soon. -## Actors {#actors} +### Actors The ecosystem of The Matic Network will have the following actors : @@ -113,23 +104,21 @@ The ecosystem of The Matic Network will have the following actors : 3. Stakers : Stakers need to deposit/stake tokens to qualify and play a very important role in the Matic Network. They validate the transactions and propose checkpoints on the mainchain using PoS consensus mechanism with a ⅔ majority. They also choose Block Producers amongst themselves, who satisfy a certain criteria, to produce blocks on the sidechains. 4. Block Producers : These are block producers chosen by Stakers who in turn enable faster blockchain generation times. They have to provide a significant stake to be nominated. -## Consensus {#con} +### Consensus The Matic Network uses a dual strategy of Proof of Stake at the checkpointing layer and Block Producers at the block producer layer to achieve faster blocktimes while ensuring a **high degree of decentralization by achieving finality on the main chains using the checkpoints and fraud proof mechanisms.** -![Matic checkpoints](matic-architecture.png) - Through this mechanism, The Matic Network achieves high transcation speed with a high degree of decentralization and finality on Mainchain. In the first version which has Ethereum only as the base chain, Ethereum root contract enforces solvency and finality through header block(checkpoints) very efficiently. The various elements and mechanisms of the system are described below: -## Checkpointing Layer {#checklayer} +### Checkpointing Layer Basically, anyone can stake their Matic Tokens on root contract to become a Staker in the PoS checkpointing layer (contract deployed on Ethereum chain). This provides a highly decentralized base layer for Matic Chain. -## Block Producers +### Block Producers At the blockchain layer of the Matic Network, there are Block Producers, selected by PoS Stakers on the base layer, who will be creating the Matic Blocks. To achieve faster block generation times, these Block Producers will be low in number. **This layer is expected to achieve ~1 second block generation times at extremely low to negligible transaction fees.** -## Checkpointing Mechanism +### Checkpointing Mechanism On Matic Network’s checkpointing layer, the basis of Matic Network's PoS mechanism, for every few blocks on the block layer of the Matic Network, a proposer will be chosen among the stakeholders to propose a checkpoint on the main chain. These checkpoints are created by the proposer after validating all the blocks on the block layer of the Matic Network and creating the Merkle tree of the block hashes since the last checkpoint. The Merkle root is then broadcasted to the Staker network for their signatures. The other stakeholders also verify the proof. They will approve the proposed block, if it is valid, by providing their signatures. @@ -139,11 +128,11 @@ Apart from providing finality on the mainchain, Checkpoints have a very importan Through this mechanism, The Matic Network achieves a high transaction speed, a high degree of decentralization and finality on Mainchain. In its first version which has Ethereum as the base chain, the Ethereum root contract enforces solvency and finality through header blocks (checkpoints) very efficiently. -## Block Producer Selection +### Block Producer Selection Block Producers are chosen by Stakers in the checkpointing layer through voting on the mainchain. A Block Producer is selected for a pre-determined interval of time until slashed/removed by the network consensus mechanism or if it is unable to participate in the block production due to any external issue. -### Seeding of the network +#### Seeding of the network ``` 1. Matic Network will ask for applications from the public to run the Block Producer nodes 2. It will also run 3 Block Producer nodes itself during the seed stage of the network @@ -151,7 +140,7 @@ Block Producers are chosen by Stakers in the checkpointing layer through voting 4. These nodes will be kickstarted with a Matic Chain N(number of) genesis configuration ``` -### Block Producer application process +#### Block Producer application process ``` 1. The Block Producers have to apply by staking the Block Producer Stake requirement amount in Matic Tokens on the mainchain 2. The Network will maintain a pool of interested Block Producers (An incentive system for the Block Producer nominees would be devised to keep ample number of Block Producers in the pipeline) @@ -165,18 +154,18 @@ Criteria on the basis on which Stakers will decide to vote for a particular nomi - Other factors under consideration (e.g. [Zcash Board Nominations](https://github.com/ZcashFoundation/Elections/blob/master/2018-Q2/Board-Nominations/Sokolov_selfnomination.md) ) ``` -### Selection through Voting at tenure completion +#### Selection through Voting at tenure completion ``` 1. Voting process is scheduled and completed one week before the completion of one tenure 2. Existing Block Producers can re-appear in the elections 3. Stakers vote for Block Producers from the pool of Nominees ``` -### Replacement of a Block Producer during the ongoing tenure +#### Replacement of a Block Producer during the ongoing tenure In an event of untimely removal/incapability of a Block Producer to take part in block production, a new Block Producer from the transient pool will be recruited. An appropriate incentive mechanism to have a prioritized/preferred list of Block Producers as per the stakers' vote will be devised to maintain a healthy pool of Block Producers. -## Multi Chain Support (Horizontal Sharding) {#multichain} +### Multi Chain Support (Horizontal Sharding) The Matic Network public checkpointing layer supports multiple side chains by design. Theoretically there can be an infinite number of side chains working under the secured and decentralized layer of checkpoints. Businesses can have their dedicated side chains connected to the public checkpointing layer having full control of their execution environments, while still retaining the immutability, provability and security of transactions via the checkpointing mechanism. @@ -188,7 +177,7 @@ Key factors influencing design of this sharding process are expected to be: - Developers will be provided with API/SDKs to build programmable interfaces for inter-chain transactions 3. Movement of the assets from one chain to another will be managed at the checkpointing layer and may not require any interaction with the mainchain. Research is currently underway to facilitate faster (possibly instant) inter sidechain transfers. -## Interoperability {#interoper} +### Interoperability As mentioned earlier in the whitepaper, the Ethereum mainchain is the first base/mainchain that Matic Network securely integrates with, using an adapted implementation of the Plasma framework. In addition, the Matic network intends to integrate multiple leading smart contract platforms cryptocurrencies such as Bitcoin and others to provide an universal platform for the users to be able to use/exchange their assets from various blockchains. @@ -196,7 +185,7 @@ It can also provide a strong foundation for large DEXs (Decentralized exchanges) Judging from the proliferation of Layer 1 blockchains, it is a given that there might be more than 2-3 public blockchains that will be adopted by the mainstream eventually, rather than only a single winning blockchain platform. Therefore, the Matic Development Team expects to see hitherto unseen use-cases, arising from the Decentralized application movement across these blockchains. The vision of the Matic Development Team is to provide infrastructure and interfaces such that anyone who wishes to build decentralized applications on any blockchain, will be able to do it easily - and communicate and transfer value across multiple blockchains. -## Generalized State Scaling on Plasma {#genscaling} +### Generalized State Scaling on Plasma Generalized State scaling is the next frontier for the Matic Network, once the Matic Development Team is done with implementing micropayments, asset transfers and swaps in the first phase of development of the Matic Network. This is a research problem, and it will take time and effort to accomplish a breakthrough here. @@ -238,13 +227,13 @@ Some work on this already started (see [solevm](https://github.com/Ohalo-Ltd/sol Overall, if one can efficiently identify the problematic EVM state transition for verification, through an EVM-in-an-EVM construction, one can subject it to challenges, and thereby securing it. -# Security +## Security -## Fraud Proofs {#fraud} +### Fraud Proofs To enhance the security of the transactions, Matic Network also provides Fraud Proofs on the mainchain. The mechanism enables any individual on the mainchain to submit the details of the transactions which he/she thinks is fraudulent. If the challenge is successful, the stakes of the parties involved in the fraud are slashed and the challenger receives the slashed funds as an incentive for detecting the fraud. This can be considered as an always-running high reward bounty program for any parties who wish to investigate the veracity of the transactions on the Matic Network. -### Basic proofs {#basicp} +#### Basic proofs Each proof must be submitted with the following corresponding proofs whenever necessary: @@ -252,13 +241,13 @@ Each proof must be submitted with the following corresponding proofs whenever ne - Merkle proof for block inclusion: This type of proof is needed to prove that the block is included in the given checkpoint -### Block {#blockp} +#### Block This proof is needed to prove that the block is in sequence with a valid referenced hash. -### Transaction +#### Transaction -#### Single level txn proof {#singletp} +##### Single level txn proof ```js // validate ERC20 TX @@ -282,7 +271,7 @@ This proof is needed to prove that the block is in sequence with a valid referen } ``` -#### Nonce validation {#noncevp} +##### Nonce validation - To check if there are transactions with duplicate nonces @@ -319,11 +308,11 @@ This proof is needed to prove that the block is in sequence with a valid referen } ``` -#### Receipt validation {#recvalp} +##### Receipt validation - To check receipt fields, events, topics and data types in given receipt -#### Deposit {#depositp} +##### Deposit - Validate deposit transactions Validates deposit transaction on the mainchain and see if it matches with DepositBlock object in rootchain. @@ -333,18 +322,18 @@ This proof is needed to prove that the block is in sequence with a valid referen - Validate deposited amount and the depositor address -#### ERC20 transfer {#erc20tp} +##### ERC20 transfer - To validate ERC20 transaction data, receipt logs and values - To check if UTXO-style input in log receipt log equals that of an UTXO-style output of a recent transaction log receipt -### Iterative txn proof +#### Iterative txn proof Details to be updated in a later version of the whitepaper -# Network Economics {#economics} +## Network Economics -## Transaction Fee Determinative Factors and Trade-off +### Transaction Fee Determinative Factors and Trade-off 1. Block Size = (Average Transaction Amount)/(Block) - 100Txs/Block is insanely expensive. - ETH is 600~1000Txs/Block @@ -370,7 +359,7 @@ Details to be updated in a later version of the whitepaper - A shorter duration means faster Maliciousness detection, but it also means a higher committed Gas fee. - If a Byzantine behavior (e.g. Double Spend through Tx deletion) occurs just after checkpoint creation, this duration is the worst-case time until the Ceremony. If some Block Producers delete transactions, the Matic Network can recover the cancelled transaction, and the double spend attack would be foiled. -# Focus on User Experience {#usere} +## Focus on User Experience The Matic Development Team is developing a wallet by implementing the [WalletConnect](https://walletconnect.org/) protocol, which is an open protocol to connect web-based distributed applications to mobile crypto assets. @@ -378,25 +367,25 @@ This wallet will help users to interact with DApps and sign transactions easily, Other than this, the team is also looking at context specific ether-less accounts and Gas relay abstraction on identity to enable ether-less sign transactions, which can be a huge boost for mainstream user adoption. -# Matic Stack {#stack} +## Matic Stack This section details out various parts of the Matic chain and components in the Ethereum chain. -### Matic contracts on mainchain {#mcontracts} +#### Matic contracts on mainchain The Matic smart contracts on the mainchain provide the core logic for the Matic Network. The contracts contain various mechanisms such as deposit and exits from the mainchain to the sidechain and vice versa. They also contain the exit priority queue, the periodic state commitments from the Validator layer, fraud proof mechanisms, bonded exit challenge logic and various other components. The Stake Manager also resides here. -### Matic Deposit Bridge {#mdb} +#### Matic Deposit Bridge The bridge(s) of the Matic Network are part of Block Producer nodes that listen to the RootContract events on the mainchain and monitor any token/ether transfer events happening to the RootContract. This bridge utilizes Matic Network’s famous tool named [Dagger](https://github.com/maticnetwork/eth-dagger.js). Once the bridge detects a deposit on the mainchain, it fires a Deposit event on the Matic chain and the user’s address on the Matic Network is allocated the deposited amount. -### Matic PoS {#mpos} +#### Matic PoS The checkpointing mechanism of the Matic Network is a PoS enabled layer which has Stakers who propose the checkpoints to the mainchain. There will be about 100-150 Stakers at the checkpointing layer to start with. In future with the advent of more efficient signature mechanisms on the Ethereum blockchain, the Matic Network will be able to significantly increase its number of stakers on the checkpointing layer which is expected to further increase its degree of decentralization, perhaps rivalling that of the leading public blockchains like Ethereum and Bitcoin. More details of the PoS checkpoint layers will be given in a later version of the Whitepaper. -### Block Producer Layer {#bplay} +#### Block Producer Layer At the base layer, the Matic Network has Block Producer nodes chosen by the Stakers of the PoS layer through voting for every checkpointing interval. These Block Producers will also run the Matic Deposit bridge. @@ -404,17 +393,17 @@ Block Producers accept transactions through the Matic VM and are expected to cre More technical and code level details of the Block Producer layer will be added in a later version of the whitepaper. -### Matic Virtual Machine {#vm} +#### Matic Virtual Machine The Matic Network uses a standard EVM based state machine, which is run by the Block Producer nodes to generate blocks. Using the EVM allows the Matic Network to be able to build and deploy protocols such as ERC protocols as well as other protocols like Kyber Network, ZRX etc. The beauty of the Matic Network architecture is that since it uses an EVM-compatible state machine, it becomes very easy to port DApps and smart contracts running on the Ethereum blockchain to the Matic Network. The Matic Development Team intends to support generalized state transitions on the Matic Network, and this architecture provides a smooth foundation to build upon. -### Matic Withdrawal Bridge {#mvb} +#### Matic Withdrawal Bridge When an address on the Matic Network submits a withdrawal request to the network, the corresponding tokens are burnt (withdrawn from) on the Matic chain and this transaction is pushed on to the Matic chain. After the specified checkpoint interval, the PoS checkpoint layer will publish the checkpoint to the main chain, which will include the proof of burn (withdrawal) of these tokens on the Matic chain. Once this checkpoint is committed on the mainchain, the user can claim their withdrawn tokens. -## Spam Protection {#spam} +### Spam Protection The Block Producers running the block producer layer of the Matic Network will watch the transfer state of the assets to identify frivolous transactions. They reject any incoming transactions with zero amount in payments thereby foiling any DoS/spam attacks with zero cost transactions. Even if the Matic tokens are very low in cost and the fees being very low, due to the high TPS of Matic Network, it would not be economically viable to run sustained DoS attacks on the Matic Network. @@ -428,11 +417,11 @@ Additional checks are run to mitigate spam based on this: - Check for duplicate transactions with same outputs in the transaction pool. - Check for duplicate transactions with same transaction fee in the pool. -# Potential Use Cases {#potential} +## Potential Use Cases Matic Network Pte. Ltd. (The Governing body) is committed to provide a scalable and user- friendly ecosystem for third party Decentralized applications to thrive on. The governing body, like Ethereum and other platform foundations, will promote various Base chain DApps (like DApps built on Ethereum currently, and NEO, EOS in future) to build and migrate their user facing applications / transactions on the Matic Network. It will also award grants and funding to third party app developers to build various use cases on top of the Matic Network like: -### Payments {#payment} +### Payments The Matic Network will provide an interface for users, payment APIs and SDKs for DApps, merchant and users to instantly accept or pay in crypto assets (e.g., ERC20 tokens, Ethers, ERC721 tokens). @@ -441,23 +430,23 @@ The Matic Development Team has plans to roll-out this system in three phases: 2. Multi-asset cross chain transfer and payment through atomic swaps and liquidity providers 3. Fiat enabled off-ramp payment system integration through fiat liquidity providers -### Atomic Swaps {#atom} +### Atomic Swaps Matic contract allows users to pay with any crypto token they prefer, and receiver will receive payment in assets they prefer. The Matic Network can handle conversation through atomic swaps between cross-chain crypto assets. -### Liquidity providers {#liquidity} +### Liquidity providers Third parties can use the Matic Network to exchange any tokens for other tokens by leveraging 0x liquidity pool or other liquidity providers while transferring crypto assets. In the case of fiat, the Matic Development Team is planning to collaborate with fiat liquidity providers in currencies of major countries. -### Decentralized Exchange (DEX) and Marketplace support {#dex} +### Decentralized Exchange (DEX) and Marketplace support The Matic Network is expected to have all characteristics which an exchange platform should have — faster and cheaper trades. The Matic Network is capable of supporting decentralized exchanges and enabling trust-less, reliable and easy crypto trades. The decentralized exchange is the future for digital assets and provides better security and solvency than the centralized exchanges. -### Lending & Credit Scoring platform {#lcsp} +### Lending & Credit Scoring platform The Matic Network will enable platforms for merchants to assess the creditworthiness of connected users via their transaction history. This enables merchants to lend tokens to users on the network when transacting with users that do not have sufficient funds. The Matic Network expects to use the Dharma protocol to provide tokenized debt to users. -### Identity {#identity} +### Identity Users need a utilitarian yet user-friendly interface where MetaMask or web3 enabled browsers are not required. They do not need to understand how Ethereum works under the hood. @@ -465,15 +454,15 @@ Decentralized apps need a way to sign transactions, but that must happen without This system will also provide a way to auto-approve certain kind of transactions depending upon the criteria chosen by the users. This will drive the recurring payments on the Matic Network. -### Games {#games} +### Games We expect games to be a big part of the Matic Network. In-game assets represented as NFTs (ERC721) are expected to be bought, sold and traded in huge numbers on our sidechains. Developers will also be able to save game state on the sidechains, if they choose to. Along with the NFT marketplace that we will enable, developers and users will truly have a fast, efficient and secure sidechain to build and play games on. -### Infrastructure {#infrastructure} +### Infrastructure The Matic Development Team will act on the simple mantra - make it simple and seamless. For that, the team will provide new infrastructure around the Matic Network including user-friendly wallets for individual users and merchants, payroll dashboards, payment SDKs and other open source tools. -### Dagger {#dagger} +### Dagger The Matic Development Team already has started building infrastructure for developers, starting with Dagger. [Dagger](https://matic.network/dagger) is a tool or engine to track Ethereum accounts and events in real-time. @@ -481,26 +470,26 @@ Developers can use Dagger to track their own smart contracts, accounts, and tran Further information about Dagger can be found here: -https://medium.com/matic-network/ethereum-in-realtime-dagger-98ee2d717c76
-and check how it works:
+https://medium.com/matic-network/ethereum-in-realtime-dagger-98ee2d717c76 +and check how it works: https://medium.com/matic-network/understanding-dagger-453d90480c51 -### Matic Wallet {#mwallet} +### Matic Wallet The Matic development team is working on building an easy-to-use Plasma wallet mobile app, integrated with WalletConnect, to ensure secure storage of keys, intuitive access to the features provided by the Matic Network, as well as a seamless mechanism to connect browser-based DApps to the mobile app. Users can interact with DApps on browsers and in the future many more devices, while still keeping their keys secure in their mobile wallet. The Matic wallet will act as a ready tool for DApp developers to get their users onboarded and working with Matic sidechains quickly and efficiently. -# Matic Tokens -The native digital cryptographically-secured utility token of the Matic Network (Matic Token) is a major component of the ecosystem on the Matic Network, and is designed to be adopted for use as the primary token on the network. Matic Token will be issued as ERC-20 standard compliant digital tokens on the Ethereum blockchain.
+## Matic Tokens +The native digital cryptographically-secured utility token of the Matic Network (Matic Token) is a major component of the ecosystem on the Matic Network, and is designed to be adopted for use as the primary token on the network. Matic Token will be issued as ERC-20 standard compliant digital tokens on the Ethereum blockchain. -Matic Token is designed to be a utility token which functions as the unit of payment and settlement between participants who interact within the ecosystem on the Matic Network. Matic Token does not in any way represent any shareholding, participation, right, title, or interest in the Governing body, the Issuer, its affiliates, or any other company, enterprise or undertaking, nor will Matic Token entitle token holders to any promise of fees, dividends, revenue, profits or investment returns, and are not intended to constitute securities in Singapore or any relevant jurisdiction. Ownership of Matic Token carries no rights, express or implied, other than that which may be afforded by the Matic Network and/or any other third parties whom may use such Tokens.
+Matic Token is designed to be a utility token which functions as the unit of payment and settlement between participants who interact within the ecosystem on the Matic Network. Matic Token does not in any way represent any shareholding, participation, right, title, or interest in the Governing body, the Issuer, its affiliates, or any other company, enterprise or undertaking, nor will Matic Token entitle token holders to any promise of fees, dividends, revenue, profits or investment returns, and are not intended to constitute securities in Singapore or any relevant jurisdiction. Ownership of Matic Token carries no rights, express or implied, other than that which may be afforded by the Matic Network and/or any other third parties whom may use such Tokens. -Matic Tokens are expected to provide the economic incentives to encourage participants to contribute and maintain the ecosystem on the Matic Network. Computational resources are required for performing various functions on the Matic Network such as validating blocks and publishing proofs, thus providers of these services / resources would be rewarded with Matic tokens for providing these resources to the network (i.e. "mining" on the Matic Network) to maintain network integrity. Matic Token will be used as the unit of exchange to quantify and pay the costs of the consumed computational resources. Matic Token is an integral and indispensable part of the Matic Network, because without the Matic Token, there would be no incentive for users to expend resources to participate in activities or provide services for the benefit of the entire ecosystem on the Matic Network. Only users which have actually contributed to network maintenance would receive token incentives. Users of the Matic Network and/or holders of Matic Token which did not actively participate will not receive any Matic Token as rewards.
+Matic Tokens are expected to provide the economic incentives to encourage participants to contribute and maintain the ecosystem on the Matic Network. Computational resources are required for performing various functions on the Matic Network such as validating blocks and publishing proofs, thus providers of these services / resources would be rewarded with Matic tokens for providing these resources to the network (i.e. "mining" on the Matic Network) to maintain network integrity. Matic Token will be used as the unit of exchange to quantify and pay the costs of the consumed computational resources. Matic Token is an integral and indispensable part of the Matic Network, because without the Matic Token, there would be no incentive for users to expend resources to participate in activities or provide services for the benefit of the entire ecosystem on the Matic Network. Only users which have actually contributed to network maintenance would receive token incentives. Users of the Matic Network and/or holders of Matic Token which did not actively participate will not receive any Matic Token as rewards. -In order to participate in the consensus process on the Matic Network, users would be required to stake Matic Token as an indication of that user's commitment to the process. Matic Token would thus also be used as a deterrent for punishing stakers for various offences (e.g. invalid blocks, illegally verifying blocks, or invalid transaction execution) by requiring them to first put up a stake of Matic Token before being entitled to participate in the ecosystem. Matic Token would be deducted in the event that an offence was committed by a staker.
+In order to participate in the consensus process on the Matic Network, users would be required to stake Matic Token as an indication of that user's commitment to the process. Matic Token would thus also be used as a deterrent for punishing stakers for various offences (e.g. invalid blocks, illegally verifying blocks, or invalid transaction execution) by requiring them to first put up a stake of Matic Token before being entitled to participate in the ecosystem. Matic Token would be deducted in the event that an offence was committed by a staker. -In particular, it is highlighted that Matic Token:
+In particular, it is highlighted that Matic Token: 1. is non-refundable and cannot be exchanged for cash (or its equivalent value in any other virtual currency) or any payment obligation by the Governing body, the Issuer or any affiliate; 2. does not represent or confer on the token holder any right of any form with respect to the Governing body, the Issuer (or any of its affiliates), or its revenues or assets, including without limitation any right to receive future dividends, revenue, shares, ownership right or stake, share or security, any voting, distribution, redemption, liquidation, proprietary (including all forms of intellectual property or licence rights), or other financial or legal rights or equivalent rights, or intellectual property rights or any other form of participation in or relating to the Matic Network, the Governing body, the Issuer and/or their service providers; 3. is not intended to represent any rights under a contract for differences or under any other contract the purpose or pretended purpose of which is to secure a profit or avoid a loss; @@ -510,7 +499,7 @@ In particular, it is highlighted that Matic Token:
The contributions in the token sale will be held by the Issuer(or its affiliate) after the token sale, and contributors will have no economic or legal right over or beneficial interest in these contributions or the assets of that entity after the token sale. To the extent a secondary market or exchange for trading Matic Token does develop, it would be run and operated wholly independently of the Governing body, the Issuer, the sale of Matic Token and the Matic Network. Neither the Governing body nor the Issuer will create such secondary markets nor will either entity act as an exchange for Matic Token. -# Features on our development roadmap {#future} +## Features on our development roadmap The Matic Development team expects to conduct various additional research based on topics proposed by the community, including but not limited to: @@ -522,17 +511,16 @@ The Matic Development team expects to conduct various additional research based 6. Blockchain interoperability 7. State channels on top of the sidechain -# Team {#team} - -- Jaynti Kanani. Co-founder and Chief Executive Officer. Contributor to Web3, Plasma, WalletConnect. Previously data scientist at Housing.com.
-https://www.linkedin.com/in/jdkanani/ -- Anurag Arjun. Co-founder and Chief Product Officer. Previously AVP (Product Management), IRIS Business. Stints at SNL Financial, Dexter Consultancy and Cognizant Tech.
-https://www.linkedin.com/in/anuragarjun/ -- Sandeep Nailwal. Co-founder and Chief Operating Officer. Blockchain Programmer and Entrepreneur. Previously CEO Scopeweaver, CTO (Ecommerce) Welspun Group.
-https://www.linkedin.com/in/sandeep-nailwal-60709a33/ +## Team +- Jaynti Kanani. Co-founder and Chief Executive Officer. Contributor to Web3, Plasma, WalletConnect. Previously data scientist at Housing.com. + https://www.linkedin.com/in/jdkanani/ +- Anurag Arjun. Co-founder and Chief Product Officer. Previously AVP (Product Management), IRIS Business. Stints at SNL Financial, Dexter Consultancy and Cognizant Tech. + https://www.linkedin.com/in/anuragarjun/ +- Sandeep Nailwal. Co-founder and Chief Operating Officer. Blockchain Programmer and Entrepreneur. Previously CEO Scopeweaver, CTO (Ecommerce) Welspun Group. + https://www.linkedin.com/in/sandeep-nailwal-60709a33/ -# Risks {#risks} +## Risks You acknowledge and agree that there are numerous risks associated with purchasing Matic Token, holding Matic Token, and using Matic Token for participation in the Matic Network. In the worst scenario, this could lead to the loss of all or part of the Matic Token which had been purchased. IF YOU DECIDE TO PURCHASE Matic Token, YOU EXPRESSLY ACKNOWLEDGE, ACCEPT AND ASSUME THE FOLLOWING RISKS: @@ -546,4 +534,4 @@ You acknowledge and agree that there are numerous risks associated with purchasi 5. Security weaknesses : Hackers or other malicious groups or organisations may attempt to interfere with Matic Token and/or the Matic Network in a variety of ways, including, but not limited to, malware attacks, denial of service attacks, consensus-based attacks, Sybil attacks, smurfing and spoofing. Furthermore, there is a risk that a third party or a member of the Foundation, the Distributor or its affiliates may intentionally or unintentionally introduce weaknesses into the core infrastructure of Matic Token and/or the Matic Network, which could negatively affect Matic Token and/or the Matic Network. Further, the future of cryptography and security innovations are highly unpredictable and advances in cryptography, or technical advances (including without limitation development of quantum computing), could present unknown risks to Matic Token and/or the Matic Network by rendering ineffective the cryptographic consensus mechanism that underpins that blockchain protocol. -6. Other risks : In addition, the potential risks briefly mentioned above are not exhaustive and there are other risks (as more particularly set out in the Terms and Conditions) associated with your purchase, holding and use of Matic Token, including those that the Foundation or the Distributor cannot anticipate. Such risks may further materialise as unanticipated variations or combinations of the aforementioned risks. You should conduct full due diligence on the Foundation, the Distributor, its affiliates and the Matic Development team, as well as understand the overall framework, mission and vision for the Matic Network prior to purchasing Matic Token. \ No newline at end of file +6. Other risks : In addition, the potential risks briefly mentioned above are not exhaustive and there are other risks (as more particularly set out in the Terms and Conditions) associated with your purchase, holding and use of Matic Token, including those that the Foundation or the Distributor cannot anticipate. Such risks may further materialise as unanticipated variations or combinations of the aforementioned risks. You should conduct full due diligence on the Foundation, the Distributor, its affiliates and the Matic Development team, as well as understand the overall framework, mission and vision for the Matic Network prior to purchasing Matic Token. diff --git a/datasets/crypto-whitepapers/monero.md b/datasets/crypto-whitepapers/monero.md index 64534ea..b1c3e24 100644 --- a/datasets/crypto-whitepapers/monero.md +++ b/datasets/crypto-whitepapers/monero.md @@ -1,22 +1,24 @@ # Monero (CryptoNote) -- **Title:** CryptoNote v 2.0 - **Project:** Monero (built on the CryptoNote protocol) -- **Author(s):** Nicolas van Saberhagen (pseudonym) -- **Year:** 2013 (dated October 17, 2013) -- **Canonical source:** https://cryptonote.org/whitepaper.pdf (original site defunct; archived copy used) — - Monero's own annotated copy: https://www.getmonero.org/resources/research-lab/pubs/whitepaper_annotated.pdf -- **License / distribution:** **FLAG (mild).** The original 2013 CryptoNote v2 paper carries no explicit - license statement. It is universally mirrored (Monero, Bytecoin, Zenodo, etc.), and the Zenodo archival - copy is published under CC-BY 4.0. Included on that basis, but confirm before durable public hosting. -- **File:** `cryptonote.pdf` (fetched from Web Archive mirror and validated as the real CryptoNote v2 paper) +- **Paper:** *CryptoNote v 2.0* +- **Author:** Nicolas van Saberhagen (pseudonym) +- **Year:** 2013 (dated 17 October 2013) +- **Canonical source:** originally https://cryptonote.org/whitepaper.pdf (site now offline; archived at + https://web.archive.org/web/2020/https://cryptonote.org/whitepaper.pdf). Monero's annotated copy: + https://www.getmonero.org/resources/research-lab/pubs/whitepaper_annotated.pdf +- **File in this folder:** `cryptonote.pdf` (byte-identical to the archived cryptonote.org copy) ## Summary -CryptoNote v2 is the protocol paper that Monero is built on; it is the foundational document of the -privacy-coin lineage. It identifies traceability and linkability weaknesses in Bitcoin's transparent ledger -and proposes cryptographic fixes: **ring signatures** to obscure which input actually spent funds (hiding -the sender among a set of plausible signers) and **one-time stealth addresses** so that recipients cannot be -linked across payments. It also discusses an egalitarian, memory-hard proof-of-work. Monero implemented and -extended these ideas (later adding RingCT to hide amounts), becoming the most prominent privacy-focused -cryptocurrency. Note this file is the CryptoNote protocol paper, not a Monero-branded document. +CryptoNote is the protocol paper that Monero is built on, and the founding document of the privacy-coin +family. It sets out two privacy goals that Bitcoin does not meet, **untraceability** (every possible sender +of a payment is equally likely) and **unlinkability** (two payments cannot be shown to go to the same +person), and proposes fixes: **ring signatures**, which hide the real signer of a transaction among a group +of possible signers, and **one-time addresses**, so that a recipient's payments cannot be linked together. +It also proposes a proof-of-work function meant to give ordinary CPUs a fair chance against GPUs and +specialized hardware. + +Monero launched in April 2014 as a fork of Bytecoin, an earlier CryptoNote-based coin. It has since extended the +design, for example by hiding transaction amounts with Ring Confidential Transactions (2017) and adopting the +RandomX proof-of-work (2019). This file is the CryptoNote paper, not a Monero-branded document. diff --git a/datasets/crypto-whitepapers/polkadot.md b/datasets/crypto-whitepapers/polkadot.md index 45ee13b..3407a61 100644 --- a/datasets/crypto-whitepapers/polkadot.md +++ b/datasets/crypto-whitepapers/polkadot.md @@ -1,21 +1,21 @@ # Polkadot -- **Title:** Polkadot: Vision for a Heterogeneous Multi-Chain Framework (Draft 1) -- **Project:** Polkadot (Web3 Foundation / Parity) -- **Author(s):** Dr. Gavin Wood (founder, Ethereum & Parity) +- **Project:** Polkadot +- **Paper:** *Polkadot: Vision for a Heterogeneous Multi-Chain Framework* (Draft 1) +- **Author:** Gavin Wood - **Year:** 2016 -- **Canonical source:** Web3 Foundation / polkadot.com (whitepaper). The included PDF was fetched from a - reputable mirror; the canonical authoritative source is the Web3 Foundation. -- **License / distribution:** Web3 Foundation whitepaper, freely circulated. Included as a - freely-distributed project whitepaper. -- **File:** `polkadot.pdf` (fetched and validated as the genuine Gavin Wood Polkadot whitepaper) +- **Canonical source:** https://github.com/w3f/polkadot-white-paper (Web3 Foundation) +- **File in this folder:** `polkadot.pdf` (a December 2016 build of Draft 1; the Web3 Foundation's current + copy has minor later edits, such as renumbered references) ## Summary -Polkadot's whitepaper argues that existing blockchains conflate two distinct concerns — **canonicality** -(agreeing on a single ordered history) and **validity** (agreeing that state transitions are correct) — and -that separating them enables scalability and extensibility. Polkadot proposes a central **relay chain** that -provides shared security and consensus to many parallel application-specific chains called **parachains**, -which can have heterogeneous designs and still interoperate and pass messages. Validators secure the relay -chain while collators produce parachain blocks. The result is a framework for many specialized chains -operating under one pooled security umbrella, with cross-chain communication as a first-class feature. +The Polkadot whitepaper argues that existing blockchains tie together two separate concerns: +**canonicality** (agreeing on one ordered history) and **validity** (agreeing that state transitions are +correct). Separating them, it says, makes chains easier to extend and scale. Polkadot proposes a central +**relay chain** that provides consensus and shared security to many parallel chains called +**parachains**, which can have different designs and still pass messages to each other. Validators secure +the relay chain while collators produce parachain blocks. + +Gavin Wood, an Ethereum co-founder, wrote the paper. Polkadot's network launched in May 2020 using +nominated proof-of-stake, and parachains went live in December 2021. diff --git a/datasets/crypto-whitepapers/polygon.md b/datasets/crypto-whitepapers/polygon.md index a73cdbe..06dd48a 100644 --- a/datasets/crypto-whitepapers/polygon.md +++ b/datasets/crypto-whitepapers/polygon.md @@ -1,25 +1,25 @@ # Polygon (Matic Network) -- **Title:** Matic Network: Scalable and Instant Token Transfers and Payments (litepaper) -- **Project:** Polygon (formerly Matic Network) -- **Author(s):** Jaynti Kanani, Sandeep Nailwal, Anurag Arjun (founders) -- **Year:** 2019 (litepaper); project launched 2017 -- **Canonical source:** https://github.com/maticnetwork/whitepaper (project repo); - litepaper PDF mirrored at allcryptowhitepapers.com -- **License / distribution:** Matic Network whitepaper, freely published in the project's open-source repo. - Included as a freely-distributed project document. -- **Files:** - - `matic-whitepaper.md` — **authoritative** Matic Whitepaper v1.1, fetched from the official - `maticnetwork/whitepaper` GitHub repo (the project publishes it as a GitBook/markdown, not a single PDF). - - `matic-litepaper.pdf` — supplementary 5-page litepaper PDF from a whitepaper mirror; valid PDF, but the - markdown above is the authoritative source. +- **Project:** Polygon (originally Matic Network) +- **Papers:** + - *Matic Whitepaper* (version 1.1): Jaynti Kanani, Sandeep Nailwal, Anurag Arjun. Published in the + project's GitHub repository from June 2018; last revised March 2019. + - *Matic Network* litepaper: an undated 5-page summary from about 2019 (no authors listed). +- **Canonical sources:** https://github.com/maticnetwork/whitepaper (whitepaper); + https://www.allcryptowhitepapers.com/wp-content/uploads/2019/04/matic-litepaper.pdf (litepaper; a + third-party archive, as the project no longer hosts it) +- **Files in this folder:** `matic-whitepaper.md` (whitepaper full text from the repository's `README.md`, + with formatting cleaned up) and `matic-litepaper.pdf` (byte-identical to the archive copy above) ## Summary -Polygon, originally Matic Network, is an Ethereum scaling solution. Its early litepaper describes a system -built on an adapted **Plasma** framework plus a proof-of-stake sidechain layer to deliver fast, -very-low-cost transactions while periodically committing state back to the Ethereum mainnet for security. -The goal is to address Ethereum's throughput and fee problems without sacrificing the ability to withdraw -assets safely to the root chain. Polygon later expanded into a broader suite of scaling technologies -(PoS chain, zk-rollups, etc.), but this document captures the founding Matic design. Newer Polygon papers -(e.g. the POL token paper) exist at https://polygon.technology/papers. +Matic Network was designed to scale Ethereum. Its whitepaper describes sidechains built on an adapted +**Plasma** framework, with a small set of block producers creating blocks quickly and a larger set of +proof-of-stake validators ("stakers") periodically committing checkpoints of those blocks to Ethereum. +Fraud proofs let anyone on Ethereum challenge invalid transactions, and users can withdraw their assets +back to the Ethereum main chain. The aim was fast, very low-cost transactions without giving up the +security of the root chain. The litepaper is a short, less technical overview of the same design. + +The project was founded in 2017 by Jaynti Kanani, Sandeep Nailwal, Anurag Arjun and Mihailo Bjelic, and +rebranded as Polygon in February 2021. It later grew into a family of scaling technologies, and in 2024 +began migrating its token from MATIC to POL. diff --git a/datasets/crypto-whitepapers/solana.md b/datasets/crypto-whitepapers/solana.md index 0df787d..0a5815b 100644 --- a/datasets/crypto-whitepapers/solana.md +++ b/datasets/crypto-whitepapers/solana.md @@ -1,20 +1,19 @@ # Solana -- **Title:** Solana: A new architecture for a high performance blockchain (Proof of History) - **Project:** Solana -- **Author(s):** Anatoly Yakovenko -- **Year:** 2017 (whitepaper widely circulated 2017–2018) +- **Paper:** *Solana: A new architecture for a high performance blockchain* (v0.8.13) +- **Author:** Anatoly Yakovenko +- **Year:** first drafted 2017; this version 2018 - **Canonical source:** https://solana.com/solana-whitepaper.pdf -- **License / distribution:** Freely published via solana.com. Included as a freely-distributed project - whitepaper. -- **File:** `solana.pdf` (fetched and validated) +- **File in this folder:** `solana.pdf` (byte-identical to the solana.com copy) ## Summary -Solana's whitepaper introduces **Proof of History (PoH)**, a verifiable delay function that creates a -cryptographic, append-only record proving that events occurred in a particular order and at a particular -time. By establishing a trustless global "clock," validators no longer need to communicate timestamps to -agree on ordering, removing a major bottleneck in traditional consensus. Combined with a PoH-aware -proof-of-stake mechanism and pipelined transaction processing, the design targets very high throughput and -low latency. The paper frames Solana as an architecture for a high-performance, single global state -blockchain capable of supporting demanding applications. +Solana's whitepaper introduces **Proof of History (PoH)**: a sequential hash chain that acts as a +verifiable record that events happened in a particular order and that time passed between them. Because +every validator can check this shared "clock" locally, nodes do not need to exchange messages to agree on +ordering, which removes a major bottleneck in traditional consensus. + +The paper combines PoH with a proof-of-stake consensus mechanism and pipelined transaction processing, +aiming for very high throughput and low latency on a single global state. Solana's network opened to the +public in March 2020. diff --git a/datasets/crypto-whitepapers/tezos.md b/datasets/crypto-whitepapers/tezos.md index 2b36773..a442804 100644 --- a/datasets/crypto-whitepapers/tezos.md +++ b/datasets/crypto-whitepapers/tezos.md @@ -1,20 +1,24 @@ # Tezos -- **Title:** Tezos: A Self-Amending Crypto-Ledger (whitepaper) + Tezos position paper - **Project:** Tezos -- **Author(s):** L.M Goodman (pseudonym; Arthur Breitman) +- **Papers:** + - *Tezos: A Self-Amending Crypto-Ledger: Position Paper*, dated 3 August 2014 + - *Tezos: a self-amending crypto-ledger: White paper*, dated 2 September 2014 +- **Author:** L.M. Goodman (pseudonym of Arthur Breitman) - **Year:** 2014 -- **Canonical source:** https://tezos.com/whitepaper.pdf (also https://tezos.com/position-paper.pdf) -- **License / distribution:** Freely published via tezos.com. Included as a freely-distributed project - whitepaper. -- **Files:** `tezos-whitepaper.pdf`, `tezos-position-paper.pdf` (both fetched and validated) +- **Canonical sources:** https://tezos.com/position-paper.pdf and https://tezos.com/whitepaper.pdf +- **Files in this folder:** `tezos-position-paper.pdf` and `tezos-whitepaper.pdf` (both byte-identical to the + tezos.com copies) ## Summary -Tezos is a smart-contract platform whose defining feature is **on-chain governance and self-amendment**: -the protocol can upgrade its own rules through a formal, stake-weighted voting process, avoiding contentious -hard forks. It uses a liquid proof-of-stake consensus (baking) and emphasizes formal verification — its -smart-contract language, Michelson, is designed so contracts can be mathematically reasoned about, which -suits high-value financial use. The position paper frames the philosophy and governance model; the -whitepaper details the ledger and amendment mechanics. Two documents are included because Tezos is -canonically distributed as a whitepaper plus a position paper. +Tezos is a smart-contract platform whose defining feature is **self-amendment**: the protocol includes a +procedure for stakeholders to vote on changes to the protocol itself, including changes to the voting +procedure, so it can upgrade without contentious hard forks. The position paper explains the motivation and +the choice of proof-of-stake and the OCaml language. The whitepaper describes the design: a network shell +that can run any blockchain protocol as a module, the seed amendment procedure, proof-of-stake consensus and +Turing-complete smart contracts. The hosted whitepaper is a later edition in which changes between the +original paper and the implementation are marked in red. + +Tezos was created by Arthur and Kathleen Breitman, and its mainnet went live in 2018. Its smart-contract +language, Michelson, is designed to make formal verification of contracts practical. diff --git a/datasets/crypto-whitepapers/tron.md b/datasets/crypto-whitepapers/tron.md index f399f4c..660c0cd 100644 --- a/datasets/crypto-whitepapers/tron.md +++ b/datasets/crypto-whitepapers/tron.md @@ -1,30 +1,21 @@ -# Tron — FLAGGED (PDF intentionally NOT included) +# TRON -- **Title:** TRON: Advanced Decentralized Blockchain Platform (whitepaper) -- **Project:** Tron -- **Author(s):** Tron Foundation (Justin Sun) -- **Year:** 2017–2018 -- **Canonical source:** Originally tron.network — the English whitepaper was **removed** from the official - site following the plagiarism allegations. Third-party mirrors exist but are not authoritative. -- **License / distribution:** **PROBLEMATIC — FLAGGED FOR JAMES.** -- **File:** **none — intentionally omitted.** +- **Project:** TRON (TRX) +- **Paper:** *TRON: Advanced Decentralized Blockchain Platform* (whitepaper version 2.1, for TRON protocol 4.8.0) +- **Author:** TRON DAO (formerly the TRON Foundation) +- **Year:** 2025 (version 2.1); version 2.0 is dated 10 December 2018 +- **Canonical source:** https://tron.network/static/doc/white_paper_v_2_1.pdf (version 2.0: + https://tron.network/static/doc/white_paper_v_2_0.pdf) +- **File in this folder:** this card only (the whitepaper is linked above) -## Why this is flagged (do not host the PDF without James's sign-off) +## Summary -In January 2018, Protocol Labs founder Juan Benet publicly alleged that at least nine pages of Tron's -English-language whitepaper were copied — in places nearly verbatim — from the **IPFS** and **Filecoin** -whitepapers, without citation. The IPFS/Filecoin papers were published under a Creative Commons license that -requires attribution, so copying them uncited would also be a license violation. After the accusations, -Tron removed the whitepaper from its official website; Justin Sun attributed the overlap to -Chinese-to-English translation issues. +TRON is a smart-contract platform founded by Justin Sun. The TRON Foundation was set up in Singapore in July +2017, and TRX began as an ERC-20 token on Ethereum before moving to TRON's own mainnet in 2018. In July 2018 +the foundation acquired BitTorrent. -Because (a) the document's originality and copyright status are disputed and (b) it was withdrawn from the -official source, we do **not** include the PDF. This entry exists to document the coin honestly and to flag -the controversy. If a Tron paper is ever wanted in the dataset, James should source it deliberately and -decide how to caveat it. - -## Summary (of the project, not an endorsement of the paper) - -Tron is a smart-contract / dApp platform marketed around high throughput and content/entertainment use -cases, using a delegated-proof-of-stake consensus. Its whitepaper is historically significant mainly for -the plagiarism controversy described above rather than for a novel technical contribution. +The whitepaper describes a **delegated proof-of-stake** network in which TRX holders who stake their tokens +vote for 27 "Super Representatives", who take turns producing a block every 3 seconds. Smart contracts run +on the TRON Virtual Machine (TVM), which supports Solidity. The paper also defines TRON's token standards +(TRC-10 and TRC-20) and a resource model in which transactions consume "bandwidth" and "energy" that users +obtain by staking TRX. diff --git a/datasets/crypto-whitepapers/uniswap.md b/datasets/crypto-whitepapers/uniswap.md index ea3f470..9c4748d 100644 --- a/datasets/crypto-whitepapers/uniswap.md +++ b/datasets/crypto-whitepapers/uniswap.md @@ -1,21 +1,22 @@ # Uniswap -- **Title:** Uniswap v2 Core; Uniswap v3 Core - **Project:** Uniswap -- **Author(s):** Hayden Adams, Noah Zinsmeister, Moody Salem, River Keefer, Dan Robinson (varies by version) -- **Year:** v2 — 2020; v3 — March 2021 (original v1 concept, 2018) -- **Canonical source:** https://app.uniswap.org/whitepaper.pdf (v2); https://app.uniswap.org/whitepaper-v3.pdf (v3) -- **License / distribution:** Freely published via uniswap.org. Included as freely-distributed project - whitepapers. -- **Files:** `uniswap-v2-core.pdf`, `uniswap-v3-core.pdf` (both fetched and validated) +- **Papers:** + - *Uniswap v2 Core*: Hayden Adams, Noah Zinsmeister, Dan Robinson. March 2020. + - *Uniswap v3 Core*: Hayden Adams, Noah Zinsmeister, Moody Salem, River Keefer, Dan Robinson. March 2021. +- **Canonical sources:** https://app.uniswap.org/whitepaper.pdf (v2); + https://app.uniswap.org/whitepaper-v3.pdf (v3) +- **Files in this folder:** `uniswap-v2-core.pdf` and `uniswap-v3-core.pdf` (both byte-identical to the + uniswap.org copies) ## Summary -Uniswap is the protocol that popularized the **automated market maker (AMM)** model for decentralized -exchange. Instead of an order book, liquidity providers deposit pairs of tokens into pools, and trades -execute against a deterministic pricing curve. The **v2 Core** paper formalizes the constant-product -invariant (x·y = k), adds direct ERC20-to-ERC20 pairs, time-weighted average price oracles, and flash swaps. -The **v3 Core** paper introduces **concentrated liquidity**, letting providers allocate capital within -custom price ranges for far greater capital efficiency, along with multiple fee tiers. Two versions are -included because they represent distinct, influential designs in DeFi. (v1 was only a blog/explainer; v2 and -v3 are the canonical formal papers.) +Uniswap is the protocol that popularized the **automated market maker (AMM)** for decentralized exchange. +Instead of an order book, liquidity providers deposit pairs of tokens into a pool, and trades execute +against a pricing formula that keeps the product of the two reserves constant (x · y = k). The **v2 Core** +paper explains the design of the v2 contracts: pools between any two ERC-20 tokens, a price oracle that +gives time-weighted average prices, "flash swaps", and a protocol fee that can be switched on later. + +The **v3 Core** paper introduces **concentrated liquidity**, which lets providers place their capital within +chosen price ranges for much greater capital efficiency, along with multiple fee tiers and an improved +oracle. Uniswap runs on Ethereum and other EVM chains. diff --git a/datasets/crypto-whitepapers/xrp-ripple.md b/datasets/crypto-whitepapers/xrp-ripple.md index 7caeb9a..7484eba 100644 --- a/datasets/crypto-whitepapers/xrp-ripple.md +++ b/datasets/crypto-whitepapers/xrp-ripple.md @@ -1,20 +1,22 @@ -# XRP (Ripple) +# XRP Ledger (Ripple) -- **Title:** The Ripple Protocol Consensus Algorithm -- **Project:** Ripple / XRP Ledger -- **Author(s):** David Schwartz, Noah Youngs, Arthur Britto (Ripple Labs Inc.) +- **Project:** XRP Ledger / Ripple +- **Paper:** *The Ripple Protocol Consensus Algorithm* +- **Authors:** David Schwartz, Noah Youngs, Arthur Britto (Ripple Labs Inc.) - **Year:** 2014 - **Canonical source:** https://ripple.com/files/ripple_consensus_whitepaper.pdf -- **License / distribution:** Published openly by Ripple Labs; freely available. Included as a - freely-distributed project whitepaper. -- **File:** `ripple-consensus-whitepaper.pdf` (8 pages; fetched and validated) +- **File in this folder:** `ripple-consensus-whitepaper.pdf` (8 pages; byte-identical to the ripple.com copy) ## Summary -The Ripple consensus whitepaper presents a low-latency consensus algorithm for the XRP Ledger that does not -rely on proof-of-work mining. Each node trusts a configurable set of peers (a "Unique Node List"), and the -network reaches agreement through iterative rounds in which nodes propose and progressively converge on a -set of candidate transactions, requiring only that trusted subnetworks overlap sufficiently. The paper shows -that with minimal connectivity this achieves network-wide agreement quickly and tolerates a bounded fraction -of faulty nodes. The design targets fast, cheap cross-border payments and settlement — Ripple's core use -case — rather than general smart contracts. +The paper presents a low-latency consensus algorithm for the XRP Ledger that does not use proof-of-work +mining. Each node chooses a list of validators it trusts (its "Unique Node List", or UNL), and the network +agrees on the next ledger through rounds in which nodes propose transaction sets and converge on one, as +long as the trusted lists of different nodes overlap enough. The paper argues that only minimal overlap is +needed and that the network tolerates a bounded fraction of faulty nodes. The design targets fast, cheap +payments and settlement rather than general smart contracts. + +A 2018 analysis by Ripple researchers Brad Chase and Ethan MacBrough (*Analysis of the XRP Ledger Consensus +Protocol*, arXiv:1802.07242) found that the paper's overlap condition (about 20% of a node's UNL) was +too weak, and that safety requires much larger overlap (roughly 90% under a general fault model). The PDF +carries a note from Ripple saying it is kept for historical interest and pointing readers to that analysis. diff --git a/datasets/crypto-whitepapers/zcash.md b/datasets/crypto-whitepapers/zcash.md index cac2d75..b288598 100644 --- a/datasets/crypto-whitepapers/zcash.md +++ b/datasets/crypto-whitepapers/zcash.md @@ -1,24 +1,23 @@ # Zcash (Zerocash) -- **Title:** Zerocash: Decentralized Anonymous Payments from Bitcoin (extended version) - **Project:** Zcash (built on the Zerocash construction) -- **Author(s):** Eli Ben-Sasson, Alessandro Chiesa, Christina Garman, Matthew Green, Ian Miers, - Eran Tromer, Madars Virza -- **Year:** 2014 (IEEE S&P 2014; extended version dated May 18, 2014) +- **Paper:** *Zerocash: Decentralized Anonymous Payments from Bitcoin* (extended version) +- **Authors:** Eli Ben-Sasson, Alessandro Chiesa, Christina Garman, Matthew Green, Ian Miers, Eran Tromer, + Madars Virza +- **Year:** 2014 (IEEE Symposium on Security and Privacy 2014; extended version dated 18 May 2014) - **Canonical source:** http://zerocash-project.org/paper -- **License / distribution:** **FLAG (mild).** The official conference version is **IEEE-copyrighted**. - The file included here is the **authors' freely-hosted extended version** from zerocash-project.org — - redistributing an author preprint is standard and acceptable, but it is not the IEEE version. Noting the - distinction for James. -- **File:** `zerocash.pdf` (authors' extended version; fetched and validated) +- **File in this folder:** `zerocash.pdf` (the authors' extended version, byte-identical to + http://zerocash-project.org/media/pdf/zerocash-extended-20140518.pdf) ## Summary Zerocash is the academic protocol behind Zcash and a landmark in applied zero-knowledge cryptography. It -shows how to build a decentralized anonymous payment scheme on top of a Bitcoin-like ledger using -**zk-SNARKs** (zero-knowledge succinct non-interactive arguments of knowledge): users can prove a -transaction is valid — that inputs exist and balances are conserved — without revealing the sender, -recipient, or amount. This provides much stronger privacy than mixing or ring signatures, with fully shielded -transactions. Zcash implemented these ideas as a live cryptocurrency offering both transparent and shielded -addresses. The trade-off historically involved a trusted setup for the SNARK parameters, which the paper and -later work address. +shows how to build a payment system on a Bitcoin-like ledger in which transactions hide the sender, the +recipient and the amount. Users prove that a transaction is valid, meaning the coins exist and the amounts +balance, using **zk-SNARKs** (zero-knowledge succinct non-interactive arguments of knowledge) without +revealing anything else. The paper reports transactions under 1 kB that take under 6 ms to verify. + +The construction needs a one-time trusted setup to generate its public parameters. Zcash launched in +October 2016 with both transparent and shielded addresses, after a multi-party ceremony to generate those +parameters. Later research, starting with the Halo technique in 2019, showed how to remove the need for a +trusted setup. From e8ec7985e75efd672e28d21d593cd60cf572d917 Mon Sep 17 00:00:00 2001 From: James Carnley Date: Tue, 27 Oct 2026 17:03:13 -0500 Subject: [PATCH 02/16] cypherpunk: host the two founding manifestos in full again The owner wants A Cypherpunk's Manifesto (Hughes, 1993) and The Crypto Anarchist Manifesto (May, 1988) on chain in full; they're foundational and widely republished. The repo had turned both into link-only records, while Sepolia still serves the full texts seeded in June. The full texts are restored byte-for-byte from that June seed, so the seeder only corrects their contentHash in place instead of publishing new copies. Manifest entries, README counts and the collection index are updated to match (5 hosted works, 16 link-only records). Also names the source of the Ocalan excerpt (The Sociology of Freedom, Volume 3); 2020 is the English edition's year. Co-authored-by: Claude Opus 5.5 --- datasets/cypherpunk-canon/README.md | 8 ++-- datasets/cypherpunk-canon/collection.md | 9 ++-- .../crypto-anarchist-manifesto-full.md | 35 ++++++++++----- .../cypherpunks-manifesto-full.md | 43 ++++++++++++++----- ...ition-of-democratic-civilization-record.md | 5 ++- datasets/cypherpunk-canon/manifest.json | 34 +++++++-------- 6 files changed, 84 insertions(+), 50 deletions(-) diff --git a/datasets/cypherpunk-canon/README.md b/datasets/cypherpunk-canon/README.md index a19469b..d9bd432 100644 --- a/datasets/cypherpunk-canon/README.md +++ b/datasets/cypherpunk-canon/README.md @@ -13,10 +13,10 @@ third-party bytes. ## Contents - 21 represented works. -- 3 works included locally as PDFs. -- 18 link-only metadata records. +- 5 works included locally: three PDFs and the full texts of the two manifestos. +- 16 link-only metadata records. - 25 deployable EFS entries: one index, three PDFs, three human-readable about - cards, and eighteen records. + cards, two manifesto texts, and sixteen records. Open [`collection.md`](./collection.md) for the human-readable shelf. `manifest.json` is the deployable, machine-readable inventory. @@ -28,6 +28,8 @@ Open [`collection.md`](./collection.md) for the human-readable shelf. | The Praxeology of Privacy | PDF | Explicit public-domain dedication in the work and on the author's site | | 21 Lessons | PDF | CC BY-SA 4.0 in the work and on the author's site | | Farewell to Westphalia | PDF | CC BY-SA 4.0 in the book | +| A Cypherpunk's Manifesto | Markdown | No explicit grant; hosted in full as a foundational, widely republished text (owner decision, 2026-10-27) | +| The Crypto Anarchist Manifesto | Markdown | No explicit grant; the source page says "freely distributable with attribution"; hosted in full (owner decision, 2026-10-27) | The binary files are unmodified. diff --git a/datasets/cypherpunk-canon/collection.md b/datasets/cypherpunk-canon/collection.md index c08879d..bd19f17 100644 --- a/datasets/cypherpunk-canon/collection.md +++ b/datasets/cypherpunk-canon/collection.md @@ -3,8 +3,9 @@ This index follows the 21-work collection assembled by [The Cypherpunk Library](https://www.cypherpunkbooks.com/collection). -EFS mirrors a work only when its redistribution terms are independently -supportable. Other works remain useful, discoverable records with links to an +EFS mirrors a work when its redistribution terms are independently supportable, +or when the work is foundational to the movement and widely republished (the two +manifestos). Other works remain useful, discoverable records with links to an upstream copy. A link-only record does not claim that EFS may redistribute the underlying work. @@ -15,13 +16,13 @@ underlying work. | The Praxeology of Privacy | Max Hillebrand | 2026 | PDF | | 21 Lessons | Gigi | 2019 | PDF | | Farewell to Westphalia | Jarrad Hope and Peter Ludlow | 2025 | PDF | +| A Cypherpunk's Manifesto | Eric Hughes | 1993 | Markdown (full text) | +| The Crypto Anarchist Manifesto | Timothy C. May | 1988 | Markdown (full text) | ## Linked Records | Work | Author | Year | |---|---|---:| -| A Cypherpunk's Manifesto | Eric Hughes | 1993 | -| The Crypto Anarchist Manifesto | Timothy C. May | 1988 | | A Declaration of the Independence of Cyberspace | John Perry Barlow | 1996 | | Your Secret Right to Cash | Peter Van Valkenburgh | 2017 | | Of Cypherpunks and Sousveillance | Patrick Anderson | 2022 | diff --git a/datasets/cypherpunk-canon/crypto-anarchist-manifesto-full.md b/datasets/cypherpunk-canon/crypto-anarchist-manifesto-full.md index 34da4f4..0d4c9a6 100644 --- a/datasets/cypherpunk-canon/crypto-anarchist-manifesto-full.md +++ b/datasets/cypherpunk-canon/crypto-anarchist-manifesto-full.md @@ -1,16 +1,29 @@ # The Crypto Anarchist Manifesto -- **Author:** Timothy C. May -- **Original year:** 1988 -- **Mailing-list publication:** 1992 -- **Source:** https://www.activism.net/cypherpunk/crypto-anarchy.html -- **Rights status:** NOASSERTION -- **EFS status:** Link-only; the underlying manifesto is not mirrored without - an explicit redistribution grant. +*Timothy C. May* -## Summary +> **Distribution note (posted to the Cypherpunks list, 22 Nov 1992):** +> Cypherpunks of the World, +> Several of you at the "physical Cypherpunks" gathering yesterday in Silicon Valley requested that more of the material passed out in meetings be available electronically to the entire readership of the Cypherpunks list, spooks, eavesdroppers, and all. +> Here's the "Crypto Anarchist Manifesto" I read at the September 1992 founding meeting. It dates back to mid-1988 and was distributed to some like-minded techno-anarchists at the "Crypto '88" conference and then again at the "Hackers Conference" that year. I later gave talks at Hackers on this in 1989 and 1990. +> There are a few things I'd change, but for historical reasons I'll just leave it as is. Some of the terms may be unfamiliar to you...I hope the Crypto Glossary I just distributed will help. +> (This should explain all those cryptic terms in my .signature!) +> --Tim May -May's early vision anticipates anonymous networks, digital money, reputation -systems, and markets that are difficult for states to observe or control. +--- -This EFS-authored metadata record is CC0-1.0. +"A specter is haunting the modern world, the specter of crypto anarchy." + +Computer technology is on the verge of providing the ability for individuals and groups to communicate and interact with each other in a totally anonymous manner. Two persons may exchange messages, conduct business, and negotiate electronic contracts without ever knowing the True Name, or legal identity, of the other. Interactions over networks will be untraceable, via extensive re-routing of encrypted packets and tamper-proof boxes which implement cryptographic protocols with nearly perfect assurance against any tampering. Reputations will be of central importance, far more important in dealings than even the credit ratings of today. These developments will alter completely the nature of government regulation, the ability to tax and control economic interactions, the ability to keep information secret, and will even alter the nature of trust and reputation. + +The technology for this revolution--and it surely will be both a social and economic revolution--has existed in theory for the past decade. The methods are based upon public-key encryption, zero-knowledge interactive proof systems, and various software protocols for interaction, authentication, and verification. The focus has until now been on academic conferences in Europe and the U.S., conferences monitored closely by the National Security Agency. But only recently have computer networks and personal computers attained sufficient speed to make the ideas practically realizable. And the next ten years will bring enough additional speed to make the ideas economically feasible and essentially unstoppable. High-speed networks, ISDN, tamper-proof boxes, smart cards, satellites, Ku-band transmitters, multi-MIPS personal computers, and encryption chips now under development will be some of the enabling technologies. + +The State will of course try to slow or halt the spread of this technology, citing national security concerns, use of the technology by drug dealers and tax evaders, and fears of societal disintegration. Many of these concerns will be valid; crypto anarchy will allow national secrets to be trade freely and will allow illicit and stolen materials to be traded. An anonymous computerized market will even make possible abhorrent markets for assassinations and extortion. Various criminal and foreign elements will be active users of CryptoNet. But this will not halt the spread of crypto anarchy. + +Just as the technology of printing altered and reduced the power of medieval guilds and the social power structure, so too will cryptologic methods fundamentally alter the nature of corporations and of government interference in economic transactions. Combined with emerging information markets, crypto anarchy will create a liquid market for any and all material which can be put into words and pictures. And just as a seemingly minor invention like barbed wire made possible the fencing-off of vast ranches and farms, thus altering forever the concepts of land and property rights in the frontier West, so too will the seemingly minor discovery out of an arcane branch of mathematics come to be the wire clippers which dismantle the barbed wire around intellectual property. + +Arise, you have nothing to lose but your barbed wire fences! + +--- + +*Source: https://www.activism.net/cypherpunk/crypto-anarchy.html — freely distributable with attribution to Timothy C. May.* diff --git a/datasets/cypherpunk-canon/cypherpunks-manifesto-full.md b/datasets/cypherpunk-canon/cypherpunks-manifesto-full.md index c05628c..86e8d43 100644 --- a/datasets/cypherpunk-canon/cypherpunks-manifesto-full.md +++ b/datasets/cypherpunk-canon/cypherpunks-manifesto-full.md @@ -1,16 +1,37 @@ # A Cypherpunk's Manifesto -- **Author:** Eric Hughes -- **Year:** 1993 -- **Source:** https://www.activism.net/cypherpunk/manifesto.html -- **Rights status:** NOASSERTION -- **EFS status:** Link-only; the underlying manifesto is not mirrored without - an explicit redistribution grant. +*by Eric Hughes — 9 March 1993* -## Summary +Privacy is necessary for an open society in the electronic age. Privacy is not secrecy. A private matter is something one doesn't want the whole world to know, but a secret matter is something one doesn't want anybody to know. Privacy is the power to selectively reveal oneself to the world. -The founding statement of the cypherpunk movement argues that privacy is the -power to reveal oneself selectively and that private systems must be built with -cryptography and code rather than requested from institutions. +If two parties have some sort of dealings, then each has a memory of their interaction. Each party can speak about their own memory of this; how could anyone prevent it? One could pass laws against it, but the freedom of speech, even more than privacy, is fundamental to an open society; we seek not to restrict any speech at all. If many parties speak together in the same forum, each can speak to all the others and aggregate together knowledge about individuals and other parties. The power of electronic communications has enabled such group speech, and it will not go away merely because we might want it to. -This EFS-authored metadata record is CC0-1.0. +Since we desire privacy, we must ensure that each party to a transaction have knowledge only of that which is directly necessary for that transaction. Since any information can be spoken of, we must ensure that we reveal as little as possible. In most cases personal identity is not salient. When I purchase a magazine at a store and hand cash to the clerk, there is no need to know who I am. When I ask my electronic mail provider to send and receive messages, my provider need not know to whom I am speaking or what I am saying or what others are saying to me; my provider only need know how to get the message there and how much I owe them in fees. When my identity is revealed by the underlying mechanism of the transaction, I have no privacy. I cannot here selectively reveal myself; I must *always* reveal myself. + +Therefore, privacy in an open society requires anonymous transaction systems. Until now, cash has been the primary such system. An anonymous transaction system is not a secret transaction system. An anonymous system empowers individuals to reveal their identity when desired and only when desired; this is the essence of privacy. + +Privacy in an open society also requires cryptography. If I say something, I want it heard only by those for whom I intend it. If the content of my speech is available to the world, I have no privacy. To encrypt is to indicate the desire for privacy, and to encrypt with weak cryptography is to indicate not too much desire for privacy. Furthermore, to reveal one's identity with assurance when the default is anonymity requires the cryptographic signature. + +We cannot expect governments, corporations, or other large, faceless organizations to grant us privacy out of their beneficence. It is to their advantage to speak of us, and we should expect that they will speak. To try to prevent their speech is to fight against the realities of information. Information does not just want to be free, it longs to be free. Information expands to fill the available storage space. Information is Rumor's younger, stronger cousin; Information is fleeter of foot, has more eyes, knows more, and understands less than Rumor. + +We must defend our own privacy if we expect to have any. We must come together and create systems which allow anonymous transactions to take place. People have been defending their own privacy for centuries with whispers, darkness, envelopes, closed doors, secret handshakes, and couriers. The technologies of the past did not allow for strong privacy, but electronic technologies do. + +We the Cypherpunks are dedicated to building anonymous systems. We are defending our privacy with cryptography, with anonymous mail forwarding systems, with digital signatures, and with electronic money. + +Cypherpunks write code. We know that someone has to write software to defend privacy, and since we can't get privacy unless we all do, we're going to write it. We publish our code so that our fellow Cypherpunks may practice and play with it. Our code is free for all to use, worldwide. We don't much care if you don't approve of the software we write. We know that software can't be destroyed and that a widely dispersed system can't be shut down. + +Cypherpunks deplore regulations on cryptography, for encryption is fundamentally a private act. The act of encryption, in fact, removes information from the public realm. Even laws against cryptography reach only so far as a nation's border and the arm of its violence. Cryptography will ineluctably spread over the whole globe, and with it the anonymous transactions systems that it makes possible. + +For privacy to be widespread it must be part of a social contract. People must come and together deploy these systems for the common good. Privacy only extends so far as the cooperation of one's fellows in society. We the Cypherpunks seek your questions and your concerns and hope we may engage you so that we do not deceive ourselves. We will not, however, be moved out of our course because some may disagree with our goals. + +The Cypherpunks are actively engaged in making the networks safer for privacy. Let us proceed together apace. + +Onward. + +Eric Hughes + +9 March 1993 + +--- + +*Source: https://www.activism.net/cypherpunk/manifesto.html — freely distributable with attribution.* diff --git a/datasets/cypherpunk-canon/definition-of-democratic-civilization-record.md b/datasets/cypherpunk-canon/definition-of-democratic-civilization-record.md index ae110e3..d7cf4bb 100644 --- a/datasets/cypherpunk-canon/definition-of-democratic-civilization-record.md +++ b/datasets/cypherpunk-canon/definition-of-democratic-civilization-record.md @@ -1,14 +1,15 @@ # Definition of Democratic Civilization - **Author:** Abdullah Ocalan -- **Year:** 2020 +- **From:** *The Sociology of Freedom: Manifesto of the Democratic Civilization, Volume 3* +- **Year:** 2020 (English edition) - **Source:** https://github.com/darkrenaissance/darkfi/blob/master/IDEOLOGY.md - **Rights status:** NOASSERTION - **EFS status:** Link-only; the underlying excerpt is not mirrored. ## Summary -An excerpt adopted by the DarkFi project that contrasts moral and political +An excerpt from Ocalan's *The Sociology of Freedom*, adopted by the DarkFi project that contrasts moral and political society with centralized state and capitalist structures. This EFS-authored metadata record is CC0-1.0. diff --git a/datasets/cypherpunk-canon/manifest.json b/datasets/cypherpunk-canon/manifest.json index 4f0e6b5..a0d19c2 100644 --- a/datasets/cypherpunk-canon/manifest.json +++ b/datasets/cypherpunk-canon/manifest.json @@ -23,33 +23,29 @@ { "path": "cypherpunks-manifesto-full.md", "name": "cypherpunks-manifesto-full.md", - "title": "About: A Cypherpunk's Manifesto", - "description": "A link record for Eric Hughes's 1993 statement on privacy, cryptography, and code.", - "tags": ["foundational", "privacy", "philosophy", "record"], - "license": "CC0-1.0", - "author": "EFS contributors", - "workAuthor": "Eric Hughes", + "title": "A Cypherpunk's Manifesto", + "description": "Eric Hughes's 1993 founding statement of the cypherpunk movement, in full.", + "tags": ["foundational", "privacy", "philosophy"], + "license": "NOASSERTION", + "author": "Eric Hughes", "originalYear": 1993, "source": "https://www.activism.net/cypherpunk/manifesto.html", - "workLicense": "NOASSERTION", - "redistributionStatus": "link-only", - "modificationStatus": "original-metadata" + "redistributionStatus": "deployable", + "modificationStatus": "verbatim" }, { "path": "crypto-anarchist-manifesto-full.md", "name": "crypto-anarchist-manifesto-full.md", - "title": "About: The Crypto Anarchist Manifesto", - "description": "A link record for Timothy C. May's vision of anonymous networks and crypto-anarchic markets.", - "tags": ["foundational", "markets", "philosophy", "record"], - "license": "CC0-1.0", - "author": "EFS contributors", - "workAuthor": "Timothy C. May", + "title": "The Crypto Anarchist Manifesto", + "description": "Timothy C. May's 1988 vision of anonymous networks and crypto-anarchic markets, in full.", + "tags": ["foundational", "markets", "philosophy"], + "license": "NOASSERTION", + "author": "Timothy C. May", "originalYear": 1988, "publicationYear": 1992, "source": "https://www.activism.net/cypherpunk/crypto-anarchy.html", - "workLicense": "NOASSERTION", - "redistributionStatus": "link-only", - "modificationStatus": "original-metadata" + "redistributionStatus": "deployable", + "modificationStatus": "verbatim" }, { "path": "cyberspace-independence-record.md", @@ -230,7 +226,7 @@ "path": "definition-of-democratic-civilization-record.md", "name": "definition-of-democratic-civilization-record.md", "title": "About: Definition of Democratic Civilization", - "description": "A link record for the Abdullah Ocalan excerpt adopted as DarkFi's ideology text.", + "description": "A link record for the excerpt from Abdullah Ocalan's The Sociology of Freedom (Volume 3) that DarkFi adopted as its ideology text.", "tags": ["governance", "political-theory", "darkfi", "record"], "license": "CC0-1.0", "author": "EFS contributors", From 92da708516133e8ac96d2fd7e51953380a96d721 Mon Sep 17 00:00:00 2001 From: James Carnley Date: Tue, 27 Oct 2026 17:03:13 -0500 Subject: [PATCH 03/16] standards: make cross-links work standalone; refresh catalog totals EIP/ERC cross-links (`./eip-N.md`) and the CC0 link (`../LICENSE.md`) only resolve inside the EIPs repo, so on EFS they were dead. They now point at eips.ethereum.org and creativecommons.org; the README notes the change. Text is otherwise verbatim. catalog.json and README byte totals match the edited datasets, and the catalog's licence posture records the owner's decisions. Co-authored-by: Claude Opus 5.5 --- README.md | 6 ++--- catalog.json | 12 ++++----- datasets/ethereum-eips/README.md | 2 +- datasets/ethereum-eips/eip-155.md | 2 +- datasets/ethereum-eips/eip-1559.md | 12 ++++----- datasets/ethereum-eips/eip-4844.md | 10 ++++---- datasets/ethereum-eips/eip-712.md | 2 +- datasets/ethereum-eips/erc-1155.md | 16 ++++++------ datasets/ethereum-eips/erc-1271.md | 4 +-- datasets/ethereum-eips/erc-20.md | 2 +- datasets/ethereum-eips/erc-4337.md | 40 +++++++++++++++--------------- datasets/ethereum-eips/erc-4626.md | 8 +++--- datasets/ethereum-eips/erc-721.md | 8 +++--- 13 files changed, 62 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 502951f..2de10fe 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ This repository is the portable content source for EFS demos and chain deploymen | Dataset | Anchor | Files | Bytes | Description | |---|---:|---:|---:|---| | [Web Games](./datasets/web-games/) | `/games` | 15 | 365441 | Single-file HTML5 games, playable in a sandboxed iframe. | -| [Crypto Whitepapers](./datasets/crypto-whitepapers/) | `/whitepapers` | 40 | 14474579 | Major cryptocurrency whitepapers and reference notes. | -| [Ethereum Standards](./datasets/ethereum-eips/) | `/standards` | 10 | 245523 | Landmark EIPs/ERCs, public domain under CC0. | -| [Cypherpunk Canon](./datasets/cypherpunk-canon/) | `/cypherpunk` | 25 | 23391250 | A rights-aware shelf representing 21 works with local files or link-only records. | +| [Crypto Whitepapers](./datasets/crypto-whitepapers/) | `/whitepapers` | 40 | 14472971 | Major cryptocurrency whitepapers and reference notes. | +| [Ethereum Standards](./datasets/ethereum-eips/) | `/standards` | 10 | 247026 | Landmark EIPs/ERCs, public domain under CC0. | +| [Cypherpunk Canon](./datasets/cypherpunk-canon/) | `/cypherpunk` | 25 | 23400126 | A rights-aware shelf representing 21 works with local files or link-only records. | `catalog.json` is the machine-readable table of contents. Each dataset folder owns its own `manifest.json`, `README.md`, and source files. diff --git a/catalog.json b/catalog.json index 2c90a21..8842352 100644 --- a/catalog.json +++ b/catalog.json @@ -22,9 +22,9 @@ "manifest": "datasets/crypto-whitepapers/manifest.json", "anchorPath": "/whitepapers", "fileCount": 40, - "bytes": 14474579, - "status": "deployable-with-review", - "licensePosture": "mixed; review per-file markdown and README notes", + "bytes": 14472971, + "status": "deployable", + "licensePosture": "papers hosted as published by their projects or authors; most carry no licence (owner decision 2026-10-27: no licence field required for documents)", "description": "Major cryptocurrency whitepapers and reference notes." }, { @@ -34,7 +34,7 @@ "manifest": "datasets/ethereum-eips/manifest.json", "anchorPath": "/standards", "fileCount": 10, - "bytes": 245523, + "bytes": 247026, "status": "deployable", "licensePosture": "CC0-1.0", "description": "Landmark Ethereum standards (EIPs/ERCs), public domain under CC0." @@ -46,9 +46,9 @@ "manifest": "datasets/cypherpunk-canon/manifest.json", "anchorPath": "/cypherpunk", "fileCount": 25, - "bytes": 23391250, + "bytes": 23400126, "status": "deployable-mixed", - "licensePosture": "local payloads are CC0, CC BY-SA, or public domain; linked works are represented by CC0 records and are not mirrored", + "licensePosture": "local PDFs are CC BY-SA or public domain; the two manifestos are hosted in full (owner decision 2026-10-27); other works are CC0 link-only records", "description": "A rights-aware shelf representing 21 cypherpunk works with local reading files or link-only records." } ] diff --git a/datasets/ethereum-eips/README.md b/datasets/ethereum-eips/README.md index ffa5f75..b62cb24 100644 --- a/datasets/ethereum-eips/README.md +++ b/datasets/ethereum-eips/README.md @@ -2,7 +2,7 @@ The landmark standards that define how Ethereum works — the token standards, the fee market, account abstraction, typed signing. A fourth reference dataset for the EFS × OnionDAO buildathon, alongside [`../crypto-whitepapers/`](../crypto-whitepapers/), [`../cypherpunk-canon/`](../cypherpunk-canon/), and [`../web-games/`](../web-games/). -**License: CC0** — EIPs and ERCs are released into the public domain ([EIP-1](https://eips.ethereum.org/EIPS/eip-1)), so they are cleanly redistributable onto EFS. Fetched verbatim from the canonical repos (`ethereum/EIPs`, `ethereum/ERCs`). +**License: CC0** — EIPs and ERCs are released into the public domain ([EIP-1](https://eips.ethereum.org/EIPS/eip-1)), so they are cleanly redistributable onto EFS. Fetched from the canonical repos (`ethereum/EIPs`, `ethereum/ERCs`). The text is verbatim except that links to other EIPs (`./eip-N.md`) and to the CC0 licence (`../LICENSE.md`) were converted to absolute URLs, so they work outside the EIPs repo. **Modeled the EFS way: flat files + tags, not folders.** Each standard is one item; its category is a **tag** (a token standard is `tokens`; ERC-721 is both `tokens` and `nft`). On EFS each `.md` = a DATA at a stable anchor with TAG edges. They render natively in the markdown pane. diff --git a/datasets/ethereum-eips/eip-155.md b/datasets/ethereum-eips/eip-155.md index 17024fa..5ae2c05 100644 --- a/datasets/ethereum-eips/eip-155.md +++ b/datasets/ethereum-eips/eip-155.md @@ -9,7 +9,7 @@ created: 2016-10-14 --- ### Hard fork -[Spurious Dragon](./eip-607.md) +[Spurious Dragon](https://eips.ethereum.org/EIPS/eip-607) ### Parameters - `FORK_BLKNUM`: 2,675,000 diff --git a/datasets/ethereum-eips/eip-1559.md b/datasets/ethereum-eips/eip-1559.md index 26a5b73..613b56d 100644 --- a/datasets/ethereum-eips/eip-1559.md +++ b/datasets/ethereum-eips/eip-1559.md @@ -14,7 +14,7 @@ requires: 2718, 2930 A transaction pricing mechanism that includes fixed-per-block network fee that is burned and dynamically expands/contracts block sizes to deal with transient congestion. ## Abstract -We introduce a new [EIP-2718](./eip-2718.md) transaction type, with the format `0x02 || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s])`. +We introduce a new [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) transaction type, with the format `0x02 || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s])`. There is a base fee per gas in protocol, which can move up or down each block according to a formula which is a function of gas used in parent block and gas target (block gas limit divided by elasticity multiplier) of parent block. The algorithm results in the base fee per gas increasing when blocks are above the gas target, and decreasing when blocks are below the gas target. @@ -39,15 +39,15 @@ An important aspect of this fee system is that miners only get to keep the prior Block validity is defined in the reference implementation below. The `GASPRICE` (`0x3a`) opcode **MUST** return the `effective_gas_price` as defined in the reference implementation below. -As of `FORK_BLOCK_NUMBER`, a new [EIP-2718](./eip-2718.md) transaction is introduced with `TransactionType` 2. +As of `FORK_BLOCK_NUMBER`, a new [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) transaction is introduced with `TransactionType` 2. -The intrinsic cost of the new transaction is inherited from [EIP-2930](./eip-2930.md), specifically `21000 + 16 * non-zero calldata bytes + 4 * zero calldata bytes + 1900 * access list storage key count + 2400 * access list address count`. +The intrinsic cost of the new transaction is inherited from [EIP-2930](https://eips.ethereum.org/EIPS/eip-2930), specifically `21000 + 16 * non-zero calldata bytes + 4 * zero calldata bytes + 1900 * access list storage key count + 2400 * access list address count`. -The [EIP-2718](./eip-2718.md) `TransactionPayload` for this transaction is `rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s])`. +The [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) `TransactionPayload` for this transaction is `rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s])`. The `signature_y_parity, signature_r, signature_s` elements of this transaction represent a secp256k1 signature over `keccak256(0x02 || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list]))`. -The [EIP-2718](./eip-2718.md) `ReceiptPayload` for this transaction is `rlp([status, cumulative_transaction_gas_used, logs_bloom, logs])`. +The [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) `ReceiptPayload` for this transaction is `rlp([status, cumulative_transaction_gas_used, logs_bloom, logs])`. *Note: `//` is integer division, round down.* ```python @@ -326,4 +326,4 @@ Should a miner attempt to execute this attack, we can simply increase the elasti By burning the base fee, we can no longer guarantee a fixed Ether supply. This could result in economic instability as the long term supply of ETH will no longer be constant over time. While a valid concern, it is difficult to quantify how much of an impact this will have. If more is burned on base fee than is generated in mining rewards then ETH will be deflationary and if more is generated in mining rewards than is burned then ETH will be inflationary. Since we cannot control user demand for block space, we cannot assert at the moment whether ETH will end up inflationary or deflationary, so this change causes the core developers to lose some control over Ether's long term quantity. ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/eip-4844.md b/datasets/ethereum-eips/eip-4844.md index de2e4a4..3eabb75 100644 --- a/datasets/ethereum-eips/eip-4844.md +++ b/datasets/ethereum-eips/eip-4844.md @@ -96,19 +96,19 @@ def fake_exponential(factor: int, numerator: int, denominator: int) -> int: ### Blob transaction -We introduce a new type of [EIP-2718](./eip-2718.md) transaction, "blob transaction", where the `TransactionType` is `BLOB_TX_TYPE` and the `TransactionPayload` is the RLP serialization of the following `TransactionPayloadBody`: +We introduce a new type of [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) transaction, "blob transaction", where the `TransactionType` is `BLOB_TX_TYPE` and the `TransactionPayload` is the RLP serialization of the following `TransactionPayloadBody`: ``` [chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, to, value, data, access_list, max_fee_per_blob_gas, blob_versioned_hashes, y_parity, r, s] ``` -The fields `chain_id`, `nonce`, `max_priority_fee_per_gas`, `max_fee_per_gas`, `gas_limit`, `value`, `data`, and `access_list` follow the same semantics as [EIP-1559](./eip-1559.md). +The fields `chain_id`, `nonce`, `max_priority_fee_per_gas`, `max_fee_per_gas`, `gas_limit`, `value`, `data`, and `access_list` follow the same semantics as [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559). The field `to` deviates slightly from the semantics with the exception that it MUST NOT be `nil` and therefore must always represent a 20-byte address. This means that blob transactions cannot have the form of a create transaction. The field `max_fee_per_blob_gas` is a `uint256` and the field `blob_versioned_hashes` represents a list of hash outputs from `kzg_to_versioned_hash`. -The [EIP-2718](./eip-2718.md) `ReceiptPayload` for this transaction is `rlp([status, cumulative_transaction_gas_used, logs_bloom, logs])`. +The [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) `ReceiptPayload` for this transaction is `rlp([status, cumulative_transaction_gas_used, logs_bloom, logs])`. #### Signature @@ -414,7 +414,7 @@ though not an unprecedented one as this also applies to transactions with large By only broadcasting announcements for blob transactions, receiving nodes will have control over which and how many transactions to receive, allowing them to throttle throughput to an acceptable level. -[EIP-5793](./eip-5793.md) will give further fine-grained control to nodes by extending the `NewPooledTransactionHashes` announcement messages to include the transaction type and size. +[EIP-5793](https://eips.ethereum.org/EIPS/eip-5793) will give further fine-grained control to nodes by extending the `NewPooledTransactionHashes` announcement messages to include the transaction type and size. In addition, we recommend including a 1.1x base fee per blob gas bump requirement to the mempool transaction replacement rules. @@ -435,4 +435,4 @@ a much shorter delay compared to proposed (but yet to be implemented) one-year r ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/eip-712.md b/datasets/ethereum-eips/eip-712.md index d6f7ba3..00828ac 100644 --- a/datasets/ethereum-eips/eip-712.md +++ b/datasets/ethereum-eips/eip-712.md @@ -361,4 +361,4 @@ The mechanism for reliably broadcasting a signature is application-specific and ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-1155.md b/datasets/ethereum-eips/erc-1155.md index 42ca3a7..8e0fc17 100644 --- a/datasets/ethereum-eips/erc-1155.md +++ b/datasets/ethereum-eips/erc-1155.md @@ -399,7 +399,7 @@ Example of such a URI: `https://token-cdn-domain/{id}.json` would be replaced wi #### Metadata Extensions -The optional `ERC1155Metadata_URI` extension can be identified with the [ERC-165 Standard Interface Detection](./eip-165.md). +The optional `ERC1155Metadata_URI` extension can be identified with the [ERC-165 Standard Interface Detection](https://eips.ethereum.org/EIPS/eip-165). If the optional `ERC1155Metadata_URI` extension is included: * The ERC-165 `supportsInterface` function MUST return the constant value `true` if `0x0e89341c` is passed through the `interfaceID` argument. @@ -577,7 +577,7 @@ fr.json: ### Approval -The function `setApprovalForAll` allows an operator to manage one's entire set of tokens on behalf of the approver. To permit approval of a subset of token IDs, an interface such as [ERC-1761 Scoped Approval Interface](./eip-1761.md) is suggested. +The function `setApprovalForAll` allows an operator to manage one's entire set of tokens on behalf of the approver. To permit approval of a subset of token IDs, an interface such as [ERC-1761 Scoped Approval Interface](https://eips.ethereum.org/EIPS/eip-1761) is suggested. The counterpart `isApprovedForAll` provides introspection into any status set by `setApprovalForAll`. An owner SHOULD be assumed to always be able to operate on their own tokens regardless of approval status, so should SHOULD NOT have to call `setApprovalForAll` to approve themselves as an operator before they can operate on them. @@ -592,7 +592,7 @@ The `name` function (for human-readable asset names, on-chain) was removed from ### Upgrades -The requirement to emit `TransferSingle` or `TransferBatch` on balance change implies that a valid implementation of ERC-1155 redeploying to a new contract address MUST emit events from the new contract address to replicate the deprecated contract final state. It is valid to only emit a minimal number of events to reflect only the final balance and omit all the transactions that led to that state. The event emit requirement is to ensure that the current state of the contract can always be traced only through events. To alleviate the need to emit events when changing contract address, consider using the proxy pattern, such as described in [EIP-2535](./eip-2535.md). This will also have the added benefit of providing a stable contract address for users. +The requirement to emit `TransferSingle` or `TransferBatch` on balance change implies that a valid implementation of ERC-1155 redeploying to a new contract address MUST emit events from the new contract address to replicate the deprecated contract final state. It is valid to only emit a minimal number of events to reflect only the final balance and omit all the transactions that led to that state. The event emit requirement is to ensure that the current state of the contract can always be traced only through events. To alleviate the need to emit events when changing contract address, consider using the proxy pattern, such as described in [EIP-2535](https://eips.ethereum.org/EIPS/eip-2535). This will also have the added benefit of providing a stable contract address for users. ### Design decision: Supporting non-batch @@ -610,7 +610,7 @@ As the Ethereum ecosystem continues to grow, many dapps are relying on tradition The function `setApprovalForAll` allows an operator to manage one's entire set of tokens on behalf of the approver. It enables frictionless interaction with exchange and trade contracts. -Restricting approval to a certain set of token IDs, quantities or other rules MAY be done with an additional interface or an external contract. The rationale is to keep the ERC-1155 standard as generic as possible for all use-cases without imposing a specific approval scheme on implementations that may not need it. Standard token approval interfaces can be used, such as the suggested [ERC-1761 Scoped Approval Interface](./eip-1761.md) which is compatible with ERC-1155. +Restricting approval to a certain set of token IDs, quantities or other rules MAY be done with an additional interface or an external contract. The rationale is to keep the ERC-1155 standard as generic as possible for all use-cases without imposing a specific approval scheme on implementations that may not need it. Standard token approval interfaces can be used, such as the suggested [ERC-1761 Scoped Approval Interface](https://eips.ethereum.org/EIPS/eip-1761) which is compatible with ERC-1155. ## Backwards Compatibility @@ -686,9 +686,9 @@ Another simple way to represent non-fungibles is to allow a maximum value of 1 f ## References **Standards** -- [ERC-721 Non-Fungible Token Standard](./eip-721.md) -- [ERC-165 Standard Interface Detection](./eip-165.md) -- [ERC-1538 Transparent Contract Standard](./eip-1538.md) +- [ERC-721 Non-Fungible Token Standard](https://eips.ethereum.org/EIPS/eip-721) +- [ERC-165 Standard Interface Detection](https://eips.ethereum.org/EIPS/eip-165) +- [ERC-1538 Transparent Contract Standard](https://eips.ethereum.org/EIPS/eip-1538) - [JSON Schema](https://json-schema.org/) - [RFC 2119 Key words for use in RFCs to Indicate Requirement Levels](https://www.ietf.org/rfc/rfc2119.txt) @@ -707,4 +707,4 @@ Another simple way to represent non-fungibles is to allow a maximum value of 1 f - [ERC-1155: A new standard for The Sandbox](https://medium.com/sandbox-game/erc-1155-a-new-standard-for-the-sandbox-c95ee1e45072) ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-1271.md b/datasets/ethereum-eips/erc-1271.md index 39f9e4e..eaa144a 100644 --- a/datasets/ethereum-eips/erc-1271.md +++ b/datasets/ethereum-eips/erc-1271.md @@ -57,7 +57,7 @@ This function should be implemented by contracts which desire to sign messages ( ## Rationale We believe the name of the proposed function to be appropriate considering that an *authorized* signers providing proper signatures for a given data would see their signature as "valid" by the signing contract. Hence, a signed action message is only valid when the signer is authorized to perform a given action on the behalf of a smart wallet. -Two arguments are provided for simplicity of separating the hash signed from the signature. A bytes32 hash is used instead of the unhashed message for simplicity, since contracts could expect a certain hashing function that is not standard, such as with [EIP-712](./eip-712.md). +Two arguments are provided for simplicity of separating the hash signed from the signature. A bytes32 hash is used instead of the unhashed message for simplicity, since contracts could expect a certain hashing function that is not standard, such as with [EIP-712](https://eips.ethereum.org/EIPS/eip-712). `isValidSignature()` should not be able to modify states in order to prevent `GasToken` minting or similar attack vectors. Again, this is to simplify the implementation surface of the function for better standardization and to allow off-chain contract queries. @@ -159,4 +159,4 @@ Note also that each contract implementing this method is responsible to ensure t ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-20.md b/datasets/ethereum-eips/erc-20.md index cdd8a14..b0f66a1 100644 --- a/datasets/ethereum-eips/erc-20.md +++ b/datasets/ethereum-eips/erc-20.md @@ -190,4 +190,4 @@ Historical links related to this standard: ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-4337.md b/datasets/ethereum-eips/erc-4337.md index 14ff3ad..8b43b66 100644 --- a/datasets/ethereum-eips/erc-4337.md +++ b/datasets/ethereum-eips/erc-4337.md @@ -25,7 +25,7 @@ A number of proposals have been thoroughly discussed, but so far none of them ha This proposal takes a different approach, avoiding any adjustments to the consensus layer. It seeks to achieve the following goals: * **Achieve the key goal of Account Abstraction**: allow users to use Smart Contract Accounts containing arbitrary verification logic instead of EOAs as their primary account. Completely remove any need at all for users to also have EOAs, - as required by both status quo Smart Contract Accounts and [EIP-7702](./eip-7702.md). + as required by both status quo Smart Contract Accounts and [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702). * **Decentralization** * Allow any bundler (think: block builder) to participate in the process of including account-abstracted `UserOperations` * Work with all activity happening over a public mempool; users do not need to know the direct communication addresses (eg. IP, onion) of any specific actors @@ -33,8 +33,8 @@ This proposal takes a different approach, avoiding any adjustments to the consen * **Do not require any Ethereum consensus changes**: Ethereum consensus layer development is focusing on scalability-oriented features, and there may not be any opportunity for further protocol changes for a long time. Hence, to increase the chance of faster adoption, this proposal avoids Ethereum consensus changes. * **Support other use cases** * Privacy-preserving applications - * Atomic multi-operations (similar goal to [EIP-7702](./eip-7702.md)) - * Pay tx fees with [ERC-20](./eip-20.md) tokens, allow developers to pay fees for their users, and [EIP-7702](./eip-7702.md)-like **sponsored transaction** use cases more generally + * Atomic multi-operations (similar goal to [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702)) + * Pay tx fees with [ERC-20](https://eips.ethereum.org/EIPS/eip-20) tokens, allow developers to pay fees for their users, and [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702)-like **sponsored transaction** use cases more generally * abstracting the validation allows the contract to use different signature schemes, multisig configuration, custom recovery, and more. * abstracting gas payments allows easy onboarding by 3rd party payments, paying with tokens, cross-chain gas payments * abstracting execution allows bundled transactions @@ -76,7 +76,7 @@ To avoid Ethereum consensus changes, we do not attempt to create new transaction | `callGasLimit` | `uint256` | The amount of gas to allocate the main execution call | | `verificationGasLimit` | `uint256` | The amount of gas to allocate for the verification step | | `preVerificationGas` | `uint256` | Extra gas to pay the bundler | -| `maxFeePerGas` | `uint256` | Maximum fee per gas (similar to [EIP-1559](./eip-1559.md) `max_fee_per_gas`) | +| `maxFeePerGas` | `uint256` | Maximum fee per gas (similar to [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559) `max_fee_per_gas`) | | `maxPriorityFeePerGas` | `uint256` | Maximum priority fee per gas (similar to EIP-1559 `max_priority_fee_per_gas`) | | `paymaster` | `address` | Address of paymaster contract, (or empty, if the `sender` pays for gas by itself) | | `paymasterVerificationGasLimit` | `uint256` | The amount of gas to allocate for the paymaster validation code (only if paymaster exists) | @@ -89,7 +89,7 @@ Users send `UserOperation` objects to a dedicated `UserOperation` mempool. To prevent replay attacks, either cross-chain or with multiple `EntryPoint` contract versions, the `signature` MUST depend on `chainid` and the `EntryPoint` address. -Note that one [EIP-7702](./eip-7702.md) "authorization tuple" value can be provided alongside the `UserOperation` struct, +Note that one [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) "authorization tuple" value can be provided alongside the `UserOperation` struct, but "authorization tuples" are not included in the `UserOperation` itself. ### `EntryPoint` interface @@ -232,7 +232,7 @@ The `EntryPoint`'s `handleOps` function must perform the following steps (we fir In the verification loop, the `handleOps` call must perform the following steps for each `UserOperation`: * **Create the `sender` Smart Contract Account if it does not yet exist**, using the `initcode` provided in the `UserOperation`. - * If the `factory` address is "0x7702", then the sender MUST be an EOA with an [EIP-7702](./eip-7702.md) authorization designation. The `EntryPoint` validates the authorized address matches the one specified in the `UserOperation` signature (see [Support for [EIP-7702] authorizations](#support-for-eip-7702-authorizations)). + * If the `factory` address is "0x7702", then the sender MUST be an EOA with an [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) authorization designation. The `EntryPoint` validates the authorized address matches the one specified in the `UserOperation` signature (see [Support for [EIP-7702] authorizations](#support-for-eip-7702-authorizations)). * If the `sender` does not exist, _and_ the `initcode` is empty, or does not deploy a contract at the "sender" address, the call must fail. * **WARNING**: If the `sender` does exist, _and_ the `initcode` is _not_ empty, then the `initcode` is ignored. * calculate the maximum possible fee the `sender` needs to pay based on validation and call gas limits, and current gas values. @@ -258,14 +258,14 @@ to verify that the signature is correct and the `UserOperation` actually pays fe A node/bundler MUST reject a `UserOperation` that fails the validation, meaning not adding it to the local mempool and not propagating it to other peers. -### JSON-RPC API for [ERC-4337](./eip-4337.md) +### JSON-RPC API for [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) In order to support sending `UserOperation` objects to bundlers, which in turn propagate them through the P2P mempool, we introduce a set of JSON-RPC APIs including `eth_sendUserOperation` and `eth_getUserOperationReceipt`. The full definition of the new JSON-RPC API is outside the scope of this proposal. -### Support for [EIP-712](./eip-712.md) signatures +### Support for [EIP-712](https://eips.ethereum.org/EIPS/eip-712) signatures The `userOpHash` is calculated as an [EIP-712] typed message hash with the following parameters: @@ -281,13 +281,13 @@ bytes32 constant PACKED_USEROP_TYPEHASH = ); ``` -### Support for [EIP-7702](./eip-7702.md) authorizations +### Support for [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) authorizations -On networks with [EIP-7702](./eip-7702.md) enabled, the `eth_sendUserOperation` method accepts an extra `eip7702Auth` parameter. -If this parameter is set, it MUST be a valid [EIP-7702](./eip-7702.md) authorization tuple, and signed by the `sender` address. +On networks with [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) enabled, the `eth_sendUserOperation` method accepts an extra `eip7702Auth` parameter. +If this parameter is set, it MUST be a valid [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) authorization tuple, and signed by the `sender` address. The bundler MUST add all required `eip7702Auth` of all `UserOperations` in a bundle to the `authorizationList` and execute the bundle using a transaction type `SET_CODE_TX_TYPE`. -Additionally, the `UserOperation` hash calculation is updated to include the desired [EIP-7702](./eip-7702.md) delegation address. +Additionally, the `UserOperation` hash calculation is updated to include the desired [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) delegation address. If the `initCode` field starts with `0x7702` right-padded with 18 zeros, and this account was deployed using an EIP-7702 transaction, then the hash is calculated as follows: @@ -296,7 +296,7 @@ If the `initCode` field starts with `0x7702` right-padded with 18 zeros, and thi * If the `initCode` is longer than 20 bytes, then the rest of the initCode is used to call an initialization function in the account itself. Note that a `UserOperation` may still be executed without such `initCode`. -In this case the `EntryPoint` doesn't hash the current [EIP-7702 delegate](./eip-7702.md), and can be potentially executed against a modified account. +In this case the `EntryPoint` doesn't hash the current [EIP-7702 delegate](https://eips.ethereum.org/EIPS/eip-7702), and can be potentially executed against a modified account. Additionally, EIP-7702 defines the gas cost of executing an authorization equal to `PER_EMPTY_ACCOUNT_COST = 25000`. This gas consumption is not observable on-chain by the `EntryPoint` contract and MUST be included in the `preVerificationGas` value. @@ -396,7 +396,7 @@ Similar to an Ethereum transaction, the offchain flow of a `UserOperation` can b When a bundler receives a `UserOperation`, it must first run some basic sanity checks, namely that: * Either the `sender` is an existing contract, or the `initCode` is not empty (but not both) -* If `initCode` is not empty, parse its first 20 bytes as a factory address or an [EIP-7702](./eip-7702.md) flag.\ +* If `initCode` is not empty, parse its first 20 bytes as a factory address or an [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) flag.\ Record whether the factory is staked, in case the later simulation indicates that it needs to be. If the factory accesses the global state, it must be staked. * The `verificationGasLimit` and `paymasterVerificationGasLimits` are lower than `MAX_VERIFICATION_GAS` (`500000`) and the `preVerificationGas` is high enough to pay for the calldata gas cost of serializing the `UserOperation` plus `PRE_VERIFICATION_OVERHEAD_GAS` (`50000`). * The `paymasterAndData` is either empty, or starts with the **paymaster** address, which is a contract that (i) currently has nonempty code on chain, (ii) has a sufficient deposit to pay for the UserOperation, and (iii) is not currently banned. During simulation, the paymaster's stake is also checked, depending on its storage usage. @@ -455,14 +455,14 @@ as it depends on non-permanent network properties such as operation and data gas However, the requirement is for the estimated value to be sufficient to cover the following costs: * Base bundle transaction cost. On Ethereum, `21000` gas divided by the number of `UserOperations`. -* The calldata gas cost related to the `UserOperation` as defined in [EIP-2028](./eip-2028.md). +* The calldata gas cost related to the `UserOperation` as defined in [EIP-2028](https://eips.ethereum.org/EIPS/eip-2028). * Static `EntryPoint` contract code execution. * Static memory cost when loading the fixed size fields of the `UserOperation` into EVM memory * Memory cost (including expansion cost) due to context returned by paymaster `validatePaymasterUserOp` function, if relevant. * External call to the `innerHandleOp()` function which is a major part of the `EntryPoint` implementation. Note that this value is not static and depends on the `UserOperation`'s position in the bundle. * [EIP-7702] authorization cost, if any. -* [EIP-7623](./eip-7623.md) calldata floor price increase is estimated as follows: +* [EIP-7623](https://eips.ethereum.org/EIPS/eip-7623) calldata floor price increase is estimated as follows: * Apply the new formula for `tx.gasUsed`, replacing the `execution_gas_used` value with an estimate for value made for this UserOperation. * The estimate is calculated as a sum of all verification gas used during simulation (account creation, validation and paymaster validation) and 10% of the sum of execution and `postOp` gas limit. @@ -554,11 +554,11 @@ either via on-chain delegate proxy contracts or via EIP-7702. When changing the underlying implementation, all Accounts MUST ensure that there are no conflicts in the storage layout of the two contracts. -One common approach to this problem is often referred to as "diamond storage" and is fully described in [ERC-7201](./eip-7201.md). +One common approach to this problem is often referred to as "diamond storage" and is fully described in [ERC-7201](https://eips.ethereum.org/EIPS/eip-7201). ### Transient Storage -Contracts using the [EIP-1153](./eip-1153.md) transient storage MUST take into account that ERC-4337 allows multiple +Contracts using the [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153) transient storage MUST take into account that ERC-4337 allows multiple `UserOperations` from different unrelated `sender` addresses to be included in the same underlying transaction. The transient storage MUST be cleaned up manually if contains any sensitive information or is used for access control. @@ -631,7 +631,7 @@ it makes a static call to the `entryPoint.getSenderAddress()` ## Backwards Compatibility -This ERC does not change the consensus layer, so there are no backwards compatibility issues for Ethereum as a whole. Unfortunately it is not easily compatible with pre-[ERC-4337](./eip-4337.md) Smart Contract Accounts, because those Accounts do not have a `validateUserOp` function. If the Smart Contract Account has a function for authorizing a trusted `UserOperation` submitter, then this could be fixed by creating an [ERC-4337](./eip-4337.md) compatible Account that re-implements the verification logic as a wrapper and setting it to be the original Account's trusted `UserOperation` submitter. +This ERC does not change the consensus layer, so there are no backwards compatibility issues for Ethereum as a whole. Unfortunately it is not easily compatible with pre-[ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) Smart Contract Accounts, because those Accounts do not have a `validateUserOp` function. If the Smart Contract Account has a function for authorizing a trusted `UserOperation` submitter, then this could be fixed by creating an [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) compatible Account that re-implements the verification logic as a wrapper and setting it to be the original Account's trusted `UserOperation` submitter. ## Security Considerations @@ -644,4 +644,4 @@ Verification would need to cover two primary claims (not including claims needed ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-4626.md b/datasets/ethereum-eips/erc-4626.md index 41de5ab..1054ba6 100644 --- a/datasets/ethereum-eips/erc-4626.md +++ b/datasets/ethereum-eips/erc-4626.md @@ -14,7 +14,7 @@ requires: 20, 2612 ## Abstract The following standard allows for the implementation of a standard API for tokenized Vaults -representing shares of a single underlying [EIP-20](./eip-20.md) token. +representing shares of a single underlying [EIP-20](https://eips.ethereum.org/EIPS/eip-20) token. This standard is an extension on the EIP-20 token that provides basic functionality for depositing and withdrawing tokens and reading balances. @@ -28,7 +28,7 @@ A standard for tokenized Vaults will lower the integration effort for yield-bear ## Specification -All [EIP-4626](./eip-4626.md) tokenized Vaults MUST implement EIP-20 to represent shares. +All [EIP-4626](https://eips.ethereum.org/EIPS/eip-4626) tokenized Vaults MUST implement EIP-20 to represent shares. If a Vault is to be non-transferrable, it MAY revert on calls to `transfer` or `transferFrom`. The EIP-20 operations `balanceOf`, `transfer`, `totalSupply`, etc. operate on the Vault "shares" which represent a claim to ownership on a fraction of the Vault's underlying holdings. @@ -36,7 +36,7 @@ which represent a claim to ownership on a fraction of the Vault's underlying hol All EIP-4626 tokenized Vaults MUST implement EIP-20's optional metadata extensions. The `name` and `symbol` functions SHOULD reflect the underlying token's `name` and `symbol` in some way. -EIP-4626 tokenized Vaults MAY implement [EIP-2612](./eip-2612.md) to improve the UX of approving shares on various integrations. +EIP-4626 tokenized Vaults MAY implement [EIP-2612](https://eips.ethereum.org/EIPS/eip-2612) to improve the UX of approving shares on various integrations. ### Definitions: @@ -609,4 +609,4 @@ the underlying token's `decimals` if at all possible, to eliminate possible sour ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/datasets/ethereum-eips/erc-721.md b/datasets/ethereum-eips/erc-721.md index 7f23182..8adce78 100644 --- a/datasets/ethereum-eips/erc-721.md +++ b/datasets/ethereum-eips/erc-721.md @@ -391,9 +391,9 @@ XXXXERC721, by William Entriken -- a scalable example implementation **Standards** -1. [ERC-20](./eip-20.md) Token Standard. -1. [ERC-165](./eip-165.md) Standard Interface Detection. -1. [ERC-173](./eip-173.md) Owned Standard. +1. [ERC-20](https://eips.ethereum.org/EIPS/eip-20) Token Standard. +1. [ERC-165](https://eips.ethereum.org/EIPS/eip-165) Standard Interface Detection. +1. [ERC-173](https://eips.ethereum.org/EIPS/eip-173) Owned Standard. 1. [ERC-223](https://github.com/ethereum/EIPs/issues/223) Token Standard. 1. [ERC-677](https://github.com/ethereum/EIPs/issues/677) `transferAndCall` Token Standard. 1. [ERC-827](https://github.com/ethereum/EIPs/issues/827) Token Standard. @@ -444,4 +444,4 @@ XXXXERC721, by William Entriken -- a scalable example implementation ## Copyright -Copyright and related rights waived via [CC0](../LICENSE.md). +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). From 73e73958fddbf531385179a4cadf3f16e3be7dd5 Mon Sep 17 00:00:00 2001 From: James Carnley Date: Tue, 27 Oct 2026 17:08:37 -0500 Subject: [PATCH 04/16] whitepapers: keep a neutral rights note on every card The previous commit dropped each card's licence/distribution line along with the internal review wording. AGENTS.md says licence notes must not be removed (Codex review), and the owner's decision was only that a machine-readable licence field isn't required for documents. Every card now carries a one-line **Rights:** note in neutral wording: what the paper itself states, or that it states nothing. Earlier claims that couldn't be confirmed are kept but marked as unverified (Ethereum's CC BY, Filecoin's Creative Commons). Polkadot's Creative Commons statement was confirmed in the PDF text. Catalog byte totals updated. Co-authored-by: Claude Opus 5.5 --- README.md | 2 +- catalog.json | 2 +- datasets/crypto-whitepapers/algorand.md | 1 + datasets/crypto-whitepapers/avalanche.md | 1 + datasets/crypto-whitepapers/binance-bnb.md | 1 + datasets/crypto-whitepapers/bitcoin.md | 1 + datasets/crypto-whitepapers/cardano.md | 1 + datasets/crypto-whitepapers/chainlink.md | 1 + datasets/crypto-whitepapers/cosmos.md | 1 + datasets/crypto-whitepapers/dogecoin.md | 1 + datasets/crypto-whitepapers/ethereum.md | 1 + datasets/crypto-whitepapers/filecoin.md | 1 + datasets/crypto-whitepapers/litecoin.md | 1 + datasets/crypto-whitepapers/monero.md | 1 + datasets/crypto-whitepapers/polkadot.md | 1 + datasets/crypto-whitepapers/polygon.md | 1 + datasets/crypto-whitepapers/solana.md | 1 + datasets/crypto-whitepapers/tezos.md | 1 + datasets/crypto-whitepapers/tron.md | 1 + datasets/crypto-whitepapers/uniswap.md | 1 + datasets/crypto-whitepapers/xrp-ripple.md | 1 + datasets/crypto-whitepapers/zcash.md | 1 + 22 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2de10fe..c81309c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This repository is the portable content source for EFS demos and chain deploymen | Dataset | Anchor | Files | Bytes | Description | |---|---:|---:|---:|---| | [Web Games](./datasets/web-games/) | `/games` | 15 | 365441 | Single-file HTML5 games, playable in a sandboxed iframe. | -| [Crypto Whitepapers](./datasets/crypto-whitepapers/) | `/whitepapers` | 40 | 14472971 | Major cryptocurrency whitepapers and reference notes. | +| [Crypto Whitepapers](./datasets/crypto-whitepapers/) | `/whitepapers` | 40 | 14475183 | Major cryptocurrency whitepapers and reference notes. | | [Ethereum Standards](./datasets/ethereum-eips/) | `/standards` | 10 | 247026 | Landmark EIPs/ERCs, public domain under CC0. | | [Cypherpunk Canon](./datasets/cypherpunk-canon/) | `/cypherpunk` | 25 | 23400126 | A rights-aware shelf representing 21 works with local files or link-only records. | diff --git a/catalog.json b/catalog.json index 8842352..fa89ce3 100644 --- a/catalog.json +++ b/catalog.json @@ -22,7 +22,7 @@ "manifest": "datasets/crypto-whitepapers/manifest.json", "anchorPath": "/whitepapers", "fileCount": 40, - "bytes": 14472971, + "bytes": 14475183, "status": "deployable", "licensePosture": "papers hosted as published by their projects or authors; most carry no licence (owner decision 2026-10-27: no licence field required for documents)", "description": "Major cryptocurrency whitepapers and reference notes." diff --git a/datasets/crypto-whitepapers/algorand.md b/datasets/crypto-whitepapers/algorand.md index d3c1685..62a1eb7 100644 --- a/datasets/crypto-whitepapers/algorand.md +++ b/datasets/crypto-whitepapers/algorand.md @@ -8,6 +8,7 @@ - **File in this folder:** `algorand.pdf` (the ePrint revision of 24 September 2017) - **Related work:** Jing Chen and Silvio Micali's earlier theory paper, *Algorand* (2016, https://arxiv.org/abs/1607.01341), introduced the underlying ideas. +- **Rights:** Academic preprint, freely available on the IACR Cryptology ePrint Archive (2017/454); no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/avalanche.md b/datasets/crypto-whitepapers/avalanche.md index fedf369..019b6b1 100644 --- a/datasets/crypto-whitepapers/avalanche.md +++ b/datasets/crypto-whitepapers/avalanche.md @@ -11,6 +11,7 @@ (platform paper, as published by Ava Labs) - **Files in this folder:** `avalanche-consensus.pdf` (arXiv v2, byte-identical) and `avalanche-platform.pdf` (byte-identical to the Ava Labs copy) +- **Rights:** The consensus paper is an arXiv preprint and the platform paper is published openly by Ava Labs; neither PDF states a licence. ## Summary diff --git a/datasets/crypto-whitepapers/binance-bnb.md b/datasets/crypto-whitepapers/binance-bnb.md index 67d7966..f34933f 100644 --- a/datasets/crypto-whitepapers/binance-bnb.md +++ b/datasets/crypto-whitepapers/binance-bnb.md @@ -6,6 +6,7 @@ - **Year:** BNB launched in 2017; BNB Smart Chain launched on 1 September 2020 - **Canonical source:** https://github.com/bnb-chain/whitepaper - **File in this folder:** this card only (the whitepaper is linked above) +- **Rights:** Published by the BNB Chain project; no explicit licence stated. Not hosted here; linked above. ## Summary diff --git a/datasets/crypto-whitepapers/bitcoin.md b/datasets/crypto-whitepapers/bitcoin.md index 67f923b..c4eba08 100644 --- a/datasets/crypto-whitepapers/bitcoin.md +++ b/datasets/crypto-whitepapers/bitcoin.md @@ -6,6 +6,7 @@ - **Year:** 2008 - **Canonical source:** https://bitcoin.org/bitcoin.pdf - **File in this folder:** `bitcoin.pdf` (9 pages; byte-identical to the bitcoin.org copy) +- **Rights:** Published openly on bitcoin.org and universally mirrored; the paper itself carries no licence statement. ## Summary diff --git a/datasets/crypto-whitepapers/cardano.md b/datasets/crypto-whitepapers/cardano.md index 7b90324..122c9a2 100644 --- a/datasets/crypto-whitepapers/cardano.md +++ b/datasets/crypto-whitepapers/cardano.md @@ -6,6 +6,7 @@ - **Year:** 2016 (IACR ePrint 2016/889; published at CRYPTO 2017) - **Canonical source:** https://eprint.iacr.org/2016/889 - **File in this folder:** `ouroboros.pdf` (the ePrint revision of 20 July 2019) +- **Rights:** Academic preprint, freely available on the IACR Cryptology ePrint Archive (2016/889); no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/chainlink.md b/datasets/crypto-whitepapers/chainlink.md index 02b2deb..bd0a949 100644 --- a/datasets/crypto-whitepapers/chainlink.md +++ b/datasets/crypto-whitepapers/chainlink.md @@ -6,6 +6,7 @@ - **Year:** 2017 (dated 4 September 2017) - **Canonical source:** https://research.chain.link/whitepaper-v1.pdf - **File in this folder:** `chainlink-whitepaper-v1.pdf` (byte-identical to the research.chain.link copy) +- **Rights:** Published openly by the Chainlink project (research.chain.link); no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/cosmos.md b/datasets/crypto-whitepapers/cosmos.md index c066948..f66ba5d 100644 --- a/datasets/crypto-whitepapers/cosmos.md +++ b/datasets/crypto-whitepapers/cosmos.md @@ -7,6 +7,7 @@ - **Canonical source:** https://github.com/cosmos/cosmos/blob/master/WHITEPAPER.md - **File in this folder:** `cosmos-whitepaper.md` (the full text, identical to `WHITEPAPER.md` in the Cosmos repository, where the whitepaper is published as Markdown) +- **Rights:** Published in the Cosmos project's open-source repository; the paper states no separate licence. ## Summary diff --git a/datasets/crypto-whitepapers/dogecoin.md b/datasets/crypto-whitepapers/dogecoin.md index a1ee55c..36ee91b 100644 --- a/datasets/crypto-whitepapers/dogecoin.md +++ b/datasets/crypto-whitepapers/dogecoin.md @@ -6,6 +6,7 @@ - **Year:** 2013 (launched 6 December 2013) - **Official site:** https://dogecoin.com - **File in this folder:** this card only +- **Rights:** No whitepaper exists, so none is hosted; this card is original EFS text. ## Summary diff --git a/datasets/crypto-whitepapers/ethereum.md b/datasets/crypto-whitepapers/ethereum.md index 3c03999..7f77d2d 100644 --- a/datasets/crypto-whitepapers/ethereum.md +++ b/datasets/crypto-whitepapers/ethereum.md @@ -7,6 +7,7 @@ - **Canonical source:** https://ethereum.org/en/whitepaper/ - **File in this folder:** `ethereum-whitepaper-2014.pdf` (the PDF edition published by ethereum.org; byte-identical to https://ethereum.org/content/whitepaper/whitepaper-pdf/Ethereum_Whitepaper_-_Buterin_2014.pdf) +- **Rights:** Published openly on ethereum.org. An earlier note recorded it as CC BY (from the original Ethereum wiki); that has not been independently verified. ## Summary diff --git a/datasets/crypto-whitepapers/filecoin.md b/datasets/crypto-whitepapers/filecoin.md index 3f57404..b29fd58 100644 --- a/datasets/crypto-whitepapers/filecoin.md +++ b/datasets/crypto-whitepapers/filecoin.md @@ -7,6 +7,7 @@ - **Canonical source:** https://research.protocol.ai/publications/filecoin-a-decentralized-storage-network/ - **File in this folder:** `filecoin.pdf` (36 pages; same text as the Protocol Labs copy, in a recompressed PDF) +- **Rights:** Published openly by Protocol Labs. An earlier note recorded it as Creative Commons–licensed; the hosted PDF itself states no licence. ## Summary diff --git a/datasets/crypto-whitepapers/litecoin.md b/datasets/crypto-whitepapers/litecoin.md index 7ae01b3..9bf4b26 100644 --- a/datasets/crypto-whitepapers/litecoin.md +++ b/datasets/crypto-whitepapers/litecoin.md @@ -6,6 +6,7 @@ - **Year:** 2011 (first released on GitHub on 7 October 2011) - **Official site:** https://litecoin.org - **File in this folder:** this card only +- **Rights:** No whitepaper exists, so none is hosted; this card is original EFS text. ## Summary diff --git a/datasets/crypto-whitepapers/monero.md b/datasets/crypto-whitepapers/monero.md index b1c3e24..7f8665b 100644 --- a/datasets/crypto-whitepapers/monero.md +++ b/datasets/crypto-whitepapers/monero.md @@ -8,6 +8,7 @@ https://web.archive.org/web/2020/https://cryptonote.org/whitepaper.pdf). Monero's annotated copy: https://www.getmonero.org/resources/research-lab/pubs/whitepaper_annotated.pdf - **File in this folder:** `cryptonote.pdf` (byte-identical to the archived cryptonote.org copy) +- **Rights:** The 2013 CryptoNote v2.0 paper carries no explicit licence statement; it is widely mirrored by the Monero and Bytecoin projects and archived on Zenodo. ## Summary diff --git a/datasets/crypto-whitepapers/polkadot.md b/datasets/crypto-whitepapers/polkadot.md index 3407a61..e42eeee 100644 --- a/datasets/crypto-whitepapers/polkadot.md +++ b/datasets/crypto-whitepapers/polkadot.md @@ -7,6 +7,7 @@ - **Canonical source:** https://github.com/w3f/polkadot-white-paper (Web3 Foundation) - **File in this folder:** `polkadot.pdf` (a December 2016 build of Draft 1; the Web3 Foundation's current copy has minor later edits, such as renumbered references) +- **Rights:** The paper states that it is placed under a Creative Commons licence. ## Summary diff --git a/datasets/crypto-whitepapers/polygon.md b/datasets/crypto-whitepapers/polygon.md index 06dd48a..545b24d 100644 --- a/datasets/crypto-whitepapers/polygon.md +++ b/datasets/crypto-whitepapers/polygon.md @@ -10,6 +10,7 @@ third-party archive, as the project no longer hosts it) - **Files in this folder:** `matic-whitepaper.md` (whitepaper full text from the repository's `README.md`, with formatting cleaned up) and `matic-litepaper.pdf` (byte-identical to the archive copy above) +- **Rights:** Published in the Matic Network open-source repository; no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/solana.md b/datasets/crypto-whitepapers/solana.md index 0a5815b..b016e5b 100644 --- a/datasets/crypto-whitepapers/solana.md +++ b/datasets/crypto-whitepapers/solana.md @@ -6,6 +6,7 @@ - **Year:** first drafted 2017; this version 2018 - **Canonical source:** https://solana.com/solana-whitepaper.pdf - **File in this folder:** `solana.pdf` (byte-identical to the solana.com copy) +- **Rights:** Published openly by Solana Labs; no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/tezos.md b/datasets/crypto-whitepapers/tezos.md index a442804..ddf2b60 100644 --- a/datasets/crypto-whitepapers/tezos.md +++ b/datasets/crypto-whitepapers/tezos.md @@ -9,6 +9,7 @@ - **Canonical sources:** https://tezos.com/position-paper.pdf and https://tezos.com/whitepaper.pdf - **Files in this folder:** `tezos-position-paper.pdf` and `tezos-whitepaper.pdf` (both byte-identical to the tezos.com copies) +- **Rights:** Published openly by the Tezos project; neither paper states a licence. ## Summary diff --git a/datasets/crypto-whitepapers/tron.md b/datasets/crypto-whitepapers/tron.md index 660c0cd..2964527 100644 --- a/datasets/crypto-whitepapers/tron.md +++ b/datasets/crypto-whitepapers/tron.md @@ -7,6 +7,7 @@ - **Canonical source:** https://tron.network/static/doc/white_paper_v_2_1.pdf (version 2.0: https://tron.network/static/doc/white_paper_v_2_0.pdf) - **File in this folder:** this card only (the whitepaper is linked above) +- **Rights:** Published by TRON DAO; no explicit licence stated. Not hosted here; linked above. ## Summary diff --git a/datasets/crypto-whitepapers/uniswap.md b/datasets/crypto-whitepapers/uniswap.md index 9c4748d..ac49b82 100644 --- a/datasets/crypto-whitepapers/uniswap.md +++ b/datasets/crypto-whitepapers/uniswap.md @@ -8,6 +8,7 @@ https://app.uniswap.org/whitepaper-v3.pdf (v3) - **Files in this folder:** `uniswap-v2-core.pdf` and `uniswap-v3-core.pdf` (both byte-identical to the uniswap.org copies) +- **Rights:** Published openly by Uniswap Labs; neither paper states a licence. ## Summary diff --git a/datasets/crypto-whitepapers/xrp-ripple.md b/datasets/crypto-whitepapers/xrp-ripple.md index 7484eba..bb0816d 100644 --- a/datasets/crypto-whitepapers/xrp-ripple.md +++ b/datasets/crypto-whitepapers/xrp-ripple.md @@ -6,6 +6,7 @@ - **Year:** 2014 - **Canonical source:** https://ripple.com/files/ripple_consensus_whitepaper.pdf - **File in this folder:** `ripple-consensus-whitepaper.pdf` (8 pages; byte-identical to the ripple.com copy) +- **Rights:** Published openly by Ripple Labs; no explicit licence stated. ## Summary diff --git a/datasets/crypto-whitepapers/zcash.md b/datasets/crypto-whitepapers/zcash.md index b288598..caae615 100644 --- a/datasets/crypto-whitepapers/zcash.md +++ b/datasets/crypto-whitepapers/zcash.md @@ -8,6 +8,7 @@ - **Canonical source:** http://zerocash-project.org/paper - **File in this folder:** `zerocash.pdf` (the authors' extended version, byte-identical to http://zerocash-project.org/media/pdf/zerocash-extended-20140518.pdf) +- **Rights:** The hosted file is the authors' extended version; the conference version (IEEE S&P 2014) is copyrighted by IEEE. ## Summary From 4e528bbdf768762662be17752cd7f428dc6f2fa3 Mon Sep 17 00:00:00 2001 From: James Carnley Date: Tue, 27 Oct 2026 17:24:16 -0500 Subject: [PATCH 05/16] games: replace the broken Pong; make Tiny Yurts start in the explorer Tested the way the explorer runs games (sandbox="allow-scripts" srcdoc iframe, headless Chrome): - pong.html only worked with a WebSocket server: paddles never moved offline. Replaced with Jake Gordon's Javascript Pong (MIT, revision ca32405), combined into one file with its images and sounds inlined. It plays the computer (skill adapts to the score), two players or a demo, by keyboard, mouse or touch, scales to its frame, and Esc no longer calls window.confirm (blocked in the sandbox). The MIT notice stays at the top of the file. Harness: no exceptions, no network requests, ball and paddles move, scoring works. - tiny-yurts.html threw a SecurityError reading localStorage at boot and showed a blank green field. A small script before the game now substitutes in-memory storage when Web Storage throws; the game code is unchanged. Harness: title screen loads with no errors, and Start opens a playable map. Manifest entries, README and catalog totals updated. `npm run validate` and `npm run test:games:fit` pass. Co-authored-by: Claude Opus 5.5 --- README.md | 2 +- catalog.json | 2 +- datasets/web-games/README.md | 8 +- datasets/web-games/manifest.json | 11 +- datasets/web-games/pong.html | 1621 +++++++++++++++++----------- datasets/web-games/tiny-yurts.html | 2 +- 6 files changed, 1030 insertions(+), 616 deletions(-) diff --git a/README.md b/README.md index c81309c..8eb1e5b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repository is the portable content source for EFS demos and chain deploymen | Dataset | Anchor | Files | Bytes | Description | |---|---:|---:|---:|---| -| [Web Games](./datasets/web-games/) | `/games` | 15 | 365441 | Single-file HTML5 games, playable in a sandboxed iframe. | +| [Web Games](./datasets/web-games/) | `/games` | 15 | 413841 | Single-file HTML5 games, playable in a sandboxed iframe. | | [Crypto Whitepapers](./datasets/crypto-whitepapers/) | `/whitepapers` | 40 | 14475183 | Major cryptocurrency whitepapers and reference notes. | | [Ethereum Standards](./datasets/ethereum-eips/) | `/standards` | 10 | 247026 | Landmark EIPs/ERCs, public domain under CC0. | | [Cypherpunk Canon](./datasets/cypherpunk-canon/) | `/cypherpunk` | 25 | 23400126 | A rights-aware shelf representing 21 works with local files or link-only records. | diff --git a/catalog.json b/catalog.json index fa89ce3..4bf1c7c 100644 --- a/catalog.json +++ b/catalog.json @@ -10,7 +10,7 @@ "manifest": "datasets/web-games/manifest.json", "anchorPath": "/games", "fileCount": 15, - "bytes": 365441, + "bytes": 413841, "status": "deployable", "licensePosture": "CC0-1.0 and MIT; preserve in-file MIT notices", "description": "Single-file HTML5 games, playable in a sandboxed iframe." diff --git a/datasets/web-games/README.md b/datasets/web-games/README.md index 0bdd39a..e45591c 100644 --- a/datasets/web-games/README.md +++ b/datasets/web-games/README.md @@ -21,14 +21,16 @@ A flat collection of **real, existing single-file HTML5 games**: each one is a w | Missile Command | `missile-command.html` | straker | CC0-1.0 | [gist](https://gist.github.com/straker/afc4e2a30b6df772a5f9f6ef01751d41) | arcade, classic | | Frogger | `frogger.html` | straker | CC0-1.0 | [gist](https://gist.github.com/straker/82a4368849cbd441b05bd6a044f2b2d3) | arcade, classic | | Bomberman | `bomberman.html` | straker | CC0-1.0 | [gist](https://gist.github.com/straker/769fb461e066147ea16ac2cb9463beae) | arcade, maze, classic | -| Pong | `pong.html` | Drake Axelrod | MIT | [repo](https://github.com/drakeaxelrod/single-html-file-apps) | arcade, classic | +| Pong | `pong.html` | Jake Gordon | MIT | [repo](https://github.com/jakesgordon/javascript-pong) (adapted to a single file) | arcade, classic | | Tiny Yurts | `tiny-yurts.html` | burntcustard | MIT | [repo](https://github.com/burntcustard/tiny-yurts) (js13k 2023) | cozy, sim, js13k | | Infernal Throne | `infernal-throne.html` | Ariel Wexler | MIT | [repo](https://github.com/arikwex/infernal-sigil) (js13k 2022) | action, platformer, js13k | | Dante | `dante.html` | Salvatore Previti (music: Ryan Malm) | MIT | [repo](https://github.com/SalvatorePreviti/js13k-2022) (js13k 2022 winner) | webgl, exploration, js13k | All fifteen games were verified in a local headless Chrome smoke test: every file rendered, and the run reported zero console errors, exceptions, network failures, or external requests. Most files are kept **verbatim** from upstream; a small number have presentation-only CSS/layout adjustments so they fit cleanly inside the EFS iframe without document scrollbars. Those adjusted files are marked in `manifest.json`. The eight added straker games carry the same upstream CC0 notice used by the existing straker entries. -**Caveat — Pong:** single-player works fully offline; it also has an *optional* online-multiplayer mode that needs a WebSocket server you run yourself. Ignore that and it's a clean self-contained game. +**Pong:** Jake Gordon's Javascript Pong, combined into one file with its images and sounds inlined. Play the computer (its skill adapts to the score), two players on one keyboard, or a demo; keyboard, mouse or touch. It replaced an earlier Pong that only worked with a WebSocket server. + +**Tiny Yurts:** a small script before the game substitutes in-memory storage, because Web Storage throws inside the explorer's sandboxed iframe. The game code is unchanged. **Note on attribution:** CC0 is public-domain (no attribution required, but we credit anyway); MIT requires the copyright notice be preserved — each MIT game keeps its in-file notice, and a seeded copy should carry it too (e.g. as a PROPERTY or a sibling about-card). @@ -46,7 +48,7 @@ Great targets if you'd rather curate than write. **Check (1) the license permits Honesty section — why curation takes judgment: - **Untrusted** (edit-the-JS adventure — perfect for a hacker crowd): license is **CC-BY-NC** (non-commercial) + needs a build + CDN deps. Link to it, don't re-host. - **Hextris** (GPLv3): redistributable but pulls Google Fonts/Analytics from CDNs — breaks offline/sandbox unless you strip those tags. -- **drakeaxelrod `snake.html`/`slots.html`**: MIT but load Phaser/React/Tailwind from CDNs (their `pong.html` is clean — that's the one we used). +- **drakeaxelrod `snake.html`/`slots.html`**: MIT but load Phaser/React/Tailwind from CDNs. Their `pong.html` was used until 2026-10-27, but it only works with a WebSocket server. - **Path to Glory**: excellent js13k game, but upstream asks people not to distribute or use it commercially without contacting the author first. - **Dying Dreams**: strong js13k candidate, but custom terms restrict redistribution to non-commercial/open-source projects. - **Edge Not Found**: polished, but published under a Charity License with a commercial-exploitation restriction. diff --git a/datasets/web-games/manifest.json b/datasets/web-games/manifest.json index 9cafe5b..7d7d4e3 100644 --- a/datasets/web-games/manifest.json +++ b/datasets/web-games/manifest.json @@ -118,11 +118,10 @@ "name": "pong.html", "tags": ["arcade", "classic"], "license": "MIT", - "author": "Drake Axelrod", - "source": "https://github.com/drakeaxelrod/single-html-file-apps", - "modificationStatus": "presentation-adjusted", - "changes": "Adjusted page layout so the Pong playfield and controls fit inside an EFS iframe without document scrollbars.", - "mirrors": ["https://raw.githubusercontent.com/drakeaxelrod/single-html-file-apps/main/apps/pong.html"] + "author": "Jake Gordon", + "source": "https://github.com/jakesgordon/javascript-pong/tree/ca3240536e4f79ab7144388e56ed19de715b6662", + "modificationStatus": "adapted", + "changes": "Combined game.js, pong.js, the menu images and sounds into one file (assets inlined as data URIs); replaced the sidebar with an on-page controls hint; scaled the canvas to fit its frame; added Enter/W/S/arrow keys and mouse/touch paddle control; Esc quits without window.confirm, which sandboxed iframes block; FPS overlay off. The MIT notice is kept at the top of the file." }, { "path": "tiny-yurts.html", @@ -131,6 +130,8 @@ "license": "MIT", "author": "burntcustard", "source": "https://github.com/burntcustard/tiny-yurts", + "modificationStatus": "sandbox-adjusted", + "changes": "Added a small script before the game that substitutes in-memory storage when localStorage/sessionStorage throw, so the game starts in the explorer's sandboxed iframe. Game code is unchanged; progress lasts until the page closes.", "mirrors": ["https://raw.githubusercontent.com/burntcustard/tiny-yurts/main/dist/index.html"] }, { diff --git a/datasets/web-games/pong.html b/datasets/web-games/pong.html index fb3e987..1852c5b 100644 --- a/datasets/web-games/pong.html +++ b/datasets/web-games/pong.html @@ -1,640 +1,1051 @@ - + - - - Multiplayer Pong - + + +Pong! + + -

🏓 Multiplayer Pong

- -
-
Not Connected
-
- 0 - 0 -
- -
- -
-
-

Connection

- - - - -
- -
-

How to Play

-

Controls: Use W/S keys (Player 1) or Up/Down arrows (Player 2)

-

Important: Click on the game area first to enable controls!

-

Multiplayer: One player hosts a game, others connect using the server URL

-

Objective: First to 10 points wins!

-
- -