feat: added isMainnetOnly to isBase and isEthereum utilities #1167

.changeset/cool-walls-dream.md

@@ -0,0 +1,5 @@
+---
+'@coinbase/onchainkit': patch
+---
+
+ok

CHANGELOG.md

@@ -4,9 +4,9 @@
 
 ### Patch Changes
 
-  - **feat**: added support for `EIP-5792` (https://eips.ethereum.org/EIPS/eip-5792) in `OnchainKitProvider`. By @0xAlec #1181
-  - **fix**: adjusted hover styling for the `Fund` and `Disconnect` wallet components in mobile view. By @cpcramer #1211
-  - **feat** added `walletCapabilities` for atomic batching (`useWriteContracts` vs `useWriteContract`) in `Transaction` component. By @0xAlec #1214
+- **feat**: added support for `EIP-5792` (https://eips.ethereum.org/EIPS/eip-5792) in `OnchainKitProvider`. By@0xAlec #1181
+- **fix**: adjusted hover styling for the `Fund` and `Disconnect` wallet components in mobile view. By@cpcramer #1211
+- **feat** added `walletCapabilities` for atomic batching (`useWriteContracts` vs `useWriteContract`) in`Transaction` component. By @0xAlec #1214
 
 ## 0.31.3
 

src/isBase.test.ts

@@ -21,4 +21,18 @@ describe('isBase', () => {
     const result = isBase({ chainId });
     expect(result).toEqual(true);
   });
+
+  it('should return true when isMainnetOnly is true and chainId is mainnet', () => {
+    const chainId = base.id;
+    const isMainnetOnly = true;
+    const result = isBase({ chainId, isMainnetOnly });
+    expect(result).toEqual(true);
+  });
+
+  it('should return false when isMainnetOnly is true and chainId is not mainnet', () => {
+    const chainId = baseSepolia.id;
+    const isMainnetOnly = true;
+    const result = isBase({ chainId, isMainnetOnly });
+    expect(result).toEqual(false);
+  });
 });

src/isBase.ts

@@ -6,9 +6,17 @@ import type { isBaseOptions } from './types';
  *  - Checks if the paymaster operations chain id is valid
  *  - Only allows the Base and Base Sepolia chain ids
  */
-export function isBase({ chainId }: isBaseOptions): boolean {
-  if (chainId !== baseSepolia.id && chainId !== base.id) {
-    return false;
+export function isBase({
+  chainId,
+  isMainnetOnly = false,
+}: isBaseOptions): boolean {
+  // If only Base mainnet
+  if (isMainnetOnly && chainId === base.id) {
+    return true;
   }
-  return true;
+  // If only Base or Base Sepolia
+  if (!isMainnetOnly && (chainId === baseSepolia.id || chainId === base.id)) {
+    return true;
+  }
+  return false;
 }

src/isEthereum.test.ts

@@ -13,4 +13,16 @@ describe('isEthereum', () => {
   it('should return false for other chains for testnet', () => {
     expect(isEthereum({ chainId: optimism.id })).toBeFalsy();
   });
+
+  it('should return true when isMainnetOnly is true and chainId is mainnet', () => {
+    expect(
+      isEthereum({ chainId: mainnet.id, isMainnetOnly: true }),
+    ).toBeTruthy();
+  });
+
+  it('should return false when isMainnetOnly is true and chainId is not mainnet', () => {
+    expect(
+      isEthereum({ chainId: sepolia.id, isMainnetOnly: true }),
+    ).toBeFalsy();
+  });
 });

src/isEthereum.ts

@@ -5,9 +5,17 @@ import type { isEthereumOptions } from './types';
  * isEthereum
  *  - Checks if the chain is mainnet or sepolia
  */
-export function isEthereum({ chainId }: isEthereumOptions): boolean {
-  if (chainId !== mainnet.id && chainId !== sepolia.id) {
-    return false;
+export function isEthereum({
+  chainId,
+  isMainnetOnly = false,
+}: isEthereumOptions): boolean {
+  // If only ETH mainnet
+  if (isMainnetOnly && chainId === mainnet.id) {
+    return true;
   }
-  return true;
+  // If only ETH or ETH Sepolia
+  if (!isMainnetOnly && (chainId === sepolia.id || chainId === mainnet.id)) {
+    return true;
+  }
+  return false;
 }

src/types.ts

@@ -7,13 +7,15 @@ import type { EASSchemaUid } from './identity/types';
  */
 export type isBaseOptions = {
   chainId: number;
+  isMainnetOnly?: boolean; // If the chainId check is only allowed on mainnet
 };
 
 /**
  * Note: exported as public Type
  */
 export type isEthereumOptions = {
   chainId: number;
+  isMainnetOnly?: boolean; // If the chainId check is only allowed on mainnet
 };
 
 /**