@esteemapp/dhive/lib/helpers/blockchain.d.ts

Hive blockchain RPC client library

/**
 * @file Hive blockchain helpers.
 * @author Johan Nordberg <code@johan-nordberg.com>
 * @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.
 */
/// <reference types="node" />
import { Client } from './../client';
export declare enum BlockchainMode {
    /**
     * Only get irreversible blocks.
     */
    Irreversible = 0,
    /**
     * Get all blocks.
     */
    Latest = 1
}
export interface BlockchainStreamOptions {
    /**
     * Start block number, inclusive. If omitted generation will start from current block height.
     */
    from?: number;
    /**
     * End block number, inclusive. If omitted stream will continue indefinitely.
     */
    to?: number;
    /**
     * Streaming mode, if set to `Latest` may include blocks that are not applied to the final chain.
     * Defaults to `Irreversible`.
     */
    mode?: BlockchainMode;
}
export declare class Blockchain {
    readonly client: Client;
    constructor(client: Client);
    /**
     * Get latest block number.
     */
    getCurrentBlockNum(mode?: BlockchainMode): Promise<number>;
    /**
     * Get latest block header.
     */
    getCurrentBlockHeader(mode?: BlockchainMode): Promise<import("..").BlockHeader>;
    /**
     * Get latest block.
     */
    getCurrentBlock(mode?: BlockchainMode): Promise<import("..").SignedBlock>;
    /**
     * Return a asynchronous block number iterator.
     * @param options Feed options, can also be a block number to start from.
     */
    getBlockNumbers(options?: BlockchainStreamOptions | number): AsyncGenerator<number, void, unknown>;
    /**
     * Return a stream of block numbers, accepts same parameters as {@link getBlockNumbers}.
     */
    getBlockNumberStream(options?: BlockchainStreamOptions | number): NodeJS.ReadableStream;
    /**
     * Return a asynchronous block iterator, accepts same parameters as {@link getBlockNumbers}.
     */
    getBlocks(options?: BlockchainStreamOptions | number): AsyncGenerator<import("..").SignedBlock, void, unknown>;
    /**
     * Return a stream of blocks, accepts same parameters as {@link getBlockNumbers}.
     */
    getBlockStream(options?: BlockchainStreamOptions | number): NodeJS.ReadableStream;
    /**
     * Return a asynchronous operation iterator, accepts same parameters as {@link getBlockNumbers}.
     */
    getOperations(options?: BlockchainStreamOptions | number): AsyncGenerator<import("..").AppliedOperation, void, unknown>;
    /**
     * Return a stream of operations, accepts same parameters as {@link getBlockNumbers}.
     */
    getOperationsStream(options?: BlockchainStreamOptions | number): NodeJS.ReadableStream;
}