linea-monorepo/ts-libs/linea-native-libs

@consensys/linea-native-libs

@consensys/linea-native-libs is a Node.js library that provides an interface to native Go libraries using the koffi package. It provides the following Go libraries wrapper:

• GoNativeCompressor: This class allows you to initialize the transaction compressor, check for errors, and get the worst compressed transaction size for a given RLP-encoded transaction.

Installation

Install the required npm package:

npm install @consensys/linea-native-libs

Usage

Compressor library

Importing the Class

import { GoNativeCompressor } from '@consensys/linea-native-libs';

Initializing the Compressor

Create an instance of GoNativeCompressor by providing a data size limit:

const dataLimit = 1024; // Example data limit
const compressor = new GoNativeCompressor(dataLimit);

Getting the Compressed Transaction Size

To get the worst compressed transaction size for a given RLP-encoded transaction:

const rlpEncodedTransaction = new Uint8Array([...]); // Your RLP-encoded transaction
const compressedTxSize = compressor.getCompressedTxSize(rlpEncodedTransaction);
console.log(`Compressed Transaction Size: ${compressedTxSize}`);

Methods

constructor(dataLimit: number)

• Parameters:

  • dataLimit: The data limit for the compressor.

• Description: Initializes the compressor with the given data limit and loads the native library.

getCompressedTxSize(rlpEncodedTransaction: Uint8Array): number

• Parameters:

  • rlpEncodedTransaction: The RLP-encoded transaction as a Uint8Array.

• Returns: The worst compressed transaction size as a number.

• Description: Returns the worst compressed transaction size for the given RLP-encoded transaction. Throws an error if compression fails.

getError(): string | null

• Returns: The error message as a string or null if no error.

• Description: Retrieves the last error message from the native library.

Error Handling

If an error occurs during initialization or compression, an Error will be thrown with a descriptive message.

Example

import { GoNativeCompressor } from '@consensys/linea-native-libs';

const dataLimit = 1024;
const compressor = new GoNativeCompressor(dataLimit);

const rlpEncodedTransaction = new Uint8Array([...]);
try {
  const compressedTxSize = compressor.getCompressedTxSize(rlpEncodedTransaction);
  console.log(`Compressed Transaction Size: ${compressedTxSize}`);
} catch (error) {
  console.error(`Error: ${error.message}`);
}

License

This project is licensed under the Apache-2.0 and the MIT licenses.