smartcontract: fix DO NOT EDIT warning to autogenerated files

The text must appear as the first line of a properly formatted Go // comment, and that comment must appear before but not be attached to the package clause and before any /* */ comment. Closes #3254 Signed-off-by: Ekaterina Pavlova <[email protected]>
nspcc-dev · Dec 25, 2023 · 1237c71 · 1237c71
1 parent de98b39
commit 1237c71
Show file tree

Hide file tree

Showing 17 changed files with 44 additions and 44 deletions.
diff --git a/cli/smartcontract/contract_test.go b/cli/smartcontract/contract_test.go
@@ -176,9 +176,9 @@ func Blocks() []*alias.Block {
 
 	bs, err := os.ReadFile(outPath)
 	require.NoError(t, err)
-	require.Equal(t, `// Package testcontract contains wrappers for testcontract contract.
-//
-// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+	require.Equal(t, `// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+
+// Package testcontract contains wrappers for testcontract contract.
 package testcontract
 
 import (

diff --git a/cli/smartcontract/generate_test.go b/cli/smartcontract/generate_test.go
@@ -151,9 +151,9 @@ callflags:
 		"--hash", h.StringLE(),
 	}))
 
-	const expected = `// Package wrapper contains wrappers for MyContract contract.
-//
-// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+	const expected = `// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+
+// Package wrapper contains wrappers for MyContract contract.
 package wrapper
 
 import (
@@ -267,9 +267,9 @@ func TestGenerateValidPackageName(t *testing.T) {
 
 	data, err := os.ReadFile(outFile)
 	require.NoError(t, err)
-	require.Equal(t, `// Package myspacecontract contains wrappers for My space	contract contract.
-//
-// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+	require.Equal(t, `// Code generated by neo-go contract generate-wrapper --manifest <file.json> --out <file.go> --hash <hash> [--config <config>]; DO NOT EDIT.
+
+// Package myspacecontract contains wrappers for My space	contract contract.
 package myspacecontract
 
 import (
@@ -293,9 +293,9 @@ func Get() int {
 
 	data, err = os.ReadFile(outFile)
 	require.NoError(t, err)
-	require.Equal(t, `// Package myspacecontract contains RPC wrappers for My space	contract contract.
-//
-// Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+	require.Equal(t, `// Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package myspacecontract contains RPC wrappers for My space	contract contract.
 package myspacecontract
 
 import (

diff --git a/cli/smartcontract/testdata/gas/gas.go b/cli/smartcontract/testdata/gas/gas.go
diff --git a/cli/smartcontract/testdata/nameservice/nns.go b/cli/smartcontract/testdata/nameservice/nns.go
diff --git a/cli/smartcontract/testdata/nex/nex.go b/cli/smartcontract/testdata/nex/nex.go
diff --git a/cli/smartcontract/testdata/nonepiter/iter.go b/cli/smartcontract/testdata/nonepiter/iter.go
diff --git a/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings.out b/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings.out
@@ -1,6 +1,6 @@
-// Package structs contains RPC wrappers for Notifications contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package structs contains RPC wrappers for Notifications contract.
 package structs
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings_extended.out b/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings_extended.out
@@ -1,6 +1,6 @@
-// Package structs contains RPC wrappers for Notifications contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package structs contains RPC wrappers for Notifications contract.
 package structs
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings_guessed.out b/cli/smartcontract/testdata/rpcbindings/notifications/rpcbindings_guessed.out
@@ -1,6 +1,6 @@
-// Package structs contains RPC wrappers for Notifications contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package structs contains RPC wrappers for Notifications contract.
 package structs
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/structs/rpcbindings.out b/cli/smartcontract/testdata/rpcbindings/structs/rpcbindings.out
@@ -1,6 +1,6 @@
-// Package structs contains RPC wrappers for Types contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package structs contains RPC wrappers for Types contract.
 package structs
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/structs/rpcbindings_dynamic_hash.out b/cli/smartcontract/testdata/rpcbindings/structs/rpcbindings_dynamic_hash.out
@@ -1,6 +1,6 @@
-// Package structs contains RPC wrappers for Types contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package structs contains RPC wrappers for Types contract.
 package structs
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/types/rpcbindings.out b/cli/smartcontract/testdata/rpcbindings/types/rpcbindings.out
@@ -1,6 +1,6 @@
-// Package types contains RPC wrappers for Types contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package types contains RPC wrappers for Types contract.
 package types
 
 import (

diff --git a/cli/smartcontract/testdata/rpcbindings/types/rpcbindings_dynamic_hash.out b/cli/smartcontract/testdata/rpcbindings/types/rpcbindings_dynamic_hash.out
@@ -1,6 +1,6 @@
-// Package types contains RPC wrappers for Types contract.
-//
 // Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package types contains RPC wrappers for Types contract.
 package types
 
 import (

diff --git a/cli/smartcontract/testdata/verifyrpc/verify.go b/cli/smartcontract/testdata/verifyrpc/verify.go
diff --git a/pkg/smartcontract/binding/generate.go b/pkg/smartcontract/binding/generate.go
diff --git a/pkg/smartcontract/rpcbinding/binding.go b/pkg/smartcontract/rpcbinding/binding.go
@@ -112,9 +112,9 @@ func (c *Contract) {{.Name}}Unsigned({{range $index, $arg := .Arguments -}}
 }
 {{end}}`
 
-	bindingDefinition = `// Package {{.PackageName}} contains RPC wrappers for {{.ContractName}} contract.
-//
-// Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+	bindingDefinition = `// Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.
+
+// Package {{.PackageName}} contains RPC wrappers for {{.ContractName}} contract.
 package {{.PackageName}}
 
 import (

diff --git a/pkg/smartcontract/zkpbinding/binding.go b/pkg/smartcontract/zkpbinding/binding.go
@@ -60,7 +60,9 @@ const (
 	// verification contract is circuit-specific, i.e. corresponds to a specific
 	// single constraint system. Thus, every new circuit requires vew verification
 	// contract to be generated and deployed to the chain.
-	goVerificationTmpl = `// Package main contains verification smart contract that uses Neo BLS12-381
+	goVerificationTmpl = `//Code generated by neo-go zkpbinding.GenerateVerifier; DO NOT EDIT.
+
+// Package main contains verification smart contract that uses Neo BLS12-381
 // curves interoperability functionality to verify provided proof against provided
 // public input. The contract contains a single 'verifyProof' method that accepts
 // a proof represented as three BLS12-381 curve points and public witnesses
@@ -74,8 +76,6 @@ const (
 // go.sum files required for compilation. Please, refer to the NeoGo ZKP example
 // to see how to verify proofs via the Verifier contract:
 // https://github.com/nspcc-dev/neo-go/tree/master/examples/zkp/cubic_circuit.
-//
-// Code generated by neo-go zkpbinding.GenerateVerifier; DO NOT EDIT.
 package main
 
 import (