Stateful Precompile Improvements

accounts/abi/bind/bind.go

@@ -44,12 +44,8 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 )
 
-const (
-	setAdminFuncKey      = "setAdmin"
-	setEnabledFuncKey    = "setEnabled"
-	setNoneFuncKey       = "setNone"
-	readAllowListFuncKey = "readAllowList"
-)
+// BindHook is a callback function that can be used to customize the binding.
+type BindHook func(lang Lang, pkg string, types []string, contracts map[string]*TmplContract, structs map[string]*TmplStruct) (data interface{}, templateSource string, err error)
 
 // Lang is a target programming language selector to generate bindings for.
 type Lang int
@@ -101,13 +97,17 @@ func isKeyWord(arg string) bool {
 // to be used as is in client code, but rather as an intermediate struct which
 // enforces compile time type safety and naming convention opposed to having to
 // manually maintain hard coded strings that break on runtime.
-func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]string, pkg string, lang Lang, libs map[string]string, aliases map[string]string, isPrecompile bool) (string, error) {
+func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]string, pkg string, lang Lang, libs map[string]string, aliases map[string]string) (string, error) {
+	return BindHelper(types, abis, bytecodes, fsigs, pkg, lang, libs, aliases, nil)
+}
+
+func BindHelper(types []string, abis []string, bytecodes []string, fsigs []map[string]string, pkg string, lang Lang, libs map[string]string, aliases map[string]string, bindHook BindHook) (string, error) {
 	var (
 		// contracts is the map of each individual contract requested binding
-		contracts = make(map[string]*tmplContract)
+		contracts = make(map[string]*TmplContract)
 
 		// structs is the map of all redeclared structs shared by passed contracts.
-		structs = make(map[string]*tmplStruct)
+		structs = make(map[string]*TmplStruct)
 
 		// isLib is the map used to flag each encountered library as such
 		isLib = make(map[string]struct{})
@@ -128,11 +128,11 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 
 		// Extract the call and transact methods; events, struct definitions; and sort them alphabetically
 		var (
-			calls     = make(map[string]*tmplMethod)
-			transacts = make(map[string]*tmplMethod)
+			calls     = make(map[string]*TmplMethod)
+			transacts = make(map[string]*TmplMethod)
 			events    = make(map[string]*tmplEvent)
-			fallback  *tmplMethod
-			receive   *tmplMethod
+			fallback  *TmplMethod
+			receive   *TmplMethod
 
 			// identifiers are used to detect duplicated identifiers of functions
 			// and events. For all calls, transacts and events, abigen will generate
@@ -155,7 +155,7 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 			normalizedName := methodNormalizer[lang](alias(aliases, original.Name))
 
 			// Ensure there is no duplicated identifier
-			var identifiers = callIdentifiers
+			identifiers := callIdentifiers
 			if !original.IsConstant() {
 				identifiers = transactIdentifiers
 			}
@@ -178,11 +178,6 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 			normalized.Outputs = make([]abi.Argument, len(original.Outputs))
 			copy(normalized.Outputs, original.Outputs)
 			for j, output := range normalized.Outputs {
-				if isPrecompile {
-					if output.Name == "" {
-						return "", fmt.Errorf("ABI outputs for %s require a name to generate the precompile binding, re-generate the ABI from a Solidity source file with all named outputs", normalized.Name)
-					}
-				}
 				if output.Name != "" {
 					normalized.Outputs[j].Name = capitalise(output.Name)
 				}
@@ -192,9 +187,9 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 			}
 			// Append the methods to the call or transact lists
 			if original.IsConstant() {
-				calls[original.Name] = &tmplMethod{Original: original, Normalized: normalized, Structured: structured(original.Outputs)}
+				calls[original.Name] = &TmplMethod{Original: original, Normalized: normalized, Structured: structured(original.Outputs)}
 			} else {
-				transacts[original.Name] = &tmplMethod{Original: original, Normalized: normalized, Structured: structured(original.Outputs)}
+				transacts[original.Name] = &TmplMethod{Original: original, Normalized: normalized, Structured: structured(original.Outputs)}
 			}
 		}
 		for _, original := range evmABI.Events {
@@ -238,17 +233,17 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 		}
 		// Add two special fallback functions if they exist
 		if evmABI.HasFallback() {
-			fallback = &tmplMethod{Original: evmABI.Fallback}
+			fallback = &TmplMethod{Original: evmABI.Fallback}
 		}
 		if evmABI.HasReceive() {
-			receive = &tmplMethod{Original: evmABI.Receive}
+			receive = &TmplMethod{Original: evmABI.Receive}
 		}
 		// There is no easy way to pass arbitrary java objects to the Go side.
 		if len(structs) > 0 && lang == LangJava {
 			return "", errors.New("java binding for tuple arguments is not supported yet")
 		}
 
-		contracts[types[i]] = &tmplContract{
+		contracts[types[i]] = &TmplContract{
 			Type:        capitalise(types[i]),
 			InputABI:    strings.ReplaceAll(strippedABI, "\"", "\\\""),
 			InputBin:    strings.TrimPrefix(strings.TrimSpace(bytecodes[i]), "0x"),
@@ -291,19 +286,14 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 		templateSource string
 	)
 
-	// Generate the contract template data according to contract type (precompile/non)
-	if isPrecompile {
-		if lang != LangGo {
-			return "", errors.New("only GoLang binding for precompiled contracts is supported yet")
-		}
-
-		if len(contracts) != 1 {
-			return "", errors.New("cannot generate more than 1 contract")
+	// Generate the contract template data according to hook
+	if bindHook != nil {
+		var err error
+		data, templateSource, err = bindHook(lang, pkg, types, contracts, structs)
+		if err != nil {
+			return "", err
 		}
-		precompileType := types[0]
-		firstContract := contracts[precompileType]
-		data, templateSource = createPrecompileDataAndTemplate(firstContract, structs)
-	} else {
+	} else { // default to generate contract binding
 		templateSource = tmplSource[lang]
 		data = &tmplData{
 			Package:   pkg,
@@ -342,7 +332,7 @@ func Bind(types []string, abis []string, bytecodes []string, fsigs []map[string]
 
 // bindType is a set of type binders that convert Solidity types to some supported
 // programming language types.
-var bindType = map[Lang]func(kind abi.Type, structs map[string]*tmplStruct) string{
+var bindType = map[Lang]func(kind abi.Type, structs map[string]*TmplStruct) string{
 	LangGo:   bindTypeGo,
 	LangJava: bindTypeJava,
 }
@@ -374,7 +364,7 @@ func bindBasicTypeGo(kind abi.Type) string {
 // bindTypeGo converts solidity types to Go ones. Since there is no clear mapping
 // from all Solidity types to Go ones (e.g. uint17), those that cannot be exactly
 // mapped will use an upscaled type (e.g. BigDecimal).
-func bindTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindTypeGo(kind abi.Type, structs map[string]*TmplStruct) string {
 	switch kind.T {
 	case abi.TupleTy:
 		return structs[kind.TupleRawName+kind.String()].Name
@@ -451,7 +441,7 @@ func pluralizeJavaType(typ string) string {
 // bindTypeJava converts a Solidity type to a Java one. Since there is no clear mapping
 // from all Solidity types to Java ones (e.g. uint17), those that cannot be exactly
 // mapped will use an upscaled type (e.g. BigDecimal).
-func bindTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindTypeJava(kind abi.Type, structs map[string]*TmplStruct) string {
 	switch kind.T {
 	case abi.TupleTy:
 		return structs[kind.TupleRawName+kind.String()].Name
@@ -464,14 +454,14 @@ func bindTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
 
 // bindTopicType is a set of type binders that convert Solidity types to some
 // supported programming language topic types.
-var bindTopicType = map[Lang]func(kind abi.Type, structs map[string]*tmplStruct) string{
+var bindTopicType = map[Lang]func(kind abi.Type, structs map[string]*TmplStruct) string{
 	LangGo:   bindTopicTypeGo,
 	LangJava: bindTopicTypeJava,
 }
 
 // bindTopicTypeGo converts a Solidity topic type to a Go one. It is almost the same
 // functionality as for simple types, but dynamic types get converted to hashes.
-func bindTopicTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindTopicTypeGo(kind abi.Type, structs map[string]*TmplStruct) string {
 	bound := bindTypeGo(kind, structs)
 
 	// todo(rjl493456442) according solidity documentation, indexed event
@@ -488,7 +478,7 @@ func bindTopicTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
 
 // bindTopicTypeJava converts a Solidity topic type to a Java one. It is almost the same
 // functionality as for simple types, but dynamic types get converted to hashes.
-func bindTopicTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindTopicTypeJava(kind abi.Type, structs map[string]*TmplStruct) string {
 	bound := bindTypeJava(kind, structs)
 
 	// todo(rjl493456442) according solidity documentation, indexed event
@@ -505,15 +495,15 @@ func bindTopicTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
 
 // bindStructType is a set of type binders that convert Solidity tuple types to some supported
 // programming language struct definition.
-var bindStructType = map[Lang]func(kind abi.Type, structs map[string]*tmplStruct) string{
+var bindStructType = map[Lang]func(kind abi.Type, structs map[string]*TmplStruct) string{
 	LangGo:   bindStructTypeGo,
 	LangJava: bindStructTypeJava,
 }
 
 // bindStructTypeGo converts a Solidity tuple type to a Go one and records the mapping
 // in the given map.
 // Notably, this function will resolve and record nested struct recursively.
-func bindStructTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindStructTypeGo(kind abi.Type, structs map[string]*TmplStruct) string {
 	switch kind.T {
 	case abi.TupleTy:
 		// We compose a raw struct name and a canonical parameter expression
@@ -542,7 +532,7 @@ func bindStructTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
 		}
 		name = capitalise(name)
 
-		structs[id] = &tmplStruct{
+		structs[id] = &TmplStruct{
 			Name:   name,
 			Fields: fields,
 		}
@@ -559,7 +549,7 @@ func bindStructTypeGo(kind abi.Type, structs map[string]*tmplStruct) string {
 // bindStructTypeJava converts a Solidity tuple type to a Java one and records the mapping
 // in the given map.
 // Notably, this function will resolve and record nested struct recursively.
-func bindStructTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
+func bindStructTypeJava(kind abi.Type, structs map[string]*TmplStruct) string {
 	switch kind.T {
 	case abi.TupleTy:
 		// We compose a raw struct name and a canonical parameter expression
@@ -581,7 +571,7 @@ func bindStructTypeJava(kind abi.Type, structs map[string]*tmplStruct) string {
 		if name == "" {
 			name = fmt.Sprintf("Class%d", len(structs))
 		}
-		structs[id] = &tmplStruct{
+		structs[id] = &TmplStruct{
 			Name:   name,
 			Fields: fields,
 		}
@@ -710,45 +700,3 @@ func hasStruct(t abi.Type) bool {
 		return false
 	}
 }
-
-func createPrecompileDataAndTemplate(contract *tmplContract, structs map[string]*tmplStruct) (interface{}, string) {
-	funcs := make(map[string]*tmplMethod)
-
-	for k, v := range contract.Transacts {
-		funcs[k] = v
-	}
-
-	for k, v := range contract.Calls {
-		funcs[k] = v
-	}
-	isAllowList := allowListEnabled(funcs)
-	if isAllowList {
-		// remove these functions as we will directly inherit AllowList
-		delete(funcs, readAllowListFuncKey)
-		delete(funcs, setAdminFuncKey)
-		delete(funcs, setEnabledFuncKey)
-		delete(funcs, setNoneFuncKey)
-	}
-
-	precompileContract := &tmplPrecompileContract{
-		tmplContract: contract,
-		AllowList:    isAllowList,
-		Funcs:        funcs,
-	}
-
-	data := &tmplPrecompileData{
-		Contract: precompileContract,
-		Structs:  structs,
-	}
-	return data, tmplSourcePrecompileGo
-}
-
-func allowListEnabled(funcs map[string]*tmplMethod) bool {
-	keys := []string{readAllowListFuncKey, setAdminFuncKey, setEnabledFuncKey, setNoneFuncKey}
-	for _, key := range keys {
-		if _, ok := funcs[key]; !ok {
-			return false
-		}
-	}
-	return true
-}

accounts/abi/bind/bind_test.go

@@ -2099,7 +2099,7 @@ func golangBindings(t *testing.T, overload bool) {
 				types = []string{tt.name}
 			}
 			// Generate the binding and create a Go source file in the workspace
-			bind, err := Bind(types, tt.abi, tt.bytecode, tt.fsigs, "bindtest", LangGo, tt.libs, tt.aliases, false)
+			bind, err := Bind(types, tt.abi, tt.bytecode, tt.fsigs, "bindtest", LangGo, tt.libs, tt.aliases)
 			if err != nil {
 				t.Fatalf("test %d: failed to generate binding: %v", i, err)
 			}
@@ -2529,7 +2529,7 @@ public class Test {
 		},
 	}
 	for i, c := range cases {
-		binding, err := Bind([]string{c.name}, []string{c.abi}, []string{c.bytecode}, nil, "bindtest", LangJava, nil, nil, false)
+		binding, err := Bind([]string{c.name}, []string{c.abi}, []string{c.bytecode}, nil, "bindtest", LangJava, nil, nil)
 		if err != nil {
 			t.Fatalf("test %d: failed to generate binding: %v", i, err)
 		}