Adds handling for content in beacon network (#428)

* Add content handling to network scaffolding * Add tests for storing and retrieving beacon content * Integration test scaffolding * Add UTP handling in sendFindContent * WIP * WIP * Finish test for finding content * Turn off logging * Fix method names * Add TODO
ethereumjs · Aug 15, 2023 · 99fb319 · 99fb319
1 parent eb29512
commit 99fb319
Show file tree

Hide file tree

Showing 41 changed files with 649 additions and 224 deletions.
diff --git a/packages/archived-browser-client/src/Components/DisplayBlock.tsx b/packages/archived-browser-client/src/Components/DisplayBlock.tsx
@@ -18,7 +18,7 @@ import {
   ExtendedEthersBlockWithTransactions,
   fromHexString,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   toHexString,
   TxReceiptWithType,
   decodeReceipts,
@@ -222,7 +222,7 @@ const DisplayBlock = () => {
         Buffer.from(
           fromHexString(
             await state.provider!.historyProtocol.get(
-              getContentKey(ContentType.Receipt, fromHexString(state.block!.hash))
+              getContentKey(HistoryNetworkContentType.Receipt, fromHexString(state.block!.hash))
             )
           )
         )
@@ -243,9 +243,9 @@ const DisplayBlock = () => {
       typeof (state.block as any).hash === 'string'
         ? (state.block as any).hash
         : toHexString((state.block as any).hash())
-    const header = getContentKey(ContentType.BlockHeader, Buffer.from(fromHexString(hash)))
+    const header = getContentKey(HistoryNetworkContentType.BlockHeader, Buffer.from(fromHexString(hash)))
 
-    const body = getContentKey(ContentType.BlockBody, Buffer.from(fromHexString(hash)))
+    const body = getContentKey(HistoryNetworkContentType.BlockBody, Buffer.from(fromHexString(hash)))
     setKeys({
       header,
       body,

diff --git a/packages/archived-browser-client/src/Components/GetEpoch.tsx b/packages/archived-browser-client/src/Components/GetEpoch.tsx
@@ -2,7 +2,7 @@ import { SearchIcon } from '@chakra-ui/icons'
 import { HStack, Input, useToast, IconButton } from '@chakra-ui/react'
 import {
   ContentLookup,
-  ContentType,
+  HistoryNetworkContentType,
   EpochAccumulator,
   epochRootByBlocknumber,
   epochRootByIndex,
@@ -29,7 +29,7 @@ export default function GetEpoch() {
     ) as HistoryProtocol
     const lookup = new ContentLookup(
       protocol,
-      fromHexString(getContentKey(ContentType.EpochAccumulator, epochRootHash))
+      fromHexString(getContentKey(HistoryNetworkContentType.EpochAccumulator, epochRootHash))
     )
     const epoch = await lookup.startLookup()
     if (epoch !== undefined) {

diff --git a/packages/archived-browser-client/src/Components/PortalButtons.tsx b/packages/archived-browser-client/src/Components/PortalButtons.tsx
@@ -17,7 +17,7 @@ import {
 import { ChevronDownIcon, SearchIcon } from '@chakra-ui/icons'
 import { AppContext, AppContextType, StateChange } from '../globalReducer'
 import { PeerActions } from '../peerActions'
-import { ENR, fromHexString, getContentId, getContentKey, ContentType } from 'portalnetwork'
+import { ENR, fromHexString, getContentId, getContentKey, HistoryNetworkContentType } from 'portalnetwork'
 import { PeerContext, PeerContextType, PeerStateChange } from '../peerReducer'
 
 enum GetBy {
@@ -61,7 +61,7 @@ export function PortalButton(props: IPortalButton) {
     setInput(blockHash)
   }, [blockHash])
 
-  const addToOffer = async (type: ContentType) => {
+  const addToOffer = async (type: HistoryNetworkContentType) => {
     const contentKey = getContentKey(type, Buffer.from(fromHexString(blockHash)))
     const contentId = getContentId(type, blockHash)
     if (await state.provider?.historyProtocol.get(contentKey)) {
@@ -231,7 +231,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.BlockHeader)
+                addToOffer(HistoryNetworkContentType.BlockHeader)
               }}
             >
               add_header_to_offer
@@ -241,7 +241,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.BlockBody)
+                addToOffer(HistoryNetworkContentType.BlockBody)
               }}
             >
               add_block_body_to_offer
@@ -251,7 +251,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.EpochAccumulator)
+                addToOffer(HistoryNetworkContentType.EpochAccumulator)
               }}
             >
               add_epoch_to_offer

diff --git a/packages/archived-browser-client/src/peerActions.ts b/packages/archived-browser-client/src/peerActions.ts
@@ -3,7 +3,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   HistoryProtocol,
   reassembleBlock,
   epochRootByIndex,
@@ -20,7 +20,7 @@ export class PeerActions {
     this.historyProtocol = protocol
   }
 
-  addToOffer = (type: ContentType): void => {
+  addToOffer = (type: HistoryNetworkContentType): void => {
     this.dispatch({
       type: PeerStateChange.SETOFFER,
       payload: [...this.state.offer, getContentId(type, this.state.blockHash)],
@@ -56,7 +56,7 @@ export class PeerActions {
   sendFindContent = async (type: string, enr: string) => {
     if (type === 'header') {
       const headerContentId = fromHexString(
-        getContentKey(ContentType.BlockHeader, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockHeader, fromHexString(this.state.blockHash)),
       )
       const header = await this.historyProtocol.sendFindContent(
         ENR.decodeTxt(enr).nodeId,
@@ -66,16 +66,16 @@ export class PeerActions {
       return block //
     } else if (type === 'body') {
       const headerContentKey = fromHexString(
-        getContentKey(ContentType.BlockHeader, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockHeader, fromHexString(this.state.blockHash)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, headerContentKey)
       const bodyContentKey = fromHexString(
-        getContentKey(ContentType.BlockBody, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockBody, fromHexString(this.state.blockHash)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, bodyContentKey)
     } else if (type === 'epoch') {
       const epochContentKey = fromHexString(
-        getContentKey(ContentType.EpochAccumulator, epochRootByIndex(this.state.epoch)),
+        getContentKey(HistoryNetworkContentType.EpochAccumulator, epochRootByIndex(this.state.epoch)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, epochContentKey)
     }

diff --git a/packages/browser-client/src/Components/DisplayBlock.tsx b/packages/browser-client/src/Components/DisplayBlock.tsx
@@ -18,7 +18,7 @@ import {
   ExtendedEthersBlockWithTransactions,
   fromHexString,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   toHexString,
   TxReceiptWithType,
   decodeReceipts,
@@ -224,7 +224,7 @@ const DisplayBlock = () => {
           fromHexString(
             await state.provider!.historyProtocol.get(
               ProtocolId.HistoryNetwork,
-              getContentKey(ContentType.Receipt, fromHexString(state.block!.hash)),
+              getContentKey(HistoryNetworkContentType.Receipt, fromHexString(state.block!.hash)),
             ),
           ),
         ),
@@ -245,9 +245,15 @@ const DisplayBlock = () => {
       typeof (state.block as any).hash === 'string'
         ? (state.block as any).hash
         : toHexString((state.block as any).hash())
-    const header = getContentKey(ContentType.BlockHeader, Buffer.from(fromHexString(hash)))
+    const header = getContentKey(
+      HistoryNetworkContentType.BlockHeader,
+      Buffer.from(fromHexString(hash)),
+    )
 
-    const body = getContentKey(ContentType.BlockBody, Buffer.from(fromHexString(hash)))
+    const body = getContentKey(
+      HistoryNetworkContentType.BlockBody,
+      Buffer.from(fromHexString(hash)),
+    )
     setKeys({
       header,
       body,

diff --git a/packages/browser-client/src/Components/GetEpoch.tsx b/packages/browser-client/src/Components/GetEpoch.tsx
@@ -2,7 +2,7 @@ import { SearchIcon } from '@chakra-ui/icons'
 import { HStack, Input, useToast, IconButton } from '@chakra-ui/react'
 import {
   ContentLookup,
-  ContentType,
+  HistoryNetworkContentType,
   EpochAccumulator,
   epochRootByIndex,
   fromHexString,
@@ -27,7 +27,7 @@ export default function GetEpoch() {
     ) as HistoryProtocol
     const lookup = new ContentLookup(
       protocol,
-      fromHexString(getContentKey(ContentType.EpochAccumulator, epochRootHash)),
+      fromHexString(getContentKey(HistoryNetworkContentType.EpochAccumulator, epochRootHash)),
     )
     const epoch = await lookup.startLookup()
     if (epoch !== undefined) {

diff --git a/packages/browser-client/src/Components/PortalButtons.tsx b/packages/browser-client/src/Components/PortalButtons.tsx
@@ -22,7 +22,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   ProtocolId,
 } from 'portalnetwork'
 import { PeerContext, PeerContextType, PeerStateChange } from '../peerReducer'
@@ -68,7 +68,7 @@ export function PortalButton(props: IPortalButton) {
     setInput(blockHash)
   }, [blockHash])
 
-  const addToOffer = async (type: ContentType) => {
+  const addToOffer = async (type: HistoryNetworkContentType) => {
     const contentKey = getContentKey(type, Buffer.from(fromHexString(blockHash)))
     const contentId = getContentId(type, blockHash)
     if (await state.provider?.historyProtocol.get(ProtocolId.HistoryNetwork, contentKey)) {
@@ -238,7 +238,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.BlockHeader)
+                addToOffer(HistoryNetworkContentType.BlockHeader)
               }}
             >
               add_header_to_offer
@@ -248,7 +248,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.BlockBody)
+                addToOffer(HistoryNetworkContentType.BlockBody)
               }}
             >
               add_block_body_to_offer
@@ -258,7 +258,7 @@ export function PortalButton(props: IPortalButton) {
               width={'50%'}
               title="Add content to offer"
               onClick={() => {
-                addToOffer(ContentType.EpochAccumulator)
+                addToOffer(HistoryNetworkContentType.EpochAccumulator)
               }}
             >
               add_epoch_to_offer

diff --git a/packages/browser-client/src/peerActions.ts b/packages/browser-client/src/peerActions.ts
@@ -3,7 +3,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   HistoryProtocol,
   reassembleBlock,
   epochRootByIndex,
@@ -20,7 +20,7 @@ export class PeerActions {
     this.historyProtocol = protocol
   }
 
-  addToOffer = (type: ContentType): void => {
+  addToOffer = (type: HistoryNetworkContentType): void => {
     this.dispatch({
       type: PeerStateChange.SETOFFER,
       payload: [...this.state.offer, getContentId(type, this.state.blockHash)],
@@ -56,7 +56,7 @@ export class PeerActions {
   sendFindContent = async (type: string, enr: string) => {
     if (type === 'header') {
       const headerContentId = fromHexString(
-        getContentKey(ContentType.BlockHeader, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockHeader, fromHexString(this.state.blockHash)),
       )
       const header = await this.historyProtocol.sendFindContent(
         ENR.decodeTxt(enr).nodeId,
@@ -66,16 +66,16 @@ export class PeerActions {
       return block //
     } else if (type === 'body') {
       const headerContentKey = fromHexString(
-        getContentKey(ContentType.BlockHeader, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockHeader, fromHexString(this.state.blockHash)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, headerContentKey)
       const bodyContentKey = fromHexString(
-        getContentKey(ContentType.BlockBody, fromHexString(this.state.blockHash)),
+        getContentKey(HistoryNetworkContentType.BlockBody, fromHexString(this.state.blockHash)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, bodyContentKey)
     } else if (type === 'epoch') {
       const epochContentKey = fromHexString(
-        getContentKey(ContentType.EpochAccumulator, epochRootByIndex(this.state.epoch)),
+        getContentKey(HistoryNetworkContentType.EpochAccumulator, epochRootByIndex(this.state.epoch)),
       )
       this.historyProtocol!.sendFindContent(ENR.decodeTxt(enr).nodeId, epochContentKey)
     }

diff --git a/packages/cli/scripts/gossipTest.ts b/packages/cli/scripts/gossipTest.ts
@@ -5,7 +5,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   ProtocolId,
   toHexString,
 } from 'portalnetwork'
@@ -46,7 +46,7 @@ const gossip = async () => {
   // GossipTest
 
     const headerKey = getContentKey(
-      ContentType.BlockHeader,
+      HistoryNetworkContentType.BlockHeader,
       testBlocks[0].hash()
     )
     const header = testBlocks[0].header.serialize()

diff --git a/packages/cli/scripts/recursiveFindContentTest.ts b/packages/cli/scripts/recursiveFindContentTest.ts
@@ -5,7 +5,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   ProtocolId,
   toHexString,
 } from 'portalnetwork'
@@ -46,7 +46,7 @@ const recursiveFindContent = async () => {
   // GossipTest
 
   const headerKey = getContentKey(
-    ContentType.BlockHeader,
+    HistoryNetworkContentType.BlockHeader,
     testBlocks[0].hash()
   )
   const header = testBlocks[0].header.serialize()

diff --git a/packages/cli/scripts/seeder.ts b/packages/cli/scripts/seeder.ts
@@ -1,7 +1,7 @@
 import jayson, { HttpClient } from 'jayson/promise/index.js'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
-import { fromHexString, getContentKey, ContentType, ProtocolId, toHexString } from 'portalnetwork'
+import { fromHexString, getContentKey, HistoryNetworkContentType, ProtocolId, toHexString } from 'portalnetwork'
 import { createRequire } from 'module'
 import { readFileSync } from 'fs'
 import { Block } from '@ethereumjs/block'
@@ -84,7 +84,7 @@ const main = async () => {
     }
     console.log(`ok ${method} test`)
   }
-  const epochKey = getContentKey(ContentType.EpochAccumulator, fromHexString(epoch.hash))
+  const epochKey = getContentKey(HistoryNetworkContentType.EpochAccumulator, fromHexString(epoch.hash))
   let res = await clientInfo.ultralight.client.request('ultralight_addContentToDB', [
     epochKey,
     epoch.serialized,
@@ -165,7 +165,7 @@ const main = async () => {
     await testRes([clients[0]], 'portal_historyOffer', [
       [
         clientInfo.peer1.enr,
-        getContentKey(ContentType.BlockHeader, fromHexString(block[0])),
+        getContentKey(HistoryNetworkContentType.BlockHeader, fromHexString(block[0])),
         toHexString(
           Block.fromRLPSerializedBlock(hexToBytes((block[1] as any).rlp), {
             setHardfork: true,

diff --git a/packages/cli/scripts/sendPingTest.ts b/packages/cli/scripts/sendPingTest.ts
@@ -5,7 +5,7 @@ import {
   fromHexString,
   getContentId,
   getContentKey,
-  ContentType,
+  HistoryNetworkContentType,
   ProtocolId,
   toHexString,
 } from 'portalnetwork'