WriteCreReportRequest

[zeuslawyer]

Reference:

cre-sdk-typescript/packages/cre-sdk/src/generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen.ts

Line 73 in 8837745

$report: true

Suggestion 1
the $report field in WriteCreReportRequest should be removed or optional? No need to enforce user to include it (and its not present in WriteCreReportRequestJson

Suggestion 2
also type WriteCreReportRequest doesnt seem to be importable by clients?

had to import it via:
import { type WriteCreReportRequest } from "@chainlink/cre-sdk/dist/generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen";

Suggestion 3
WriteCreReportRequest has a receiver property of type uint8Array. should this also be string | Viem.Address?

note that the client call works with type string as well....!

[ernest-nowacki]

Thanks for making the suggestions!

Suggestion 1
the $report field in WriteCreReportRequest should be removed or optional? No need to enforce user to include it (and its not present in WriteCreReportRequestJson

$report field is required here. WriteCreReportRequest and WriteCreReportRequestJson are two different types for different purposes. WriteCreReportRequest represents shape we eventually need the data to have - it's the only valid one for proto communication. WriteCreReportRequestJson is simplified type that we can use as it feels more natural to just use JSON in TypeScript world. When you use WriteCreReportRequestJson you would use fromJson() helper which would translate it to WriteCreReportRequest basically.

Long story short we will keep the $report field here.

Suggestion 2
also type WriteCreReportRequest doesnt seem to be importable by clients?

That's a great catch, I will make it available for consumers.

Suggestion 3
WriteCreReportRequest has a receiver property of type uint8Array. should this also be string | Viem.Address?
note that the client call works with type string as well....!

I assume you talk about .writeReport() call in client code that works with string. This is again related to the ability to use both WriteCreReportRequest or WriteCreReportRequestJson type. When passing JSON you can use string but under the hood we will translate that into uint8Array.

So no changes expected here.

[zeuslawyer]

thanks @ernest-nowacki ! for the $report then perhaps mark optional as TS clients dont need to pass it and it complains? (IIRC)

re: WriteCreReportRequest - i cant remember how i encountered this but when using this as the type on the client side, it was forcing uint8 because of this objects typing. But somehow was accepting a string at runtime. Even when i was passing JSOn it complained (IIRC)...so hence I suggested making receiver on WriteCreReportRequest accept a string | uint8Array

if i can repro this post smartcon I'll try