feat: generate client constructor for apis in venus-shared (#4747)

Makefile

@@ -49,6 +49,7 @@ test-venus-shared:
 
 api-gen:
 	cd ./venus-devtool/ && go run ./api-gen/ proxy
+	cd ./venus-devtool/ && go run ./api-gen/ client
 
 v0APIDoc = ../venus-shared/api/v0-api-document.md
 v1APIDoc = ../venus-shared/api/v1-api-document.md

venus-devtool/api-gen/common.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"go/format"
+	"io/ioutil"
+	"path/filepath"
+	"reflect"
+
+	"github.com/filecoin-project/venus/venus-devtool/util"
+	"github.com/filecoin-project/venus/venus-shared/api/messager"
+	"github.com/filecoin-project/venus/venus-shared/api/wallet"
+)
+
+func init() {
+	for _, capi := range util.ChainAPIPairs {
+		apiTargets = append(apiTargets, capi.Venus)
+	}
+
+	apiTargets = append(apiTargets,
+		util.APIMeta{
+			Type: reflect.TypeOf((*messager.IMessager)(nil)).Elem(),
+			ParseOpt: util.InterfaceParseOption{
+				ImportPath: "github.com/filecoin-project/venus/venus-shared/api/messager",
+				IncludeAll: true,
+			},
+			RPCMeta: util.RPCMeta{
+				MethodNamespace: "Message",
+			},
+		},
+		util.APIMeta{
+			Type: reflect.TypeOf((*wallet.IFullAPI)(nil)).Elem(),
+			ParseOpt: util.InterfaceParseOption{
+				ImportPath: "github.com/filecoin-project/venus/venus-shared/api/wallet",
+				IncludeAll: true,
+			},
+		},
+	)
+}
+
+var apiTargets []util.APIMeta
+
+func structName(ifaceName string) string {
+	return ifaceName + "Struct"
+}
+
+func outputSourceFile(location, fname string, buf *bytes.Buffer) error {
+	formatted, err := format.Source(buf.Bytes())
+	if err != nil {
+		return fmt.Errorf("format source content: %w", err)
+	}
+
+	outputFile := filepath.Join(location, fname)
+	err = ioutil.WriteFile(outputFile, formatted, 0644)
+	if err != nil {
+		return fmt.Errorf("write to output %s: %w", outputFile, err)
+	}
+
+	return nil
+}

venus-devtool/api-gen/main.go

@@ -15,6 +15,7 @@ func main() {
 		Flags:                []cli.Flag{},
 		Commands: []*cli.Command{
 			proxyCmd,
+			clientCmd,
 		},
 	}
 

venus-devtool/api-gen/proxy.go

@@ -4,49 +4,22 @@ import (
 	"bytes"
 	"fmt"
 	"go/ast"
-	"go/format"
 	"go/printer"
 	"io"
-	"io/ioutil"
 	"log"
 	"path/filepath"
-	"reflect"
 	"strings"
 
 	"github.com/urfave/cli/v2"
 
 	"github.com/filecoin-project/venus/venus-devtool/util"
-	"github.com/filecoin-project/venus/venus-shared/api/messager"
-	"github.com/filecoin-project/venus/venus-shared/api/wallet"
 )
 
-func init() {
-	for _, capi := range util.ChainAPIPairs {
-		proxyTargets = append(proxyTargets, capi.Venus)
-	}
-
-	proxyTargets = append(proxyTargets, util.APIMeta{
-		Type: reflect.TypeOf((*messager.IMessager)(nil)).Elem(),
-		ParseOpt: util.InterfaceParseOption{
-			ImportPath: "github.com/filecoin-project/venus/venus-shared/api/messager",
-			IncludeAll: true,
-		},
-	}, util.APIMeta{
-		Type: reflect.TypeOf((*wallet.IFullAPI)(nil)).Elem(),
-		ParseOpt: util.InterfaceParseOption{
-			ImportPath: "github.com/filecoin-project/venus/venus-shared/api/wallet",
-			IncludeAll: true,
-		},
-	})
-}
-
-var proxyTargets []util.APIMeta
-
 var proxyCmd = &cli.Command{
 	Name:  "proxy",
 	Flags: []cli.Flag{},
 	Action: func(cctx *cli.Context) error {
-		for _, target := range proxyTargets {
+		for _, target := range apiTargets {
 			err := genProxyForAPI(target)
 			if err != nil {
 				log.Fatalf("got error while generating proxy codes for %s: %s", target.Type, err)
@@ -100,18 +73,7 @@ func genProxyForAPI(t util.APIMeta) error {
 		return fmt.Errorf("copy contents into output: %w", err)
 	}
 
-	formatted, err := format.Source(fileBuffer.Bytes())
-	if err != nil {
-		return fmt.Errorf("format source content: %w", err)
-	}
-
-	outputFile := filepath.Join(astMeta.Location, "proxy_gen.go")
-	err = ioutil.WriteFile(outputFile, formatted, 0644)
-	if err != nil {
-		return fmt.Errorf("write to output %s: %w", outputFile, err)
-	}
-
-	return nil
+	return outputSourceFile(astMeta.Location, "proxy_gen.go", &fileBuffer)
 }
 
 func writeImports(deps map[string]util.ImportMeta, dst *bytes.Buffer) error {
@@ -200,10 +162,6 @@ type %s struct {
 `
 )
 
-func structName(ifaceName string) string {
-	return ifaceName + "Struct"
-}
-
 func writeStruct(dst *bytes.Buffer, ifaceMeta *util.InterfaceMeta, astMeta *util.ASTMeta) error {
 	fmt.Fprintf(dst, structHeadFormat, structName(ifaceMeta.Name))
 

venus-devtool/go.sum

@@ -664,6 +664,7 @@ github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB7
 github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
 github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
 github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
+github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
 github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/gostaticanalysis/analysisutil v0.0.0-20190318220348-4088753ea4d3/go.mod h1:eEOZF4jCKGi+aprrirO9e7WKB3beBRtWgqGunKl6pKE=
 github.com/gostaticanalysis/analysisutil v0.0.3/go.mod h1:eEOZF4jCKGi+aprrirO9e7WKB3beBRtWgqGunKl6pKE=

venus-devtool/util/api_meta.go

@@ -54,9 +54,15 @@ var ChainAPIPairs = []struct {
 
 var LatestChainAPIPair = ChainAPIPairs[len(ChainAPIPairs)-1]
 
+type RPCMeta struct {
+	Namespace       string
+	MethodNamespace string
+}
+
 type APIMeta struct {
 	Type     reflect.Type
 	ParseOpt InterfaceParseOption
+	RPCMeta
 }
 
 func GetAPIMethodPerm(m InterfaceMethodMeta) string {

venus-shared/api/request_header.go

@@ -0,0 +1,3 @@
+package api
+
+const VenusAPINamespaceHeader = "X-VENUS-API-NAMESPACE"