/gasless/estimate and /gasless/send to return protocol name

Author: aleksej-paschenko

api/openapi.json

@@ -3467,6 +3467,17 @@
     ],
     "type": "object"
    },
+   "GaslessTx": {
+    "properties": {
+     "protocol_name": {
+      "type": "string"
+     }
+    },
+    "required": [
+     "protocol_name"
+    ],
+    "type": "object"
+   },
    "ImagePreview": {
     "properties": {
      "resolution": {
@@ -5299,6 +5310,9 @@
       },
       "type": "array"
      },
+     "protocol_name": {
+      "type": "string"
+     },
      "relay_address": {
       "example": "0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf",
       "format": "address",
@@ -5315,7 +5329,8 @@
      "relay_address",
      "commission",
      "from",
-     "valid_until"
+     "valid_until",
+     "protocol_name"
     ],
     "type": "object"
    },
@@ -8641,6 +8656,13 @@
     },
     "responses": {
      "200": {
+      "content": {
+       "application/json": {
+        "schema": {
+         "$ref": "#/components/schemas/GaslessTx"
+        }
+       }
+      },
       "description": "the message has been sent"
      },
      "default": {

api/openapi.yml

@@ -2126,6 +2126,10 @@ paths:
       responses:
         '200':
           description: the message has been sent
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GaslessTx'
         'default':
           $ref: '#/components/responses/Error'
   /v2/pubkeys/{public_key}/wallets:
@@ -4806,6 +4810,13 @@ components:
           type: string
           format: cell
           description: "Raw once-cell BoC encoded in hex."
+    GaslessTx:
+      type: object
+      required:
+        - protocol_name
+      properties:
+        protocol_name:
+          type: string
     SignRawParams:
       type: object
       required:
@@ -4814,7 +4825,10 @@ components:
         - commission
         - from
         - valid_until
+        - protocol_name
       properties:
+        protocol_name:
+          type: string
         relay_address:
           type: string
           format: address

pkg/api/gasless_handlers.go

@@ -59,6 +59,7 @@ func (h *Handler) GaslessEstimate(ctx context.Context, req *oas.GaslessEstimateR
 		Commission:   signParams.Commission,
 		From:         walletAddress.ToRaw(),
 		ValidUntil:   time.Now().UTC().Add(4 * time.Minute).Unix(),
+		ProtocolName: signParams.ProtocolName,
 	}
 	o.Messages = make([]oas.SignRawMessage, 0, len(signParams.Messages))
 	for _, msg := range signParams.Messages {
@@ -77,23 +78,24 @@ func (h *Handler) GaslessEstimate(ctx context.Context, req *oas.GaslessEstimateR
 	return o, nil
 }
 
-func (h *Handler) GaslessSend(ctx context.Context, req *oas.GaslessSendReq) error {
+func (h *Handler) GaslessSend(ctx context.Context, req *oas.GaslessSendReq) (*oas.GaslessTx, error) {
 	if h.gasless == nil {
-		return toError(http.StatusNotImplemented, fmt.Errorf("not implemented"))
+		return nil, toError(http.StatusNotImplemented, fmt.Errorf("not implemented"))
 	}
 	msg, err := decodeMessage(req.Boc)
 	if err != nil {
-		return toError(http.StatusBadRequest, err)
+		return nil, toError(http.StatusBadRequest, err)
 	}
 	pubkey, err := hex.DecodeString(req.WalletPublicKey)
 	if err != nil {
-		return toError(http.StatusBadRequest, err)
+		return nil, toError(http.StatusBadRequest, err)
 	}
 	if len(pubkey) != ed25519.PublicKeySize {
-		return toError(http.StatusBadRequest, fmt.Errorf("invalid public key"))
+		return nil, toError(http.StatusBadRequest, fmt.Errorf("invalid public key"))
 	}
-	if err := h.gasless.Send(ctx, pubkey, msg.payload); err != nil {
-		return toError(http.StatusInternalServerError, err)
+	results, err := h.gasless.Send(ctx, pubkey, msg.payload)
+	if err != nil {
+		return nil, toError(http.StatusInternalServerError, err)
 	}
-	return nil
+	return &oas.GaslessTx{ProtocolName: results.ProtocolName}, nil
 }

pkg/api/interfaces.go

@@ -174,7 +174,7 @@ type addressBook interface {
 type Gasless interface {
 	Config(ctx context.Context) (gasless.Config, error)
 	Estimate(ctx context.Context, masterID ton.AccountID, walletAddress ton.AccountID, walletPubkey []byte, messages []string) (gasless.SignRawParams, error)
-	Send(ctx context.Context, walletPublicKey ed25519.PublicKey, payload []byte) error
+	Send(ctx context.Context, walletPublicKey ed25519.PublicKey, payload []byte) (*gasless.TxSendingResults, error)
 }
 
 type ratesSource interface {

pkg/gasless/models.go

@@ -16,4 +16,9 @@ type SignRawParams struct {
 	RelayAddress string
 	Commission   string
 	Messages     []Message
+	ProtocolName string
+}
+
+type TxSendingResults struct {
+	ProtocolName string
 }