add DownloadBlockchainBlockBoc handler

Author: erokhinav

api/openapi.json

@@ -6691,7 +6691,7 @@
   },
   "/v2/accounts/{account_id}/events/emulate": {
    "post": {
-    "description": "Emulate sending message to blockchain",
+    "description": "Emulate sending message to retrieve account-specific events",
     "operationId": "emulateMessageToAccountEvent",
     "parameters": [
      {
@@ -7683,6 +7683,44 @@
     ]
    }
   },
+  "/v2/blockchain/blocks/{block_id}/boc": {
+   "get": {
+    "description": "Download blockchain block BOC",
+    "operationId": "downloadBlockchainBlockBoc",
+    "parameters": [
+     {
+      "$ref": "#/components/parameters/blockchainBlockIDParameter"
+     }
+    ],
+    "responses": {
+     "200": {
+      "content": {
+       "application/octet-stream": {
+        "schema": {
+         "format": "binary",
+         "type": "string"
+        }
+       }
+      },
+      "description": "Block BOC file",
+      "headers": {
+       "Content-Disposition": {
+        "schema": {
+         "example": "attachment; filename=\"block.boc\"",
+         "type": "string"
+        }
+       }
+      }
+     },
+     "default": {
+      "$ref": "#/components/responses/Error"
+     }
+    },
+    "tags": [
+     "Blockchain"
+    ]
+   }
+  },
   "/v2/blockchain/blocks/{block_id}/transactions": {
    "get": {
     "description": "Get transactions from block",
@@ -8181,7 +8219,7 @@
   },
   "/v2/events/emulate": {
    "post": {
-    "description": "Emulate sending message to blockchain",
+    "description": "Emulate sending message to retrieve general blockchain events",
     "operationId": "emulateMessageToEvent",
     "parameters": [
      {
@@ -10720,7 +10758,7 @@
   },
   "/v2/traces/emulate": {
    "post": {
-    "description": "Emulate sending message to blockchain",
+    "description": "Emulate sending message to retrieve with a detailed execution trace",
     "operationId": "emulateMessageToTrace",
     "parameters": [
      {
@@ -10823,7 +10861,7 @@
   },
   "/v2/wallet/emulate": {
    "post": {
-    "description": "Emulate sending message to blockchain",
+    "description": "Emulate sending message to retrieve the resulting wallet state",
     "operationId": "emulateMessageToWallet",
     "parameters": [
      {

api/openapi.yml

@@ -168,6 +168,29 @@ paths:
                 $ref: '#/components/schemas/BlockchainBlock'
         'default':
           $ref: '#/components/responses/Error'
+  /v2/blockchain/blocks/{block_id}/boc:
+    get:
+      description: Download blockchain block BOC
+      operationId: downloadBlockchainBlockBoc
+      tags:
+        - Blockchain
+      parameters:
+        - $ref: '#/components/parameters/blockchainBlockIDParameter'
+      responses:
+        '200':
+          description: Block BOC file
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+          headers:
+            Content-Disposition:
+              schema:
+                type: string
+                example: 'attachment; filename="block.boc"'
+        'default':
+          $ref: '#/components/responses/Error'
   /v2/blockchain/masterchain/{masterchain_seqno}/shards:
     get:
       description: Get blockchain block shards

pkg/api/blockchain_handlers.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
 	"errors"
@@ -72,6 +73,25 @@ func (h *Handler) GetBlockchainBlock(ctx context.Context, params oas.GetBlockcha
 	return &res, nil
 }
 
+func (h *Handler) DownloadBlockchainBlockBoc(ctx context.Context, params oas.DownloadBlockchainBlockBocParams) (*oas.DownloadBlockchainBlockBocOKHeaders, error) {
+	blockID, err := ton.ParseBlockID(params.BlockID)
+	if err != nil {
+		return nil, toError(http.StatusBadRequest, err)
+	}
+
+	bocBytes, err := h.blockSource.GetBlockchainBlock(ctx, blockID.Workchain, blockID.Shard, blockID.Seqno)
+	if err != nil {
+		return nil, toError(http.StatusInternalServerError, err)
+	}
+
+	return &oas.DownloadBlockchainBlockBocOKHeaders{
+		ContentDisposition: oas.NewOptString(fmt.Sprintf(`attachment; filename="block_%s.boc"`, params.BlockID)),
+		Response: oas.DownloadBlockchainBlockBocOK{
+			Data: bytes.NewReader(bocBytes),
+		},
+	}, nil
+}
+
 func (h *Handler) GetBlockchainMasterchainShards(ctx context.Context, params oas.GetBlockchainMasterchainShardsParams) (r *oas.BlockchainBlockShards, _ error) {
 	shards, err := h.storage.GetBlockShards(ctx, ton.BlockID{Shard: 0x8000000000000000, Seqno: uint32(params.MasterchainSeqno), Workchain: -1})
 	if errors.Is(err, core.ErrEntityNotFound) {

pkg/api/handler.go

@@ -47,6 +47,7 @@ type Handler struct {
 	metaCache      metadataCache
 	tonConnect     *tonconnect.Server
 	verifierSource verifierSource
+	blockSource    blockSource
 
 	// mempoolEmulate contains results of emulation of messages that are in the mempool.
 	mempoolEmulate mempoolEmulate
@@ -139,6 +140,12 @@ func WithRatesSource(source ratesSource) Option {
 	}
 }
 
+func WithBlocksSource(source blockSource) Option {
+	return func(o *Options) {
+		o.blockSource = source
+	}
+}
+
 func WithTonConnectSecret(tonConnectSecret string) Option {
 	return func(o *Options) {
 		o.tonConnectSecret = tonConnectSecret
@@ -238,6 +245,7 @@ func NewHandler(logger *zap.Logger, opts ...Option) (*Handler, error) {
 		score:          options.score,
 		ratesSource:    rates.InitCalculator(options.ratesSource),
 		verifierSource: options.verifier,
+		blockSource:    options.blockSource,
 		metaCache: metadataCache{
 			collectionsCache: cache.NewLRUCache[tongo.AccountID, tep64.Metadata](10000, "nft_metadata_cache"),
 			jettonsCache:     cache.NewLRUCache[tongo.AccountID, tep64.Metadata](10000, "jetton_metadata_cache"),

pkg/api/interfaces.go

@@ -213,3 +213,7 @@ type mempoolEmulate struct {
 	traces         cache.Cache[ton.Bits256, *core.Trace]
 	accountsTraces cache.Cache[tongo.AccountID, []ton.Bits256]
 }
+
+type blockSource interface {
+	GetBlockchainBlock(ctx context.Context, workchain int32, shard uint64, seqno uint32) ([]byte, error)
+}