Document LevelDB keys #14029

1. 
   kostyantyn commented at 9:37 am on August 23, 2018: contributor

   Currently, without reading the whole code it’s hard to understand which keys are used where and is it a full key or a prefix.

   Having these small comments helps to understand what each DB stores.

2. Document LevelDB keys

   Currently, without reading the whole code it's hard to understand which keys are used where and is it a full key or a prefix.
   
   Having these small comments helps to understand what each DB stores.

   81acaee635
3. fanquake added the label Docs on Aug 23, 2018
4. randolf approved
5. 
   sipa commented at 4:17 pm on August 23, 2018: member

   These comments are pretty minimal. What does “key prefix” mean?
6. 
   laanwj commented at 6:23 pm on August 23, 2018: member

   I agree with @sipa here, adding documentation here would be very welcome, but this is the same message for all of them and it doesn’t really add much, imo.
7. 
   kostyantyn commented at 8:52 pm on August 23, 2018: contributor

   @sipa With the key prefix I meant that this is not the full leveldb key (like DB_BEST_BLOCK = 'B') but only the prefix of it. For instance, to get the coin, we lookup by this key DB_COIN + COutPoint

   Let me then add a full description to every key and explain how it’s being used.

8. randolf approved
9. 
   MarcoFalke commented at 9:21 pm on August 30, 2018: member

   Related: https://bitcoin.stackexchange.com/a/29418/3576
10. 
    laanwj commented at 1:58 pm on August 31, 2018: member

    I’m closing this for now, please open a new PR (or tell me to re-open this one) when you start work on this again.
11. laanwj closed this on Aug 31, 2018

    ---

12. MarcoFalke added the label Up for grabs on Aug 31, 2018
13. MarcoFalke locked this on Sep 8, 2021

Contributors
kostyantyn randolf sipa laanwj MarcoFalke

Labels
Docs Up for grabs