Geth "Miner and DAG" management API's implemented (web3-eth-miner)

packages/web3-core-method/src/index.js

@@ -118,3 +118,10 @@ export PostMethod from './methods/shh/PostMethod';
 export SetMaxMessageSizeMethod from './methods/shh/SetMaxMessageSizeMethod';
 export SetMinPoWMethod from './methods/shh/SetMinPoWMethod';
 export ShhVersionMethod from './methods/shh/ShhVersionMethod';
+
+// Miner
+export SetEtherBaseMethod from './methods/miner/SetEtherBaseMethod';
+export SetExtraMethod from './methods/miner/SetExtraMethod';
+export SetGasPriceMethod from './methods/miner/SetGasPriceMethod';
+export StartMinerMethod from './methods/miner/StartMinerMethod';
+export StopMinerMethod from './methods/miner/StopMinerMethod';

packages/web3-core-method/src/methods/miner/SetEtherBaseMethod.js

@@ -0,0 +1,36 @@
+/*
+    This file is part of web3.js.
+
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file SetEtherBaseMethod.js
+ * @author Prince Sinha <[email protected]>
+ * @date 2019
+ */
+
+import AbstractMethod from '../../../lib/methods/AbstractMethod';
+
+export default class SetEtherBaseMethod extends AbstractMethod {
+    /**
+     * @param {Utils} utils
+     * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
+     *
+     * @constructor
+     */
+    constructor(utils, formatters, moduleInstance) {
+        super('miner_setEtherbase', 1, utils, formatters, moduleInstance);
+    }
+}

packages/web3-core-method/src/methods/miner/SetExtraMethod.js

@@ -0,0 +1,36 @@
+/*
+    This file is part of web3.js.
+
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file SetExtraMethod.js
+ * @author Prince Sinha <[email protected]>
+ * @date 2019
+ */
+
+import AbstractMethod from '../../../lib/methods/AbstractMethod';
+
+export default class SetExtraMethod extends AbstractMethod {
+    /**
+     * @param {Utils} utils
+     * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
+     *
+     * @constructor
+     */
+    constructor(utils, formatters, moduleInstance) {
+        super('miner_setExtra', 1, utils, formatters, moduleInstance);
+    }
+}

packages/web3-core-method/src/methods/miner/SetGasPriceMethod.js

@@ -0,0 +1,36 @@
+/*
+    This file is part of web3.js.
+
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file SetGasPriceMethod.js
+ * @author Prince Sinha <[email protected]>
+ * @date 2019
+ */
+
+import AbstractMethod from '../../../lib/methods/AbstractMethod';
+
+export default class SetGasPriceMethod extends AbstractMethod {
+    /**
+     * @param {Utils} utils
+     * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
+     *
+     * @constructor
+     */
+    constructor(utils, formatters, moduleInstance) {
+        super('miner_setGasPrice', 1, utils, formatters, moduleInstance);
+    }
+}

packages/web3-core-method/src/methods/miner/StartMinerMethod.js

@@ -0,0 +1,36 @@
+/*
+    This file is part of web3.js.
+
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file StartMinerMethod.js
+ * @author Prince Sinha <[email protected]>
+ * @date 2019
+ */
+
+import AbstractMethod from '../../../lib/methods/AbstractMethod';
+
+export default class StartMinerMethod extends AbstractMethod {
+    /**
+     * @param {Utils} utils
+     * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
+     *
+     * @constructor
+     */
+    constructor(utils, formatters, moduleInstance) {
+        super('miner_start', 1, utils, formatters, moduleInstance);
+    }
+}

packages/web3-core-method/src/methods/miner/StopMinerMethod.js

@@ -0,0 +1,36 @@
+/*
+    This file is part of web3.js.
+
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file StopMinerMethod.js
+ * @author Prince Sinha <[email protected]>
+ * @date 2019
+ */
+
+import AbstractMethod from '../../../lib/methods/AbstractMethod';
+
+export default class StopMinerMethod extends AbstractMethod {
+    /**
+     * @param {Utils} utils
+     * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
+     *
+     * @constructor
+     */
+    constructor(utils, formatters, moduleInstance) {
+        super('miner_stop', 0, utils, formatters, moduleInstance);
+    }
+}

packages/web3-core-method/tests/src/methods/miner/SetEtherBaseMethodTest.js

@@ -0,0 +1,29 @@
+import {formatters} from 'web3-core-helpers';
+import AbstractMethod from '../../../../lib/methods/AbstractMethod';
+import SetEtherBaseMethod from '../../../../src/methods/miner/SetEtherBaseMethod';
+
+// Mocks
+jest.mock('web3-core-helpers');
+
+/**
+ * SetEtherBaseMethod test
+ */
+describe('SetEtherBaseMethodTest', () => {
+    let method;
+
+    beforeEach(() => {
+        method = new SetEtherBaseMethod(null, formatters, {});
+    });
+
+    it('constructor check', () => {
+        expect(method).toBeInstanceOf(AbstractMethod);
+
+        expect(method.rpcMethod).toEqual('miner_setEtherbase');
+
+        expect(method.parametersAmount).toEqual(1);
+
+        expect(method.utils).toEqual(null);
+
+        expect(method.formatters).toEqual(formatters);
+    });
+});

packages/web3-core-method/tests/src/methods/miner/SetExtraMethodTest.js

@@ -0,0 +1,29 @@
+import {formatters} from 'web3-core-helpers';
+import AbstractMethod from '../../../../lib/methods/AbstractMethod';
+import SetExtraMethod from '../../../../src/methods/miner/SetExtraMethod';
+
+// Mocks
+jest.mock('web3-core-helpers');
+
+/**
+ * SetExtraMethod test
+ */
+describe('SetExtraMethodTest', () => {
+    let method;
+
+    beforeEach(() => {
+        method = new SetExtraMethod(null, formatters, {});
+    });
+
+    it('constructor check', () => {
+        expect(method).toBeInstanceOf(AbstractMethod);
+
+        expect(method.rpcMethod).toEqual('miner_setExtra');
+
+        expect(method.parametersAmount).toEqual(1);
+
+        expect(method.utils).toEqual(null);
+
+        expect(method.formatters).toEqual(formatters);
+    });
+});

packages/web3-core-method/tests/src/methods/miner/SetGasPriceMethodTest.js

@@ -0,0 +1,29 @@
+import {formatters} from 'web3-core-helpers';
+import AbstractMethod from '../../../../lib/methods/AbstractMethod';
+import SetGasPriceMethod from '../../../../src/methods/miner/SetGasPriceMethod';
+
+// Mocks
+jest.mock('web3-core-helpers');
+
+/**
+ * SetGasPriceMethod test
+ */
+describe('SetGasPriceMethodTest', () => {
+    let method;
+
+    beforeEach(() => {
+        method = new SetGasPriceMethod(null, formatters, {});
+    });
+
+    it('constructor check', () => {
+        expect(method).toBeInstanceOf(AbstractMethod);
+
+        expect(method.rpcMethod).toEqual('miner_setGasPrice');
+
+        expect(method.parametersAmount).toEqual(1);
+
+        expect(method.utils).toEqual(null);
+
+        expect(method.formatters).toEqual(formatters);
+    });
+});

packages/web3-core-method/tests/src/methods/miner/StartMinerMethodTest.js

@@ -0,0 +1,29 @@
+import {formatters} from 'web3-core-helpers';
+import AbstractMethod from '../../../../lib/methods/AbstractMethod';
+import StartMinerMethod from '../../../../src/methods/miner/StartMinerMethod';
+
+// Mocks
+jest.mock('web3-core-helpers');
+
+/**
+ * StartMinerMethod test
+ */
+describe('StartMinerMethodTest', () => {
+    let method;
+
+    beforeEach(() => {
+        method = new StartMinerMethod(null, formatters, {});
+    });
+
+    it('constructor check', () => {
+        expect(method).toBeInstanceOf(AbstractMethod);
+
+        expect(method.rpcMethod).toEqual('miner_start');
+
+        expect(method.parametersAmount).toEqual(1);
+
+        expect(method.utils).toEqual(null);
+
+        expect(method.formatters).toEqual(formatters);
+    });
+});

packages/web3-core-method/tests/src/methods/miner/StopMinerMethodTest.js

@@ -0,0 +1,29 @@
+import {formatters} from 'web3-core-helpers';
+import AbstractMethod from '../../../../lib/methods/AbstractMethod';
+import StopMinerMethod from '../../../../src/methods/miner/StopMinerMethod';
+
+// Mocks
+jest.mock('web3-core-helpers');
+
+/**
+ * StopMinerMethod test
+ */
+describe('StopMinerMethodTest', () => {
+    let method;
+
+    beforeEach(() => {
+        method = new StopMinerMethod(null, formatters, {});
+    });
+
+    it('constructor check', () => {
+        expect(method).toBeInstanceOf(AbstractMethod);
+
+        expect(method.rpcMethod).toEqual('miner_stop');
+
+        expect(method.parametersAmount).toEqual(0);
+
+        expect(method.utils).toEqual(null);
+
+        expect(method.formatters).toEqual(formatters);
+    });
+});

packages/web3-core/types/index.d.ts

@@ -197,3 +197,5 @@ export interface Log {
     blockHash: string;
     blockNumber: number;
 }
+
+export type Hex = string | number;

packages/web3-eth-miner/README.md

@@ -0,0 +1,31 @@
+# web3-eth-miner
+
+This is a sub package of [web3.js][repo]
+
+This is the miner package to be used in the `web3-eth` package.
+Please read the [documentation][docs] for more.
+
+## Installation
+
+```bash
+npm install web3-eth-miner
+```
+
+## Usage
+
+```js
+import {Miner} from 'web3-eth-miner';
+
+const miner = new Miner(
+    'http://127.0.0.1:8546',
+    null,
+    options
+);
+```
+
+## Types 
+
+All the typescript typings are placed in the types folder. 
+
+[docs]: http://web3js.readthedocs.io/en/1.0/
+[repo]: https://github.com/ethereum/web3.js

packages/web3-eth-miner/jest.config.js

@@ -0,0 +1,3 @@
+const jestConfig = require('../../jest.config');
+
+module.exports = jestConfig();