Init Changelog Sync Script

CHANGELOG.md

@@ -1137,4 +1137,8 @@ should use 4.0.1-alpha.0 for testing.
 
 ## [Unreleased]
 
+### Added
+
+#### web3-core
+
 -   Added rpc exception codes following eip-1474 as an experimental feature (if `useRpcCallSpecification` at `enableExperimentalFeatures` is `true`) (#5525)

fixtures/contracts/Basic.sol

@@ -28,23 +28,11 @@ contract Basic {
 		return boolValue;
 	}
 
-	function getValues()
-		public
-		view
-		returns (
-			uint256,
-			string memory,
-			bool
-		)
-	{
+	function getValues() public view returns (uint256, string memory, bool) {
 		return (intValue, stringValue, boolValue);
 	}
 
-	function setValues(
-		uint256 _value,
-		string memory _stringValue,
-		bool _boolValue
-	) public {
+	function setValues(uint256 _value, string memory _stringValue, bool _boolValue) public {
 		intValue = _value;
 		stringValue = _stringValue;
 		boolValue = _boolValue;
@@ -62,19 +50,11 @@ contract Basic {
 		revert('REVERTED WITH REVERT');
 	}
 
-	function firesMultiValueEvent(
-		string memory str,
-		uint256 val,
-		bool flag
-	) public {
+	function firesMultiValueEvent(string memory str, uint256 val, bool flag) public {
 		emit MultiValueEvent(str, val, flag);
 	}
 
-	function firesMultiValueIndexedEvent(
-		string memory str,
-		uint256 val,
-		bool flag
-	) public {
+	function firesMultiValueIndexedEvent(string memory str, uint256 val, bool flag) public {
 		emit MultiValueIndexedEvent(str, val, flag);
 	}
 

fixtures/contracts/Greeter.sol

@@ -3,29 +3,29 @@
 pragma solidity ^0.8.13;
 
 contract Greeter {
-    uint256 counter;
-    string private greeting;
+	uint256 counter;
+	string private greeting;
 
-    event GREETING_CHANGING(string from, string to);
-    event GREETING_CHANGED(string greeting);
+	event GREETING_CHANGING(string from, string to);
+	event GREETING_CHANGED(string greeting);
 
-    constructor(string memory _greeting) {
-        greeting = _greeting;
-        counter = 0;
-    }
+	constructor(string memory _greeting) {
+		greeting = _greeting;
+		counter = 0;
+	}
 
-    function greet() public view returns (string memory) {
-        return greeting;
-    }
+	function greet() public view returns (string memory) {
+		return greeting;
+	}
 
-    function setGreeting(string memory _greeting) public returns (bool, string memory) {
-        emit GREETING_CHANGING(greeting, _greeting);
-        greeting = _greeting;
-        emit GREETING_CHANGED(greeting);
-        return (true, greeting);
-    }
+	function setGreeting(string memory _greeting) public returns (bool, string memory) {
+		emit GREETING_CHANGING(greeting, _greeting);
+		greeting = _greeting;
+		emit GREETING_CHANGED(greeting);
+		return (true, greeting);
+	}
 
-    function increment() public {
-        counter = counter + 1;
-    }
+	function increment() public {
+		counter = counter + 1;
+	}
 }

package.json

@@ -37,6 +37,7 @@
 		"build": "lerna run build --stream",
 		"build:web": "lerna run build:web --stream",
 		"build:docs": "cd docs && yarn install && yarn build",
+		"changelog": "ts-node scripts/changelog/src/index.ts",
 		"clean": "lerna run clean --stream --parallel",
 		"ganache:start": "WEB3_SYSTEM_TEST_BACKEND=ganache && ./scripts/ganache.sh start",
 		"ganache:start:background": "WEB3_SYSTEM_TEST_BACKEND=ganache && ./scripts/ganache.sh start 1",
@@ -49,9 +50,9 @@
 		"geth-binary:stop": "WEB3_SYSTEM_TEST_BACKEND=geth && ./scripts/geth_binary.sh stop",
 		"lint": "lerna run lint --stream --parallel",
 		"lint:fix": "lerna run lint:fix --stream --parallel",
-		"format": "lerna run format --stream --parallel",
+		"format": "lerna run format --stream --parallel && prettier --write ./scripts/**/*.ts",
 		"test": "lerna run test --stream --parallel",
-		"test:unit": "lerna run test:unit --stream --parallel",
+		"test:unit": "lerna run test:unit --stream --parallel && jest --config=./scripts/jest.config.js",
 		"test:integration": "lerna run test:integration --stream",
 		"test:e2e:ganache:http": "./scripts/test-runner.sh ganache http",
 		"test:e2e:ganache:ws": "./scripts/test-runner.sh ganache ws",

packages/web3-core/src/web3_subscription_manager.ts

@@ -23,7 +23,8 @@ import { Web3RequestManager, Web3RequestManagerEvent } from './web3_request_mana
 import { Web3SubscriptionConstructor } from './web3_subscriptions';
 
 type ShouldUnsubscribeCondition = ({
-	id: sub,
+	id,
+	sub,
 }: {
 	id: string;
 	sub: unknown;

packages/web3-errors/src/index.ts

@@ -28,4 +28,4 @@ export * from './errors/transaction_errors';
 export * from './errors/utils_errors';
 export * from './errors/response_errors';
 export * from './errors/core_errors';
-export * from './errors/rpc_errors';
+export * from './errors/rpc_errors';

packages/web3-eth-contract/test/fixtures/contracts/SampleStorageContract.sol

@@ -18,17 +18,16 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 pragma solidity ^0.8.7;
 
 contract SampleStorageContract {
+	uint256 uintNum;
 
-    uint256 uintNum;
+	event NEWNUM(uint256 param);
 
-    event NEWNUM(uint256 param);
+	function storeNum(uint256 param) public {
+		uintNum = param;
+		emit NEWNUM(param);
+	}
 
-    function storeNum(uint256 param) public {
-        uintNum = param;
-        emit NEWNUM(param);
-    }
-
-    function retrieveNum() public view returns (uint256){
-        return uintNum;
-    }
-}
+	function retrieveNum() public view returns (uint256) {
+		return uintNum;
+	}
+}

packages/web3-validator/src/utils.ts

@@ -28,7 +28,7 @@ import { isAbiParameterSchema } from './validation/abi';
 import { isHexStrict } from './validation/string';
 // import { abiToJsonSchemaCases } from '../test/fixtures/abi_to_json_schema';
 
-export const parseBaseType = <T = typeof VALID_ETH_BASE_TYPES[number]>(
+export const parseBaseType = <T = (typeof VALID_ETH_BASE_TYPES)[number]>(
 	type: string,
 ): {
 	baseType?: T;

scripts/changelog/src/add_changelog_entry.ts

@@ -0,0 +1,69 @@
+/*
+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/>.
+*/
+import { readFileSync, writeFileSync } from 'fs';
+
+// eslint-disable-next-line import/no-cycle
+import { ChangelogConfig, DEFAULT_CHANGELOG_CONFIG } from './types';
+import { getPackageGroupedUnreleasedEntries, getUnreleasedSection } from './sync';
+
+export const addChangelogEntry = (commandName: string, args: string[]) => {
+	let CHANGELOG_CONFIG: ChangelogConfig;
+	if (args?.[0] !== undefined && args[0].endsWith('.json')) {
+		CHANGELOG_CONFIG = JSON.parse(readFileSync(args[0], 'utf8')) as ChangelogConfig;
+		args.shift();
+	} else {
+		CHANGELOG_CONFIG = DEFAULT_CHANGELOG_CONFIG;
+	}
+
+	const [packageName, changelogEntry] = args;
+	const parsedChangelog = readFileSync(
+		`${CHANGELOG_CONFIG.packagesDirectoryPath}/${packageName}/${CHANGELOG_CONFIG.packagesChangelogPath}`,
+		'utf8',
+	).split(/\n/);
+	const groupedUnreleasedEntries = getPackageGroupedUnreleasedEntries(
+		getUnreleasedSection(parsedChangelog),
+	);
+	const formattedCommandName = `### ${
+		commandName.charAt(0).toUpperCase() + commandName.slice(1)
+	}`;
+	const formattedChangelogEntry = `-   ${changelogEntry}`;
+
+	if (groupedUnreleasedEntries[formattedCommandName] !== undefined) {
+		groupedUnreleasedEntries[formattedCommandName].push(formattedChangelogEntry);
+	} else {
+		groupedUnreleasedEntries[formattedCommandName] = [formattedChangelogEntry];
+	}
+
+	const flattenedModifiedUnreleasedEntries: string[] = [];
+	for (const entryHeader of Object.keys(groupedUnreleasedEntries)) {
+		const entries = groupedUnreleasedEntries[entryHeader];
+		flattenedModifiedUnreleasedEntries.push(entryHeader);
+		flattenedModifiedUnreleasedEntries.push('');
+		for (const [index, entry] of entries.entries()) {
+			flattenedModifiedUnreleasedEntries.push(entry);
+			if (index + 1 === entries.length) flattenedModifiedUnreleasedEntries.push('');
+		}
+	}
+
+	// +2 is so the header, ## [Unreleased], and the newline after it don't get removed
+	parsedChangelog.splice(parsedChangelog.findIndex(item => item === '## [Unreleased]') + 2);
+	parsedChangelog.push(...flattenedModifiedUnreleasedEntries);
+	writeFileSync(
+		`${CHANGELOG_CONFIG.packagesDirectoryPath}/${packageName}/${CHANGELOG_CONFIG.packagesChangelogPath}`,
+		parsedChangelog.join('\n'),
+	);
+};

scripts/changelog/src/helpers.ts

@@ -0,0 +1,40 @@
+/*
+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/>.
+*/
+import { readdirSync } from 'fs';
+
+// eslint-disable-next-line import/no-cycle
+import { Command, getCommands } from './types';
+
+export const parseArgs = (commands: Command[] = getCommands()): unknown => {
+	const commandArg = process.argv[2];
+	for (const command of commands) {
+		if (command.name === commandArg) {
+			return command.commandFunction(command.name, process.argv.slice(3));
+		}
+	}
+
+	// eslint-disable-next-line no-console
+	console.log('Invalid command, please refer to below table for expected commands:');
+	// eslint-disable-next-line no-console
+	console.table(commands);
+	return undefined;
+};
+
+export const getListOfPackageNames = (packagesDirectory: string) =>
+	readdirSync(packagesDirectory, { withFileTypes: true })
+		.filter(dirent => dirent.isDirectory())
+		.map(dirent => dirent.name);

scripts/changelog/src/index.ts

@@ -0,0 +1,20 @@
+/*
+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/>.
+*/
+// eslint-disable-next-line import/no-cycle
+import { parseArgs } from './helpers';
+
+parseArgs();