chore: replace ethers implementations of sha256, scrypt and `ke…

…ccak` (#1786) * chore: replace ethers sha256 in hasher * chore: replace ethers sha256 in transactions * chore: replace ethers sha256 in abi-coder * chore: replace ethers sha256 in address * chore: replace ethers sha256 in merkle * chore: regen lock * chore: replace ethers in merkle and hash package * chore: replace ethers in crypto * chore: replace ethers in contract * chore: replace ethers BytesLike in abi coder * chore: fix hasher teest * feat: replace sha256 usages in account * feat: replace scrypt usage * feat: replace keccak * chore: regen lock * chore: add missing utils dep * chore: changeset * chore: regen lock
FuelLabs · Mar 6, 2024 · 1e24dc0 · 1e24dc0
1 parent f9b8af9
commit 1e24dc0
Show file tree

Hide file tree

Showing 36 changed files with 124 additions and 119 deletions.
diff --git a/.changeset/orange-lions-drop.md b/.changeset/orange-lions-drop.md
@@ -0,0 +1,13 @@
+---
+"@fuel-ts/abi-coder": patch
+"@fuel-ts/account": patch
+"@fuel-ts/address": patch
+"@fuel-ts/contract": patch
+"@fuel-ts/crypto": patch
+"@fuel-ts/errors": patch
+"@fuel-ts/hasher": patch
+"@fuel-ts/merkle": patch
+"@fuel-ts/transactions": patch
+---
+
+Migrate implementations of `sha256`, `keccak` and `scrypt` to `@noble/hashes`
diff --git a/packages/abi-coder/package.json b/packages/abi-coder/package.json
@@ -28,11 +28,12 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@fuel-ts/crypto": "workspace:*",
+    "@fuel-ts/errors": "workspace:*",
+    "@fuel-ts/hasher": "workspace:^",
     "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/math": "workspace:*",
-    "@fuel-ts/versions": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
-    "@fuel-ts/errors": "workspace:*",
+    "@fuel-ts/versions": "workspace:*",
     "ethers": "^6.7.1",
     "type-fest": "^3.1.0"
   }

diff --git a/packages/abi-coder/src/FunctionFragment.ts b/packages/abi-coder/src/FunctionFragment.ts
@@ -1,9 +1,9 @@
 import { bufferFromString } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { bn } from '@fuel-ts/math';
 import { arrayify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 
 import { AbiCoder } from './AbiCoder';
 import { ResolvedAbiType } from './ResolvedAbiType';

diff --git a/packages/abi-coder/src/encoding/coders/AbstractCoder.ts b/packages/abi-coder/src/encoding/coders/AbstractCoder.ts
@@ -1,5 +1,5 @@
+import type { BytesLike } from '@fuel-ts/interfaces';
 import type { BN } from '@fuel-ts/math';
-import type { BytesLike } from 'ethers';
 
 import type { Option } from './v0/OptionCoder';
 

diff --git a/packages/account/src/hdwallet/hdwallet.ts b/packages/account/src/hdwallet/hdwallet.ts
@@ -1,16 +1,9 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { bn, toBytes, toHex } from '@fuel-ts/math';
 import { arrayify, hexlify, concat } from '@fuel-ts/utils';
-import {
-  toBeHex,
-  dataSlice,
-  encodeBase58,
-  decodeBase58,
-  sha256,
-  computeHmac,
-  ripemd160,
-} from 'ethers';
+import { toBeHex, dataSlice, encodeBase58, decodeBase58, computeHmac, ripemd160 } from 'ethers';
 
 import { Mnemonic } from '../mnemonic';
 import { Signer } from '../signer';

diff --git a/packages/account/src/mnemonic/mnemonic.ts b/packages/account/src/mnemonic/mnemonic.ts
@@ -1,8 +1,9 @@
 import { randomBytes } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { arrayify, hexlify, concat } from '@fuel-ts/utils';
-import { dataSlice, pbkdf2, sha256, computeHmac, encodeBase58 } from 'ethers';
+import { dataSlice, pbkdf2, computeHmac, encodeBase58 } from 'ethers';
 
 import { english } from '../wordlists';
 

diff --git a/packages/account/src/mnemonic/utils.ts b/packages/account/src/mnemonic/utils.ts
@@ -1,7 +1,7 @@
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { arrayify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 
 /* Mnemonic phrase composed by words from the provided wordlist it can be a text or a array of words */
 export type MnemonicPhrase = string | Array<string>;

diff --git a/packages/account/src/providers/transaction-request/hash-transaction.ts b/packages/account/src/providers/transaction-request/hash-transaction.ts
@@ -1,9 +1,8 @@
 import { ZeroBytes32 } from '@fuel-ts/address/configs';
-import { uint64ToBytesBE } from '@fuel-ts/hasher';
+import { uint64ToBytesBE, sha256 } from '@fuel-ts/hasher';
 import { bn } from '@fuel-ts/math';
 import { TransactionType, InputType, OutputType, TransactionCoder } from '@fuel-ts/transactions';
 import { concat } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 import { clone } from 'ramda';
 
 import type { TransactionRequest } from './types';

diff --git a/packages/account/src/signer/signer.test.ts b/packages/account/src/signer/signer.test.ts
@@ -1,5 +1,5 @@
+import { sha256 } from '@fuel-ts/hasher';
 import { arrayify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 
 import { Signer } from './signer';
 

diff --git a/packages/address/package.json b/packages/address/package.json
@@ -42,7 +42,7 @@
     "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/utils": "workspace:^",
     "@fuel-ts/versions": "workspace:*",
-    "bech32": "^2.0.0",
-    "ethers": "^6.7.1"
+    "@noble/hashes": "^1.3.3",
+    "bech32": "^2.0.0"
   }
 }
diff --git a/packages/address/src/address.ts b/packages/address/src/address.ts
@@ -2,7 +2,7 @@ import { FuelError } from '@fuel-ts/errors';
 import { AbstractAddress } from '@fuel-ts/interfaces';
 import type { Bech32Address, B256Address, EvmAddress, AssetId } from '@fuel-ts/interfaces';
 import { arrayify, hexlify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
+import { sha256 } from '@noble/hashes/sha256';
 
 import {
   normalizeBech32,
@@ -150,7 +150,7 @@ export default class Address extends AbstractAddress {
       throw new FuelError(FuelError.CODES.INVALID_PUBLIC_KEY, `Invalid Public Key: ${publicKey}.`);
     }
 
-    const b256Address = sha256(hexlify(arrayify(publicKey)));
+    const b256Address = hexlify(sha256(arrayify(publicKey)));
     return new Address(toBech32(b256Address));
   }
 

diff --git a/packages/contract/package.json b/packages/contract/package.json
@@ -36,7 +36,7 @@
     "@fuel-ts/versions": "workspace:*",
     "@fuel-ts/account": "workspace:*",
     "@fuel-ts/errors": "workspace:*",
-    "ethers": "^6.7.1"
+    "@fuel-ts/hasher": "workspace:*"
   },
   "devDependencies": {
     "@fuel-ts/forc": "workspace:*"

diff --git a/packages/contract/src/util.ts b/packages/contract/src/util.ts
@@ -1,9 +1,9 @@
 import { FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import { calcRoot, SparseMerkleTree } from '@fuel-ts/merkle';
 import type { StorageSlot } from '@fuel-ts/transactions';
 import { chunkAndPadBytes, hexlify, concat, arrayify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 
 /**
  * @hidden

diff --git a/packages/crypto/package.json b/packages/crypto/package.json
@@ -30,7 +30,7 @@
   "dependencies": {
     "@fuel-ts/errors": "workspace:*",
     "@fuel-ts/utils": "workspace:^",
-    "ethereum-cryptography": "^2.1.2",
+    "@noble/hashes": "^1.3.3",
     "ethers": "^6.7.1"
   }
 }
diff --git a/packages/crypto/src/browser/aes-ctr.ts b/packages/crypto/src/browser/aes-ctr.ts
@@ -19,7 +19,6 @@ export const keyFromPassword: CryptoApi['keyFromPassword'] = (
 ): Uint8Array => {
   const passBuffer = bufferFromString(String(password).normalize('NFKC'), 'utf-8');
   const key = pbkdf2(passBuffer, saltBuffer, 100000, 32, 'sha256');
-
   return arrayify(key);
 };
 

diff --git a/packages/crypto/src/shared/keccak256.test.ts b/packages/crypto/src/shared/keccak256.test.ts
@@ -4,8 +4,8 @@ import { keccak256 as keccak } from './keccak256';
 
 const data = bufferFromString('hashedKey');
 
-vi.mock('ethereum-cryptography/keccak', () => ({
-  keccak256: vi.fn(() => data),
+vi.mock('@noble/hashes/sha3', () => ({
+  keccak_256: vi.fn(() => data),
 }));
 
 /**

diff --git a/packages/crypto/src/shared/keccak256.ts b/packages/crypto/src/shared/keccak256.ts
@@ -1,3 +1,3 @@
-import { keccak256 as keccak } from 'ethereum-cryptography/keccak';
+import { keccak_256 } from '@noble/hashes/sha3';
 
-export const keccak256 = (data: Uint8Array): Uint8Array => keccak(data);
+export const keccak256 = (data: Uint8Array): Uint8Array => keccak_256(data);
diff --git a/packages/crypto/src/shared/scrypt.test.ts b/packages/crypto/src/shared/scrypt.test.ts
@@ -5,8 +5,8 @@ import { scrypt } from './scrypt';
 
 const data = bufferFromString('hashedKey');
 
-vi.mock('ethereum-cryptography/scrypt', () => ({
-  scryptSync: vi.fn(() => data),
+vi.mock('@noble/hashes/scrypt', () => ({
+  scrypt: vi.fn(() => data),
 }));
 
 /**

diff --git a/packages/crypto/src/shared/scrypt.ts b/packages/crypto/src/shared/scrypt.ts
@@ -1,11 +1,10 @@
-import { scryptSync as ethCryScrypt } from 'ethereum-cryptography/scrypt';
+import { scrypt as scryptNoble } from '@noble/hashes/scrypt';
 
 import type { IScryptParams } from '../types';
 
 export const scrypt = (params: IScryptParams): Uint8Array => {
   const { password, salt, n, p, r, dklen } = params;
-
-  const derivedKey = ethCryScrypt(password, salt, n, r, p, dklen);
+  const derivedKey = scryptNoble(password, salt, { N: n, r, p, dkLen: dklen });
 
   return derivedKey;
 };
diff --git a/packages/hasher/package.json b/packages/hasher/package.json
@@ -30,7 +30,7 @@
     "@fuel-ts/interfaces": "workspace:^",
     "@fuel-ts/math": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
-    "ethers": "^6.7.1",
+    "@noble/hashes": "^1.3.3",
     "ramda": "^0.29.0"
   },
   "devDependencies": {

diff --git a/packages/hasher/src/hasher.test.ts b/packages/hasher/src/hasher.test.ts
@@ -1,10 +1,19 @@
-import { hashMessage, hash, uint64ToBytesBE } from './hasher';
+import { bufferFromString } from '@fuel-ts/crypto';
+
+import { hashMessage, hash, uint64ToBytesBE, sha256 } from './hasher';
 
 /**
  * @group node
  * @group browser
  */
 describe('Hasher', () => {
+  it('Hash "hello world"', () => {
+    const bytes = bufferFromString('hello world', 'utf-8');
+    expect(sha256(bytes)).toEqual(
+      '0xb94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
+    );
+  });
+
   it('Hash message', () => {
     const message = 'my message';
     const hashedMessage = '0xea38e30f75767d7e6c21eba85b14016646a3b60ade426ca966dac940a5db1bab';

diff --git a/packages/hasher/src/hasher.ts b/packages/hasher/src/hasher.ts
@@ -1,15 +1,24 @@
 import { bufferFromString } from '@fuel-ts/crypto';
 import type { BytesLike } from '@fuel-ts/interfaces';
-import { sha256 } from 'ethers';
+import { arrayify, hexlify } from '@fuel-ts/utils';
+import { sha256 as sha256AsBytes } from '@noble/hashes/sha256';
 
 /**
- * hash string messages with sha256
+ * @param data - The data to be hashed
+ * @returns A sha256 hash of the data in hex format
+ */
+export function sha256(data: BytesLike): string {
+  return hexlify(sha256AsBytes(arrayify(data)));
+}
+
+/**
+ * wrap sha256
  *
- * @param msg - The string message to be hashed
- * @returns A sha256 hash of the message
+ * @param data - The data to be hash
+ * @returns A sha256 hash of the data
  */
-export function hashMessage(msg: string) {
-  return sha256(bufferFromString(msg, 'utf-8'));
+export function hash(data: BytesLike): string {
+  return sha256(data);
 }
 
 /**
@@ -24,11 +33,11 @@ export function uint64ToBytesBE(value: number): Uint8Array {
 }
 
 /**
- * wrap sha256
+ * hash string messages with sha256
  *
- * @param data - The data to be hash
- * @returns A sha256 hash of the data
+ * @param msg - The string message to be hashed
+ * @returns A sha256 hash of the message
  */
-export function hash(data: BytesLike) {
-  return sha256(data);
+export function hashMessage(msg: string) {
+  return hash(bufferFromString(msg, 'utf-8'));
 }
diff --git a/packages/merkle/package.json b/packages/merkle/package.json
@@ -25,8 +25,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@fuel-ts/hasher": "workspace:^",
     "@fuel-ts/interfaces": "workspace:^",
-    "@fuel-ts/math": "workspace:*",
-    "ethers": "^6.7.1"
+    "@fuel-ts/math": "workspace:*"
   }
 }
diff --git a/packages/merkle/src/binary/binaryMerkleTree.ts b/packages/merkle/src/binary/binaryMerkleTree.ts
@@ -1,5 +1,7 @@
 // A set of useful helper methods for testing binary Merkle trees.
-import { EMPTY, hash } from '../common';
+import { hash } from '@fuel-ts/hasher';
+
+import { EMPTY } from '../common';
 
 import Node from './types/node';
 

diff --git a/packages/merkle/src/common/cryptography.ts b/packages/merkle/src/common/cryptography.ts
diff --git a/packages/merkle/src/common/index.ts b/packages/merkle/src/common/index.ts
@@ -1,2 +1 @@
 export * from './common';
-export * from './cryptography';
diff --git a/packages/merkle/src/sparse/proofs.ts b/packages/merkle/src/sparse/proofs.ts
@@ -1,4 +1,4 @@
-import { hash } from '../common';
+import { hash } from '@fuel-ts/hasher';
 
 import { hashLeaf, hashNode, parseLeaf } from './treeHasher';
 import SparseCompactMerkleProof from './types/sparseCompactMerkleProof';

diff --git a/packages/merkle/src/sparse/sparseMerkleTree.test.ts b/packages/merkle/src/sparse/sparseMerkleTree.test.ts
@@ -1,12 +1,12 @@
+import { hash } from '@fuel-ts/hasher';
 import { toHex } from '@fuel-ts/math';
 
-import { hash } from '../common';
-
 import { DeepSparseMerkleSubTree } from './deepSparseMerkleSubTree';
 import { SparseMerkleTree } from './sparseMerkleTree';
 
 /**
  * @group node
+ * @group browser
  */
 describe('Sparse Merkle Tree', () => {
   it('Update and delete', () => {

diff --git a/packages/merkle/src/sparse/sparseMerkleTree.ts b/packages/merkle/src/sparse/sparseMerkleTree.ts
@@ -1,6 +1,6 @@
 /// @dev The Fuel testing Merkle trees.
 /// A set of useful helper methods for testing and deploying Merkle trees.
-import { hash } from '../common';
+import { hash } from '@fuel-ts/hasher';
 
 import { compactProof } from './proofs';
 import { isLeaf, hashLeaf, hashNode, parseLeaf, parseNode } from './treeHasher';

diff --git a/packages/merkle/src/sparse/treeHasher.ts b/packages/merkle/src/sparse/treeHasher.ts
@@ -1,4 +1,4 @@
-import { hash } from '../common';
+import { hash } from '@fuel-ts/hasher';
 
 export const leafPrefix = '0x00';
 export const nodePrefix = '0x01';

diff --git a/packages/merkle/src/sum/sumMerkleTree.ts b/packages/merkle/src/sum/sumMerkleTree.ts
@@ -1,9 +1,8 @@
 /// @dev The Fuel testing Merkle trees.
 /// A set of useful helper methods for testing and deploying Merkle trees.
+import { hash } from '@fuel-ts/hasher';
 import { bn, toHex } from '@fuel-ts/math';
 
-import { hash } from '../common';
-
 import Node from './types/node';
 import Proof from './types/proof';
 

diff --git a/packages/transactions/package.json b/packages/transactions/package.json
@@ -40,9 +40,9 @@
     "@fuel-ts/abi-coder": "workspace:*",
     "@fuel-ts/address": "workspace:*",
     "@fuel-ts/errors": "workspace:*",
+    "@fuel-ts/hasher": "workspace:^",
     "@fuel-ts/interfaces": "workspace:^",
     "@fuel-ts/math": "workspace:*",
-    "@fuel-ts/utils": "workspace:*",
-    "ethers": "^6.7.1"
+    "@fuel-ts/utils": "workspace:*"
   }
 }
diff --git a/packages/transactions/src/coders/input.ts b/packages/transactions/src/coders/input.ts
@@ -1,10 +1,10 @@
 /* eslint-disable max-classes-per-file */
 import { Coder, B256Coder, NumberCoder, BigNumberCoder } from '@fuel-ts/abi-coder';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { sha256 } from '@fuel-ts/hasher';
 import type { BytesLike } from '@fuel-ts/interfaces';
 import type { BN } from '@fuel-ts/math';
 import { concat, arrayify } from '@fuel-ts/utils';
-import { sha256 } from 'ethers';
 
 import { ByteArrayCoder } from './byte-array';
 import type { TxPointer } from './tx-pointer';
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@
		export * from './common';
		export * from './cryptography';