/** * @file Hive block type definitions. * @author Johan Nordberg * @license * Copyright (c) 2017 Johan Nordberg. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * 1. Redistribution of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistribution in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * 3. Neither the name of the copyright holder nor the names of its contributors * may be used to endorse or promote products derived from this software without * specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. * * You acknowledge that this software is not designed, licensed or intended for use * in the design, construction, operation or maintenance of any military facility. */ import { Transaction } from "./transaction.js"; /** * Hive block header without the witness signature. * * @remarks * Block headers link blocks through `previous`, identify the producing witness, * and commit to the transaction list through the transaction Merkle root. * * @example * ```ts * const header = await client.database.getBlockHeader(90_000_000) * console.log(header.witness, header.timestamp) * ``` */ export interface BlockHeader { previous: string; timestamp: string; witness: string; transaction_merkle_root: string; extensions: unknown[]; } /** * Hive block header plus witness signature. * * @remarks * Witness signatures prove that the scheduled witness produced the block using * its active block-signing key. * * @example * ```ts * const block = await client.database.getBlock(90_000_000) * console.log(block.witness_signature) * ``` */ export interface SignedBlockHeader extends BlockHeader { witness_signature: string; } /** * Full Hive signed block including transactions. * * @remarks * This is the primary unit consumed by indexers. It carries the signed header, * transaction ids, and the deserialized transactions in block order. * * @example * ```ts * const block = await client.database.getBlock(90_000_000) * for (const transaction of block.transactions) { * console.log(transaction.operations.length) * } * ``` */ export interface SignedBlock extends SignedBlockHeader { block_id: string; signing_key: string; transaction_ids: string[]; transactions: Transaction[]; }