hermeznetwork / hermez-node

Hermez node Go implementation
GNU Affero General Public License v3.0
58 stars 33 forks source link

TODO: Add HistoryDB consistency documentation #1083

Open tclemos opened 3 years ago

tclemos commented 3 years ago

Rationale

Explain better how History DB is kept consistent

https://github.com/hermeznetwork/hermez-node/blob/3fc5b4c531394e9d6a9975e2fa798bbd5029e6a4/db/historydb/historydb.go#L40

Implementation

Add a comment session to the beginning of the historydb.go file explaining the rationale behind its consistency.

Also double-check the relation with this other consistency check

https://github.com/hermeznetwork/hermez-node/blob/3fc5b4c531394e9d6a9975e2fa798bbd5029e6a4/db/l2db/l2db.go#L40