|
3 | 3 | ## Overview
|
4 | 4 |
|
5 | 5 | This package implements a client and server that allows for the syncing of a [MerkleDB](../merkledb/README.md).
|
6 |
| -The servers have an up to date version of the database, and the clients have an out of date version of the database or an empty database. |
| 6 | +The servers have an up-to-date version of the database, and the clients have an out of date version of the database or an empty database. |
7 | 7 |
|
8 | 8 | It's planned that these client and server implementations will eventually be compatible with Firewood.
|
9 | 9 |
|
@@ -62,7 +62,7 @@ are in range [`start`, `end`] for the revision with root `root_hash`" for some k
|
62 | 62 | Note that `root_hash` is the root hash of the revision that the client is trying to sync to, not the
|
63 | 63 | root hash of its own (incomplete) database.
|
64 | 64 | Tracking the revision associated with each downloaded key range, as well as using data in its own
|
65 |
| -(incomplete) database, allows the client to figure out which key ranges are not up to date and need to be synced. |
| 65 | +(incomplete) database, allows the client to figure out which key ranges are not up-to-date and need to be synced. |
66 | 66 | The hash of the incomplete database on a client is never sent anywhere because it does not represent a root hash of any revision.
|
67 | 67 |
|
68 | 68 | When the client is created, it is given the root hash of the revision to sync to.
|
@@ -94,7 +94,7 @@ The sync client can be notified that the root hash of the database it's trying t
|
94 | 94 | Detecting that the root hash to sync to has changed is done outside this package.
|
95 | 95 | For example, if the database is being used to store blockchain state then the sync client would be
|
96 | 96 | notified when a new block is accepted because that implies a commit to the database.
|
97 |
| -If this occurs, the key-value pairs the client has learned about via range proofs may no longer be up to date. |
| 97 | +If this occurs, the key-value pairs the client has learned about via range proofs may no longer be up-to-date. |
98 | 98 |
|
99 | 99 | We use change proofs as an optimization to correct the out of date key-value pairs.
|
100 | 100 | When the sync client is notified that the root hash to sync to has changed, it requests a change proof
|
|
0 commit comments