Skip to content

Commit 6a821f7

Browse files
committed
[VIndex] Top level docs reflect current status
1 parent 52eb79b commit 6a821f7

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

vindex/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
## Verifiable Index
22

3-
Status: Experimental. Goal is to have MVP by 2025Q3. See [Milestones](#milestones) for detailed feature progress.
3+
Status: Working Prototype of an end-to-end verifiable index for transparency logs. See [Milestones](#milestones) for detailed feature progress.
4+
5+
There is a complete solution provided for the [Go Module Proxy (SumDB) log](./cmd/sumdb/).
46

57
This idea has been distilled from years of experiments with maps, and a pressing need to have an efficient and verifiable way for an end-user to find _their_ data in logs without needing to download the whole log.
68

@@ -39,8 +41,8 @@ The result is a system that extends the verifiability of the underlying log to i
3941

4042
This verifiable map can be applied to any log where users have a need to enumerate all values matching a specific query. For example:
4143

42-
* CT: domain owners wish to query for all certs matching a particular domain
43-
* SumDB: package owners want to find all releases for a given package
44+
* CT: domain owners wish to query for all certs matching a domain they own
45+
* [SumDB](./cmd/sumdb/): package owners want to find all releases for a package they maintain
4446

4547
Indices exist for both ecosystems at the moment, but they aren’t verifiable.
4648

@@ -184,6 +186,7 @@ Known applications:
184186

185187
## Milestones
186188

189+
187190
| # | Step | Status |
188191
| :-: | --------------------------------------------------------- | :----: |
189192
| 1 | Public code base and documentation for prototype ||
@@ -195,11 +198,11 @@ Known applications:
195198
| 7 | Storage backed verifiable-map ||
196199
| 8 | MapFn defined in WASM ||
197200
| 9 | Support reading directly from Input Log instead of Clone ||
198-
| 10 | Example written for mapping SumDB ||
201+
| 10 | Example written for indexing SumDB ||
199202
| 11 | Example written for hosting a log and VIndex together ||
200-
| 12 | Example written for mapping CT | ⚠️ |
201-
| 13 | Promote this from the `incubator` repo ||
203+
| 12 | Example written for indexing CT | ⚠️ |
204+
| 13 | Replace Merkle Tree with a faster implementation ||
205+
| 14 | Promote this from the `incubator` repo ||
202206
| N | Production ready ||
203207

204208

205-
Note that a storage-backed map needs to be implemented before this can be applied to larger logs, e.g. CT.

0 commit comments

Comments
 (0)