Correct web3-eth2- packages types

CHANGELOG.md

@@ -309,14 +309,14 @@ Released with 1.0.0-beta.37 code base.
 - Grammar changes to inputAddressFormatter error message
 - Fixed vulnerable dependencies
 
-## [Unreleased]
-
 ## [1.3.2]
 
 ### Fixed
 
 - Fix EIP-1193 provider subscriptions (#3864)
 
+## [Unreleased]
+
 ## [1.3.3]
 
 ### Changed
@@ -326,7 +326,19 @@ Released with 1.0.0-beta.37 code base.
 - Rename `web3-eth2-base` to `web3-eth2-core` and `web3-eth2-beacon` to `web3-eth2-beaconchain`
 - Bump `ts-node` from version `^8.10.2` to `^9.0.0`
 - Ran `npm audit fix` which fixed 4 vulnerabilities
-- Correct `web3-eth2-beaconchain` type declarations
+- Correct `web3-eth2-beaconchain` type declarations (#3859) and (#3865)
+- Move interfaces `IBaseAPISchema` and `IBaseAPIMethodSchema` to `index.d.ts` for `web3-eth2-core`
+- Removes `IETH2BeaconChain` interface in favor of exporting a class type: `ETH2BeaconChain`
+- Remove `index.d.ts` files in favor of `types.ts` for `web3-eth2-core` and `web3-eth2-beaconchain`
+- Update dependencies for `web3-eth2-core`
+
+### Removed
+
+- `schema.ts` from `web3-eth2-core`
 
 ### Added
-- Deprecation of bzz warning
+
+- Add `ETH2Core` class export to `index.d.ts` for `web3-eth2-core`
+- Deprecation of bzz warning
+
+## [1.3.4]

packages/web3-eth2-beaconchain/src/index.ts

@@ -1,18 +1,14 @@
-// @ts-ignore - types not full implemented yet
-import { ETH2Core } from 'web3-eth2-core'
+import { ETH2Core, BaseAPISchema, ETH2BaseOpts } from 'web3-eth2-core'
 import { DefaultSchema } from './schema'
 
-import { IETH2BeaconChain } from '../types/index'
-// @ts-ignore - types not full implemented yet
-import { IBaseAPISchema } from 'web3-eth2-core'
-// @ts-ignore - types not full implemented yet
-import { ETH2BaseOpts } from 'web3-eth2-core'
+import { ETH2BeaconChain as IETH2BeaconChain } from '../types'
 
 // @ts-ignore - ETH2BeaconChain incorrectly implements interface IETH2BeaconChain
+// because methods are added during runtime
 export class ETH2BeaconChain extends ETH2Core implements IETH2BeaconChain {
     constructor(
         provider: string,
-        schema: IBaseAPISchema = DefaultSchema,
+        schema: BaseAPISchema = DefaultSchema,
         opts: ETH2BaseOpts = { protectProvider: true }) {
         super(provider, schema, opts)
     }

packages/web3-eth2-beaconchain/tsconfig.json

@@ -1,62 +1,21 @@
 {
   "compilerOptions": {
-    /* Basic Options */
-    "target": "esnext",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "lib",                          /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true,     /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-
-    /* Source Map Options */
-    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    // "declarationDir": "lib"                /* Output directory for generated declaration files. */
+    "declaration": true,
+    "outDir": "lib",
+    "strict": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "lib": ["es6"],
+    "target": "es6",
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true,
+    "allowSyntheticDefaultImports": false,
+    "baseUrl": ".",
+    "paths": {
+        "web3-eth2-beaconchain": ["."]
+    }
   }
 }

packages/web3-eth2-beaconchain/types.ts

@@ -0,0 +1,47 @@
+import {
+    Slot,
+    Root,
+    Genesis,
+    Fork,
+    FinalityCheckpoints,
+    Validator,
+    ValidatorResponse,
+    ValidatorBalance,
+    Epoch,
+    BeaconCommitteeResponse,
+    SignedBeaconHeaderResponse,
+    Attestation,
+    CommitteeIndex,
+    IndexedAttestation,
+    ProposerSlashing,
+    SignedVoluntaryExit
+  } from '@chainsafe/lodestar-types'
+
+  export type StateId = 'head' | 'genesis' | 'finalized' | 'justified' | Slot | Root
+  export type BlockId = 'head' | 'genesis' | 'finalized' | Slot | Root
+
+  export interface ETH2BeaconChain {
+    getGenesis(): Promise<Genesis | null>
+    getHashRoot(params: {stateId: StateId}): Promise<{ root: Root }>
+    getForkData(params: {stateId: StateId}): Promise<Fork>
+    getFinalityCheckpoint(params: {stateId: StateId}): Promise<FinalityCheckpoints>
+    getValidators(params: {stateId: StateId}): Promise<Validator[]>
+    getValidatorById(params: {stateId: StateId, validatorId: string}): Promise<ValidatorResponse>
+    getValidatorBalances(params: {stateId: StateId}): Promise<ValidatorBalance>
+    getEpochCommittees(params: {stateId: StateId, epoch: Epoch}): Promise<BeaconCommitteeResponse>
+    getBlockHeaders(): Promise<SignedBeaconHeaderResponse[]>
+    getBlockHeader(params: {blockId: BlockId}): Promise<SignedBeaconHeaderResponse>
+    publishSignedBlock(): Promise<void>
+    getBlock(params: {blockId: BlockId}): Promise<SignedBeaconHeaderResponse>
+    getBlockRoot(params: {blockId: BlockId}): Promise<Root>
+    getBlockAttestations(params: {blockId: BlockId}): Promise<Attestation>
+    getAttestationsFromPool(params: {slot: Slot, committee_index: CommitteeIndex}): Promise<Attestation[]>
+    submitAttestation(): Promise<void>
+    getAttesterSlashings(): Promise<{ [index: string]: IndexedAttestation }>
+    submitAttesterSlashings(): Promise<void>
+    getProposerSlashings(): Promise<ProposerSlashing[]>
+    submitProposerSlashings(): Promise<void>
+    getSignedVoluntaryExits(): Promise<SignedVoluntaryExit[]>
+    submitVoluntaryExit(): Promise<void>
+  }
+

packages/web3-eth2-core/package.json

@@ -15,11 +15,11 @@
     },
     "main": "lib/index.js",
     "dependencies": {
-        "axios": "^0.20.0"
+        "axios": "^0.21.1"
     },
     "devDependencies": {
         "@types/jest": "^26.0.14",
-        "@types/node": "^14.11.8",
+        "@types/node": "^14.14.22",
         "dtslint": "^3.4.1",
         "jest": "^26.5.3",
         "ts-jest": "^26.4.1",

packages/web3-eth2-core/src/index.ts

@@ -2,8 +2,7 @@ import Axios, {AxiosInstance} from 'axios'
 
 Axios.defaults.adapter = require('axios/lib/adapters/http');
 
-import { ETH2BaseOpts, ETH2Function } from '../types/index'
-import { IBaseAPISchema } from './schema'
+import { ETH2BaseOpts, ETH2Function, BaseAPISchema } from '../types'
 
 export class ETH2Core {
     private _httpClient: AxiosInstance
@@ -14,7 +13,7 @@ export class ETH2Core {
     provider: string
     protectProvider: boolean // Protects from global overwrite when using .use functionality
 
-    constructor(provider: string, schema: IBaseAPISchema, opts: ETH2BaseOpts = {}) {
+    constructor(provider: string, schema: BaseAPISchema, opts: ETH2BaseOpts = {}) {
         this.name = schema.packageName
         this.setProvider(`${provider}${schema.routePrefix}`)
         this.protectProvider = opts.protectProvider || false
@@ -63,13 +62,14 @@ export class ETH2Core {
         }
     }
 
-    private buildAPIWrappersFromSchema(schema: IBaseAPISchema) {
+    private buildAPIWrappersFromSchema(schema: BaseAPISchema) {
         for (const method of schema.methods) {
             this[method.name] = async (routeParameters: any, queryParameters: any = {}): Promise<any> => {
                 try {
                     if (method.inputFormatter) queryParameters = method.inputFormatter(queryParameters)
 
                     const computedRoute = this.routeBuilder(method.route, routeParameters)
+                    // @ts-ignore
                     let {data} = await this._httpClient[method.restMethod](computedRoute, { params: queryParameters })
                     if (data.data) data = data.data
 

packages/web3-eth2-core/tsconfig.json

@@ -1,9 +1,21 @@
 {
-  "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "outDir": "./lib"
+    "outDir": "./lib",
+    "module": "commonjs",
+        "lib": ["es6"],
+        "target": "es6",
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "noEmit": true,
+        "allowSyntheticDefaultImports": false,
+        "baseUrl": ".",
+        "paths": {
+            "web3-eth2-core": ["."]
+        }
   },
   "include": [
     "src"
-  ]
+, "types.ts"  ]
  }