Merge pull request #1103 from oasisprotocol/ptrus/feature/runtimetxs-results

runtime: Runtime transactions raw results

Author: ptrus

.changelog/1103.feature.md

@@ -0,0 +1 @@
+api/runtime: Expose runtime transaction raw results

analyzer/queries/queries.go

@@ -660,8 +660,8 @@ var (
       SET total_received = EXCLUDED.total_received`
 
 	RuntimeTransactionInsert = `
-    INSERT INTO chain.runtime_transactions (runtime, round, tx_index, tx_hash, tx_eth_hash, fee, fee_symbol, fee_proxy_module, fee_proxy_id, gas_limit, gas_used, size, timestamp, oasis_encrypted_format, oasis_encrypted_public_key, oasis_encrypted_data_nonce, oasis_encrypted_data_data, oasis_encrypted_result_nonce, oasis_encrypted_result_data, method, body, "to", amount, amount_symbol, evm_encrypted_format, evm_encrypted_public_key, evm_encrypted_data_nonce, evm_encrypted_data_data, evm_encrypted_result_nonce, evm_encrypted_result_data, success, error_module, error_code, error_message_raw, error_message, likely_native_transfer)
-      VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21, $22, $23, $24, $25, $26, $27, $28, $29, $30, $31, $32, $33, $34, $35, $36)`
+    INSERT INTO chain.runtime_transactions (runtime, round, tx_index, tx_hash, tx_eth_hash, fee, fee_symbol, fee_proxy_module, fee_proxy_id, gas_limit, gas_used, size, raw_result, timestamp, oasis_encrypted_format, oasis_encrypted_public_key, oasis_encrypted_data_nonce, oasis_encrypted_data_data, oasis_encrypted_result_nonce, oasis_encrypted_result_data, method, body, "to", amount, amount_symbol, evm_encrypted_format, evm_encrypted_public_key, evm_encrypted_data_nonce, evm_encrypted_data_data, evm_encrypted_result_nonce, evm_encrypted_result_data, success, error_module, error_code, error_message_raw, error_message, likely_native_transfer)
+      VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21, $22, $23, $24, $25, $26, $27, $28, $29, $30, $31, $32, $33, $34, $35, $36, $37)`
 
 	// We use COALESCE here to avoid overwriting existing data with null values.
 	RuntimeTransactionEvmParsedFieldsUpdate = `

analyzer/runtime/runtime.go

@@ -357,6 +357,7 @@ func (m *processor) queueTransactionInsert(batch *storage.QueryBatch, round uint
 		transactionData.GasLimit,
 		transactionData.GasUsed,
 		transactionData.Size,
+		transactionData.RawResult,
 		timestamp,
 		oasisEncryptedFormat,
 		oasisEncryptedPublicKey,

api/spec/v1.yaml

@@ -3281,7 +3281,7 @@ components:
     RuntimeTransaction:
       type: object
       # NOTE: Not guaranteed to be present: eth_hash, to, amount.
-      required: [round, index, timestamp, hash, signers, sender_0, nonce_0, fee, fee_symbol, charged_fee, gas_limit, gas_used, size, is_likely_native_token_transfer]
+      required: [round, index, timestamp, hash, signers, sender_0, nonce_0, fee, fee_symbol, charged_fee, gas_limit, gas_used, size, raw_result, is_likely_native_token_transfer]
       properties:
         round:
           type: integer
@@ -3379,6 +3379,12 @@ components:
           type: integer
           format: int32
           description: The total byte size of the transaction.
+        raw_result:
+          type: string
+          format: byte
+          description: |
+            The raw result of the transaction execution, as returned by the runtime.
+            This is a base64-encoded byte array. The meaning of this field depends on the transaction type.
         oasis_encryption_envelope:
           allOf: [$ref: '#/components/schemas/RuntimeTransactionEncryptionEnvelope']
           description: |

storage/client/client.go

@@ -1650,6 +1650,7 @@ func runtimeTransactionFromRow(rows pgx.Rows, logger *log.Logger) (*RuntimeTrans
 		&t.GasUsed,
 		&t.ChargedFee,
 		&t.Size,
+		&t.RawResult,
 		&oasisEncryptionEnvelopeFormat,
 		&oasisEncryptionEnvelope.PublicKey,
 		&oasisEncryptionEnvelope.DataNonce,

storage/client/queries/queries.go

@@ -546,6 +546,7 @@ const (
 				ELSE COALESCE(FLOOR(txs.fee / NULLIF(txs.gas_limit, 0)) * txs.gas_used, 0)
 			END AS charged_fee,
 			txs.size,
+			txs.raw_result,
 			txs.oasis_encrypted_format,
 			txs.oasis_encrypted_public_key,
 			txs.oasis_encrypted_data_nonce,

storage/migrations/01_runtimes.up.sql

@@ -101,6 +101,8 @@ CREATE TABLE chain.runtime_transactions
   abi_parsed_at TIMESTAMP WITH TIME ZONE -- Updated in 34_runtime_abi_parsed_at.up.sql: NOT NULL DEFAULT '0001-01-01'
 
   -- likely_native_transfer BOOLEAN NOT NULL DEFAULT FALSE -- Added in 18_related_runtime_transactions_method_denorm.up.sql.
+
+  -- raw_result BYTEA -- Added in 45_runtime_transactions_raw_result.up.sql.
 );
 CREATE INDEX ix_runtime_transactions_tx_hash ON chain.runtime_transactions USING hash (tx_hash);
 CREATE INDEX ix_runtime_transactions_tx_eth_hash ON chain.runtime_transactions USING hash (tx_eth_hash);

storage/migrations/45_runtime_transactions_raw_result.up.sql

@@ -0,0 +1,5 @@
+BEGIN;
+
+ALTER TABLE chain.runtime_transactions ADD COLUMN raw_result BYTEA;
+
+COMMIT;

tests/e2e_regression/eden/expected/emerald_failed_tx.body

@@ -26,6 +26,7 @@
       "is_likely_native_token_transfer": false,
       "method": "evm.Call",
       "nonce_0": 31228,
+      "raw_result": "oWRmYWlso2Rjb2RlCGZtb2R1bGVjZXZtZ21lc3NhZ2V4unJldmVydGVkOiBDTU41b0FBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQWdBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUN0UVlYbHRaVzUwVTNCc2FYUjBaWEk2SUdGalkyOTFiblFnYVhNZ2JtOTBJR1IxWlNCd1lYbHRaVzUwQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQQ==",
       "round": 8059465,
       "sender_0": "oasis1qr9ak7ck2fs3pscs635gapk96ncl02yyxggrqgq5",
       "sender_0_eth": "0x7274e8a2F8C599a1265651037e0da68C5ECa06bD",

tests/e2e_regression/eden/expected/emerald_tx.body

@@ -20,6 +20,7 @@
       "is_likely_native_token_transfer": true,
       "method": "evm.Call",
       "nonce_0": 3063641,
+      "raw_result": "oWJva0A=",
       "round": 8060338,
       "sender_0": "oasis1qzchk9eh0n4p2raym2e6cyvegrjumxl3lqkfhztr",
       "sender_0_eth": "0xCB2412a993f406eFf10a74011410a4F35e3549E3",