Rename BeaconLightClientNetwork to BeaconNetwork (#745)

Author: acolytec3

packages/browser-client/src/portalClient.ts

@@ -68,14 +68,14 @@ export async function createNodeFromScratch(state: AppState): Promise<Ultralight
         bootnodes: bns,
         db: state.LDB as any,
         transport: TransportLayer.MOBILE,
-        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconLightClientNetwork],
+        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconNetwork],
       })
     : await UltralightProvider.create('', {
         proxyAddress: state.proxy,
         bootnodes: bns,
         db: state.LDB as any,
         transport: TransportLayer.WEB,
-        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconLightClientNetwork],
+        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconNetwork],
       })
   await startUp(provider)
   return provider
@@ -88,15 +88,15 @@ export async function createNodeFromStorage(state: AppState): Promise<Ultralight
         db: state.LDB as any,
         rebuildFromMemory: true,
         transport: TransportLayer.MOBILE,
-        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconLightClientNetwork],
+        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconNetwork],
       })
     : await UltralightProvider.create('', {
         proxyAddress: state.proxy,
         bootnodes: bns,
         db: state.LDB as any,
         rebuildFromMemory: true,
         transport: TransportLayer.WEB,
-        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconLightClientNetwork],
+        supportedNetworks: [NetworkId.HistoryNetwork, NetworkId.BeaconNetwork],
       })
   await startUp(provider)
   return provider

packages/cli/networks.md

@@ -23,32 +23,32 @@ To experiment with the Beacon Light Client Network, do the following:
 - Observe the logs.  If all goes well, you should see something like below eventually, which indicates that the embedded Lodestar light client has begun tracking the head of the chain and will continue to do so as long as new updates are piped in.
 
 ```sh
-  13527:Portal:BeaconLightClientNetwork:LightClientTransport Found LightClientBootstrap locally.  Initializing light client... +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Syncing +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { lastPeriod: 945, currentPeriod: 947 } +1ms
-  13527:Portal:BeaconLightClientNetwork:LightClientTransport requesting lightClientUpdatesByRange starting with period 945 and count 3 +15ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Updated state.optimisticHeader +19ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7743724 } +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG processed sync update +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7743724 } +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Updated state.optimisticHeader +21ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7749758 } +0ms
+  13527:Portal:Beacon:LightClientTransport Found LightClientBootstrap locally.  Initializing light client... +0ms
+  13527:Portal:Beacon:LightClient:DEBUG Syncing +0ms
+  13527:Portal:Beacon:LightClient:DEBUG { lastPeriod: 945, currentPeriod: 947 } +1ms
+  13527:Portal:Beacon:LightClientTransport requesting lightClientUpdatesByRange starting with period 945 and count 3 +15ms
+  13527:Portal:Beacon:LightClient:DEBUG Updated state.optimisticHeader +19ms
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7743724 } +0ms
+  13527:Portal:Beacon:LightClient:DEBUG processed sync update +0ms
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7743724 } +0ms
+  13527:Portal:Beacon:LightClient:DEBUG Updated state.optimisticHeader +21ms
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7749758 } +0ms
   ```
  ...
  ```sh
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7757824 } +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG processed sync update +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7757893 } +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Synced +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { currentPeriod: 947 } +0ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Started tracking the head +1ms
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7757824 } +0ms
+  13527:Portal:Beacon:LightClient:DEBUG processed sync update +0ms
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7757893 } +0ms
+  13527:Portal:Beacon:LightClient:DEBUG Synced +0ms
+  13527:Portal:Beacon:LightClient:DEBUG { currentPeriod: 947 } +0ms
+  13527:Portal:Beacon:LightClient:DEBUG Started tracking the head +1ms
   ultralight Received portal_beaconStore with params: 0: 0x03f67e760000000000,1: 0xbba4da96ac000000ffffffffffff7fffffffffffffffffffffffffffffffff... +14s
-  13527:Portal:BeaconLightClientNetwork storing LightClientOptimisticUpdate content corresponding to 0x03f67e760000000000 +14s
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Updated state.optimisticHeader +14s
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG { slot: 7765749 } +0ms
+  13527:Portal:Beacon storing LightClientOptimisticUpdate content corresponding to 0x03f67e760000000000 +14s
+  13527:Portal:Beacon:LightClient:DEBUG Updated state.optimisticHeader +14s
+  13527:Portal:Beacon:LightClient:DEBUG { slot: 7765749 } +0ms
   ultralight Received portal_beaconStore with params: 0: 0x02a07e760000000000,1: 0xbba4da9670010000ad040000f5b30300000000000000000000000000000000... +429ms
-  13527:Portal:BeaconLightClientNetwork storing LightClientFinalityUpdate content corresponding to 0x02a07e760000000000 +428ms
-  13527:Portal:BeaconLightClientNetwork:LightClient:DEBUG Updated state.finalizedHeader +429ms
+  13527:Portal:Beacon storing LightClientFinalityUpdate content corresponding to 0x02a07e760000000000 +428ms
+  13527:Portal:Beacon:LightClient:DEBUG Updated state.finalizedHeader +429ms
   ```
 
 You can also call the RPC methods `beacon_getHead` and `beacon_getFinalized` to get the latest Light Client Headers for `latest` and `finalized` blocks known to the light client.

packages/cli/scripts/beaconBridge.ts

@@ -7,7 +7,7 @@ import { ForkName } from '@lodestar/params'
 import { ssz } from '@lodestar/types'
 import jayson from 'jayson/promise/index.js'
 import {
-  BeaconLightClientNetworkContentType,
+  BeaconNetworkContentType,
   LightClientBootstrapKey,
   LightClientFinalityUpdateKey,
   LightClientOptimisticUpdateKey,
@@ -35,7 +35,7 @@ const main = async () => {
     `Retrieved latest optimistic update for slot ${BigInt(optimisticUpdate.signatureSlot)}`,
   )
   const optimisticUpdateKey = getBeaconContentKey(
-    BeaconLightClientNetworkContentType.LightClientOptimisticUpdate,
+    BeaconNetworkContentType.LightClientOptimisticUpdate,
     LightClientOptimisticUpdateKey.serialize({
       signatureSlot: BigInt(optimisticUpdate.signatureSlot),
     }),
@@ -59,7 +59,7 @@ const main = async () => {
   }
   const serializedRange = LightClientUpdatesByRange.serialize(range)
   const rangeKey = getBeaconContentKey(
-    BeaconLightClientNetworkContentType.LightClientUpdatesByRange,
+    BeaconNetworkContentType.LightClientUpdatesByRange,
     LightClientUpdatesByRangeKey.serialize({ startPeriod: BigInt(oldPeriod), count: 3n }),
   )
   const bootstrapSlot = updatesByRange[0].data.finalized_header.beacon.slot
@@ -78,7 +78,7 @@ const main = async () => {
   )
   const res = await ultralight.request('portal_beaconStore', [
     getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientBootstrap,
+      BeaconNetworkContentType.LightClientBootstrap,
       LightClientBootstrapKey.serialize({ blockHash: hexToBytes(bootstrapRoot) }),
     ),
     bytesToHex(
@@ -122,7 +122,7 @@ const main = async () => {
         .data,
     )
     const optimisticUpdateKey = getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientOptimisticUpdate,
+      BeaconNetworkContentType.LightClientOptimisticUpdate,
       LightClientOptimisticUpdateKey.serialize({
         signatureSlot: BigInt(optimisticUpdate.signatureSlot),
       }),
@@ -144,7 +144,7 @@ const main = async () => {
       (await (await fetch(beaconNode + 'eth/v1/beacon/light_client/finality_update')).json()).data,
     )
     const finalityUpdateKey = getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientFinalityUpdate,
+      BeaconNetworkContentType.LightClientFinalityUpdate,
       LightClientFinalityUpdateKey.serialize({
         finalitySlot: BigInt(finalityUpdate.finalizedHeader.beacon.slot),
       }),

packages/cli/scripts/bootstrapFinder.ts

@@ -6,7 +6,7 @@ import { computeSyncPeriodAtSlot } from '@lodestar/light-client/utils'
 import { ssz } from '@lodestar/types'
 import jayson from 'jayson/promise/index.js'
 import {
-  BeaconLightClientNetworkContentType,
+  BeaconNetworkContentType,
   LightClientBootstrapKey,
   LightClientOptimisticUpdateKey,
   LightClientUpdatesByRange,
@@ -37,7 +37,7 @@ const main = async () => {
   console.log('Retrieving bootstrap and updates from Beacon node...')
   const optimisticUpdate = (await api.lightclient.getOptimisticUpdate()).response!
   const optimisticUpdateKey = getBeaconContentKey(
-    BeaconLightClientNetworkContentType.LightClientOptimisticUpdate,
+    BeaconNetworkContentType.LightClientOptimisticUpdate,
     LightClientOptimisticUpdateKey.serialize({
       signatureSlot: BigInt(optimisticUpdate.data.attestedHeader.beacon.slot),
     }),
@@ -61,7 +61,7 @@ const main = async () => {
   }
   const serializedRange = LightClientUpdatesByRange.serialize(range)
   const rangeKey = getBeaconContentKey(
-    BeaconLightClientNetworkContentType.LightClientUpdatesByRange,
+    BeaconNetworkContentType.LightClientUpdatesByRange,
     LightClientUpdatesByRangeKey.serialize({ startPeriod: BigInt(oldPeriod), count: 4n }),
   )
   for (let x = 0; x < 4; x++) {
@@ -73,7 +73,7 @@ const main = async () => {
     const bootstrap = (await api.lightclient.getBootstrap(bootstrapRoot)).response!
     await ultralights[Math.floor(Math.random() * 10)].request('portal_beaconStore', [
       getBeaconContentKey(
-        BeaconLightClientNetworkContentType.LightClientBootstrap,
+        BeaconNetworkContentType.LightClientBootstrap,
         LightClientBootstrapKey.serialize({ blockHash: hexToBytes(bootstrapRoot) }),
       ),
       bytesToHex(
@@ -140,7 +140,7 @@ const main = async () => {
     const optimisticUpdate = (await api.lightclient.getOptimisticUpdate()).response!
     console.log('new update')
     const optimisticUpdateKey = getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientOptimisticUpdate,
+      BeaconNetworkContentType.LightClientOptimisticUpdate,
       LightClientOptimisticUpdateKey.serialize({
         signatureSlot: BigInt(optimisticUpdate.data.attestedHeader.beacon.slot),
       }),

packages/cli/scripts/postCapellaBlockBridge.ts

@@ -4,7 +4,7 @@ import { Common } from '@ethereumjs/common'
 import { ssz, sszTypesFor } from '@lodestar/types'
 import jayson from 'jayson/promise/index.js'
 import {
-  BeaconLightClientNetworkContentType,
+  BeaconNetworkContentType,
   BlockHeaderWithProof,
   getBeaconContentKey,
   getContentKey,
@@ -55,7 +55,7 @@ const main = async () => {
     `Retrieved latest optimistic update for slot ${BigInt(optimisticUpdate.signatureSlot)}`,
   )
   const optimisticUpdateKey = getBeaconContentKey(
-    BeaconLightClientNetworkContentType.LightClientOptimisticUpdate,
+    BeaconNetworkContentType.LightClientOptimisticUpdate,
     LightClientOptimisticUpdateKey.serialize({
       signatureSlot: BigInt(optimisticUpdate.signatureSlot),
     }),
@@ -86,7 +86,7 @@ const main = async () => {
   let res = await ultralight.request('portal_beaconStore', [
     bytesToHex(
       getBeaconContentKey(
-        BeaconLightClientNetworkContentType.LightClientBootstrap,
+        BeaconNetworkContentType.LightClientBootstrap,
         LightClientBootstrapKey.serialize({ blockHash: hexToBytes(bootstrapRoot) }),
       ),
     ),
@@ -126,7 +126,7 @@ const main = async () => {
   res = await ultralight.request('portal_beaconStore', [
     bytesToHex(
       getBeaconContentKey(
-        BeaconLightClientNetworkContentType.HistoricalSummaries,
+        BeaconNetworkContentType.HistoricalSummaries,
         HistoricalSummariesKey.serialize({ epoch: BigInt(finalityEpoch) }),
       ),
     ),

packages/cli/src/rpc/modules/beacon.ts

@@ -2,8 +2,8 @@ import { hexToBytes } from '@ethereumjs/util'
 import { RunStatusCode } from '@lodestar/light-client'
 import { ssz } from '@lodestar/types'
 import {
-  type BeaconLightClientNetwork,
-  BeaconLightClientNetworkContentType,
+  type BeaconNetwork,
+  BeaconNetworkContentType,
   ContentLookup,
   LightClientUpdatesByRangeKey,
   NetworkId,
@@ -24,14 +24,14 @@ const methods = ['beacon_getHead', 'beacon_getFinalized', 'beacon_getLightClient
  * @memberof module:rpc/modules
  */
 export class beacon {
-  private _beacon: BeaconLightClientNetwork
+  private _beacon: BeaconNetwork
   private logger: Debugger
   /**
    * Create beacon_* RPC module
    * @param rpcManager RPC client to which the module binds
    */
   constructor(client: PortalNetwork, logger: Debugger) {
-    this._beacon = client.networks.get(NetworkId.BeaconChainNetwork) as BeaconLightClientNetwork
+    this._beacon = client.networks.get(NetworkId.BeaconChainNetwork) as BeaconNetwork
     this.logger = logger.extend('beacon')
 
     this.methods = middleware(this.methods.bind(this), 0, [])
@@ -89,7 +89,7 @@ export class beacon {
   async getLightClientUpdate(params: [string]) {
     const period = Number(BigInt(params[0]))
     const rangeKey = getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientUpdate,
+      BeaconNetworkContentType.LightClientUpdate,
       hexToBytes(computeLightClientKeyFromPeriod(period)),
     )
     const update = await this._beacon.retrieve(rangeKey)
@@ -101,7 +101,7 @@ export class beacon {
     const lookup = new ContentLookup(
       this._beacon,
       getBeaconContentKey(
-        BeaconLightClientNetworkContentType.LightClientUpdatesByRange,
+        BeaconNetworkContentType.LightClientUpdatesByRange,
         LightClientUpdatesByRangeKey.serialize({ startPeriod: BigInt(params[0]), count: 1n }),
       ),
     )

packages/cli/src/rpc/modules/portal.ts

@@ -7,7 +7,7 @@ import {
   FoundContent,
   NetworkId,
   NodeLookup,
-  shortId
+  shortId,
 } from 'portalnetwork'
 
 import { BEACON_CLIENT_NOT_INITIALIZED, CONTENT_NOT_FOUND, INVALID_PARAMS } from '../error-code.js'
@@ -16,12 +16,7 @@ import { callWithStackTrace, isValidId } from '../util.js'
 import { middleware, validators } from '../validators.js'
 
 import type { Debugger } from 'debug'
-import type {
-  BeaconLightClientNetwork,
-  HistoryNetwork,
-  PortalNetwork,
-  StateNetwork,
-} from 'portalnetwork'
+import type { BeaconNetwork, HistoryNetwork, PortalNetwork, StateNetwork } from 'portalnetwork'
 import type { GetEnrResult } from '../schema/types.js'
 import { RunStatusCode } from '@lodestar/light-client'
 
@@ -89,16 +84,14 @@ const methods = [
 export class portal {
   private _client: PortalNetwork
   private _history: HistoryNetwork
-  private _beacon: BeaconLightClientNetwork
+  private _beacon: BeaconNetwork
   private _state: StateNetwork
   private logger: Debugger
 
   constructor(client: PortalNetwork, logger: Debugger) {
     this._client = client
     this._history = this._client.networks.get(NetworkId.HistoryNetwork) as HistoryNetwork
-    this._beacon = this._client.networks.get(
-      NetworkId.BeaconChainNetwork,
-    ) as BeaconLightClientNetwork
+    this._beacon = this._client.networks.get(NetworkId.BeaconChainNetwork) as BeaconNetwork
     this._state = this._client.networks.get(NetworkId.StateNetwork) as StateNetwork
     this.logger = logger
     this.methods = middleware(this.methods.bind(this), 0, [])
@@ -1189,29 +1182,39 @@ export class portal {
 
   async beaconOptimisticStateRoot(params: []): Promise<string> {
     this.logger(`beaconOptimisticStateRoot request received`)
-    if (this._beacon.lightClient?.status === RunStatusCode.uninitialized || this._beacon.lightClient?.status === RunStatusCode.stopped) {
+    if (
+      this._beacon.lightClient?.status === RunStatusCode.uninitialized ||
+      this._beacon.lightClient?.status === RunStatusCode.stopped
+    ) {
       const error = {
         code: BEACON_CLIENT_NOT_INITIALIZED,
         message: 'beacon client not initialized',
       }
       throw error
     }
     const res = await this._beacon.lightClient?.getHead()
-    this.logger(`beaconOptimisticStateRoot request returned ${res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'}`)
+    this.logger(
+      `beaconOptimisticStateRoot request returned ${res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'}`,
+    )
     return res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'
   }
 
   async beaconFinalizedStateRoot(params: []): Promise<string> {
     this.logger(`beaconFinalizedStateRoot request received`)
-    if (this._beacon.lightClient?.status === RunStatusCode.uninitialized || this._beacon.lightClient?.status === RunStatusCode.stopped) {
+    if (
+      this._beacon.lightClient?.status === RunStatusCode.uninitialized ||
+      this._beacon.lightClient?.status === RunStatusCode.stopped
+    ) {
       const error = {
         code: BEACON_CLIENT_NOT_INITIALIZED,
         message: 'beacon client not initialized',
       }
       throw error
     }
     const res = await this._beacon.lightClient?.getFinalized()
-    this.logger(`beaconFinalizedStateRoot request returned ${res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'}`)
+    this.logger(
+      `beaconFinalizedStateRoot request returned ${res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'}`,
+    )
     return res !== undefined ? bytesToHex(res?.beacon.stateRoot) : '0x'
   }
 

packages/cli/src/rpc/modules/ultralight.ts

@@ -5,12 +5,7 @@ import { INTERNAL_ERROR } from '../error-code.js'
 import { middleware, validators } from '../validators.js'
 
 import type { Debugger } from 'debug'
-import type {
-  BeaconLightClientNetwork,
-  HistoryNetwork,
-  PortalNetwork,
-  StateNetwork,
-} from 'portalnetwork'
+import type { BeaconNetwork, HistoryNetwork, PortalNetwork, StateNetwork } from 'portalnetwork'
 
 const methods = [
   'ultralight_methods',
@@ -28,7 +23,7 @@ export class ultralight {
   private _client: PortalNetwork
   private _history?: HistoryNetwork
   private _state?: StateNetwork
-  private _beacon?: BeaconLightClientNetwork
+  private _beacon?: BeaconNetwork
   private logger: Debugger
 
   constructor(client: PortalNetwork, logger: Debugger) {

packages/cli/test/rpc/beacon/getLightClientUpdate.spec.ts

@@ -2,7 +2,7 @@ import { bytesToHex, hexToBytes } from '@ethereumjs/util'
 import { computeSyncPeriodAtSlot } from '@lodestar/light-client/utils'
 import { ssz } from '@lodestar/types'
 import {
-  BeaconLightClientNetworkContentType,
+  BeaconNetworkContentType,
   computeLightClientKeyFromPeriod,
   getBeaconContentKey,
 } from 'portalnetwork'
@@ -15,7 +15,7 @@ describe(`${method} tests`, () => {
     const { ultralight, rpc } = await startRpc()
     const rangeJson = require('./range.json')[0]
     const rangeKey = getBeaconContentKey(
-      BeaconLightClientNetworkContentType.LightClientUpdate,
+      BeaconNetworkContentType.LightClientUpdate,
       hexToBytes(
         computeLightClientKeyFromPeriod(
           computeSyncPeriodAtSlot(Number(rangeJson.data.attested_header.beacon.slot)),