config: Add --msPerBlock flag

--msPerBlock flag added to runner.sh and `time-per-block` is used in generation config files. Close #161 Signed-off-by: Ekaterina Pavlova <[email protected]>
nspcc-dev · May 2, 2024 · de5e36d · de5e36d
1 parent 7a39b3f
commit de5e36d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -10,6 +10,7 @@ BUILD_DIR=.docker/build
 NEOBENCH_TYPE ?= NEO
 NEOBENCH_FROM_COUNT ?= 1
 NEOBENCH_TO_COUNT ?= 1
+MS_PER_BLOCK ?= 0
 
 .PHONY: help
 
@@ -112,7 +113,7 @@ config:
 	@echo "=> Generate configurations for single-node and four-nodes networks from templates"
 	@set -x \
 		&& cd ./cmd \
-		&& go run ./config/ --go-template go.protocol.template.yml --go-db leveldb --sharp-template sharp.protocol.template.yml --sharp-db LevelDBStore
+		&& go run ./config/ --go-template go.protocol.template.yml --go-db leveldb --sharp-template sharp.protocol.template.yml --sharp-db LevelDBStore --msPerBlock $(MS_PER_BLOCK)
 
 
 # Generate transactions, dump and nodes configurations for four-nodes network

diff --git a/README.md b/README.md
@@ -296,7 +296,10 @@ The following default configurations are available:
                                     Example: -l journald -l syslog -l json-file
        --tc                         Arguments to pass to 'tc qdisc netem' inside the container.
                                     Example: 'delay 100ms'
-
+       --msPerBlock                 Protocol setting specifying the minimal (and targeted for) time interval between blocks. Must be an integer number of milliseconds.
+                                    Default value is set in configuration templates and are 1s for single node and 5s for 4 nodes setup.
+                                    Example: --msPerBlock 3000
+                                    
 ```
 
 ## Build options

diff --git a/cmd/config/main.go b/cmd/config/main.go
@@ -11,6 +11,7 @@ import (
 	"os"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/k14s/ytt/pkg/cmd/template"
 	"github.com/nspcc-dev/neo-go/pkg/config"
@@ -29,6 +30,7 @@ var (
 	goDB              = flag.String("go-db", "leveldb", "database for Go node")
 	sharpTemplateFile = flag.String("sharp-template", "", "configuration template file for C# node")
 	sharpDB           = flag.String("sharp-db", "LevelDBStore", "database for C# node")
+	msPerBlock        = flag.Int("msPerBlock", 0, "time per block in milliseconds")
 )
 
 func main() {
@@ -115,6 +117,9 @@ func generateGoConfig(templatePath, database, suffix string) error {
 			return fmt.Errorf("unable to decode node template #%d: %w", i, err)
 		}
 		template.ApplicationConfiguration.DBConfiguration.Type = database
+		if msPerBlock != nil && *msPerBlock > 0 {
+			template.ProtocolConfiguration.TimePerBlock = time.Duration(*msPerBlock) * time.Millisecond
+		}
 		var configFile string
 		nodeName, err := nodeNameFromSeedList(template.ApplicationConfiguration.P2P.Addresses, template.ProtocolConfiguration.SeedList)
 		if err != nil {
@@ -154,6 +159,9 @@ func generateSharpConfig(templatePath, storageEngine, suffix string) error {
 			return fmt.Errorf("unable to decode node template #%d: %w", i, err)
 		}
 		template.ApplicationConfiguration.Storage.Engine = storageEngine
+		if msPerBlock != nil && *msPerBlock > 0 {
+			template.ProtocolConfiguration.MillisecondsPerBlock = *msPerBlock
+		}
 		var configFile string
 		nodeName, err := nodeNameFromSeedList([]string{":" + strconv.Itoa(int(template.ApplicationConfiguration.P2P.Port))}, template.ProtocolConfiguration.SeedList)
 		if err != nil {

diff --git a/runner.sh b/runner.sh
@@ -51,6 +51,9 @@ show_help() {
 	echo "                                    Example: -l journald -l syslog -l json-file"
 	echo "       --tc                         Arguments to pass to 'tc qdisc netem' inside the container."
 	echo "                                    Example: 'delay 100ms'"
+	echo "       --msPerBlock                 Protocol setting specifying the minimal (and targeted for) time interval between blocks. Must be an integer number of milliseconds."
+	echo "                                    The default value is set in configuration templates and is 1s and 5s for single node and multinode setup respectively."
+	echo "                                    Example: --msPerBlock 1000"
 	exit 0
 }
 
@@ -188,6 +191,12 @@ while test $# -gt 0; do
 		shift
 		;;
 
+	--msPerBlock)
+		test $# -gt 0 || fatal "milliseconds per block should be specified"
+		export MS_PER_BLOCK="$1"
+		shift
+		;;
+
 	*) fatal "Unknown option: $_opt" ;;
 	esac
 done