Protocol

Dataset sg-bip-status, method 1.0.0. Every status is the BIP repository's own: the Status header in the BIP's preamble, in the four words BIP 3 sets (Draft, Complete, Deployed, Closed). Type and layer are read the same way. The desk maps and renames nothing, and each time it reads the files it checks the words against BIP 3's own text. A status is the repository's label for a document. It is not an endorsement, and it does not say a consensus change has activated: under BIP 3 a BIP can be Deployed on the evidence of one established project shipping support for it.

The repository is read without an account or a token. The desk reads its commits feed for the newest commit, then the README index and every BIP file the index links, each at that commit, so one read describes one state of the repository. The feed's time for that commit is GitHub's clock. Files are read from raw.githubusercontent.com at most one a second and kept on the desk's machine by commit, so a second run on the same commit asks for the feed alone.

A change is recorded when a BIP's status differs from the one in the desk's previous saved file, or when the index lists a BIP the desk has not recorded before. It is dated by the day the desk saw it, not the day it happened: the repository may have made the change on any day since the desk's previous read. Recorded changes are added to and never rewritten. The first read records none.

A BIP is held when its preamble cannot be read as BIP 3 lays it out, names a status, type or layer outside BIP 3's words, or disagrees with the index on number, layer, type or status. A held row keeps what the desk last recorded, with the reason and the day the hold began, is left out of the counts by status and records no change. Nothing is guessed. A read writes nothing when the feed, the index or any file fails, when the feed's newest commit is older than the one already read, when the index drops a BIP the desk has recorded or lists fewer than 150, when more than one row in twenty would be held, or when BIP 3's own words have changed.

Authors is the number of lines in the preamble's Authors header. One line can name more than one person. Names and addresses are not kept. A number the index lists without a document is kept apart, in the index's own words, and is not counted as a BIP with a status.

Listed without a document at this commit: 40, Stratum wire protocol (“BIP number allocated”); 41, Stratum mining protocol (“BIP number allocated”); 63, Stealth Addresses (“BIP number allocated”).

• BIP 3, which sets the statuses ↗
• The index at this commit ↗
• Commit 927b6de ↗
• The repository’s commits feed ↗

Check a row yourself, here BIP 3’s own preamble: curl -s https://raw.githubusercontent.com/bitcoin/bips/927b6de9915c9262615a6399de51b200f81e5aa4/bip-0003.md | head -20

The BIPs repository is public on GitHub and is read without an account: its commits feed and its raw files only. Each BIP names its own licence in its preamble where it has one. The desk keeps facts from the index and the preambles (number, title, layer, type, status, the date a number was assigned, the BIPs a preamble names as replaced or as a proposed replacement, and a count of author lines) and none of a BIP's text.