Update sha3 and sha3Raw type definitions to accept Buffer (#5357)

* Update sha3 type def to accept Buffer
web3 · Aug 18, 2022 · 4524ea0 · 4524ea0
1 parent 9f4e7c0
commit 4524ea0
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -586,4 +586,7 @@ Released with 1.0.0-beta.37 code base.
 
 ## [Unreleased]
 
-## [1.7.6]
+## [1.7.6]
+
+### Changed
+-  Updated `sha3` and `sha3Raw` type definition to accept `Buffer`
diff --git a/docs/web3-utils.rst b/docs/web3-utils.rst
@@ -218,8 +218,8 @@ sha3
 
 .. code-block:: javascript
 
-    web3.utils.sha3(string)
-    web3.utils.keccak256(string) // ALIAS
+    web3.utils.sha3(string | BN | Buffer)
+    web3.utils.keccak256(string | BN | Buffer) // ALIAS
 
 Will calculate the sha3 of the input.
 

diff --git a/packages/web3-utils/types/index.d.ts b/packages/web3-utils/types/index.d.ts
@@ -95,8 +95,8 @@ export function padLeft(value: string | number, characterAmount: number, sign?:
 export function leftPad(string: string | number, characterAmount: number, sign?: string): string;
 export function rightPad(string: string | number, characterAmount: number, sign?: string): string;
 export function padRight(string: string | number, characterAmount: number, sign?: string): string;
-export function sha3(value: string | BN): string | null;
-export function sha3Raw(value: string | BN): string;
+export function sha3(value: string | BN | Buffer): string | null;
+export function sha3Raw(value: string | BN | Buffer): string;
 export function randomHex(bytesSize: number): string;
 export function utf8ToHex(string: string): string;
 export function stringToHex(string: string): string;

diff --git a/packages/web3-utils/types/tests/sha3-raw-test.ts b/packages/web3-utils/types/tests/sha3-raw-test.ts
@@ -26,6 +26,8 @@ import {sha3Raw} from 'web3-utils';
 // $ExpectType string
 sha3Raw('234');
 // $ExpectType string
+sha3Raw(Buffer.from('123'));
+// $ExpectType string
 sha3Raw(new BN(3));
 
 // $ExpectError

diff --git a/packages/web3-utils/types/tests/sha3-test.ts b/packages/web3-utils/types/tests/sha3-test.ts
@@ -26,6 +26,8 @@ import {sha3} from 'web3-utils';
 // $ExpectType string | null
 sha3('234');
 // $ExpectType string | null
+sha3(Buffer.from('123'));
+// $ExpectType string | null
 sha3(new BN(3));
 
 // $ExpectError