services/horizon + horizonclient: Add new async transaction submission endpoint

clients/stellarcore/client.go

@@ -29,6 +29,18 @@ type Client struct {
 	URL string
 }
 
+type ClientInterface interface {
+	Upgrade(ctx context.Context, version int) (err error)
+	GetLedgerEntry(ctx context.Context, ledgerKey xdr.LedgerKey) (proto.GetLedgerEntryResponse, error)
+	Info(ctx context.Context) (resp *proto.InfoResponse, err error)
+	SetCursor(ctx context.Context, id string, cursor int32) (err error)
+	SubmitTransaction(ctx context.Context, envelope string) (resp *proto.TXResponse, err error)
+	WaitForNetworkSync(ctx context.Context) error
+	ManualClose(ctx context.Context) (err error)
+	http() HTTP
+	simpleGet(ctx context.Context, newPath string, query url.Values) (*http.Request, error)
+}
+
 // drainReponse is a helper method for draining the body stream off the http
 // response object and optionally close the stream. It would also update the
 // error but only as long as there wasn't an error before - this would allow

clients/stellarcore/mocks.go

@@ -0,0 +1,71 @@
+package stellarcore
+
+import (
+	"context"
+	"net/http"
+	"net/url"
+
+	"github.com/stellar/go/support/http/httptest"
+
+	proto "github.com/stellar/go/protocols/stellarcore"
+	"github.com/stellar/go/xdr"
+	"github.com/stretchr/testify/mock"
+)
+
+// MockClient is a mockable stellar-core client.
+type MockClient struct {
+	mock.Mock
+}
+
+// Upgrade mocks the Upgrade method
+func (m *MockClient) Upgrade(ctx context.Context, version int) error {
+	args := m.Called(ctx, version)
+	return args.Error(0)
+}
+
+// GetLedgerEntry mocks the GetLedgerEntry method
+func (m *MockClient) GetLedgerEntry(ctx context.Context, ledgerKey xdr.LedgerKey) (proto.GetLedgerEntryResponse, error) {
+	args := m.Called(ctx, ledgerKey)
+	return args.Get(0).(proto.GetLedgerEntryResponse), args.Error(1)
+}
+
+// Info mocks the Info method
+func (m *MockClient) Info(ctx context.Context) (*proto.InfoResponse, error) {
+	args := m.Called(ctx)
+	return args.Get(0).(*proto.InfoResponse), args.Error(1)
+}
+
+// SetCursor mocks the SetCursor method
+func (m *MockClient) SetCursor(ctx context.Context, id string, cursor int32) error {
+	args := m.Called(ctx, id, cursor)
+	return args.Error(0)
+}
+
+// SubmitTransaction mocks the SubmitTransaction method
+func (m *MockClient) SubmitTransaction(ctx context.Context, envelope string) (*proto.TXResponse, error) {
+	args := m.Called(ctx, envelope)
+	return args.Get(0).(*proto.TXResponse), args.Error(1)
+}
+
+// WaitForNetworkSync mocks the WaitForNetworkSync method
+func (m *MockClient) WaitForNetworkSync(ctx context.Context) error {
+	args := m.Called(ctx)
+	return args.Error(0)
+}
+
+// ManualClose mocks the ManualClose method
+func (m *MockClient) ManualClose(ctx context.Context) error {
+	args := m.Called(ctx)
+	return args.Error(0)
+}
+
+// Mock for http() method
+func (m *MockClient) http() HTTP {
+	return httptest.NewClient()
+}
+
+// Mock for simpleGet() method
+func (m *MockClient) simpleGet(ctx context.Context, newPath string, query url.Values) (*http.Request, error) {
+	args := m.Called(ctx, newPath, query)
+	return args.Get(0).(*http.Request), args.Error(1)
+}

services/horizon/internal/actions/submit_transaction.go

@@ -2,17 +2,13 @@ package actions
 
 import (
 	"context"
-	"encoding/hex"
-	"mime"
 	"net/http"
 
-	"github.com/stellar/go/network"
 	"github.com/stellar/go/protocols/horizon"
 	"github.com/stellar/go/protocols/stellarcore"
 	hProblem "github.com/stellar/go/services/horizon/internal/render/problem"
 	"github.com/stellar/go/services/horizon/internal/resourceadapter"
 	"github.com/stellar/go/services/horizon/internal/txsub"
-	"github.com/stellar/go/support/errors"
 	"github.com/stellar/go/support/render/hal"
 	"github.com/stellar/go/support/render/problem"
 	"github.com/stellar/go/xdr"
@@ -29,53 +25,6 @@ type SubmitTransactionHandler struct {
 	CoreStateGetter
 }
 
-type envelopeInfo struct {
-	hash      string
-	innerHash string
-	raw       string
-	parsed    xdr.TransactionEnvelope
-}
-
-func (handler SubmitTransactionHandler) extractEnvelopeInfo(raw string, passphrase string) (envelopeInfo, error) {
-	result := envelopeInfo{raw: raw}
-	err := xdr.SafeUnmarshalBase64(raw, &result.parsed)
-	if err != nil {
-		return result, err
-	}
-
-	var hash [32]byte
-	hash, err = network.HashTransactionInEnvelope(result.parsed, passphrase)
-	if err != nil {
-		return result, err
-	}
-	result.hash = hex.EncodeToString(hash[:])
-	if result.parsed.IsFeeBump() {
-		hash, err = network.HashTransaction(result.parsed.FeeBump.Tx.InnerTx.V1.Tx, passphrase)
-		if err != nil {
-			return result, err
-		}
-		result.innerHash = hex.EncodeToString(hash[:])
-	}
-	return result, nil
-}
-
-func (handler SubmitTransactionHandler) validateBodyType(r *http.Request) error {
-	c := r.Header.Get("Content-Type")
-	if c == "" {
-		return nil
-	}
-
-	mt, _, err := mime.ParseMediaType(c)
-	if err != nil {
-		return errors.Wrap(err, "Could not determine mime type")
-	}
-
-	if mt != "application/x-www-form-urlencoded" && mt != "multipart/form-data" {
-		return &hProblem.UnsupportedMediaType
-	}
-	return nil
-}
-
 func (handler SubmitTransactionHandler) response(r *http.Request, info envelopeInfo, result txsub.Result) (hal.Pageable, error) {
 	if result.Err == nil {
 		var resource horizon.Transaction
@@ -137,7 +86,7 @@ func (handler SubmitTransactionHandler) response(r *http.Request, info envelopeI
 }
 
 func (handler SubmitTransactionHandler) GetResource(w HeaderWriter, r *http.Request) (interface{}, error) {
-	if err := handler.validateBodyType(r); err != nil {
+	if err := validateBodyType(r); err != nil {
 		return nil, err
 	}
 
@@ -157,7 +106,7 @@ func (handler SubmitTransactionHandler) GetResource(w HeaderWriter, r *http.Requ
 		return nil, err
 	}
 
-	info, err := handler.extractEnvelopeInfo(raw, handler.NetworkPassphrase)
+	info, err := extractEnvelopeInfo(raw, handler.NetworkPassphrase)
 	if err != nil {
 		return nil, &problem.P{
 			Type:   "transaction_malformed",

services/horizon/internal/actions/submit_transaction_async.go

@@ -0,0 +1,165 @@
+package actions
+
+import (
+	"net/http"
+
+	"github.com/stellar/go/clients/stellarcore"
+	proto "github.com/stellar/go/protocols/stellarcore"
+	hProblem "github.com/stellar/go/services/horizon/internal/render/problem"
+	"github.com/stellar/go/support/render/problem"
+)
+
+const (
+	HTTPStatusCodeForPending       = http.StatusCreated
+	HTTPStatusCodeForDuplicate     = http.StatusConflict
+	HTTPStatusCodeForTryAgainLater = http.StatusServiceUnavailable
+	HTTPStatusCodeForError         = http.StatusBadRequest
+)
+
+type AsyncSubmitTransactionHandler struct {
+	NetworkPassphrase string
+	DisableTxSub      bool
+	CoreClient        stellarcore.ClientInterface
+	CoreStateGetter
+}
+
+// TransactionSubmissionResponse represents the response returned by Horizon
+// when using the transaction-submission-v2 endpoint.
+type TransactionSubmissionResponse struct {
+	// ErrorResultXDR is present only if Status is equal to proto.TXStatusError.
+	// ErrorResultXDR is a TransactionResult xdr string which contains details on why
+	// the transaction could not be accepted by stellar-core.
+	ErrorResultXDR string `json:"errorResultXdr,omitempty"`
+	// DiagnosticEventsXDR is present only if Status is equal to proto.TXStatusError.
+	// DiagnosticEventsXDR is a base64-encoded slice of xdr.DiagnosticEvent
+	DiagnosticEventsXDR string `json:"diagnosticEventsXdr,omitempty"`
+	// TxStatus represents the status of the transaction submission returned by stellar-core.
+	// It can be one of: proto.TXStatusPending, proto.TXStatusDuplicate,
+	// proto.TXStatusTryAgainLater, or proto.TXStatusError.
+	TxStatus string `json:"tx_status"`
+	// HttpStatus represents the corresponding http status code.
+	HttpStatus int `json:"status"`
+	// Hash is a hash of the transaction which can be used to look up whether
+	// the transaction was included in the ledger.
+	Hash string `json:"hash"`
+}
+
+func (handler AsyncSubmitTransactionHandler) GetResource(_ HeaderWriter, r *http.Request) (interface{}, error) {
+	if err := validateBodyType(r); err != nil {
+		return nil, err
+	}
+
+	raw, err := getString(r, "tx")
+	if err != nil {
+		return nil, err
+	}
+
+	if handler.DisableTxSub {
+		return nil, &problem.P{
+			Type:   "transaction_submission_disabled",
+			Title:  "Transaction Submission Disabled",
+			Status: http.StatusMethodNotAllowed,
+			Detail: "Transaction submission has been disabled for Horizon. " +
+				"To enable it again, remove env variable DISABLE_TX_SUB.",
+			Extras: map[string]interface{}{
+				"envelope_xdr": raw,
+			},
+		}
+	}
+
+	info, err := extractEnvelopeInfo(raw, handler.NetworkPassphrase)
+	if err != nil {
+		return nil, &problem.P{
+			Type:   "transaction_malformed",
+			Title:  "Transaction Malformed",
+			Status: http.StatusBadRequest,
+			Detail: "Horizon could not decode the transaction envelope in this " +
+				"request. A transaction should be an XDR TransactionEnvelope struct " +
+				"encoded using base64.  The envelope read from this request is " +
+				"echoed in the `extras.envelope_xdr` field of this response for your " +
+				"convenience.",
+			Extras: map[string]interface{}{
+				"envelope_xdr": raw,
+			},
+		}
+	}
+
+	coreState := handler.GetCoreState()
+	if !coreState.Synced {
+		return nil, hProblem.StaleHistory
+	}
+
+	resp, err := handler.CoreClient.SubmitTransaction(r.Context(), info.raw)
+	if err != nil {
+		return nil, &problem.P{
+			Type:   "transaction_submission_failed",
+			Title:  "Transaction Submission Failed",
+			Status: http.StatusBadRequest,
+			Detail: "Could not submit transaction to stellar-core. " +
+				"The `extras.error` field on this response contains further " +
+				"details.  Descriptions of each code can be found at: " +
+				"https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-v2/transaction_submission_failed",
+			Extras: map[string]interface{}{
+				"envelope_xdr": raw,
+				"error":        err,
+			},
+		}
+	}
+
+	if resp.IsException() {
+		return nil, &problem.P{
+			Type:   "transaction_submission_exception",
+			Title:  "Transaction Submission Exception",
+			Status: http.StatusBadRequest,
+			Detail: "Received exception from stellar-core." +
+				"The `extras.error` field on this response contains further " +
+				"details.  Descriptions of each code can be found at: " +
+				"https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-v2/transaction_submission_exception",
+			Extras: map[string]interface{}{
+				"envelope_xdr": raw,
+				"error":        resp.Exception,
+			},
+		}
+	}
+
+	switch resp.Status {
+	case proto.TXStatusError:
+		return TransactionSubmissionResponse{
+			ErrorResultXDR:      resp.Error,
+			DiagnosticEventsXDR: resp.DiagnosticEvents,
+			TxStatus:            resp.Status,
+			HttpStatus:          HTTPStatusCodeForError,
+			Hash:                info.hash,
+		}, nil
+	case proto.TXStatusPending, proto.TXStatusDuplicate, proto.TXStatusTryAgainLater:
+		var httpStatus int
+		if resp.Status == proto.TXStatusPending {
+			httpStatus = HTTPStatusCodeForPending
+		} else if resp.Status == proto.TXStatusDuplicate {
+			httpStatus = HTTPStatusCodeForDuplicate
+		} else {
+			httpStatus = HTTPStatusCodeForTryAgainLater
+		}
+
+		return TransactionSubmissionResponse{
+			TxStatus:   resp.Status,
+			HttpStatus: httpStatus,
+			Hash:       info.hash,
+		}, nil
+	default:
+		return nil, &problem.P{
+			Type:   "transaction_submission_invalid_status",
+			Title:  "Transaction Submission Invalid Status",
+			Status: http.StatusBadRequest,
+			Detail: "Received invalid status from stellar-core." +
+				"The `extras.error` field on this response contains further " +
+				"details.  Descriptions of each code can be found at: " +
+				"https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-v2/transaction_submission_invalid_status",
+			Extras: map[string]interface{}{
+				"envelope_xdr": raw,
+				"error":        resp.Error,
+			},
+		}
+	}
+
+}