Skip to content

cardano-serialization-lib with custom garbage collector for WASM

Notifications You must be signed in to change notification settings

mlabs-haskell/cardano-serialization-lib-gc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cardano-serialization-lib-gc

This is a small ESM library that provides a wrapper for managing garbage collection for cardano-serialization-library. It does this by using a FinalizationRegistry object to keep track of objects that are no longer in use, and calling the free() method on them when they are finalized.

Example usage with NodeJS:

import * as lib from "@mlabs-haskell/cardano-serialization-lib-gc";

function fixture() {
  lib.PlutusData.new_bytes(
    new Uint8Array(Array(10000000).fill(0))
  );
}

setInterval(() => {
  for (let i = 0; i < 10; i++) {
    fixture()
  }
}, 500) // collection of unused objects will trigger `free()` calls
// for the corresponding WASM-allocated memory

This code will not leak, but if you try to use the original package, the memory usage will steadily grow.

If you want to use this library as a CommonJS module, use legacy csl-gc-wrapper instead.

About

cardano-serialization-lib with custom garbage collector for WASM

Resources

Stars

Watchers

Forks

Packages

No packages published