# Nimbus # Copyright (c) 2021-2023 Status Research & Development GmbH # Licensed and distributed under either of # * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT). # * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0). # at your option. This file may not be copied, modified, or distributed except according to those terms. {.push raises: [].} import stew/results, chronos, chronicles, eth/[common/eth_types_rlp, rlp], eth/p2p/discoveryv5/[protocol, enr], ../../common/common_types, ../../content_db, ../../network_metadata, ../../../nimbus/[constants, db/core_db], ../wire/[portal_protocol, portal_stream, portal_protocol_config], "."/[history_content, accumulator] logScope: topics = "portal_hist" export accumulator # This looks like it makes no sense, because it makes no sense. It's a # workaround for what seems to be a compiler bug; see here: # # https://github.com/status-im/nimbus-eth1/pull/1465 # # Without this, the call `error` on a `Result` might give a compiler error for # the `Result[BlockHeader, string]` or `Result[seq[BlockHeader], string]` types. # The error is due to the `$` for `BlockHeader causing side effects, which # appears to be due to the timestamp field, which is of `times.Time` type. Its # `$` from the times module has side effects (Yes, silly times). In (my) theory # this `$` should not leak here, but it seems to do. To workaround this we # introduce this additional `$` call, which appears to work. # # Note that this also fixes the same error in another module, even when not # specifically exporting (no asterisk) the call. # # If you think this is unnecessary, feel free to try deleting it; if all the # tests still pass after deleting it, feel free to leave it out. In the # meantime, please just ignore it and go on with your life. # proc `$`(x: BlockHeader): string = $x const historyProtocolId* = [byte 0x50, 0x0B] type HistoryNetwork* = ref object portalProtocol*: PortalProtocol contentDB*: ContentDB contentQueue*: AsyncQueue[(Opt[NodeId], ContentKeysList, seq[seq[byte]])] accumulator*: FinishedAccumulator processContentLoop: Future[void] statusLogLoop: Future[void] Block* = (BlockHeader, BlockBody) func toContentIdHandler(contentKey: ByteList): results.Opt[ContentId] = ok(toContentId(contentKey)) ## Calls to go from SSZ decoded Portal types to RLP fully decoded EL types func fromPortalBlockBody*( T: type BlockBody, body: PortalBlockBodyLegacy): Result[T, string] = ## Get the EL BlockBody from the SSZ-decoded `PortalBlockBodyLegacy`. try: var transactions: seq[Transaction] for tx in body.transactions: transactions.add(rlp.decode(tx.asSeq(), Transaction)) let uncles = rlp.decode(body.uncles.asSeq(), seq[BlockHeader]) ok(BlockBody(transactions: transactions, uncles: uncles)) except RlpError as e: err("RLP decoding failed: " & e.msg) func fromPortalBlockBody*( T: type BlockBody, body: PortalBlockBodyShanghai): Result[T, string] = ## Get the EL BlockBody from the SSZ-decoded `PortalBlockBodyShanghai`. try: var transactions: seq[Transaction] for tx in body.transactions: transactions.add(rlp.decode(tx.asSeq(), Transaction)) var withdrawals: seq[Withdrawal] for w in body.withdrawals: withdrawals.add(rlp.decode(w.asSeq(), Withdrawal)) ok(BlockBody( transactions: transactions, uncles: @[], # Uncles must be empty: TODO where validation? withdrawals: some(withdrawals))) except RlpError as e: err("RLP decoding failed: " & e.msg) func fromPortalBlockBodyOrRaise*( T: type BlockBody, body: PortalBlockBodyLegacy | PortalBlockBodyShanghai): T = ## Get the EL BlockBody from one of the SSZ-decoded Portal BlockBody types. ## Will raise Assertion in case of invalid RLP encodings. Only use of data ## has been validated before! # TODO: Using ValueOr here gives compile error let res = BlockBody.fromPortalBlockBody(body) if res.isOk(): res.get() else: raiseAssert(res.error) func fromPortalReceipts*( T: type seq[Receipt], receipts: PortalReceipts): Result[T, string] = ## Get the full decoded EL seq[Receipt] from the SSZ-decoded `PortalReceipts`. try: var res: seq[Receipt] for receipt in receipts: res.add(rlp.decode(receipt.asSeq(), Receipt)) ok(res) except RlpError as e: err("RLP decoding failed: " & e.msg) ## Calls to encode EL block types to the SSZ encoded Portal types. # TODO: The fact that we have different Portal BlockBody types for the different # forks but not for the EL BlockBody (usage of Option) does not play so well # together. func fromBlockBody(T: type PortalBlockBodyLegacy, body: BlockBody): T = var transactions: Transactions for tx in body.transactions: discard transactions.add(TransactionByteList(rlp.encode(tx))) let uncles = Uncles(rlp.encode(body.uncles)) PortalBlockBodyLegacy(transactions: transactions, uncles: uncles) func fromBlockBody(T: type PortalBlockBodyShanghai, body: BlockBody): T = var transactions: Transactions for tx in body.transactions: discard transactions.add(TransactionByteList(rlp.encode(tx))) let uncles = Uncles(rlp.encode(body.uncles)) doAssert(body.withdrawals.isSome()) var withdrawals: Withdrawals for w in body.withdrawals.get(): discard withdrawals.add(WithdrawalByteList(rlp.encode(w))) PortalBlockBodyShanghai(transactions: transactions, uncles: uncles, withdrawals: withdrawals) func fromReceipts*(T: type PortalReceipts, receipts: seq[Receipt]): T = var portalReceipts: PortalReceipts for receipt in receipts: discard portalReceipts.add(ReceiptByteList(rlp.encode(receipt))) portalReceipts func encode*(blockBody: BlockBody): seq[byte] = if blockBody.withdrawals.isSome(): SSZ.encode(PortalBlockBodyShanghai.fromBlockBody(blockBody)) else: SSZ.encode(PortalBlockBodyLegacy.fromBlockBody(blockBody)) func encode*(blockBody: BlockBody, T: type PortalBlockBodyShanghai): seq[byte] = let portalBlockBody = PortalBlockBodyShanghai.fromBlockBody(blockBody) SSZ.encode(portalBlockBody) func encode*(receipts: seq[Receipt]): seq[byte] = let portalReceipts = PortalReceipts.fromReceipts(receipts) SSZ.encode(portalReceipts) ## Calls and helper calls to do validation of block header, body and receipts # TODO: Failures on validation and perhaps deserialisation should be punished # for if/when peer scoring/banning is added. proc calcRootHash(items: Transactions | PortalReceipts | Withdrawals): Hash256 = var tr = newCoreDbRef(LegacyDbMemory).mptPrune for i, item in items: try: tr.put(rlp.encode(i), item.asSeq()) except CatchableError as e: # tr.put now is a generic interface to whatever underlying db # and it can raise exception if the backend db is something like aristo raiseAssert(e.msg) return tr.rootHash template calcTxsRoot*(transactions: Transactions): Hash256 = calcRootHash(transactions) template calcReceiptsRoot*(receipts: PortalReceipts): Hash256 = calcRootHash(receipts) template calcWithdrawalsRoot*(receipts: Withdrawals): Hash256 = calcRootHash(receipts) func validateBlockHeaderBytes*( bytes: openArray[byte], hash: BlockHash): Result[BlockHeader, string] = let header = ? decodeRlp(bytes, BlockHeader) if header.excessBlobGas.isSome: return err("EIP-4844 not yet implemented") # TODO: Verify timestamp with Shanghai timestamp to if isSome() # TODO 2: Verify block number with merge block to check ommerhash if not (header.blockHash() == hash): err("Block header hash does not match") else: ok(header) proc validateBlockBody( body: PortalBlockBodyLegacy, header: BlockHeader): Result[void, string] = ## Validate the block body against the txRoot and ommersHash from the header. let calculatedOmmersHash = keccakHash(body.uncles.asSeq()) if calculatedOmmersHash != header.ommersHash: return err("Invalid ommers hash") let calculatedTxsRoot = calcTxsRoot(body.transactions) if calculatedTxsRoot != header.txRoot: return err("Invalid transactions root: expected " & $header.txRoot & " - got " & $calculatedTxsRoot) ok() proc validateBlockBody( body: PortalBlockBodyShanghai, header: BlockHeader): Result[void, string] = ## Validate the block body against the txRoot, ommersHash and withdrawalsRoot ## from the header. # Shortcut the ommersHash calculation as uncles must be an RLP encoded # empty list if body.uncles.asSeq() != @[byte 0xc0]: return err("Invalid ommers hash, uncles list is not empty") let calculatedTxsRoot = calcTxsRoot(body.transactions) if calculatedTxsRoot != header.txRoot: return err("Invalid transactions root: expected " & $header.txRoot & " - got " & $calculatedTxsRoot) # TODO: This check is done higher up but perhaps this can become cleaner with # some refactor. doAssert(header.withdrawalsRoot.isSome()) let calculatedWithdrawalsRoot = calcWithdrawalsRoot(body.withdrawals) headerWithdrawalsRoot = header.withdrawalsRoot.get() if calculatedWithdrawalsRoot != headerWithdrawalsRoot: return err("Invalid withdrawals root: expected " & $headerWithdrawalsRoot & " - got " & $calculatedWithdrawalsRoot) ok() proc decodeBlockBodyBytes*(bytes: openArray[byte]): Result[BlockBody, string] = if (let body = decodeSsz(bytes, PortalBlockBodyShanghai); body.isOk()): BlockBody.fromPortalBlockBody(body.get()) elif (let body = decodeSsz(bytes, PortalBlockBodyLegacy); body.isOk()): BlockBody.fromPortalBlockBody(body.get()) else: err("All Portal block body decodings failed") proc validateBlockBodyBytes*( bytes: openArray[byte], header: BlockHeader): Result[BlockBody, string] = ## Fully decode the SSZ encoded Portal Block Body and validate it against the ## header. ## TODO: improve this decoding in combination with the block body validation ## calls. let timestamp = Moment.init(header.timestamp.int64, Second) # TODO: The additional header checks are not needed as header is implicitly # verified by means of the accumulator? Except that we don't use this yet # post merge, so the checks are still useful, for now. if isShanghai(chainConfig, timestamp): if header.withdrawalsRoot.isNone(): return err("Expected withdrawalsRoot for Shanghai block") elif header.ommersHash != EMPTY_UNCLE_HASH: return err("Expected empty uncles for a Shanghai block") else: let body = ? decodeSsz(bytes, PortalBlockBodyShanghai) ? validateBlockBody(body, header) BlockBody.fromPortalBlockBody(body) elif isPoSBlock(chainConfig, header.blockNumber.truncate(uint64)): if header.withdrawalsRoot.isSome(): return err("Expected no withdrawalsRoot for pre Shanghai block") elif header.ommersHash != EMPTY_UNCLE_HASH: return err("Expected empty uncles for a PoS block") else: let body = ? decodeSsz(bytes, PortalBlockBodyLegacy) ? validateBlockBody(body, header) BlockBody.fromPortalBlockBody(body) else: if header.withdrawalsRoot.isSome(): return err("Expected no withdrawalsRoot for pre Shanghai block") else: let body = ? decodeSsz(bytes, PortalBlockBodyLegacy) ? validateBlockBody(body, header) BlockBody.fromPortalBlockBody(body) proc validateReceipts*( receipts: PortalReceipts, receiptsRoot: KeccakHash): Result[void, string] = let calculatedReceiptsRoot = calcReceiptsRoot(receipts) if calculatedReceiptsRoot != receiptsRoot: return err("Unexpected receipt root") else: return ok() proc validateReceiptsBytes*( bytes: openArray[byte], receiptsRoot: KeccakHash): Result[seq[Receipt], string] = ## Fully decode the SSZ Block Body and validate it against the header. let receipts = ? decodeSsz(bytes, PortalReceipts) ? validateReceipts(receipts, receiptsRoot) seq[Receipt].fromPortalReceipts(receipts) ## ContentDB helper calls for specific history network types proc get(db: ContentDB, T: type BlockHeader, contentId: ContentId): Opt[T] = let contentFromDB = db.get(contentId) if contentFromDB.isSome(): let headerWithProof = try: SSZ.decode(contentFromDB.get(), BlockHeaderWithProof) except SerializationError as e: raiseAssert(e.msg) let res = decodeRlp(headerWithProof.header.asSeq(), T) if res.isErr(): raiseAssert(res.error) else: Opt.some(res.get()) else: Opt.none(T) proc get(db: ContentDB, T: type BlockBody, contentId: ContentId, header: BlockHeader): Opt[T] = let encoded = db.get(contentId).valueOr: return Opt.none(T) let timestamp = Moment.init(header.timestamp.int64, Second) body = if isShanghai(chainConfig, timestamp): BlockBody.fromPortalBlockBodyOrRaise( decodeSszOrRaise(encoded, PortalBlockBodyShanghai)) elif isPoSBlock(chainConfig, header.blockNumber.truncate(uint64)): BlockBody.fromPortalBlockBodyOrRaise( decodeSszOrRaise(encoded, PortalBlockBodyLegacy)) else: BlockBody.fromPortalBlockBodyOrRaise( decodeSszOrRaise(encoded, PortalBlockBodyLegacy)) Opt.some(body) proc get(db: ContentDB, T: type seq[Receipt], contentId: ContentId): Opt[T] = let contentFromDB = db.getSszDecoded(contentId, PortalReceipts) if contentFromDB.isSome(): let res = T.fromPortalReceipts(contentFromDB.get()) if res.isErr(): raiseAssert(res.error) else: Opt.some(res.get()) else: Opt.none(T) proc get( db: ContentDB, T: type EpochAccumulator, contentId: ContentId): Opt[T] = db.getSszDecoded(contentId, T) proc getContentFromDb( n: HistoryNetwork, T: type, contentId: ContentId): Opt[T] = if n.portalProtocol.inRange(contentId): n.contentDB.get(T, contentId) else: Opt.none(T) ## Public API to get the history network specific types, either from database ## or through a lookup on the Portal Network const requestRetries = 4 # TODO: Currently doing 4 retries on lookups but only when the validation fails. # This is to avoid nodes that provide garbage from blocking us with getting the # requested data. Might want to also do that on a failed lookup, as perhaps this # could occur when being really unlucky with nodes timing out on requests. # Additionally, more improvements could be done with the lookup, as currently # ongoing requests are cancelled after the receival of the first response, # however that response is not yet validated at that moment. func verifyHeader( n: HistoryNetwork, header: BlockHeader, proof: BlockHeaderProof): Result[void, string] = verifyHeader(n.accumulator, header, proof) proc getVerifiedBlockHeader*( n: HistoryNetwork, hash: BlockHash): Future[Opt[BlockHeader]] {.async.} = let contentKey = ContentKey.init(blockHeader, hash).encode() contentId = contentKey.toContentId() logScope: hash contentKey # Note: This still requests a BlockHeaderWithProof from the database, as that # is what is stored. But the proof doesn't need to be verified as it gets # gets verified before storing. let headerFromDb = n.getContentFromDb(BlockHeader, contentId) if headerFromDb.isSome(): info "Fetched block header from database" return headerFromDb for i in 0..