feat: remove uuid dependency in favor of crypto.randomUUID()

.changeset/hot-hairs-sit.md

@@ -0,0 +1,7 @@
+---
+"@fuel-ts/crypto": minor
+"@fuel-ts/wallet": minor
+---
+
+- Now exporting `randomUUID` from `@fuel-ts/crypto`
+- Bumping `@fuel-ts/wallet` because it's consuming `randomUUID`

packages/crypto/src/browser/crypto.ts

@@ -9,6 +9,27 @@ if (!crypto) {
   );
 }
 
+if (!crypto.randomUUID) {
+  throw new FuelError(
+    ErrorCode.ENV_DEPENDENCY_MISSING,
+    `Could not find 'crypto.randomUUID' in current browser environment.`
+  );
+}
+
+if (!crypto.subtle) {
+  throw new FuelError(
+    ErrorCode.ENV_DEPENDENCY_MISSING,
+    `Could not find 'crypto.subtle' in current browser environment.`
+  );
+}
+
+if (!crypto.getRandomValues) {
+  throw new FuelError(
+    ErrorCode.ENV_DEPENDENCY_MISSING,
+    `Could not find 'crypto.getRandomValues' in current browser environment.`
+  );
+}
+
 if (!btoa) {
   throw new FuelError(
     ErrorCode.ENV_DEPENDENCY_MISSING,

packages/crypto/src/browser/index.ts

@@ -18,6 +18,7 @@ const api: CryptoApi = {
   keccak256,
   decryptJsonWalletData,
   encryptJsonWalletData,
+  randomUUID: crypto.randomUUID,
 };
 
 export default api;

packages/crypto/src/index.browser.ts

@@ -13,4 +13,5 @@ export const {
   keccak256,
   decryptJsonWalletData,
   encryptJsonWalletData,
+  randomUUID,
 } = cryptoApi;

packages/crypto/src/index.ts

@@ -13,4 +13,5 @@ export const {
   keccak256,
   decryptJsonWalletData,
   encryptJsonWalletData,
+  randomUUID,
 } = cryptoApi;

packages/crypto/src/node/index.ts

@@ -1,3 +1,5 @@
+import crypto from 'crypto';
+
 import { scrypt, keccak256 } from '../shared';
 import type { CryptoApi } from '../types';
 
@@ -18,6 +20,7 @@ const api: CryptoApi = {
   keccak256,
   decryptJsonWalletData,
   encryptJsonWalletData,
+  randomUUID: crypto.randomUUID,
 };
 
 export default api;

packages/crypto/src/types.ts

@@ -26,4 +26,5 @@ export interface CryptoApi {
   keccak256(data: Uint8Array): Uint8Array;
   encryptJsonWalletData(data: Uint8Array, key: Uint8Array, iv: Uint8Array): Promise<Uint8Array>;
   decryptJsonWalletData(data: Uint8Array, key: Uint8Array, iv: Uint8Array): Promise<Uint8Array>;
+  randomUUID(): string;
 }

packages/crypto/test/crypto-browser/btoa-undefined.test.ts

@@ -0,0 +1,26 @@
+import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
+
+import { CryptoMock } from './crypto-mock';
+
+/**
+ * @group node
+ */
+describe('throws when btoa is unavailable', () => {
+  test('btoa is undefined', async () => {
+    if (!globalThis.crypto) {
+      // this is for node v18 where globalThis.crypto is undefined
+      // these are tests for the browser environment anyways so doing this is okay
+      vi.stubGlobal('crypto', new CryptoMock());
+    }
+    vi.stubGlobal('btoa', undefined);
+
+    await expectToThrowFuelError(
+      () => import('../../src/browser/crypto'),
+      new FuelError(
+        ErrorCode.ENV_DEPENDENCY_MISSING,
+        `Could not find 'btoa' in current browser environment.`
+      )
+    );
+  });
+});

packages/crypto/test/crypto-browser/crypto-getRandomValues-undefined.test.ts

@@ -0,0 +1,21 @@
+import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
+
+import { CryptoMock } from './crypto-mock';
+
+/**
+ * @group node
+ */
+describe('throws when crypto.getRandomValues is unavailable', () => {
+  test('crypto.getRandomValues is undefined', async () => {
+    vi.stubGlobal('crypto', new CryptoMock('getRandomValues'));
+
+    await expectToThrowFuelError(
+      () => import('../../src/browser/crypto'),
+      new FuelError(
+        ErrorCode.ENV_DEPENDENCY_MISSING,
+        `Could not find 'crypto.getRandomValues' in current browser environment.`
+      )
+    );
+  });
+});

packages/crypto/test/crypto-browser/crypto-mock.ts

@@ -0,0 +1,17 @@
+import * as cr from 'crypto';
+
+export class CryptoMock {
+  constructor(private toUndefined?: 'subtle' | 'randomUUID' | 'getRandomValues') {}
+
+  get subtle() {
+    return this.toUndefined === 'subtle' ? undefined : cr.subtle;
+  }
+
+  get randomUUID() {
+    return this.toUndefined === 'randomUUID' ? undefined : cr.randomUUID;
+  }
+
+  get getRandomValues() {
+    return this.toUndefined === 'getRandomValues' ? undefined : cr.getRandomValues;
+  }
+}

packages/crypto/test/crypto-browser/crypto-randomUUID-undefined.test.ts

@@ -0,0 +1,21 @@
+import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
+
+import { CryptoMock } from './crypto-mock';
+
+/**
+ * @group node
+ */
+describe('throws when crypto.randomUUID is unavailable', () => {
+  test('crypto.randomUUID is undefined', async () => {
+    vi.stubGlobal('crypto', new CryptoMock('randomUUID'));
+
+    await expectToThrowFuelError(
+      () => import('../../src/browser/crypto'),
+      new FuelError(
+        ErrorCode.ENV_DEPENDENCY_MISSING,
+        `Could not find 'crypto.randomUUID' in current browser environment.`
+      )
+    );
+  });
+});

packages/crypto/test/crypto-browser/crypto-subtle-undefined.test.ts

@@ -0,0 +1,21 @@
+import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
+
+import { CryptoMock } from './crypto-mock';
+
+/**
+ * @group node
+ */
+describe('throws when crypto.subtle is unavailable', () => {
+  test('crypto.subtle is undefined', async () => {
+    vi.stubGlobal('crypto', new CryptoMock('subtle'));
+
+    await expectToThrowFuelError(
+      () => import('../../src/browser/crypto'),
+      new FuelError(
+        ErrorCode.ENV_DEPENDENCY_MISSING,
+        `Could not find 'crypto.subtle' in current browser environment.`
+      )
+    );
+  });
+});

packages/crypto/test/crypto-browser/crypto-undefined.test.ts

@@ -0,0 +1,19 @@
+import { ErrorCode, FuelError } from '@fuel-ts/errors';
+import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
+
+/**
+ * @group node
+ */
+describe('throws when crypto is unavailable', () => {
+  test('crypto is undefined', async () => {
+    vi.stubGlobal('crypto', undefined);
+
+    await expectToThrowFuelError(
+      () => import('../../src/browser/crypto'),
+      new FuelError(
+        ErrorCode.ENV_DEPENDENCY_MISSING,
+        `Could not find 'crypto' in current browser environment.`
+      )
+    );
+  });
+});

packages/wallet/package.json

@@ -62,10 +62,6 @@
     "@fuel-ts/errors": "workspace:*",
     "ethers": "^6.7.1",
     "portfinder": "^1.0.32",
-    "tree-kill": "^1.2.2",
-    "uuid": "^9.0.0"
-  },
-  "devDependencies": {
-    "@types/uuid": "^9.0.1"
+    "tree-kill": "^1.2.2"
   }
 }

packages/wallet/src/keystore-wallet.ts

@@ -7,11 +7,11 @@ import {
   stringFromBuffer,
   decryptJsonWalletData,
   encryptJsonWalletData,
+  randomUUID,
 } from '@fuel-ts/crypto';
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import type { AbstractAddress } from '@fuel-ts/interfaces';
 import { hexlify } from 'ethers';
-import { v4 as uuidv4 } from 'uuid';
 
 export type KeystoreWallet = {
   id: string;
@@ -90,7 +90,7 @@ export async function encryptKeystoreWallet(
 
   // Construct keystore.
   const keystore: KeystoreWallet = {
-    id: uuidv4(),
+    id: randomUUID(),
     version: 3,
     address: removeHexPrefix(ownerAddress.toHexString()),
     crypto: {