Client: Rename lib to src Folder (ethereumjs#2722)

* Client: rename lib -> src folder

* Client: rename lib references to src

* Fix Karma tests

* fix linter and ts config

---------

Co-authored-by: acolytec3 <[email protected]>
Co-authored-by: acolytec3 <[email protected]>

Author: holgerd77

packages/block/test/eip4844block.spec.ts

@@ -19,7 +19,7 @@ import type { TypedTransaction } from '@ethereumjs/tx'
 // Hack to detect if running in browser or not
 const isBrowser = new Function('try {return this===window;}catch(e){ return false;}')
 
-if (isBrowser() === false) initKZG(kzg, __dirname + '/../../client/lib/trustedSetups/devnet4.txt')
+if (isBrowser() === false) initKZG(kzg, __dirname + '/../../client/src/trustedSetups/devnet4.txt')
 const gethGenesis = require('./testdata/4844-hardfork.json')
 const common = Common.fromGethGenesis(gethGenesis, {
   chain: 'customChain',

packages/client/.c8rc.json

@@ -1,4 +1,4 @@
 {
   "extends": "../../config/.c8rc.json",
-  "include": ["lib/**/*.ts"]
+  "include": ["src/**/*.ts"]
 }

packages/client/.eslintrc.js

@@ -5,7 +5,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['bin/**.ts'],
+      files: ['bin/**.ts', 'test/sim/**.ts'],
       rules: {
         'no-console': 'off',
       },

packages/client/bin/cli.ts

@@ -24,18 +24,18 @@ import * as readline from 'readline'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 
-import { EthereumClient } from '../lib/client'
-import { Config, DataDirectory, SyncMode } from '../lib/config'
-import { LevelDB } from '../lib/execution/level'
-import { getLogger } from '../lib/logging'
-import { Event } from '../lib/types'
-import { parseMultiaddrs } from '../lib/util'
+import { EthereumClient } from '../src/client'
+import { Config, DataDirectory, SyncMode } from '../src/config'
+import { LevelDB } from '../src/execution/level'
+import { getLogger } from '../src/logging'
+import { Event } from '../src/types'
+import { parseMultiaddrs } from '../src/util'
 
 import { helprpc, startRPCServers } from './startRpc'
 
-import type { Logger } from '../lib/logging'
-import type { FullEthereumService } from '../lib/service'
-import type { ClientOpts } from '../lib/types'
+import type { Logger } from '../src/logging'
+import type { FullEthereumService } from '../src/service'
+import type { ClientOpts } from '../src/types'
 import type { RPCArgs } from './startRpc'
 import type { BlockBytes } from '@ethereumjs/block'
 import type { GenesisState } from '@ethereumjs/blockchain'
@@ -658,7 +658,7 @@ async function run() {
 
   // TODO sharding: Just initialize kzg library now, in future it can be optimized to be
   // loaded and initialized on the sharding hardfork activation
-  initKZG(kzg, __dirname + '/../lib/trustedSetups/devnet4.txt')
+  initKZG(kzg, __dirname + '/../src/trustedSetups/devnet4.txt')
   // Give network id precedence over network name
   const chain = args.networkId ?? args.network ?? Chain.Mainnet
 

packages/client/bin/startRpc.ts

@@ -2,17 +2,17 @@ import { hexStringToBytes, randomBytes } from '@ethereumjs/util'
 import { bytesToHex } from 'ethereum-cryptography/utils'
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs'
 
-import { RPCManager, saveReceiptsMethods } from '../lib/rpc'
-import * as modules from '../lib/rpc/modules'
+import { RPCManager, saveReceiptsMethods } from '../src/rpc'
+import * as modules from '../src/rpc/modules'
 import {
   MethodConfig,
   createRPCServer,
   createRPCServerListener,
   createWsRPCServerListener,
-} from '../lib/util'
+} from '../src/util'
 
-import type { EthereumClient } from '../lib/client'
-import type { Config } from '../lib/config'
+import type { EthereumClient } from '../src/client'
+import type { Config } from '../src/config'
 import type { Server as RPCServer } from 'jayson/promise'
 
 export type RPCArgs = {

packages/client/browser/index.ts

@@ -3,48 +3,48 @@ import { Chain, Common } from '@ethereumjs/common'
 import debug from 'debug'
 import { Level } from 'level'
 
-import { EthereumClient } from '../lib/client'
-import { Config } from '../lib/config'
-import { LevelDB } from '../lib/execution/level'
-import { parseMultiaddrs } from '../lib/util'
+import { EthereumClient } from '../src/client'
+import { Config } from '../src/config'
+import { LevelDB } from '../src/execution/level'
+import { parseMultiaddrs } from '../src/util'
 
 import { getLogger } from './logging'
 // Blockchain
-export * from '../lib/blockchain/chain'
+export * from '../src/blockchain/chain'
 
 // Peer
-export * from '../lib/net/peer/libp2ppeer'
-export * from '../lib/net/peer/peer'
+export * from '../src/net/peer/libp2ppeer'
+export * from '../src/net/peer/peer'
 export * from './libp2pnode'
 
 // Peer Pool
-export * from '../lib/net/peerpool'
+export * from '../src/net/peerpool'
 
 // Protocol
-export * from '../lib/net/protocol/ethprotocol'
-export * from '../lib/net/protocol/flowcontrol'
-export * from '../lib/net/protocol/lesprotocol'
-export * from '../lib/net/protocol/protocol'
+export * from '../src/net/protocol/ethprotocol'
+export * from '../src/net/protocol/flowcontrol'
+export * from '../src/net/protocol/lesprotocol'
+export * from '../src/net/protocol/protocol'
 
 // Server
-export * from '../lib/net/server/libp2pserver'
-export * from '../lib/net/server/server'
+export * from '../src/net/server/libp2pserver'
+export * from '../src/net/server/server'
 
 // EthereumClient
-export * from '../lib/client'
+export * from '../src/client'
 
 // Service
-export * from '../lib/service/fullethereumservice'
-export * from '../lib/service/lightethereumservice'
-export * from '../lib/service/service'
+export * from '../src/service/fullethereumservice'
+export * from '../src/service/lightethereumservice'
+export * from '../src/service/service'
 
 // Synchronizer
-export * from '../lib/sync/fullsync'
-export * from '../lib/sync/lightsync'
-export * from '../lib/sync/sync'
+export * from '../src/sync/fullsync'
+export * from '../src/sync/lightsync'
+export * from '../src/sync/sync'
 
 // Utilities
-export * from '../lib/util/parse'
+export * from '../src/util/parse'
 
 // Logging
 export * from './logging'

packages/client/browser/util/index.ts

@@ -6,7 +6,7 @@ import { platform } from 'os'
 
 import { version as packageVersion } from '../../package.json'
 
-export * from '../../lib/util/parse'
+export * from '../../src/util/parse'
 
 export function short(bytes: Uint8Array | string): string {
   if (bytes === null || bytes === undefined || bytes === '') return ''

packages/client/devnets/4844-interop/tools/txGenerator.ts

@@ -21,7 +21,7 @@ const input = process.argv[3] // text to generate blob from
 const genesisJson = require(process.argv[4]) // Genesis parameters
 const pkey = hexStringToBytes(process.argv[5]) // private key of tx sender as unprefixed hex string
 
-initKZG(kzg, __dirname + '/../../../lib/trustedSetups/devnet4.txt')
+initKZG(kzg, __dirname + '/../../../src/trustedSetups/devnet4.txt')
 
 const sender = Address.fromPrivateKey(pkey)
 const common = Common.fromGethGenesis(genesisJson, {

packages/client/karma.conf.js

@@ -2,7 +2,7 @@ module.exports = function (config) {
   config.set({
     frameworks: ['karma-typescript', 'tap'],
 
-    files: ['lib/**/*.ts', 'test/blockchain/chain.spec.ts'],
+    files: ['src/**/*.ts', 'test/blockchain/chain.spec.ts'],
 
     preprocessors: {
       '**/*.ts': ['karma-typescript'],

packages/client/package.json

@@ -20,9 +20,9 @@
   },
   "license": "MPL-2.0",
   "author": "Vinay Pulim ([email protected])",
-  "main": "dist/lib/index.js",
+  "main": "dist/src/index.js",
   "browser": "dist/bundle.js",
-  "types": "dist/lib/index.d.ts",
+  "types": "dist/src/index.d.ts",
   "bin": {
     "ethereumjs": "dist/bin/cli.js"
   },
@@ -31,7 +31,7 @@
   ],
   "scripts": {
     "binWorkaround": "test -f dist/bin/cli.js || echo 'install fails if bin script does not exist (https://github.com/npm/cli/issues/2632), creating placeholder file at \"dist/bin/cli.js\"' && mkdir -p 'dist/bin' && touch dist/bin/cli.js",
-    "build": "npm run build:common && mkdir -p ./lib/trustedSetup/ && cp -Rf ./lib/trustedSetups ./dist/lib/",
+    "build": "npm run build:common && mkdir -p ./src/trustedSetup/ && cp -Rf ./src/trustedSetups ./dist/src/",
     "build:browser": "../../config/cli/ts-build.sh browser && npm run bundle && rm -rf dist.browser",
     "build:common": "../../config/cli/ts-build.sh",
     "bundle": "webpack",