Connection.getBlock return types are missing the blockHeight field

[jeff-delonge]

Overview

In 1.87.6, the return types of Connection.getBlock such as VersionedBlockResponse and BlockResponse omit the blockHeight field. If Connection.getBlock returns a non-null value, the returned object includes this field.

The types should be updated to include the blockHeight field.

Steps to reproduce

    const connection = new Connection("https://api.mainnet-beta.solana.com", "finalized");
    const latestBlockhashResult = await connection.getLatestBlockhashAndContext("finalized");
    const block = await connection.getBlock(latestBlockhashResult.context.slot, {
        commitment: "finalized",
        maxSupportedTransactionVersion: undefined,
        rewards: false,
        transactionDetails: "none",
    });
    console.log("latestBlockhashResult", latestBlockhashResult);
    console.log("block", block);

Description of bug

The above logs something like the following. Note that the block includes the blockHeight field.

latestBlockhashResult {
  context: { apiVersion: '1.16.18', slot: 235912008 },
  value: {
    blockhash: 'D7Qr3rwEbYKh9cYvV25wmXCcvzJqHxixnZs91tL1Rvsa',
    lastValidBlockHeight: 217323342
  }
}
block {
  blockHeight: 217323042,
  blockTime: 1702587441,
  blockhash: 'D7Qr3rwEbYKh9cYvV25wmXCcvzJqHxixnZs91tL1Rvsa',
  parentSlot: 235912007,
  previousBlockhash: '7vXphDU9znbs6SNBqiyPSEkvJtiZE5D5g55mxw5NKSZk',
  rewards: undefined
}

If instead I try to build the following code (note the const blockHeight = block?.blockHeight), TypeScript will complain because the blockHeight field is missing from the VersionedBlockResponse type in @solana/web3.js:

    const connection = new Connection("https://api.mainnet-beta.solana.com", "finalized");
    const latestBlockhashResult = await connection.getLatestBlockhashAndContext("finalized");
    const block = await connection.getBlock(latestBlockhashResult.context.slot, {
        commitment: "finalized",
        maxSupportedTransactionVersion: undefined,
        rewards: false,
        transactionDetails: "none",
    });
    const blockHeight = block?.blockHeight;
    console.log("latestBlockhashResult", latestBlockhashResult);
    console.log("block", block);

The type error is:

error TS2339: Property 'blockHeight' does not exist on type 'VersionedBlockResponse'.

37     const blockHeight = block?.blockHeight;

[steveluscher]

Thanks! In the meantime, you might be interested in using the new @solana/web3.js that gets this typespec right.

https://stackblitz.com/edit/typescript-gnvm4e?devToolsHeight=33&file=index.ts

More: https://github.com/solana-labs/solana-web3.js/blob/2ac1df6b886bcf335c35651445bd384222cae752/packages/library/README.md

[RaghavenderSingh]

Hey, I'm interested in working on this one

[buffalojoec]

Hey, I'm interested in working on this one

Please do! Note this is in the legacy library.