@agoric/cosmos 0.34.2-dev-fb3af6c.0 → 0.34.2-dev-d6f50e3.0

package/git-revision.txt

@@ -1 +1 @@
-fb3af6c
+d6f50e3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cosmos",
-  "version": "0.34.2-dev-fb3af6c.0+fb3af6c",
+  "version": "0.34.2-dev-d6f50e3.0+d6f50e3",
   "description": "Connect JS to the Cosmos blockchain SDK",
   "parsers": {
     "js": "mjs"
@@ -39,5 +39,5 @@
   "typeCoverage": {
     "atLeast": 0
   },
-  "gitHead": "fb3af6c419a81e243809ebee78c5de0763b19412"
+  "gitHead": "d6f50e32f6f19bb14cfe4530812609dff00d21b8"
 }

package/util/util.go

@@ -4,6 +4,15 @@ import (
 	"github.com/spf13/viper"
 )
 
+func IndexOf[T comparable](a []T, x T) int {
+	for i, s := range a {
+		if s == x {
+			return i
+		}
+	}
+	return -1
+}
+
 func NewFileOnlyViper(v1 *viper.Viper) (*viper.Viper, error) {
 	v2 := viper.New()
 	v2.SetConfigFile(v1.ConfigFileUsed())

package/x/swingset/config.go

@@ -7,6 +7,8 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
+	pruningtypes "github.com/cosmos/cosmos-sdk/pruning/types"
+	serverconfig "github.com/cosmos/cosmos-sdk/server/config"
 	servertypes "github.com/cosmos/cosmos-sdk/server/types"
 
 	"github.com/Agoric/agoric-sdk/golang/cosmos/util"
@@ -15,8 +17,24 @@ import (
 const (
 	ConfigPrefix = "swingset"
 	FlagSlogfile = ConfigPrefix + ".slogfile"
+
+	SnapshotRetentionOptionDebug       = "debug"
+	SnapshotRetentionOptionOperational = "operational"
+
+	TranscriptRetentionOptionArchival    = "archival"
+	TranscriptRetentionOptionOperational = "operational"
 )
 
+var snapshotRetentionValues []string = []string{
+	SnapshotRetentionOptionDebug,
+	SnapshotRetentionOptionOperational,
+}
+
+var transcriptRetentionValues []string = []string{
+	TranscriptRetentionOptionArchival,
+	TranscriptRetentionOptionOperational,
+}
+
 // DefaultConfigTemplate defines a default TOML configuration section for the SwingSet VM.
 // Values are pulled from a "Swingset" property, in accord with CustomAppConfig from
 // ../../daemon/cmd/root.go.
@@ -27,30 +45,74 @@ const DefaultConfigTemplate = `
 ###############################################################################
 
 [swingset]
-# slogfile is the path at which a SwingSet log "slog" file should be written.
+# 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 = "{{ .Swingset.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 = {{ .Swingset.MaxVatsOnline }}
+max-vats-online = {{ .Swingset.MaxVatsOnline }}
+
+# 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 = "{{ .Swingset.VatSnapshotRetention }}"
+
+# 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 = "{{ .Swingset.VatTranscriptRetention }}"
 `
 
 // SwingsetConfig defines configuration for the SwingSet VM.
+// "mapstructure" tag data is used to direct reads from app.toml;
+// "json" tag data is used to populate init messages for the VM.
+// This should be kept in sync with SwingsetConfigShape in
+// ../../../../packages/cosmic-swingset/src/chain-main.js.
 // TODO: Consider extensions from docs/env.md.
 type SwingsetConfig struct {
-	// SlogFile is the absolute path at which a SwingSet log "slog" file should be written.
+	// SlogFile is the path at which a SwingSet log "slog" file should be written.
+	// If relative, it is interpreted against the application home directory
 	SlogFile string `mapstructure:"slogfile" json:"slogfile,omitempty"`
+
 	// MaxVatsOnline is the maximum number of vats that the SwingSet kernel will have online
 	// at any given time.
-	MaxVatsOnline int `mapstructure:"max_vats_online" json:"maxVatsOnline,omitempty"`
+	MaxVatsOnline int `mapstructure:"max-vats-online" json:"maxVatsOnline,omitempty"`
+
+	// VatSnapshotRetention controls retention of vat snapshots,
+	// and has values analogous to those of export `artifactMode` (cf.
+	// ../../../../packages/swing-store/docs/data-export.md#optional--historical-data ).
+	// * "debug": keep all snapshots
+	// * "operational": keep only the last snapshot
+	VatSnapshotRetention string `mapstructure:"vat-snapshot-retention" json:"vatSnapshotRetention,omitempty"`
+
+	// VatTranscriptRetention controls retention of vat transcript spans,
+	// and has values analogous to those of export `artifactMode` (cf.
+	// ../../../../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")
+	VatTranscriptRetention string `mapstructure:"vat-transcript-retention" json:"vatTranscriptRetention,omitempty"`
 }
 
 var DefaultSwingsetConfig = SwingsetConfig{
-	SlogFile:      "",
-	MaxVatsOnline: 50,
+	SlogFile:               "",
+	MaxVatsOnline:          50,
+	VatSnapshotRetention:   "operational",
+	VatTranscriptRetention: "default",
 }
 
 func SwingsetConfigFromViper(resolvedConfig servertypes.AppOptions) (*SwingsetConfig, error) {
@@ -66,11 +128,44 @@ func SwingsetConfigFromViper(resolvedConfig servertypes.AppOptions) (*SwingsetCo
 		return nil, nil
 	}
 	v.MustBindEnv(FlagSlogfile, "SLOGFILE")
-	wrapper := struct{ Swingset SwingsetConfig }{}
-	if err := v.Unmarshal(&wrapper); err != nil {
+	// See CustomAppConfig in ../../daemon/cmd/root.go.
+	type ExtendedConfig struct {
+		serverconfig.Config `mapstructure:",squash"`
+		Swingset            SwingsetConfig `mapstructure:"swingset"`
+	}
+	extendedConfig := ExtendedConfig{}
+	if err := v.Unmarshal(&extendedConfig); err != nil {
+		return nil, err
+	}
+	ssConfig := &extendedConfig.Swingset
+
+	// Validate vat snapshot retention only if non-empty (because otherwise it
+	// it will be omitted, leaving the VM to apply its own defaults).
+	if ssConfig.VatSnapshotRetention != "" {
+		if util.IndexOf(snapshotRetentionValues, ssConfig.VatSnapshotRetention) == -1 {
+			err := fmt.Errorf(
+				"value for vat-snapshot-retention must be in %q",
+				snapshotRetentionValues,
+			)
+			return nil, err
+		}
+	}
+
+	// Default/validate vat transcript retention.
+	if ssConfig.VatTranscriptRetention == "" || ssConfig.VatTranscriptRetention == "default" {
+		if extendedConfig.Pruning == pruningtypes.PruningOptionNothing {
+			ssConfig.VatTranscriptRetention = TranscriptRetentionOptionArchival
+		} else {
+			ssConfig.VatTranscriptRetention = TranscriptRetentionOptionOperational
+		}
+	}
+	if util.IndexOf(transcriptRetentionValues, ssConfig.VatTranscriptRetention) == -1 {
+		err := fmt.Errorf(
+			"value for vat-transcript-retention must be in %q",
+			transcriptRetentionValues,
+		)
 		return nil, err
 	}
-	config := &wrapper.Swingset
 
 	// Interpret relative paths from config files against the application home
 	// directory and from other sources (e.g. env vars) against the current
@@ -101,11 +196,11 @@ func SwingsetConfigFromViper(resolvedConfig servertypes.AppOptions) (*SwingsetCo
 		return filepath.Abs(path)
 	}
 
-	resolvedSlogFile, err := resolvePath(config.SlogFile, FlagSlogfile)
+	resolvedSlogFile, err := resolvePath(ssConfig.SlogFile, FlagSlogfile)
 	if err != nil {
 		return nil, err
 	}
-	config.SlogFile = resolvedSlogFile
+	ssConfig.SlogFile = resolvedSlogFile
 
-	return config, nil
+	return ssConfig, nil
 }