vacp2p/linea-monorepo
1
0
Fork 0
mirror of https://github.com/vacp2p/linea-monorepo.git synced 2026-01-09 04:08:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

New compression dictionary and update guide (#890)

Browse Source 
* docs: compressor dictionary update guide

* feat new dictionary

* remove unused dictionary
This commit is contained in:
Arya Tabaie
2025-05-05 17:28:20 -05:00
committed by GitHub
parent 1b874b45fb
commit 004d459e77
4 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
prover/lib/compressor/Readme.md
View File

@@ -9,4 +9,6 @@ go build -ldflags "-s -w" -buildmode=c-shared -o libcompressor.so libcompressor.
* The Java (Kotlin) part
See [jvm-libs/blob-compressor/src/main/kotlin/net/consensys/linea/nativecompressor/GoNativeBlobCompressor.kt](jvm-libs/blob-compressor/src/main/kotlin/net/consensys/linea/nativecompressor/GoNativeBlobCompressor.kt).
See [jvm-libs/blob-compressor/src/main/kotlin/net/consensys/linea/nativecompressor/GoNativeBlobCompressor.kt](jvm-libs/blob-compressor/src/main/kotlin/net/consensys/linea/nativecompressor/GoNativeBlobCompressor.kt).
* [How to update the dictionary](dictionary-update-guide.md)

BIN
prover/lib/compressor/dict/25-01-15-INCOMPLETE.bin
View File

Binary file not shown.

BIN
prover/lib/compressor/dict/25-04-21.bin Normal file
View File

Binary file not shown.

22
prover/lib/compressor/dictionary-update-guide.md Normal file
View File

@@ -0,0 +1,22 @@
# Blob Compression Dictionary Update Guide
The process is simple. The only subtle point is that support for new dictionaries should be added downstream-first (i.e. first in the prover and the decompressor, and then in the blob compressor,) and that conversely retiring a dictionary should be done upstream-first (i.e. first in the blob compressor, and then in the prover, and never in a decompressor used for state reconstruction.)
## Updating the Prover
Download the dictionary file on the machine running the prover. Add its path relative to the prover root, to the prover configuration `.toml` file, in the `dict_paths` property, under `blob_decompression`. Normally the dictionary would already be available in the Linea repository, its path looking like `"lib/compressor/dict/yy-mm-dd.bin"`.
The next time the prover is started, it will (also) load the new dictionary. Note that there is no need to recompile the decompression circuit.
Example:
```toml
[blob_decompression]
dict_paths = [
"/path/to/old/dictionary",
"/path/to/new/dictionary"
]
```
## Updating the Decompressor
The JNI library has a function `LoadDictionaries` available that can be used to add the new dictionary, similarly to the prover. There is not even a need to restart the process.
## Updating the Blob Compressor
Unlike the prover and decompressor, the blob compressor cannot support multiple dictionaries. The `Init` function, takes as its second input the relative path of the dictionary file. The dictionary is loaded when the compressor is initialized, and it will be used for all subsequent compression operations. This initialization function can be called multiple times, and not only at the beginning of the process. But it will reset the compressor's cache, so any blocks written into an embryonic blob will be erased.