API handlers to return error containing error key

Author: aleksej-paschenko

api/openapi.json

@@ -690,6 +690,23 @@
        "properties": {
         "error": {
          "type": "string"
+        },
+        "error_key": {
+         "enum": [
+          "err-gasless-jetton-is-not-supported",
+          "err-gasless-temporary",
+          "err-gasless-signature",
+          "err-gasless-pending-messages",
+          "err-gasless-bad-request",
+          "err-gasless-operation-is-not-supported",
+          "err-gasless-user-disabled",
+          "err-gasless-estimating-commission",
+          "err-gasless-commission",
+          "err-gasless-balance",
+          "err-gasless-bootstrap-transfer-disabled",
+          "err-gasless-unknown"
+         ],
+         "type": "string"
         }
        },
        "required": [

api/openapi.yml

@@ -7391,3 +7391,18 @@ components:
             properties:
               error:
                 type: string
+              error_key:
+                type: string
+                enum:
+                  - "err-gasless-jetton-is-not-supported"
+                  - "err-gasless-temporary"
+                  - "err-gasless-signature"
+                  - "err-gasless-pending-messages"
+                  - "err-gasless-bad-request"
+                  - "err-gasless-operation-is-not-supported"
+                  - "err-gasless-user-disabled"
+                  - "err-gasless-estimating-commission"
+                  - "err-gasless-commission"
+                  - "err-gasless-balance"
+                  - "err-gasless-bootstrap-transfer-disabled"
+                  - "err-gasless-unknown"

pkg/api/converters.go

@@ -3,14 +3,16 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
-	imgGenerator "github.com/tonkeeper/opentonapi/pkg/image"
 	"math/big"
 	"reflect"
 	"strconv"
 	"strings"
 	"unicode"
 
+	imgGenerator "github.com/tonkeeper/opentonapi/pkg/image"
+
 	"github.com/go-faster/jx"
 	"github.com/tonkeeper/tongo"
 	"github.com/tonkeeper/tongo/boc"
@@ -22,15 +24,47 @@ import (
 	walletPkg "github.com/tonkeeper/opentonapi/pkg/wallet"
 )
 
-func toError(code int, err error) *oas.ErrorStatusCode {
-	if strings.HasPrefix(err.Error(), "failed to connect to") || strings.Contains(err.Error(), "host=") {
-		return &oas.ErrorStatusCode{StatusCode: code, Response: oas.Error{Error: "unknown error"}}
+// Error helps to pass additional information about an error from private tonapi2 handlers.
+type Error struct {
+	Code    int
+	Message string
+	Key     string
+}
+
+func (e Error) Error() string {
+	return e.Message
+}
+
+// censor removes sensitive information from the error message.
+func censor(msg string) string {
+	if strings.HasPrefix(msg, "failed to connect to") || strings.Contains(msg, "host=") {
+		return "unknown error"
+	}
+	return msg
+}
+
+func errorKey(s string) oas.OptErrorErrorKey {
+	if s == "" {
+		return oas.OptErrorErrorKey{}
+	}
+	return oas.NewOptErrorErrorKey(oas.ErrorErrorKey(s))
+}
+
+func toError(defaultCode int, err error) *oas.ErrorStatusCode {
+	var e Error
+	if errors.As(err, &e) {
+		return &oas.ErrorStatusCode{
+			StatusCode: e.Code,
+			Response: oas.Error{
+				Error:    censor(e.Message),
+				ErrorKey: errorKey(e.Key),
+			},
+		}
 	}
 	if s, ok := status.FromError(err); ok {
-		return &oas.ErrorStatusCode{StatusCode: code, Response: oas.Error{Error: s.Message()}}
+		return &oas.ErrorStatusCode{StatusCode: defaultCode, Response: oas.Error{Error: censor(s.Message())}}
 	}
-	msg := err.Error()
-	return &oas.ErrorStatusCode{StatusCode: code, Response: oas.Error{Error: msg}}
+	return &oas.ErrorStatusCode{StatusCode: defaultCode, Response: oas.Error{Error: censor(err.Error())}}
 }
 
 func anyToJSONRawMap(a any) map[string]jx.Raw { //todo: переписать этот ужас