generate types.json

[shannonwells]

Goal

The goal of this PR is to generate a types.json file to help with being on Subscan et al.

Closes #2062

Checklist

• Updated js/api-augment for Custom RPC OR Runtime API?
• Added types.json generation to release.yml
• Added types.json generation to package.json (two scripts, but postbuild doesn't seem to be used anywhere).
• Added types.json generation to generate_js_definitions.js script so it is triggered by make js

Verify

1. Check out this branch and run make js, which replicates the two needed steps run in CI.
2. if you cd js/api-augment/dist, this should exist: json/types.json
3. The content of types.json should look like the following, so that it would be included in the tarball if you run npm pack:

{
    "RpcEvent": {
        "phase": "Option<u32>",
        "pallet": "u8",
        "event": "u8",
        "data": "Vec<u8>"
    },
    "HandleSuffix": "u16",
    "HandleResponse": {
        "base_handle": "String",
        "canonical_base": "String",
        "suffix": "u16"
    },
    "PresumptiveSuffixesResponse": {
        "suffixes": "Vec<HandleSuffix>",
        "base_handle": "String"
    },
    "BlockPaginationRequest": {
        "from_block": "BlockNumber",
        "from_index": "u32",
        "to_block": "BlockNumber",
        "page_size": "u32"
    },
    "MessageResponse": {
        "payload": "Option<Vec<u8>>",
        "cid": "Option<Vec<u8>>",
        "provider_msa_id": "MessageSourceId",
        "msa_id": "Option<MessageSourceId>",
        "index": "u16",
        "block_number": "BlockNumber",
        "payload_length": "Option<u32>"
    },
    "BlockPaginationResponseMessage": {
        "content": "Vec<MessageResponse>",
        "has_next": "bool",
        "next_block": "Option<BlockNumber>",
        "next_index": "Option<u32>"
    },
    "MessageSourceId": "u64",
    "DelegatorId": "MessageSourceId",
    "ProviderId": "MessageSourceId",
    "KeyInfoResponse": {
        "msa_keys": "Vec<AccountId>",
        "msa_id": "MessageSourceId"
    },
    "SchemaGrantResponse": {
        "schema_id": "SchemaId",
        "revoked_at": "BlockNumber"
    },
    "DelegationResponse": {
        "provider_id": "ProviderId",
        "permissions": "Vec<SchemaGrantResponse>"
    },
    "SchemaId": "u16",
    "SchemaModel": "Vec<u8>",
    "SchemaVersion": "u8",
    "SchemaResponse": {
        "schema_id": "SchemaId",
        "model": "SchemaModel",
        "model_type": "ModelType",
        "payload_location": "PayloadLocation",
        "settings": "Vec<SchemaSetting>"
    },
    "ModelType": {
        "_enum": [
            "AvroBinary",
            "Parquet"
        ]
    },
    "PayloadLocation": {
        "_enum": [
            "OnChain",
            "IPFS",
            "Itemized",
            "Paginated"
        ]
    },
    "SchemaSetting": {
        "_enum": [
            "AppendOnly",
            "SignatureRequired"
        ]
    },
    "SchemaVersionResponse": {
        "schema_name": "String",
        "schema_version": "SchemaVersion",
        "schema_id": "SchemaId"
    },
    "PageId": "u16",
    "PageHash": "u32",
    "PageNonce": "u16",
    "ItemizedStorageResponse": {
        "index": "u16",
        "payload": "Vec<u8>"
    },
    "PaginatedStorageResponse": {
        "page_id": "PageId",
        "msa_id": "MessageSourceId",
        "schema_id": "SchemaId",
        "content_hash": "PageHash",
        "nonce": "PageNonce",
        "payload": "Vec<u8>"
    },
    "ItemizedStoragePageResponse": {
        "msa_id": "MessageSourceId",
        "schema_id": "SchemaId",
        "content_hash": "PageHash",
        "nonce": "PageNonce",
        "items": "Vec<ItemizedStorageResponse>"
    }
}

[enddynayn]

Nice! I did not know one could do this.

[enddynayn]

👍 LGTM!

[JoeCap08055]

This seems redundant since build:types-json is now part of the postbuild script

[shannonwells]

I added it because I was unsure. I'm not seeing where postbuild gets called. Do you know what it's for?

[JoeCap08055]

The way npm scripts work, any script that starts with "pre" or "post" runs before/after the main script of the same name. So "postbuild" automatically runs after "build".

[wilwade]

Two notes about where the output publishes

[wilwade]

We will need to copy the file to the dist directory to make sure that it is published in the npm api-augment package

[shannonwells]

generate.mjs output goes to dist/json/types.json

[wilwade]

Ah I see it now. I misread the output and didn't see it when I built it locally. Sorry about that!

[wilwade]

This adds it to the artifacts for the workflow, but if we want to include it as an artifact as part of the release, we need to update these two steps to include it:

• Publish Release Candidate on GitHub
• Publish Full Release on GitHub

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅