The Agoric OpCo engineering team is pleased to publish the agoric-upgrade-17 release. This release includes updates to Orchestration Core that advance chain orchestration facilities, and also improvements to reduce the storage and memory footprint required of validator nodes.
The following new features are included in this release:
- #9064: orchestration can create Interchain accounts (ICAs) on a host chain
- #9890: query support in orchestration flows
- #10029: orchestration account balance queries
- #10032: app.toml configuration for vat snapshot and delivery transcript JS database entry retention
- #10036: app.toml configuration for vat snapshot and delivery transcript file archiving
- #9900: reduce contract bundle size
The release contains at least the following fixes:
- #9961: Remotable/Presence garbage collection edge cases
- #10110: Remove init-chain-info proposal intended for a future release
The full set of changes in this release can be found at #10097 and #10114, and reviewed in detail as agoric-upgrade-16...agoric-upgrade-17.
This release has satisfied all pre-release/testnet validation checks, and is now recommended for chains to upgrade from the previous agoric-upgrade-16 release. As a chain-halting upgrade, once approved, all chain validators will need to upgrade from agoric-upgrade-16 to this new version (after the chain halts due to reaching the height required in a governance proposal).
New app configuration
We've added support for a [swingset] section to app.toml for customizing local consensus-independent behavior of the Swingset JavaScript VM. Of particular note are the vat snapshot and delivery transcript retention settings, which can be used to significantly reduce growth of the JS database size.
| Setting | Default value | Other values | Purpose |
|---|---|---|---|
slogfile |
<path to file> | if non-empty, where to write a "slog" (Swingset delivery log file) | |
max-vats-online |
50 | <positive integer> | maximum number of vats to keep loaded in memory |
vat-snapshot-retention |
"operational" | "debug" | "debug" to preserve all vat snapshots in the JS database; "operational" to preserve only the most recent |
vat-transcript-retention |
"default" | "archival", "operational" | "archival" to preserve all vat delivery transcript spans in the JS database; "operational" to drop those preceding the most recent vat snapshot; "default" to derive from pruning ("archival" with pruning = "nothing", otherwise "operational") |
vat-snapshot-archive-dir |
<path to directory> | if non-empty, where to write gzipped vat snapshot files | |
vat-transcript-archive-dir |
<path to directory> | if non-empty, where to write gzipped historical (closed) vat delivery transcript span files |
Any new app.toml file will be initialized with the new section, but we recommend that the following be added to existing files (and then customized per your needs):
###############################################################################
### SwingSet Configuration ###
###############################################################################
[swingset]
# The path at which a SwingSet log "slog" file should be written.
# If relative, it is interpreted against the application home directory
# (e.g., ~/.agoric).
# May be overridden by a SLOGFILE environment variable, which if relative is
# interpreted against the working directory.
slogfile = ""
# The maximum number of vats that the SwingSet kernel will bring online. A lower number
# requires less memory but may have a negative performance impact if vats need to
# be frequently paged out to remain under this limit.
max-vats-online = 50
# Retention of vat snapshots, with values analogous to those of export
# 'artifactMode' (cf.
# https://github.com/Agoric/agoric-sdk/blob/master/packages/swing-store/docs/data-export.md#optional--historical-data ).
# * "debug": keep all snapshots
# * "operational": keep only the last snapshot
vat-snapshot-retention = "operational"
# Retention of vat transcript spans, with values analogous to those of export
# 'artifactMode' (cf.
# https://github.com/Agoric/agoric-sdk/blob/master/packages/swing-store/docs/data-export.md#optional--historical-data ).
# * "archival": keep all transcript spans
# * "operational": keep only necessary transcript spans (i.e., since the
# last snapshot of their vat)
# * "default": determined by 'pruning' ("archival" if 'pruning' is "nothing",
# otherwise "operational")
vat-transcript-retention = "default"
# Archival of gzipped vat snapshots.
vat-snapshot-archive-dir = ""
# Archival of historical (i.e., closed) vat transcript spans to gzipped files.
vat-transcript-archive-dir = ""State-sync
State-sync snapshots now only include minimal data to restore a node, and the new configuration settings will help further reduce requirements of non-archival nodes. However, there may still be continued performance issues related to state-sync. In particular, we've observed that on some deployments, the snapshot taking and restoring process can take multiple hours, require about 20GB of temporary free disk space, and 16GB of memory.
Cosmos Upgrade Handler Name
Below is the cosmos upgrade handler name for this release. This is the name that can be used in governance proposals to deploy this upgrade.
Cosmos Upgrade Handler Name: agoric-upgrade-17
Tags
Below is the git information related to this software release. Note the git tag does not always match the cosmos upgrade handler name.
Git Tag: agoric-upgrade-17
Git Commit: 5259430561693bfcf58516c3ea54123895859708
@agoric/cosmos package version: 0.35.0-u17.1
Docker: ghcr.io/agoric/agoric-sdk:49
As shown in go.mod this release is based on:
ibc-go v6.3.1
cosmos-sdk v0.46.16
cometbft v0.34.30
How to upgrade
Presuming that your node is running agoric-upgrade-16, once the upgrade height for a subsequent proposal to upgrade to agoric-upgrade-17 has been reached, your node will halt automatically allowing you to upgrade the agoric stack.
Prerequisites
Install supported versions of Go, Node.js, and a compiler such as gcc or clang as documented in the README.
Make sure that the environment running the agd service has the same Node.js version as the environment used for building. In particular, if using nvm to manage Node.js version, the service environment should enable nvm and use the same version.
Building
# (stop the agd service)
cd agoric-sdk
git fetch --all
git checkout agoric-upgrade-17
git clean -xdf && git submodule foreach --recursive git clean -xdf
./bin/agd build
# (start the agd service)
Do not copy the agd script or Go binary to another location. If you would like to have an executable agd in another location, then create a symlink in that location pointing to agoric-sdk/bin/agd.
Troubleshooting module ... was compiled against a different Node.js version and SyntaxError issues
The agd service is not using the same version of Node.js as the one used when building. The most likely cause is that nvm was used to manage the Node.js version in the shell when building. Either install the required version of Node.js globally using the system's package manager, or enable nvm in the environment of the agd service.
Troubleshooting repoconfig.sh: No such file or directory
Unlike typical cosmos-sdk chains where the daemon is a single executable file, Agoric's use of cosmos-sdk depends on many components of agoric-sdk at runtime. Copying agd to /usr/local/bin or the like is unlikely to produce a working installation. For more detail, see: #7825
Troubleshooting Cannot find dependency ... in systemd
If you have LimitNOFILE=4096 in your systemd unit file, change it to LimitNOFILE=65536. For more detail, see #7817
Specifying --upgrade-info for the software upgrade proposal
The ./scripts/gen-upgrade-proposal.sh is designed to aid in composing a agd tx submit-proposal software-upgrade ... command. In particular, it captures package checksums to verify integrity of downloaded software.