Skip to content

Commit ef9f1b7

Browse files
committed
docs update
1 parent 93af67a commit ef9f1b7

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

jvm-libs/blob-decompressor/src/main/kotlin/net/consensys/linea/blob/GoNativeBlobDecompressor.kt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,12 @@ internal interface GoNativeBlobDecompressorJnaBinding {
5555
fun LoadDictionaries(dictPaths: String): Int
5656

5757
/**
58-
* Decompress a blob b and writes the resulting blocks in out, serialized in the format of
59-
* prover/backend/ethereum.
58+
59+
* Decompress processes a Linea blob and outputs an RLP encoded list of blocks.
60+
* Due to information loss during pre-compression encoding, two pieces of information are represented "hackily":
61+
* The block hash is in the ParentHash field.
62+
* The transaction from address is in the signature.R field.
63+
*
6064
* Returns the number of bytes in out, or -1 in case of failure
6165
* If -1 is returned, the Error() method will return a string describing the error.
6266
*

prover/lib/compressor/blob/blob.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ func GetDict() ([]byte, error) {
5050
return os.ReadFile(dictPath)
5151
}
5252

53+
// DecompressBlob takes in a Linea blob and outputs an RLP encoded list of blocks.
54+
// Due to information loss during pre-compression encoding, two pieces of information are represented "hackily":
55+
// The block hash is in the ParentHash field.
56+
// The transaction from address is in the signature.R field.
5357
func DecompressBlob(blob []byte, dictStore dictionary.Store) ([]byte, error) {
5458
vsn := GetVersion(blob)
5559
var (

prover/lib/compressor/libdecompressor/libdecompressor.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,11 @@ func LoadDictionaries(dictPaths *C.char) C.int {
4848
return C.int(len(paths))
4949
}
5050

51-
// Decompress processes a blob b and writes the resulting blocks in out, serialized in the format of
52-
// prover/backend/ethereum.
51+
// Decompress processes a Linea blob and outputs an RLP encoded list of blocks.
52+
// Due to information loss during pre-compression encoding, two pieces of information are represented "hackily":
53+
// The block hash is in the ParentHash field.
54+
// The transaction from address is in the signature.R field.
55+
//
5356
// Returns the number of bytes in out, or -1 in case of failure
5457
// If -1 is returned, the Error() method will return a string describing the error.
5558
//

0 commit comments

Comments
 (0)