Nitro integration work

.circleci/config.yml

@@ -6,7 +6,7 @@ executors:
   golang:
     docker:
       - image: cimg/go:1.19.7
-    resource_class: 2xlarge
+    resource_class: xlarge
   ubuntu:
     docker:
       - image: ubuntu:20.04
@@ -266,7 +266,7 @@ workflows:
   ci:
     jobs:
       - lint-all:
-          concurrency: "16"   # expend all docker 2xlarge CPUs.
+          concurrency: "8"   # expend all docker xlarge CPUs.
       - mod-tidy-check
       - gofmt
       - cbor-check

README.md

@@ -293,6 +293,15 @@ make devnet/down
 
 rm -rf ~/.cache/filecoin-proof-parameters
 ```
+### Nitro payment integration
+
+To enable nitro payment integration for `booster-http` the `BOOSTER_HTTP_NITRO_ENABLED` env var must be set. The env var `BOOSTER_HTTP_NITRO_ENDPOINT` can also be set to specify a specific nitro RPC endpoint; if its not set a default endpoint of `host.docker.internal:4007/api/v1` is used.
+
+```bash
+docker stop m booster-http
+docker rm booster-http
+BOOSTER_HTTP_NITRO_ENABLED=true BOOSTER_HTTP_NITRO_ENDPOINT=someurl:4007/api/v1  docker compose -f ./docker/devnet/docker-compose.yaml up -d
+```
 
 ## License
 

cmd/booster-http/gateway_handler.go

@@ -2,19 +2,30 @@ package main
 
 import (
 	"fmt"
+	"math/big"
 	"mime"
 	"net/http"
+	"net/url"
 	"strings"
 
+	"github.com/ethereum/go-ethereum/common"
 	"github.com/ipfs/boxo/gateway"
+	"github.com/statechannels/go-nitro/rpc"
+	"github.com/statechannels/go-nitro/types"
+
+	"github.com/ethereum/go-ethereum/common/hexutil"
+
+	"github.com/statechannels/go-nitro/crypto"
+	"github.com/statechannels/go-nitro/payments"
 )
 
 type gatewayHandler struct {
 	gwh              http.Handler
 	supportedFormats map[string]struct{}
+	nitroRpcClient   *rpc.RpcClient
 }
 
-func newGatewayHandler(gw *gateway.BlocksBackend, supportedFormats []string) http.Handler {
+func newGatewayHandler(gw *gateway.BlocksBackend, supportedFormats []string, nitroRpcClient *rpc.RpcClient) http.Handler {
 	headers := map[string][]string{}
 	gateway.AddAccessControlHeaders(headers)
 
@@ -23,12 +34,11 @@ func newGatewayHandler(gw *gateway.BlocksBackend, supportedFormats []string) htt
 		fmtsMap[f] = struct{}{}
 	}
 
+	// TODO: For the integration demo, we need to allow CORS requests to the gateway.
 	return &gatewayHandler{
-		gwh: gateway.NewHandler(gateway.Config{
-			Headers:               headers,
-			DeserializedResponses: true,
-		}, gw),
+		gwh:              &corsHandler{gateway.NewHandler(gateway.Config{Headers: headers, DeserializedResponses: true}, gw)},
 		supportedFormats: fmtsMap,
+		nitroRpcClient:   nitroRpcClient,
 	}
 }
 
@@ -47,10 +57,66 @@ func (h *gatewayHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	if h.nitroRpcClient != nil {
+		// This the payment we expect to receive for the file.
+		const expectedPayment = int64(5)
+
+		params, _ := url.ParseQuery(r.URL.RawQuery)
+
+		v, err := parseVoucher(params)
+		if err != nil {
+			webError(w, fmt.Errorf("could not parse voucher: %w", err), http.StatusBadRequest)
+			return
+		}
+
+		s, err := h.nitroRpcClient.ReceiveVoucher(v)
+
+		if err != nil {
+			webError(w, fmt.Errorf("error processing voucher %w", err), http.StatusBadRequest)
+			return
+		}
+
+		// s.Delta is amount our balance increases by adding this voucher
+		// AKA the payment amount we received in the request for this file
+		if s.Delta.Cmp(big.NewInt(expectedPayment)) < 0 {
+			webError(w, fmt.Errorf("payment of %d required, the voucher only resulted in a payment of %d", expectedPayment, s.Delta.Uint64()), http.StatusPaymentRequired)
+			return
+		}
+	}
+
 	h.gwh.ServeHTTP(w, r)
 }
 
+// parseVoucher takes in an a collection of query params and parses out a voucher.
+func parseVoucher(params url.Values) (payments.Voucher, error) {
+	if !params.Has("channelId") {
+		return payments.Voucher{}, fmt.Errorf("a valid channel id must be provided")
+	}
+	if !params.Has("amount") {
+		return payments.Voucher{}, fmt.Errorf("a valid amount must be provided")
+	}
+	if !params.Has("signature") {
+		return payments.Voucher{}, fmt.Errorf("a valid signature must be provided")
+	}
+	rawChId := params.Get("channelId")
+	rawAmt := params.Get("amount")
+	amount := big.NewInt(0)
+	amount.SetString(rawAmt, 10)
+	rawSignature := params.Get("signature")
+
+	v := payments.Voucher{
+		ChannelId: types.Destination(common.HexToHash(rawChId)),
+		Amount:    amount,
+		Signature: crypto.SplitSignature(hexutil.MustDecode(rawSignature)),
+	}
+	return v, nil
+}
+
 func webError(w http.ResponseWriter, err error, code int) {
+	// TODO: This is a hack to allow CORS requests to the gateway for the boost integration demo.
+	w.Header().Set("Access-Control-Allow-Origin", "*")
+	w.Header().Set("Access-Control-Allow-Headers", "*")
+	fmt.Printf("ERROR CODE %d\n", code)
 	http.Error(w, err.Error(), code)
 }
 

cmd/booster-http/http_test.go

@@ -23,7 +23,7 @@ const testFile = "test/test_file"
 func TestNewHttpServer(t *testing.T) {
 	// Create a new mock Http server
 	ctrl := gomock.NewController(t)
-	httpServer := NewHttpServer("", "0.0.0.0", 7777, mocks_booster_http.NewMockHttpServerApi(ctrl), nil)
+	httpServer := NewHttpServer("", "0.0.0.0", 7777, mocks_booster_http.NewMockHttpServerApi(ctrl), nil, nil)
 	err := httpServer.Start(context.Background())
 	require.NoError(t, err)
 	waitServerUp(t, 7777)
@@ -42,7 +42,7 @@ func TestHttpGzipResponse(t *testing.T) {
 	// Create a new mock Http server with custom functions
 	ctrl := gomock.NewController(t)
 	mockHttpServer := mocks_booster_http.NewMockHttpServerApi(ctrl)
-	httpServer := NewHttpServer("", "0.0.0.0", 7777, mockHttpServer, nil)
+	httpServer := NewHttpServer("", "0.0.0.0", 7777, mockHttpServer, nil, nil)
 	err := httpServer.Start(context.Background())
 	require.NoError(t, err)
 	waitServerUp(t, 7777)
@@ -109,7 +109,7 @@ func TestHttpInfo(t *testing.T) {
 
 	// Create a new mock Http server
 	ctrl := gomock.NewController(t)
-	httpServer := NewHttpServer("", "0.0.0.0", 7777, mocks_booster_http.NewMockHttpServerApi(ctrl), nil)
+	httpServer := NewHttpServer("", "0.0.0.0", 7777, mocks_booster_http.NewMockHttpServerApi(ctrl), nil, nil)
 	err := httpServer.Start(context.Background())
 	require.NoError(t, err)
 	waitServerUp(t, 7777)

cmd/booster-http/run.go

@@ -33,6 +33,17 @@ var runCmd = &cli.Command{
 	Usage:  "Start a booster-http process",
 	Before: before,
 	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "nitro-enabled",
+			Usage: "enables nitro micro payments",
+			Value: false,
+		},
+		&cli.StringFlag{
+			Name:  "nitro-endpoint",
+			Usage: "the endpoint for the nitro server",
+			Value: "host.docker.internal:4007/api/v1",
+		},
+
 		&cli.BoolFlag{
 			Name:  "pprof",
 			Usage: "run pprof web server on localhost:6070",
@@ -204,13 +215,20 @@ var runCmd = &cli.Command{
 			filtered := filters.NewFilteredBlockstore(rbs, multiFilter)
 			opts.Blockstore = filtered
 		}
+
+		nitroOpts := &NitroOptions{
+			Enabled:  cctx.Bool("nitro-enabled"),
+			Endpoint: cctx.String("nitro-endpoint"),
+		}
+
 		sapi := serverApi{ctx: ctx, bapi: bapi, sa: sa}
 		server := NewHttpServer(
 			cctx.String("base-path"),
 			cctx.String("address"),
 			cctx.Int("port"),
 			sapi,
 			opts,
+			nitroOpts,
 		)
 
 		// Start the server

cmd/booster-http/server.go

@@ -26,6 +26,7 @@ import (
 	"github.com/ipfs/boxo/gateway"
 	"github.com/ipfs/go-cid"
 	"github.com/ipfs/go-datastore"
+	nrpc "github.com/statechannels/go-nitro/rpc"
 	"go.opencensus.io/stats"
 )
 
@@ -53,6 +54,8 @@ type HttpServer struct {
 	ctx    context.Context
 	cancel context.CancelFunc
 	server *http.Server
+
+	nitroRpcClient *nrpc.RpcClient
 }
 
 type HttpServerApi interface {
@@ -67,11 +70,26 @@ type HttpServerOptions struct {
 	SupportedResponseFormats []string
 }
 
-func NewHttpServer(path string, listenAddr string, port int, api HttpServerApi, opts *HttpServerOptions) *HttpServer {
+type NitroOptions struct {
+	Enabled  bool
+	Endpoint string
+}
+
+func NewHttpServer(path string, listenAddr string, port int, api HttpServerApi, opts *HttpServerOptions, nitroOpts *NitroOptions) *HttpServer {
 	if opts == nil {
 		opts = &HttpServerOptions{ServePieces: true}
 	}
-	return &HttpServer{path: path, listenAddr: listenAddr, port: port, api: api, opts: *opts, idxPage: parseTemplate(*opts)}
+	var rpcClient *nrpc.RpcClient
+	var err error
+	if nitroOpts != nil && nitroOpts.Enabled {
+
+		rpcClient, err = nrpc.NewHttpRpcClient(nitroOpts.Endpoint)
+		if err != nil {
+			panic(err)
+		}
+	}
+	return &HttpServer{path: path, port: port, api: api, opts: *opts, idxPage: parseTemplate(*opts), nitroRpcClient: rpcClient}
+
 }
 
 func (s *HttpServer) pieceBasePath() string {
@@ -96,7 +114,7 @@ func (s *HttpServer) Start(ctx context.Context) error {
 		if err != nil {
 			return fmt.Errorf("creating blocks gateway: %w", err)
 		}
-		handler.Handle(s.ipfsBasePath(), newGatewayHandler(gw, s.opts.SupportedResponseFormats))
+		handler.Handle(s.ipfsBasePath(), newGatewayHandler(gw, s.opts.SupportedResponseFormats, s.nitroRpcClient))
 	}
 
 	handler.HandleFunc("/", s.handleIndex)
@@ -156,6 +174,7 @@ func (s *HttpServer) handleByPieceCid(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	// TODO: Update to parse out multiple url params
 	pieceCidStr := r.URL.Path[prefixLen:]
 	pieceCid, err := cid.Parse(pieceCidStr)
 	if err != nil {

cmd/booster-http/util.go

@@ -1,6 +1,9 @@
 package main
 
-import "fmt"
+import (
+	"fmt"
+	"net/http"
+)
 
 func addCommas(count uint64) string {
 	str := fmt.Sprintf("%d", count)
@@ -9,3 +12,19 @@ func addCommas(count uint64) string {
 	}
 	return str
 }
+
+type corsHandler struct {
+	sub http.Handler
+}
+
+func (h *corsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	w.Header().Set("Access-Control-Allow-Origin", "*")
+	w.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE, PUT")
+	w.Header().Set("Access-Control-Allow-Headers", "*")
+	if r.Method == "OPTIONS" {
+		_, _ = w.Write([]byte("OK"))
+		return
+	}
+
+	h.sub.ServeHTTP(w, r)
+}

docker/devnet/booster-http/entrypoint.sh

@@ -10,4 +10,5 @@ echo $MINER_API_INFO
 echo $BOOST_API_INFO
 
 echo Starting booster-http...
-exec booster-http run --serve-files=true --api-boost=$BOOST_API_INFO --api-fullnode=$FULLNODE_API_INFO --api-storage=$MINER_API_INFO --tracing
+exec booster-http run --serve-files=true --api-boost=$BOOST_API_INFO --api-fullnode=$FULLNODE_API_INFO --api-storage=$MINER_API_INFO  --tracing \
+ --nitro-enabled=$BOOSTER_HTTP_NITRO_ENABLED --nitro-endpoint=$BOOSTER_HTTP_NITRO_ENDPOINT

docker/devnet/docker-compose.yaml

@@ -80,6 +80,8 @@ services:
       - BOOST_PATH=/var/lib/boost
       - LOTUS_PATH=/var/lib/lotus
       - LOTUS_MINER_PATH=/var/lib/lotus-miner
+      - BOOSTER_HTTP_NITRO_ENABLED=${BOOSTER_HTTP_NITRO_ENABLED:-false}
+      - BOOSTER_HTTP_NITRO_ENDPOINT=${BOOSTER_HTTP_NITRO_ENDPOINT:-host.docker.internal:4007/api/v1}
     restart: unless-stopped
     logging: *default-logging
     volumes: