lotus/build/actors/README.md
Steven Allen 30981d0fdd
feat: refactor: actor bundling system (#8838)
1. Include the builtin-actors in the lotus source tree.
2. Embed the bundle on build instead of downloading at runtime.
3. Avoid reading the bundle whenever possible by including bundle
   metadata (the bundle CID, the actor CIDs, etc.).
4. Remove everything related to dependency injection.
    1. We're no longer downloading the bundle, so doing anything ahead
       of time doesn't really help.
    2. We register the manifests on init because, unfortunately, they're
       global.
    3. We explicitly load the current actors bundle in the genesis
       state-tree method.
    4. For testing, we just change the in-use bundle with a bit of a
       hack. It's not great, but using dependency injection doesn't make
       any sense either because, again, the manifest information is
       global.
    5. Remove the bundle.toml file. Bundles may be overridden by
       specifying an override path in the parameters file, or an
       environment variable.

fixes #8701
2022-06-13 10:15:00 -07:00

748 B

Bundles

This directory includes the actors bundles for each release. Each actor bundle is a zstd compressed tarfile containing one bundle per network type. These tarfiles are subsequently embedded in the lotus binary.

Updating

To update, run the ./pack.sh script. For example, the following will pack the builtin actors release dev/20220602 into the v8 tarfile.

./pack.sh v8 dev/20220602

This will:

  1. Download the actors bundles and pack them into the appropriate tarfile ($VERSION.tar.zst).
  2. Run make bundle-gen in the top-level directory to regenerate the bundle metadata file for all network versions (all *.tar.zst files in this directory).