Merge pull request #78 from cloudstruct/chore/upgrade-go-ouroboros-network

chore: update go-ouroboros-network to v0.27.0

Author: agaffney

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/Bitrue-exchange/libada-go v0.0.1-rc.0.20220817020305-79d8b4c4dd9c
 	github.com/cloudstruct/go-cardano-ledger v0.4.0
-	github.com/cloudstruct/go-ouroboros-network v0.16.1
+	github.com/cloudstruct/go-ouroboros-network v0.27.0
 	github.com/fxamacker/cbor/v2 v2.4.0
 	github.com/gin-contrib/zap v0.0.2
 	github.com/gin-gonic/gin v1.8.1

go.sum

@@ -63,8 +63,8 @@ github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMn
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cloudstruct/go-cardano-ledger v0.4.0 h1:4BZvwZSM82r/Bt+W4XHTstJEABg0jXcougcZgDmZBo0=
 github.com/cloudstruct/go-cardano-ledger v0.4.0/go.mod h1:EBB9JG+3nBs3IV0p751yz1468XYkzJce1/A2X+xH8L8=
-github.com/cloudstruct/go-ouroboros-network v0.16.1 h1:iAYviR5keS3/rbAnJp2slXsTcEAE04ut8WDcRYzK6qM=
-github.com/cloudstruct/go-ouroboros-network v0.16.1/go.mod h1:/Rz+GYS+ItV7e5F4rXfZuCVuHa+SkFfaH3zgqjVN3eI=
+github.com/cloudstruct/go-ouroboros-network v0.27.0 h1:LURvMntHdR0WuBFmzMe+dyoeC7gQQ2hxugbQevJaqKw=
+github.com/cloudstruct/go-ouroboros-network v0.27.0/go.mod h1:GP7VdlqIqpio2y9xlKnLL7v93Wk2jpaPySycvJvs9A4=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=

internal/api/api.go

@@ -3,20 +3,22 @@ package api
 import (
 	"encoding/hex"
 	"fmt"
+	"io"
+	"time"
+
 	"github.com/cloudstruct/go-cardano-ledger"
 	"github.com/cloudstruct/go-cardano-submit-api/internal/config"
 	"github.com/cloudstruct/go-cardano-submit-api/internal/logging"
 	ouroboros "github.com/cloudstruct/go-ouroboros-network"
 	"github.com/cloudstruct/go-ouroboros-network/protocol/localtxsubmission"
+
 	"github.com/fxamacker/cbor/v2"
 	ginzap "github.com/gin-contrib/zap"
 	"github.com/gin-gonic/gin"
 	"github.com/penglongli/gin-metrics/ginmetrics"
 	swaggerFiles "github.com/swaggo/files"     // swagger embed files
 	ginSwagger "github.com/swaggo/gin-swagger" // gin-swagger middleware
 	"golang.org/x/crypto/blake2b"
-	"io"
-	"time"
 
 	_ "github.com/cloudstruct/go-cardano-submit-api/docs" // docs is generated by Swag CLI
 )
@@ -172,19 +174,16 @@ func handleSubmitTx(c *gin.Context) {
 	txIdHex := hex.EncodeToString(txIdHash[:])
 	// Connect to cardano-node and submit TX
 	errorChan := make(chan error)
-	doneChan := make(chan bool)
-	oOpts := &ouroboros.OuroborosOptions{
-		NetworkMagic:          uint32(cfg.Node.NetworkMagic),
-		ErrorChan:             errorChan,
-		UseNodeToNodeProtocol: false,
-	}
-	oConn, err := ouroboros.New(oOpts)
-	defer func() {
-		// We have to close the channel to break out of the async error handler goroutine
-		close(errorChan)
-		// Close Ouroboros connection
-		oConn.Close()
-	}()
+	oConn, err := ouroboros.New(
+		ouroboros.WithNetworkMagic(uint32(cfg.Node.NetworkMagic)),
+		ouroboros.WithErrorChan(errorChan),
+		ouroboros.WithNodeToNode(false),
+		ouroboros.WithLocalTxSubmissionConfig(
+			localtxsubmission.NewConfig(
+				localtxsubmission.WithTimeout(5*time.Second),
+			),
+		),
+	)
 	if err != nil {
 		logger.Errorf("failure creating Ouroboros connection: %s", err)
 		c.JSON(500, "failure communicating with node")
@@ -213,50 +212,36 @@ func handleSubmitTx(c *gin.Context) {
 			logger.Errorf("failure communicating with node: %s", err)
 			c.JSON(500, "failure communicating with node")
 			_ = ginmetrics.GetMonitor().GetMetric("tx_submit_fail_count").Inc(nil)
-			doneChan <- true
 		}
 	}()
+	defer func() {
+		// Close Ouroboros connection
+		oConn.Close()
+	}()
 	// Start local-tx-submission protocol
-	localTxSubmissionCallbackConfig := &localtxsubmission.CallbackConfig{
-		AcceptTxFunc: func() error {
-			// Return transaction ID
-			c.JSON(202, txIdHex)
-			doneChan <- true
-			// Increment custom metric
-			_ = ginmetrics.GetMonitor().GetMetric("tx_submit_count").Inc(nil)
-			return nil
-		},
-		RejectTxFunc: func(reasonCbor []byte) error {
-			if c.GetHeader("Accept") == "application/cbor" {
-				c.Data(400, "application/cbor", reasonCbor)
-			} else {
-				if reason, err := ledger.NewTxSubmitErrorFromCbor(reasonCbor); err == nil {
-					c.JSON(400, reason)
-				} else {
-					c.JSON(400, fmt.Sprintf("transaction rejected by node, but the 'reason' data could not be parsed (raw CBOR: %x)", reasonCbor))
-				}
-			}
-			doneChan <- true
-			// Increment custom metric
-			_ = ginmetrics.GetMonitor().GetMetric("tx_submit_fail_count").Inc(nil)
-			return nil
-		},
-	}
-	oConn.LocalTxSubmission.Start(localTxSubmissionCallbackConfig)
+	oConn.LocalTxSubmission().Client.Start()
 	// Determine transaction type (era)
 	txType, err := determineTransactionType(txRawBytes)
 	if err != nil {
 		c.JSON(400, "could not parse transaction to determine type")
 		return
 	}
 	// Submit the transaction
-	if err := oConn.LocalTxSubmission.SubmitTx(txType, txRawBytes); err != nil {
-		logger.Errorf("failure submitting transaction: %s", err)
-		c.JSON(500, "failure communicating with node")
+	if err := oConn.LocalTxSubmission().Client.SubmitTx(txType, txRawBytes); err != nil {
+		if c.GetHeader("Accept") == "application/cbor" {
+			txRejectErr := err.(localtxsubmission.TransactionRejectedError)
+			c.Data(400, "application/cbor", txRejectErr.ReasonCbor)
+		} else {
+			c.JSON(400, err.Error())
+		}
+		// Increment custom metric
+		_ = ginmetrics.GetMonitor().GetMetric("tx_submit_fail_count").Inc(nil)
 		return
 	}
-	// Wait for async process to finish
-	<-doneChan
+	// Return transaction ID
+	c.JSON(202, txIdHex)
+	// Increment custom metric
+	_ = ginmetrics.GetMonitor().GetMetric("tx_submit_count").Inc(nil)
 }
 
 func determineTransactionType(data []byte) (uint16, error) {

internal/config/config.go

@@ -23,8 +23,8 @@ type LoggingConfig struct {
 }
 
 type ApiConfig struct {
-	ListenAddress  string `yaml:"address" envconfig:"API_LISTEN_ADDRESS"`
-	ListenPort     uint   `yaml:"port" envconfig:"API_LISTEN_PORT"`
+	ListenAddress string `yaml:"address" envconfig:"API_LISTEN_ADDRESS"`
+	ListenPort    uint   `yaml:"port" envconfig:"API_LISTEN_PORT"`
 }
 
 type DebugConfig struct {
@@ -52,8 +52,8 @@ var globalConfig = &Config{
 		Healthchecks: false,
 	},
 	Api: ApiConfig{
-		ListenAddress:  "",
-		ListenPort:     8090,
+		ListenAddress: "",
+		ListenPort:    8090,
 	},
 	Debug: DebugConfig{
 		ListenAddress: "localhost",
@@ -122,19 +122,10 @@ func (c *Config) populateNetworkMagic() error {
 
 func (c *Config) checkNode() error {
 	// Connect to cardano-node
-	errorChan := make(chan error)
-	oOpts := &ouroboros.OuroborosOptions{
-		NetworkMagic:          uint32(c.Node.NetworkMagic),
-		ErrorChan:             errorChan,
-		UseNodeToNodeProtocol: false,
-	}
-	oConn, err := ouroboros.New(oOpts)
-	defer func() {
-		// We have to close the channel to break out of the async error handler goroutine
-		close(errorChan)
-		// Close Ouroboros connection
-		oConn.Close()
-	}()
+	oConn, err := ouroboros.New(
+		ouroboros.WithNetworkMagic(uint32(c.Node.NetworkMagic)),
+		ouroboros.WithNodeToNode(false),
+	)
 	if err != nil {
 		return fmt.Errorf("failure creating Ouroboros connection: %s", err)
 	}
@@ -159,5 +150,7 @@ func (c *Config) checkNode() error {
 	} else {
 		return fmt.Errorf("you must specify either the UNIX socket path or the address/port for your cardano-node")
 	}
+	// Close Ouroboros connection
+	oConn.Close()
 	return nil
 }