feat(logic)!: add max_variables limits params

bdeneux · bdeneux · commit 94e54e04ee22 · 2024-07-25T09:04:22.000+02:00
diff --git a/docs/proto/logic.md b/docs/proto/logic.md
@@ -279,6 +279,7 @@ Limits defines the limits of the logic module.
 | `max_size` | [string](#string) |  | max_size specifies the maximum size, in bytes, that is accepted for a program. nil value remove size limitation. |
 | `max_result_count` | [string](#string) |  | max_result_count specifies the maximum number of results that can be requested for a query. nil value remove max result count limitation. |
 | `max_user_output_size` | [string](#string) |  | max_user_output_size specifies the maximum number of bytes to keep in the user output. If the user output exceeds this size, the interpreter will overwrite the oldest bytes with the new ones to keep the size constant. nil value or 0 value means that no user output is used at all. |
+| `max_variables` | [string](#string) |  | max_variables specifies the maximum number of variables that can be create by the interpreter. nil value or 0 value means that no limit is set. |
 
 <a name="logic.v1beta2.Params"></a>
 
diff --git a/proto/logic/v1beta2/params.proto b/proto/logic/v1beta2/params.proto
@@ -59,6 +59,14 @@ message Limits {
     (gogoproto.customtype) = "cosmossdk.io/math.Uint",
     (gogoproto.nullable) = true
   ];
+
+  // max_variables specifies the maximum number of variables that can be create by the interpreter.
+  // nil value or 0 value means that no limit is set.
+  string max_variables = 5 [
+    (gogoproto.moretags) = "yaml:\"max_variables\"",
+    (gogoproto.customtype) = "cosmossdk.io/math.Uint",
+    (gogoproto.nullable) = true
+  ];
 }
 
 // Filter defines the parameters for filtering the set of strings which can designate anything.
diff --git a/x/logic/interpreter/interpreter.go b/x/logic/interpreter/interpreter.go
@@ -2,6 +2,7 @@ package interpreter
 
 import (
 	goctx "context"
+	"cosmossdk.io/math"
 	"fmt"
 	"io"
 	"io/fs"
@@ -68,6 +69,17 @@ func WithFS(fs fs.FS) Option {
 	}
 }
 
+func WithMaxVariables(maxVariables *math.Uint) Option {
+	return func(i *prolog.Interpreter) error {
+		if maxVariables != nil {
+			i.SetMaxVariables(maxVariables.Uint64())
+		} else {
+			i.SetMaxVariables(0)
+		}
+		return nil
+	}
+}
+
 // New creates a new prolog.Interpreter with the specified options.
 func New(
 	opts ...Option,
diff --git a/x/logic/keeper/interpreter.go b/x/logic/keeper/interpreter.go
@@ -133,6 +133,7 @@ func (k Keeper) newInterpreter(ctx context.Context, params types.Params) (*prolo
 		interpreter.WithBootstrap(ctx, util.NonZeroOrDefault(interpreterParams.GetBootstrap(), bootstrap.Bootstrap())),
 		interpreter.WithFS(filtered.NewFS(k.fsProvider(ctx), whitelistUrls, blacklistUrls)),
 		interpreter.WithUserOutputWriter(userOutputBuffer),
+		interpreter.WithMaxVariables(limits.MaxVariables),
 	}
 
 	i, err := interpreter.New(options...)
diff --git a/x/logic/types/params.go b/x/logic/types/params.go
@@ -17,6 +17,7 @@ var (
 	DefaultPredicatesBlacklist = make([]string, 0)
 	DefaultMaxSize             = math.NewUint(uint64(5000))
 	DefaultMaxResultCount      = math.NewUint(uint64(1))
+	DefaultMaxVariables        = math.NewUint(uint64(100000))
 )
 
 // NewParams creates a new Params object.
@@ -146,6 +147,13 @@ func WithMaxUserOutputSize(maxUserOutputSize math.Uint) LimitsOption {
 	}
 }
 
+// WithMaxVariables sets the maximum number of variables that can be created by the interpreter.
+func WithMaxVariables(maxVariables math.Uint) LimitsOption {
+	return func(i *Limits) {
+		i.MaxVariables = &maxVariables
+	}
+}
+
 // NewLimits creates a new Limits object.
 func NewLimits(opts ...LimitsOption) Limits {
 	l := Limits{}
@@ -161,6 +169,10 @@ func NewLimits(opts ...LimitsOption) Limits {
 		l.MaxResultCount = &DefaultMaxResultCount
 	}
 
+	if l.MaxVariables == nil {
+		l.MaxVariables = &DefaultMaxVariables
+	}
+
 	return l
 }
 
diff --git a/x/logic/types/params.pb.go b/x/logic/types/params.pb.go

Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,7 @@ func (k Keeper) newInterpreter(ctx context.Context, params types.Params) (*prolo`
`133`	`133`	`interpreter.WithBootstrap(ctx, util.NonZeroOrDefault(interpreterParams.GetBootstrap(), bootstrap.Bootstrap())),`
`134`	`134`	`interpreter.WithFS(filtered.NewFS(k.fsProvider(ctx), whitelistUrls, blacklistUrls)),`
`135`	`135`	`interpreter.WithUserOutputWriter(userOutputBuffer),`
	`136`	`+ interpreter.WithMaxVariables(limits.MaxVariables),`
`136`	`137`	`}`
`137`	`138`
`138`	`139`	`i, err := interpreter.New(options...)`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ var (`
`17`	`17`	`DefaultPredicatesBlacklist = make([]string, 0)`
`18`	`18`	`DefaultMaxSize = math.NewUint(uint64(5000))`
`19`	`19`	`DefaultMaxResultCount = math.NewUint(uint64(1))`
	`20`	`+ DefaultMaxVariables = math.NewUint(uint64(100000))`
`20`	`21`	`)`
`21`	`22`
`22`	`23`	`// NewParams creates a new Params object.`
`@@ -146,6 +147,13 @@ func WithMaxUserOutputSize(maxUserOutputSize math.Uint) LimitsOption {`
`146`	`147`	`}`
`147`	`148`	`}`
`148`	`149`
	`150`	`+// WithMaxVariables sets the maximum number of variables that can be created by the interpreter.`
	`151`	`+func WithMaxVariables(maxVariables math.Uint) LimitsOption {`
	`152`	`+ return func(i *Limits) {`
	`153`	`+ i.MaxVariables = &maxVariables`
	`154`	`+ }`
	`155`	`+}`
	`156`	`+`
`149`	`157`	`// NewLimits creates a new Limits object.`
`150`	`158`	`func NewLimits(opts ...LimitsOption) Limits {`
`151`	`159`	`l := Limits{}`
`@@ -161,6 +169,10 @@ func NewLimits(opts ...LimitsOption) Limits {`
`161`	`169`	`l.MaxResultCount = &DefaultMaxResultCount`
`162`	`170`	`}`
`163`	`171`
	`172`	`+ if l.MaxVariables == nil {`
	`173`	`+ l.MaxVariables = &DefaultMaxVariables`
	`174`	`+ }`
	`175`	`+`
`164`	`176`	`return l`
`165`	`177`	`}`
`166`	`178`