feat: venus-shared: api version / namespaces & helper func for rpc en…

…dpoint (#4782)

* feat: helper for formating endpoint with given addr & ver

* feat: add Version for api-gen

* feat: re-generate api clients with ver & nss

* refactor: rename v0 to gateway so that we could have a better api namespace

venus-devtool/api-gen/common.go

@@ -30,6 +30,7 @@ func init() {
 				IncludeAll: true,
 			},
 			RPCMeta: util.RPCMeta{
+				Version:         0,
 				MethodNamespace: "Message",
 			},
 		},
@@ -39,6 +40,9 @@ func init() {
 				ImportPath: "github.com/filecoin-project/venus/venus-shared/api/wallet",
 				IncludeAll: true,
 			},
+			RPCMeta: util.RPCMeta{
+				Version: 0,
+			},
 		},
 		util.APIMeta{
 			Type: reflect.TypeOf((*gatewayv1.IGateway)(nil)).Elem(),
@@ -47,6 +51,7 @@ func init() {
 				IncludeAll: true,
 			},
 			RPCMeta: util.RPCMeta{
+				Version:         1,
 				MethodNamespace: "Gateway",
 			},
 		},
@@ -57,6 +62,7 @@ func init() {
 				IncludeAll: true,
 			},
 			RPCMeta: util.RPCMeta{
+				Version:         0,
 				MethodNamespace: "Gateway",
 			},
 		},
@@ -67,6 +73,7 @@ func init() {
 				IncludeAll: true,
 			},
 			RPCMeta: util.RPCMeta{
+				Version:         0,
 				MethodNamespace: "VENUS_MARKET",
 			},
 		},
@@ -77,6 +84,7 @@ func init() {
 				IncludeAll: true,
 			},
 			RPCMeta: util.RPCMeta{
+				Version:         0,
 				MethodNamespace: "VENUS_MARKET_CLIENT",
 			},
 		},

venus-devtool/util/api_meta.go

@@ -31,6 +31,9 @@ var ChainAPIPairs = []struct {
 				ImportPath: "github.com/filecoin-project/venus/venus-shared/api/chain/v0",
 				IncludeAll: true,
 			},
+			RPCMeta: RPCMeta{
+				Version: 0,
+			},
 		},
 	},
 	{
@@ -48,13 +51,17 @@ var ChainAPIPairs = []struct {
 				ImportPath: "github.com/filecoin-project/venus/venus-shared/api/chain/v1",
 				IncludeAll: true,
 			},
+			RPCMeta: RPCMeta{
+				Version: 1,
+			},
 		},
 	},
 }
 
 var LatestChainAPIPair = ChainAPIPairs[len(ChainAPIPairs)-1]
 
 type RPCMeta struct {
+	Version         uint32
 	Namespace       string
 	MethodNamespace string
 }

venus-shared/api/endpoint.go

@@ -0,0 +1,28 @@
+package api
+
+import (
+	"fmt"
+	"net/url"
+)
+
+func Endpoint(raw string, ver uint32) (string, error) {
+	u, err := url.Parse(raw)
+	if err != nil {
+		return "", fmt.Errorf("invalid url: %w", err)
+	}
+
+	if u.Scheme == "" {
+		return "", fmt.Errorf("scheme is required")
+	}
+
+	if u.Host == "" {
+		return "", fmt.Errorf("host is required")
+	}
+
+	// raw url contains more than just scheme://host(:prot)
+	if u.Path != "" && u.Path != "/" {
+		return raw, nil
+	}
+
+	return fmt.Sprintf("%s://%s/rpc/v%d", u.Scheme, u.Host, ver), nil
+}

venus-shared/api/endpoint_test.go

@@ -0,0 +1,95 @@
+package api
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestParseHost(t *testing.T) {
+
+	cases := []struct {
+		raw      string
+		ver      uint32
+		expected string
+	}{
+		// valid
+		{
+			raw:      "http://api.venus.io:1234",
+			ver:      1,
+			expected: "http://api.venus.io:1234/rpc/v1",
+		},
+		{
+			raw:      "http://api.venus.io:1234/",
+			ver:      1,
+			expected: "http://api.venus.io:1234/rpc/v1",
+		},
+		{
+			raw:      "http://api.venus.io:1234/rpc",
+			ver:      1,
+			expected: "http://api.venus.io:1234/rpc",
+		},
+
+		{
+			raw:      "http://api.venus.io:1234/rpc/v0",
+			ver:      1,
+			expected: "http://api.venus.io:1234/rpc/v0",
+		},
+
+		// invalid: no scheme
+		{
+			raw:      "://api.venus.io:1234",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "://api.venus.io:1234/",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "://api.venus.io:1234/rpc",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "://api.venus.io:1234/rpc/v0",
+			ver:      1,
+			expected: "",
+		},
+
+		// invalid: no scheme 2
+		{
+			raw:      "api.venus.io:1234",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "api.venus.io:1234/",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "api.venus.io:1234/rpc",
+			ver:      1,
+			expected: "",
+		},
+		{
+			raw:      "api.venus.io:1234/rpc/v0",
+			ver:      1,
+			expected: "",
+		},
+	}
+
+	for i := range cases {
+		c := cases[i]
+		got, err := Endpoint(c.raw, c.ver)
+		if c.expected == "" {
+			require.Errorf(t, err, "%s is expected to be invalid, got %s", c.raw, got)
+			continue
+		}
+
+		require.NoErrorf(t, err, "%s is expected to be valid", c.raw)
+		require.Equal(t, c.expected, got, "converted endpoint")
+	}
+}

venus-shared/api/gateway/v0/api.go

@@ -1,4 +1,4 @@
-package v0
+package gateway
 
 type IGateway interface {
 	IProofEvent

venus-shared/api/gateway/v0/market_event.go

@@ -1,4 +1,4 @@
-package v0
+package gateway
 
 import (
 	"context"

venus-shared/api/gateway/v0/proof_event.go

@@ -1,4 +1,4 @@
-package v0
+package gateway
 
 import (
 	"context"

venus-shared/api/gateway/v0/wallet_event.go

@@ -1,4 +1,4 @@
-package v0
+package gateway
 
 import (
 	"context"