Merge pull request #353 from tonlabs/0.62.0-rc

Version 0.62.0

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.62.0] - 2023-07-20
+
+### New
+
+- `trace` field in transaction is a list of VM step info objects
+
+### Fixed
+
+- implemented support for `archive` parameter in all blockchain queries.
+- `archive` parameter was not propagated to the nested join queries.
+
+### Improved
+
+- All user parameters that are enums are now checked for typos on startup
+
 ## [0.61.0] - 2023-07-04
 
 ### New

package.json

@@ -1,6 +1,6 @@
 {
     "name": "ton-q-server",
-    "version": "0.61.0",
+    "version": "0.62.0",
     "description": "TON Q Server – realtime queries over TON blockchain.",
     "main": "index.js",
     "repository": "[email protected]:tonlabs/ton-q-server.git",

res/type-defs-blockchain/codegen-stubs.graphql

@@ -188,6 +188,19 @@ enum BounceTypeEnum {
     Ok
 }
 
+type TransactionTrace {
+	info_type: String,
+	step: Int,
+	cmd_str: String,
+	stack: [String],
+	gas_used: String,
+	gas_cmd: String,
+	cmd_code_rem_bits: Int,
+	cmd_code_hex: String,
+	cmd_code_cell_hash: String,
+	cmd_code_offset: Int,
+}
+
 """
 Due to GraphQL limitations big numbers are returned as a string.
 You can specify format used to string representation for big integers.

res/type-defs-blockchain/transaction.graphql

@@ -102,7 +102,7 @@ type BlockchainTransaction implements Node {
 	tr_type: Int
 	tr_type_name: TransactionTypeEnum
 	"VM debug trace"
-	trace: String
+	trace: [TransactionTrace]
 	tt: String
 	"Workchain id of the account address (account_addr field)"
 	workchain_id: Int

res/type-defs-generated.graphql

@@ -678,6 +678,19 @@ type TransactionSplitInfo {
 	this_addr: String
 }
 
+type TransactionTrace {
+	cmd_code_cell_hash: String
+	cmd_code_hex: String
+	cmd_code_offset: Float
+	cmd_code_rem_bits: Float
+	cmd_str: String
+	gas_cmd: String
+	gas_used: String
+	info_type: String
+	stack: [String]
+	step: Float
+}
+
 type BlockValueFlow {
 	created(format: BigIntFormat): String
 	created_other: [OtherCurrency]
@@ -1233,8 +1246,7 @@ type Transaction {
 	"""
 	tr_type: Int
 	tr_type_name: TransactionTypeEnum
-	"VM debug trace"
-	trace: String
+	trace: [TransactionTrace]
 	tt: String
 	"Workchain id of the account address (account_addr field)"
 	workchain_id: Int
@@ -2103,6 +2115,20 @@ input TransactionSplitInfoFilter {
     OR: TransactionSplitInfoFilter
 }
 
+input TransactionTraceFilter {
+	cmd_code_cell_hash: StringFilter
+	cmd_code_hex: StringFilter
+	cmd_code_offset: FloatFilter
+	cmd_code_rem_bits: FloatFilter
+	cmd_str: StringFilter
+	gas_cmd: StringFilter
+	gas_used: StringFilter
+	info_type: StringFilter
+	stack: StringArrayFilter
+	step: FloatFilter
+    OR: TransactionTraceFilter
+}
+
 input BlockValueFlowFilter {
 	created: StringFilter
 	created_other: OtherCurrencyArrayFilter
@@ -2605,6 +2631,11 @@ input MessageArrayFilter {
 	all: MessageFilter
 }
 
+input TransactionTraceArrayFilter {
+	any: TransactionTraceFilter
+	all: TransactionTraceFilter
+}
+
 input TransactionProcessingStatusEnumFilter {
 	eq: TransactionProcessingStatusEnum
 	ne: TransactionProcessingStatusEnum
@@ -2737,8 +2768,7 @@ input TransactionFilter {
 	"""
 	tr_type: IntFilter
 	tr_type_name: TransactionTypeEnumFilter
-	"VM debug trace"
-	trace: StringFilter
+	trace: TransactionTraceArrayFilter
 	tt: StringFilter
 	"Workchain id of the account address (account_addr field)"
 	workchain_id: IntFilter

src/__tests__/config-test.ts

@@ -73,6 +73,46 @@ test("Config Priority", () => {
     expect(only_env_options.server.port).toEqual(8081)
 })
 
+test("Test SubscriptionsMode enum", () => {
+    const config = resolveConfig({}, {}, { Q_SUBSCRIPTIONS_MODE: "disabled" })
+    expect(config.subscriptionsMode).toEqual("disabled")
+
+    expect(() => {
+        resolveConfig({}, {}, { Q_SUBSCRIPTIONS_MODE: "disable" })
+    }).toThrowError(/Unknown subscriptions-mode/)
+})
+
+test("Test SlowQueriesMode enum", () => {
+    const config = resolveConfig({}, {}, { Q_SLOW_QUERIES: "redirect" })
+    expect(config.queries.slowQueries).toEqual("redirect")
+
+    expect(() => {
+        resolveConfig({}, {}, { Q_SLOW_QUERIES: "something" })
+    }).toThrowError(/Unknown slow-queries/)
+})
+
+test("Test RequestsMode enum", () => {
+    const config = resolveConfig({}, {}, { Q_REQUESTS_MODE: "kafka" })
+    expect(config.requests.mode).toEqual("kafka")
+
+    expect(() => {
+        resolveConfig({}, {}, { Q_REQUESTS_MODE: "something" })
+    }).toThrowError(/Unknown requests-mode/)
+})
+
+test("Test FilterOrConversion enum", () => {
+    const config = resolveConfig(
+        {},
+        {},
+        { Q_FILTER_OR_CONVERSION: "sub-queries" },
+    )
+    expect(config.queries.filter.orConversion).toEqual("sub-queries")
+
+    expect(() => {
+        resolveConfig({}, {}, { Q_FILTER_OR_CONVERSION: "something" })
+    }).toThrowError(/Unknown filter-or-conversion/)
+})
+
 test("Arango Config", () => {
     expect(parseArangoConfig("arango")).toMatchObject({
         server: "https://arango",

src/server/config.ts

@@ -507,15 +507,6 @@ function checkSubscriptionsConfig(
             ? SubscriptionsMode.Arango
             : SubscriptionsMode.Disabled
     }
-    if (!Object.values(SubscriptionsMode).includes(config.subscriptionsMode)) {
-        throw QError.invalidConfig(
-            `Unknown subscriptions-mode: got ${
-                config.subscriptionsMode
-            }, but expected one of [${Object.values(SubscriptionsMode).join(
-                ", ",
-            )}]`,
-        )
-    }
 }
 
 function applyDatabaseDefaults(config: string[], def: string[]) {
@@ -548,6 +539,15 @@ export function resolveConfig(
     applyDataProviderDefaults(config.blockchain.blocks, config)
     applyDataProviderDefaults(config.blockchain.transactions, config)
     checkSubscriptionsConfig(config, specified)
+    // Check all parameters that are enums
+    checkEnum("subscriptions-mode", config.subscriptionsMode, SubscriptionsMode)
+    checkEnum("slow-queries", config.queries.slowQueries, SlowQueriesMode)
+    checkEnum("requests-mode", config.requests.mode, RequestsMode)
+    checkEnum(
+        "filter-or-conversion",
+        config.queries.filter.orConversion,
+        FilterOrConversion,
+    )
 
     const slow = config.slowQueriesBlockchain
     if (slow !== undefined) {
@@ -573,3 +573,17 @@ export function resolveConfig(
     }
     return config
 }
+
+function checkEnum(
+    paramName: string,
+    paramValue: string,
+    matchedEnum: Record<string, unknown>,
+) {
+    if (!Object.values(matchedEnum).includes(`${paramValue}`)) {
+        throw QError.invalidConfig(
+            `Unknown ${paramName}: got ${paramValue}, but expected one of [${Object.values(
+                matchedEnum,
+            ).join(", ")}]`,
+        )
+    }
+}

src/server/data/data-provider.ts

@@ -86,7 +86,7 @@ export type QDataProviderQueryParams = {
     request: QRequestContext
     traceSpan: QTraceSpan
     maxRuntimeInS?: number
-    archive?: boolean
+    archive?: boolean | null
 }
 
 export interface QDataProvider {

src/server/graphql/blockchain/blockchain.ts

@@ -186,6 +186,7 @@ export const resolvers: Resolvers<QRequestContext> = {
                     context,
                     info,
                     traceSpan,
+                    args.archive,
                 )
             })
         },
@@ -235,6 +236,7 @@ export const resolvers: Resolvers<QRequestContext> = {
                     context,
                     info,
                     traceSpan,
+                    args.archive,
                 )
             })
         },
@@ -258,6 +260,7 @@ export const resolvers: Resolvers<QRequestContext> = {
                     context,
                     info,
                     traceSpan,
+                    args.archive,
                 )
             })
         },

src/server/graphql/blockchain/config.ts

@@ -225,6 +225,7 @@ export type CompiledCollectionConfig<TItem> = {
         context: QRequestContext,
         traceSpan: QTraceSpan,
         maxJoinDepth: number,
+        archive: boolean | undefined | null,
     ) => Promise<void>
     qDataCollectionSelector: (context: QRequestContext) => QDataCollection
 }
@@ -357,6 +358,7 @@ export function compileCollectionConfig<TItem>(
         context: QRequestContext,
         traceSpan: QTraceSpan,
         maxJoinDepth: number,
+        archive: boolean | undefined | null,
     ) => {
         for (const join of collection.joins || []) {
             const joinSelectionSet = getFieldSelectionSet(
@@ -412,6 +414,7 @@ export function compileCollectionConfig<TItem>(
                     orderBy: [],
                     request: context,
                     traceSpan,
+                    archive,
                 },
             )) as any[][]
             for (const joinItem of queryResult.flat()) {
@@ -461,6 +464,7 @@ export function compileCollectionConfig<TItem>(
                     context,
                     traceSpan,
                     maxJoinDepth - 1,
+                    archive,
                 )
             }
         }

src/server/graphql/blockchain/fetchers/accounts.ts

@@ -58,6 +58,7 @@ export async function resolve_account(
         context,
         traceSpan,
         maxJoinDepth,
+        false,
     )
 
     return queryResult[0]

src/server/graphql/blockchain/fetchers/blocks.ts

@@ -30,6 +30,7 @@ async function fetch_blocks(
     context: QRequestContext,
     info: GraphQLResolveInfo,
     traceSpan: QTraceSpan,
+    archive: boolean | undefined | null,
     additionalFields: KeyOf<BlockchainBlock>[] = [],
     maxJoinDepth = 1,
 ) {
@@ -59,6 +60,7 @@ async function fetch_blocks(
             orderBy: [],
             request: context,
             traceSpan,
+            archive,
         },
     )) as BlockchainBlock[]
 
@@ -68,6 +70,7 @@ async function fetch_blocks(
         context,
         traceSpan,
         maxJoinDepth,
+        archive,
     )
 
     return queryResult
@@ -78,14 +81,15 @@ export async function resolve_block(
     context: QRequestContext,
     info: GraphQLResolveInfo,
     traceSpan: QTraceSpan,
+    archive: boolean | undefined | null,
 ) {
     return (
         await fetch_blocks(
             params => `doc._key == @${params.add(hash)}`,
             context,
             info,
             traceSpan,
-            // TODO: shard
+            archive,
         )
     )[0]
 }
@@ -109,6 +113,7 @@ export async function resolve_block_by_seq_no(
             context,
             info,
             traceSpan,
+            args.archive,
         )
     )[0]
 }
@@ -146,6 +151,7 @@ export async function resolve_prev_shard_blocks(
             orderBy: [],
             request: context,
             traceSpan,
+            archive: args.archive,
         },
     )) as BlockchainBlock[]
 
@@ -155,6 +161,7 @@ export async function resolve_prev_shard_blocks(
         context,
         traceSpan,
         0,
+        args.archive,
     )
 
     return queryResult
@@ -174,6 +181,7 @@ export async function resolve_next_shard_blocks(
         context,
         info,
         traceSpan,
+        args.archive,
         ["after_split"],
         0,
     )
@@ -236,7 +244,7 @@ export async function resolve_key_blocks(
             ],
             request: context,
             traceSpan,
-            archive: args.archive ?? undefined,
+            archive: args.archive,
         },
     )) as BlockchainBlock[]
 
@@ -312,7 +320,7 @@ export async function resolve_blockchain_blocks(
             ],
             request: context,
             traceSpan,
-            archive: args.archive ?? undefined,
+            archive: args.archive,
         },
     )) as BlockchainBlock[]