Merge pull request #269 from gosuda/feature/relay-api-routing

Feature/relay api routing

Author: gosunuts

README.md

@@ -72,7 +72,7 @@ portal expose --name myapp \
 
 # Require x402 payment before a local HTTP upstream receives traffic
 portal expose 3000 --name paid-api \
-  --x402-facilitator-url https://portal.example.com/x402 \
+  --x402-facilitator-url https://portal.example.com/api/x402 \
   --x402-network eip155:8453 \
   --x402-price "$0.001"
 

cmd/payment-app/main.go

@@ -63,7 +63,7 @@ func run(args []string) error {
 	utils.StringFlag(fs, &cfg.thumbnail, "thumbnail", defaultPhotoURL, "lease thumbnail")
 	utils.StringFlag(fs, &cfg.photoURL, "photo-url", defaultPhotoURL, "image URL revealed after payment")
 	utils.BoolFlag(fs, &cfg.hide, "hide", false, "hide this lease from listings")
-	utils.StringFlag(fs, &cfg.x402.FacilitatorURL, "x402-facilitator-url", "https://gosunuts.xyz/x402", "x402 facilitator URL, such as https://relay.example.com:4017/x402")
+	utils.StringFlag(fs, &cfg.x402.FacilitatorURL, "x402-facilitator-url", "https://gosunuts.xyz/api/x402", "x402 facilitator URL, such as https://relay.example.com:4017/api/x402")
 	utils.StringFlag(fs, &cfg.x402.Network, "x402-network", "eip155:84532", "x402 payment network, such as eip155:8453")
 	utils.StringFlag(fs, &cfg.x402.Price, "x402-price", "$0.001", "x402 price for the protected image, such as $0.01")
 	utils.StringFlag(fs, &cfg.x402.PayTo, "x402-pay-to", "", "x402 recipient address; empty uses the payment app identity address")
@@ -182,7 +182,7 @@ func printUsage(w io.Writer) {
 		[]string{
 			"payment-app",
 			"payment-app --name paid-photo",
-			"payment-app --x402-facilitator-url https://relay.example.com:4017/x402 --x402-network eip155:8453 --x402-price \"$0.01\"",
+			"payment-app --x402-facilitator-url https://relay.example.com:4017/api/x402 --x402-network eip155:8453 --x402-price \"$0.01\"",
 		},
 	)
 }

cmd/portal-tunnel/README.md

@@ -35,13 +35,13 @@ portal list
 If your relay publishes its own installer, use that relay instead:
 
 ```bash
-curl -sSL https://portal.example.com/install.sh | bash
+curl -sSL https://portal.example.com/api/install.sh | bash
 portal expose 3000 --relays https://portal.example.com --discovery=false
 ```
 
 ```powershell
 $ProgressPreference = 'SilentlyContinue'
-irm https://portal.example.com/install.ps1 | iex
+irm https://portal.example.com/api/install.ps1 | iex
 portal expose 3000 --relays https://portal.example.com --discovery=false
 ```
 
@@ -78,7 +78,7 @@ app receives the request:
 ```text
 portal expose 3000 --name paid-api \
   --description "Paid API" \
-  --x402-facilitator-url https://portal.example.com:4017/x402 \
+  --x402-facilitator-url https://portal.example.com:4017/api/x402 \
   --x402-network eip155:8453 \
   --x402-price "$0.001" \
   --x402-resource /
@@ -117,7 +117,7 @@ upstream = "http://127.0.0.1:3001"
 network = "eip155:8453"
 price = "$0.010"
 pay_to = "identity"
-facilitator_url = "https://portal.example.com:4017/x402"
+facilitator_url = "https://portal.example.com:4017/api/x402"
 resource = "/api/report"
 mime_type = "application/json"
 
@@ -129,7 +129,7 @@ upstream = "http://127.0.0.1:3001"
 network = "eip155:8453"
 price = "$0.050"
 pay_to = "identity"
-facilitator_url = "https://portal.example.com:4017/x402"
+facilitator_url = "https://portal.example.com:4017/api/x402"
 resource = "/api/dataset"
 mime_type = "application/json"
 ```
@@ -153,7 +153,7 @@ protected, err := portalx402.NewHTTPRouteHandler(portalx402.HTTPRouteHandlerConf
 `cmd/payment-app` includes this native x402 pattern. Run it with:
 
 ```text
-payment-app --x402-facilitator-url https://portal.example.com:4017/x402 \
+payment-app --x402-facilitator-url https://portal.example.com:4017/api/x402 \
   --x402-network eip155:8453 \
   --x402-price "$0.01"
 ```
@@ -388,7 +388,7 @@ upstream = "http://127.0.0.1:3000"
 network = "eip155:8453"
 price = "$0.001"
 pay_to = "identity"
-facilitator_url = "https://portal.example.com:4017/x402"
+facilitator_url = "https://portal.example.com:4017/api/x402"
 resource = "/"
 ```
 

cmd/portal-tunnel/agent/dashboard.go

@@ -167,7 +167,7 @@ func RunDashboard(configPath, stateDir string) error {
 		metadataOwner:       newAgentDashboardInlineInput("owner"),
 		metadataThumbnail:   newAgentDashboardInlineInput("https://..."),
 		metadataHide:        newAgentDashboardInlineInput("true or false"),
-		x402FacilitatorURL:  newAgentDashboardInlineInput("https://relay.example.com/x402"),
+		x402FacilitatorURL:  newAgentDashboardInlineInput("https://relay.example.com/api/x402"),
 	}
 	model.resizeInputs(0)
 

cmd/portal-tunnel/installer/installer.go

@@ -4,6 +4,8 @@ import (
 	_ "embed"
 	"errors"
 	"strings"
+
+	"github.com/gosuda/portal-tunnel/v2/types"
 )
 
 //go:embed install.sh
@@ -47,7 +49,7 @@ func relayShellScript(portalURL, script string) string {
 	overrides := strings.Join([]string{
 		"BASE_URL=" + quoteShellValue(portalURL),
 		"RELAY_URL=" + quoteShellValue(portalURL),
-		"BIN_PATH_PREFIX='install/bin'",
+		"BIN_PATH_PREFIX=" + quoteShellValue(strings.Trim(types.PathInstallBinPrefix, "/")),
 		"",
 	}, "\n")
 	return insertAfterShebang(script, overrides)
@@ -57,7 +59,7 @@ func relayPowerShellScript(portalURL, script string) string {
 	overrides := strings.Join([]string{
 		"$env:BASE_URL = " + quotePowerShellValue(portalURL),
 		"$env:RELAY_URL = " + quotePowerShellValue(portalURL),
-		"$env:BIN_PATH_PREFIX = 'install/bin'",
+		"$env:BIN_PATH_PREFIX = " + quotePowerShellValue(strings.Trim(types.PathInstallBinPrefix, "/")),
 		"",
 	}, "\n")
 	return overrides + script

cmd/portal-tunnel/installer/update.go

@@ -14,6 +14,8 @@ import (
 	"strings"
 	"time"
 
+	"golang.org/x/mod/semver"
+
 	"github.com/gosuda/portal-tunnel/v2/types"
 	"github.com/gosuda/portal-tunnel/v2/utils"
 )
@@ -48,7 +50,12 @@ func StartUpdateCheck(currentVersion string) {
 						segments := strings.Split(strings.TrimPrefix(parsed.Path, "/"), "/")
 						if len(segments) >= 5 {
 							version := segments[4]
-							if strings.HasPrefix(version, "v") && version != currentVersion {
+							current := strings.TrimSpace(currentVersion)
+							if current != "" && !strings.HasPrefix(current, "v") {
+								current = "v" + current
+							}
+							latestValid := strings.HasPrefix(version, "v") && semver.IsValid(version)
+							if latestValid && semver.IsValid(current) && semver.Compare(version, current) > 0 {
 								fmt.Fprintf(os.Stderr, "\nA new version is available: %s. Run 'portal update' to upgrade.\n", version)
 							}
 						}

cmd/relay-server/api.go

@@ -171,7 +171,7 @@ func (api *RelayAPI) serveAdmin(w http.ResponseWriter, r *http.Request) {
 	}
 
 	switch path {
-	case "/admin/metrics":
+	case types.PathAdmin + "/metrics":
 		promhttp.Handler().ServeHTTP(w, r)
 		return
 	default:

cmd/relay-server/main.go

@@ -93,7 +93,7 @@ func runServeCommand(args []string) error {
 	utils.StringFlagEnv(fs, &cfg.AdminWallets, "admin-wallets", "", "admin wallet address allowlist, comma-separated; relay identity address is always allowed", "ADMIN_WALLETS")
 	utils.BoolFlagEnv(fs, &cfg.PProfEnabled, "pprof-enabled", false, "enable pprof diagnostics HTTP server", "PPROF_ENABLED")
 	utils.StringFlagEnv(fs, &cfg.PProfAddr, "pprof-addr", portal.DefaultPProfListenAddr, "pprof diagnostics listen address when enabled", "PPROF_ADDR")
-	utils.BoolFlagEnv(fs, &cfg.X402Enabled, "x402-facilitator-enabled", false, "enable relay-local x402 facilitator endpoints under /x402", "X402_FACILITATOR_ENABLED")
+	utils.BoolFlagEnv(fs, &cfg.X402Enabled, "x402-facilitator-enabled", false, "enable relay-local x402 facilitator endpoints under /api/x402", "X402_FACILITATOR_ENABLED")
 	utils.StringFlagEnv(fs, &cfg.X402Network, "x402-network", "", "x402 facilitator CAIP-2 network, such as eip155:8453", "X402_NETWORK")
 	utils.StringFlagEnv(fs, &cfg.X402RPCURL, "x402-rpc-url", "", "x402 facilitator RPC URL; empty uses the PublicNode default for supported networks", "X402_RPC_URL")
 

config.toml

@@ -2,9 +2,9 @@
 # Bump protocol versions only when wire-level behavior changes.
 
 [release]
-version  = "v2.2.5"
+version  = "v2.3.0"
 base_url = "https://github.com/gosuda/portal-tunnel/releases"
 
 [protocol]
-tunnel    = "7"
-discovery = "7"
+tunnel    = "8"
+discovery = "8"

docker-compose.yml

@@ -44,7 +44,7 @@ services:
   #   restart: unless-stopped
 
   portal-api:
-    image: ghcr.io/gosuda/portal-api:latest
+    image: ghcr.io/gosuda/portal-api:2
     build:
       context: ./frontend
       dockerfile: Dockerfile
@@ -66,7 +66,7 @@ services:
     restart: unless-stopped
 
   portal-frontend:
-    image: ghcr.io/gosuda/portal-frontend:latest
+    image: ghcr.io/gosuda/portal-frontend:2
     build:
       context: ./frontend
       dockerfile: Dockerfile
@@ -76,7 +76,7 @@ services:
     restart: unless-stopped
 
   portal:
-    image: ghcr.io/gosuda/portal:latest
+    image: ghcr.io/gosuda/portal:2
     build:
       context: .
       dockerfile: Dockerfile
@@ -111,7 +111,7 @@ services:
       TRUST_PROXY_HEADERS: ${TRUST_PROXY_HEADERS:-true}
       TRUSTED_PROXY_CIDRS: ${TRUSTED_PROXY_CIDRS:-}
 
-      # Optional: relay-local x402 facilitator exposed under /x402
+      # Optional: relay-local x402 facilitator exposed under /api/x402
       X402_FACILITATOR_ENABLED: ${X402_FACILITATOR_ENABLED:-false}
       X402_NETWORK: ${X402_NETWORK:-eip155:84532}
       X402_RPC_URL: ${X402_RPC_URL:-https://base-sepolia-rpc.publicnode.com}