Prepare report sugar (#126)

* Prepare report sugar

* Make sure file naming follows common convention

Author: ernest-nowacki

…ckages/cre-http-trigger/src/createJWT.ts …kages/cre-http-trigger/src/create-jwt.tspackages/cre-http-trigger/src/createJWT.ts renamed to packages/cre-http-trigger/src/create-jwt.ts packages/cre-http-trigger/src/createJWT.ts renamed to packages/cre-http-trigger/src/create-jwt.ts

@@ -1,7 +1,7 @@
 import { v4 as uuidv4 } from 'uuid'
 import { privateKeyToAccount } from 'viem/accounts'
-import { createJWT, type JSONRPCRequest } from './createJWT'
-import { getConfig } from './getConfig'
+import { createJWT, type JSONRPCRequest } from './create-jwt'
+import { getConfig } from './get-config'
 import type { TriggerInput, WorkflowSelector } from './schemas'
 
 export async function triggerWorkflow(workflowSelector: WorkflowSelector, payload: TriggerInput) {
@@ -38,6 +38,8 @@ export async function triggerWorkflow(workflowSelector: WorkflowSelector, payloa
 		body: JSON.stringify(jsonrpcRequest),
 	})
 
+	console.log('   Response:', response)
+
 	const result = await response.json()
 
 	return result

…ckages/cre-http-trigger/src/getConfig.ts …kages/cre-http-trigger/src/get-config.tspackages/cre-http-trigger/src/getConfig.ts renamed to packages/cre-http-trigger/src/get-config.ts packages/cre-http-trigger/src/getConfig.ts renamed to packages/cre-http-trigger/src/get-config.ts

@@ -1,7 +1,7 @@
 {
 	"name": "@chainlink/cre-sdk-examples",
 	"private": true,
-	"version": "0.0.8-alpha",
+	"version": "0.0.9-alpha",
 	"type": "module",
 	"author": "Ernest Nowacki",
 	"license": "BUSL-1.1",

packages/cre-http-trigger/src/trigger-workflow.ts

@@ -8,6 +8,7 @@ import {
 	hexToBase64,
 	LAST_FINALIZED_BLOCK_NUMBER,
 	ok,
+	prepareReportRequest,
 	Runner,
 	type Runtime,
 	TxStatus,
@@ -153,19 +154,12 @@ const onCronTrigger = (runtime: Runtime<Config>) => {
 		args: [toHex('0x'), dryRunCallData],
 	})
 
-	const report = runtime
-		.report({
-			encodedPayload: hexToBase64(writeCallData),
-			encoderName: 'evm',
-			signingAlgo: 'ecdsa',
-			hashingAlgo: 'keccak256',
-		})
-		.result()
+	const report = runtime.report(prepareReportRequest(writeCallData)).result()
 
 	const resp = evmClient
 		.writeReport(runtime, {
 			receiver: evmConfig.calculatorConsumerAddress,
-			report: report,
+			report,
 		})
 		.result()
 

packages/cre-sdk-examples/package.json

@@ -11,6 +11,7 @@ import {
 	hexToBase64,
 	LAST_FINALIZED_BLOCK_NUMBER,
 	median,
+	prepareReportRequest,
 	Runner,
 	type Runtime,
 	TxStatus,
@@ -205,14 +206,7 @@ const updateReserves = (
 	})
 
 	// Step 1: Generate report using consensus capability
-	const reportResponse = runtime
-		.report({
-			encodedPayload: hexToBase64(callData),
-			encoderName: 'evm',
-			signingAlgo: 'ecdsa',
-			hashingAlgo: 'keccak256',
-		})
-		.result()
+	const reportResponse = runtime.report(prepareReportRequest(callData)).result()
 
 	const resp = evmClient
 		.writeReport(runtime, {

packages/cre-sdk-examples/src/workflows/on-chain-write/index.ts

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "0.0.8-alpha",
+	"version": "0.0.9-alpha",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

packages/cre-sdk-examples/src/workflows/proof-of-reserve/index.ts

@@ -1,4 +1,5 @@
 import type { CallMsgJson } from '@cre/generated/capabilities/blockchain/evm/v1alpha/client_pb'
+import type { ReportRequestJson } from '@cre/generated/sdk/v1alpha/sdk_pb'
 import { hexToBase64 } from '@cre/sdk/utils/hex-utils'
 import type { Address, Hex } from 'viem'
 
@@ -57,3 +58,27 @@ export const encodeCallMsg = (payload: EncodeCallMsgPayload): CallMsgJson => ({
 	to: hexToBase64(payload.to),
 	data: hexToBase64(payload.data),
 })
+
+/**
+ * Default values expected by the EVM capability for report encoding.
+ */
+export const EVM_DEFAULT_REPORT_ENCODER = {
+	encoderName: 'evm',
+	signingAlgo: 'ecdsa',
+	hashingAlgo: 'keccak256',
+}
+
+/**
+ * Prepares a report request for the EVM capability to pass to `.report()` function.
+ *
+ * @param hexEncodedPayload - The hex encoded payload to be signed.
+ * @param reportEncoder - The report encoder to be used. Defaults to EVM_DEFAULT_REPORT_ENCODER.
+ * @returns The prepared report request.
+ */
+export const prepareReportRequest = (
+	hexEncodedPayload: Hex,
+	reportEncoder: Exclude<ReportRequestJson, 'encodedPayload'> = EVM_DEFAULT_REPORT_ENCODER,
+): ReportRequestJson => ({
+	encodedPayload: hexToBase64(hexEncodedPayload),
+	...reportEncoder,
+})