Function dash_sdk::platform::block_info_from_metadata::block_info_from_metadata

source · 
pub fn block_info_from_metadata(
    response_metadata: &ResponseMetadata,
) -> Result<BlockInfo, Error>
Expand description

Constructs a BlockInfo structure from the provided response metadata. This function translates metadata received from a platform response into a format that is specific to the application’s needs, particularly focusing on block-related information. It ensures that the epoch value from the metadata does not exceed the maximum allowed for a 16-bit integer, as this is a constraint for the BlockInfo structure.

§Parameters

  • response_metadata: A reference to ResponseMetadata obtained from a platform response. This metadata includes various block-related information such as time in milliseconds, height, core chain locked height, and epoch.

§Returns

If successful, returns Ok(BlockInfo) where BlockInfo contains:

  • time_ms: The timestamp of the block in milliseconds.
  • height: The height of the block.
  • core_height: The core chain locked height, indicating the height of the block in the core blockchain that is considered final and securely linked to this block.
  • epoch: The epoch number, converted to a 16-bit integer.

§Errors

Returns an error if:

  • The epoch value in the response metadata exceeds the maximum value that can be represented by a 16-bit integer. This is considered a data validity error as it indicates Platform returned an unexpectedly high epoch number.

The function encapsulates errors into the application’s own Error type, providing a unified interface for error handling across the application.