@ethereumjs/block/dist/esm/block/constructors.d.ts

Provides Block serialization and help functions

import { Block } from '../index.ts';
import type { EthersProvider } from '@ethereumjs/util';
import type { BeaconPayloadJSON } from '../from-beacon-payload.ts';
import type { BlockBytes, BlockData, BlockOptions, ExecutionPayload, HeaderData, JSONRPCBlock } from '../types.ts';
/**
 * Static constructor to create a block from a block data dictionary
 *
 * @param blockData
 * @param opts
 * @returns a new {@link Block} object
 */
export declare function createBlock(blockData?: BlockData, opts?: BlockOptions): Block;
/**
 * Simple static constructor if only an empty block is needed
 * (tree shaking advantages since it does not draw all the tx constructors in)
 *
 * @param headerData
 * @param opts
 * @returns a new {@link Block} object
 */
export declare function createEmptyBlock(headerData: HeaderData, opts?: BlockOptions): Block;
/**
 * Static constructor to create a block from an array of Bytes values
 *
 * @param values
 * @param opts
 * @returns a new {@link Block} object
 */
export declare function createBlockFromBytesArray(values: BlockBytes, opts?: BlockOptions): Block;
/**
 * Static constructor to create a block from a RLP-serialized block
 *
 * @param serialized
 * @param opts
 * @returns a new {@link Block} object
 */
export declare function createBlockFromRLP(serialized: Uint8Array, opts?: BlockOptions): Block;
/**
 * Creates a new block object from Ethereum JSON RPC.
 *
 * @param blockParams - Ethereum JSON RPC of block (eth_getBlockByNumber)
 * @param uncles - Optional list of Ethereum JSON RPC of uncles (eth_getUncleByBlockHashAndIndex)
 * @param opts - An object describing the blockchain
 * @returns a new {@link Block} object
 */
export declare function createBlockFromRPC(blockParams: JSONRPCBlock, uncles?: any[], options?: BlockOptions): Block;
/**
 *  Method to retrieve a block from a JSON-RPC provider and format as a {@link Block}
 * @param provider either a url for a remote provider or an Ethers JSONRPCProvider object
 * @param blockTag block hash or block number to be run
 * @param opts {@link BlockOptions}
 * @returns a new {@link Block} object specified by `blockTag`
 */
export declare const createBlockFromJSONRPCProvider: (provider: string | EthersProvider, blockTag: string | bigint, opts: BlockOptions) => Promise<Block>;
/**
 *  Method to retrieve a block from an execution payload
 * @param payload Execution payload constructed from beacon payload data
 * @param opts {@link BlockOptions}
 * @returns The constructed {@link Block} object
 */
export declare function createBlockFromExecutionPayload(payload: ExecutionPayload, opts?: BlockOptions): Promise<Block>;
/**
 *  Method to retrieve a block from a beacon payload JSON
 * @param payload JSON of a beacon block fetched from beacon APIs
 * @param opts {@link BlockOptions}
 * @returns The constructed {@link Block} object
 */
export declare function createBlockFromBeaconPayloadJSON(payload: BeaconPayloadJSON, opts?: BlockOptions): Promise<Block>;
/**
 * Creates a block for Clique networks with the seal applied during instantiation.
 * @param blockData Block fields used to build the block
 * @param cliqueSigner Private key bytes used to sign the header
 * @param opts {@link BlockOptions}
 * @returns A sealed Clique {@link Block} object
 */
export declare function createSealedCliqueBlock(blockData: BlockData | undefined, cliqueSigner: Uint8Array, opts?: BlockOptions): Block;
//# sourceMappingURL=constructors.d.ts.map