/*
 * Copyright 2020 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Address } from '../account/Address';
import { PublicAccount } from '../account/PublicAccount';
import { NetworkType } from '../network/NetworkType';
import { UInt64 } from '../UInt64';

/**
 * The block info structure describes basic information of a new gernated block (Websocket payload).
 */
export class NewBlock {
    /**
     * @param hash
     * @param generationHash
     * @param signature
     * @param signer
     * @param networkType
     * @param version
     * @param type
     * @param height
     * @param timestamp
     * @param difficulty
     * @param proofGamma
     * @param proofScalar
     * @param proofVerificationHash
     * @param feeMultiplier
     * @param totalSupply
     * @param feeToPay
     * @param inflation
     * @param collectedEpochFees
     * @param inflationMultiplier
     * @param previousBlockHash
     * @param blockTransactionsHash
     * @param blockReceiptsHash
     * @param blockStateHash
     * @param beneficiaryAddress
     */
    constructor(
        /**
         * The block hash.
         */
        public readonly hash: string,
        /**
         * The generation hash
         */
        public readonly generationHash: string,
        /**
         * The block signature.
         * The signature was generated by the signer and can be used to validate that the blockchain
         * data was not modified by a node.
         */
        public readonly signature: string,
        /**
         * The public account of block harvester.
         */
        public readonly signer: PublicAccount,
        /**
         * The network type.
         */
        public readonly networkType: NetworkType,
        /**
         * The transaction version.
         */
        public readonly version: number,
        /**
         * The block type.
         */
        public readonly type: number,
        /**
         * The height of which the block was confirmed.
         * Each block has a unique height. Subsequent blocks differ in height by 1.
         */
        public readonly height: UInt64,
        /**
         * The number of milliseconds elapsed since the creation of the nemesis blockchain.
         */
        public readonly timestamp: UInt64,
        /**
         * The POI difficulty to harvest a block.
         */
        public readonly difficulty: UInt64,
        /**
         * The feeMultiplier defined by the harvester.
         */
        public readonly feeMultiplier: number,
        public readonly totalSupply: UInt64,
        public readonly feeToPay: UInt64,
        public readonly inflation: UInt64,
        public readonly collectedEpochFees: UInt64,
        public readonly inflationMultiplier: UInt64,
        /**
         * The last block hash.
         */
        public readonly previousBlockHash: string,
        /**
         * The block transaction hash.
         */
        public readonly blockTransactionsHash: string,
        /**
         * The block receipt hash.
         */
        public readonly blockReceiptsHash: string,
        /**
         * The state hash.
         */
        public readonly stateHash: string,
        /**
         * The proof gamma.
         */
        public readonly proofGamma: string,
        /**
         * The proof scalar.
         */
        public readonly proofScalar: string,
        /**
         * The proof verification hash.
         */
        public readonly proofVerificationHash: string,
        /**
         * The beneficiary address.
         */
        public readonly beneficiaryAddress?: Address,
    ) {}
}