Generate JSON response sample

[patrickkuo]

Generate JSON response sample when schema changes.

The sample files are located in sui/open_rpc/samples, they will be regenerated together with openrpc.json when we run cargo -q run --example generate-json-rpc-spec -- record, the files can be used for downstream testing.

[666lcz]

This is an amazing improvement on our regression detection! A great next step would be to add a mode for the sui/src/generate_json_rpc_spec.rs to act as a mock data server and then we can connect the Explorer with it.

[666lcz]

Test Plan for TS-side changes

Manual Testing

I. Transactions

Landing

MoveCall

Publish

TransferCoin

II. AddressView

Aggregate Fungible Tokens section

Expanded Fungible Tokens section

III. Object View

Coin

NFT with image

NFT without image

Package

IV. Search

validate that searching for object id, transaction, address is working

Unit tests

Added TS tests to check the data schema against the mock data generated by sui/src/generate_json_rpc_spec.rs

[666lcz]

This is really not ideal as it is hard for clients to parse when some data has fields while others has coin and other names

[666lcz]

One thing I don't like about this is that sometimes the field name refers to a type (e.g., string) while in other places it's not (e.g., version).

[patrickkuo]

I have removed the tag in the parent branch, I have condensed the enum types instead of using tags to remove ambiguity.

[Clay-Mysten]

Hi team,

Thanks, Patrick! Great work, as always. Does this test plan represent a common workflow?

Let me know how we can make best use of this work. Should we link to the samples from our JSON RPC page? Perhaps reuse the screenshots for Sui Explorer docs? Would love to expand the flow presented here with details for each step.