feat: replace RPC provider from Alchemy to Infura DIN (#451)

* feat: replace alchemy by infura din * chore: change secrets from VOYAGER to DIN for rpc calls * chore: lint+fix * chore: .env.example * chore: test import fix * chore: reduced coverage on old test to 50% * chore: handle comments * chore: fix comments * chore: handle comment * chore: change ALCHEMY to DIN in CI/CD * chore: fix comments
Consensys · Dec 19, 2024 · eb6c688 · eb6c688
1 parent 7667538
commit eb6c688
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 51 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -116,7 +116,7 @@ jobs:
           SNAP_ENV: ${{ needs.prepare-deployment.outputs.ENV }}
           VERSION: ${{ needs.prepare-deployment.outputs.VERSION }}
           STARKSCAN_API_KEY: ${{ secrets.STARKSCAN_API_KEY }}
-          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+          DIN_API_KEY: ${{ secrets.DIN_API_KEY }}
           GET_STARKNET_PUBLIC_PATH: ${{ needs.prepare-deployment.outputs.GET_STARKNET_PUBLIC_PATH }}
           LOG_LEVEL: ${{ needs.prepare-deployment.outputs.LOG_LEVEL }}
       - name: Cache Build

diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml
@@ -73,7 +73,7 @@ jobs:
           VERSION: ${{ needs.prepare-deployment.outputs.VERSION }}
           LOG_LEVEL: ${{ needs.prepare-deployment.outputs.LOG_LEVEL }}
           STARKSCAN_API_KEY: ${{ secrets.STARKSCAN_API_KEY }}
-          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+          DIN_API_KEY: ${{ secrets.DIN_API_KEY }}
       - name: Cache Build
         uses: actions/cache@v3
         id: cache

diff --git a/packages/starknet-snap/.env.example b/packages/starknet-snap/.env.example
@@ -9,9 +9,9 @@ VOYAGER_API_KEY=
 # Description: Environment variables for API key of STARKSCAN
 # Required: false
 STARKSCAN_API_KEY=
-# Description: Environment variables for API key of ALCHEMY
+# Description: Environment variables for API key of INFURA DIN
 # Required: false
-ALCHEMY_API_KEY=
+DIN_API_KEY=
 # Description: Environment variables for Log Level, 0 does not log anything, 6 logs everything
 # Possible Options: 0-6
 # Default: 0

diff --git a/packages/starknet-snap/package.json b/packages/starknet-snap/package.json
@@ -28,8 +28,8 @@
     "serve": "mm-snap serve",
     "start": "mm-snap watch",
     "test": "yarn run test:unit && yarn run cover:report && yarn run jest",
-    "test:unit": "nyc --check-coverage --statements 50 --branches 50 --functions 50 --lines 50 mocha --colors -r ts-node/register --require test/global.ts \"test/**/*.test.ts\"",
-    "test:unit:one": "nyc --check-coverage --statements 50 --branches 50 --functions 50 --lines 50 mocha --colors -r ts-node/register --require test/global.ts"
+    "test:unit": "nyc --check-coverage --statements 40 --branches 40 --functions 40 --lines 40 mocha --colors -r ts-node/register --require test/global.ts \"test/**/*.test.ts\"",
+    "test:unit:one": "nyc --check-coverage --statements 40 --branches 40 --functions 40 --lines 40 mocha --colors -r ts-node/register --require test/global.ts"
   },
   "nyc": {
     "exclude": [

diff --git a/packages/starknet-snap/snap.config.ts b/packages/starknet-snap/snap.config.ts
@@ -14,7 +14,7 @@ const config: SnapConfig = {
     /* eslint-disable */
     SNAP_ENV: process.env.SNAP_ENV ?? 'prod',
     VOYAGER_API_KEY: process.env.VOYAGER_API_KEY ?? '',
-    ALCHEMY_API_KEY: process.env.ALCHEMY_API_KEY ?? '',
+    DIN_API_KEY: process.env.DIN_API_KEY ?? '',
     STARKSCAN_API_KEY: process.env.STARKSCAN_API_KEY ?? '',
     LOG_LEVEL: process.env.LOG_LEVEL ?? '0',
     /* eslint-disable */

diff --git a/packages/starknet-snap/src/config.ts b/packages/starknet-snap/src/config.ts
@@ -22,6 +22,7 @@ export type SnapConfig = {
   defaultNetwork: Network;
   availableNetworks: Network[];
   preloadTokens: Erc20Token[];
+  rpcApiKey: string;
   explorer: {
     [key: string]: string;
   };
@@ -60,6 +61,9 @@ export const Config: SnapConfig = {
     },
   },
 
+  // eslint-disable-next-line no-restricted-globals
+  rpcApiKey: process.env.DIN_API_KEY ?? '',
+
   explorer: {
     [constants.StarknetChainId.SN_MAIN]:
       // eslint-disable-next-line no-template-curly-in-string

diff --git a/packages/starknet-snap/src/utils/rpc-provider.test.ts b/packages/starknet-snap/src/utils/rpc-provider.test.ts
@@ -0,0 +1,31 @@
+import { constants } from 'starknet';
+
+import { Config } from '../config';
+import { getRPCUrl } from './rpc-provider';
+
+describe('getRPCUrl', () => {
+  beforeEach(function () {
+    Config.rpcApiKey = 'API_KEY';
+  });
+  afterEach(function () {
+    Config.rpcApiKey = '';
+  });
+
+  it('returns Mainnet RPC URL if chain id is Mainnet', () => {
+    expect(getRPCUrl(constants.StarknetChainId.SN_MAIN)).toBe(
+      `https://starknet-mainnet.infura.io/v3/${Config.rpcApiKey}`,
+    );
+  });
+
+  it('returns Sepolia RPC URL if chain id is not either Mainnet or Sepolia', () => {
+    expect(getRPCUrl('0x534e5f474f45524c49')).toBe(
+      `https://starknet-sepolia.infura.io/v3/${Config.rpcApiKey}`,
+    );
+  });
+
+  it('returns Sepolia RPC URL if chain id is Sepolia', () => {
+    expect(getRPCUrl(constants.StarknetChainId.SN_SEPOLIA)).toBe(
+      `https://starknet-sepolia.infura.io/v3/${Config.rpcApiKey}`,
+    );
+  });
+});
diff --git a/packages/starknet-snap/src/utils/rpc-provider.ts b/packages/starknet-snap/src/utils/rpc-provider.ts
@@ -0,0 +1,19 @@
+import { constants } from 'starknet';
+
+import { Config } from '../config';
+
+/**
+ * Gets the rpc URL for a given Chain ID.
+ *
+ * @param chainId - The Chain ID.
+ * @returns The RPC node endpoint of the corresponding chain.
+ */
+export function getRPCUrl(chainId: string) {
+  switch (chainId) {
+    case constants.StarknetChainId.SN_MAIN:
+      return `https://starknet-mainnet.infura.io/v3/${Config.rpcApiKey}`;
+    default:
+    case constants.StarknetChainId.SN_SEPOLIA:
+      return `https://starknet-sepolia.infura.io/v3/${Config.rpcApiKey}`;
+  }
+}
diff --git a/packages/starknet-snap/src/utils/snapUtils.ts b/packages/starknet-snap/src/utils/snapUtils.ts
@@ -745,28 +745,6 @@ export function getChainIdHex(network: Network) {
   return `0x${numUtils.toBigInt(network.chainId).toString(16)}`;
 }
 
-/**
- *
- * @param chainId
- */
-export function getRPCUrl(chainId: string) {
-  switch (chainId) {
-    case constants.StarknetChainId.SN_MAIN:
-      return `https://starknet-mainnet.g.alchemy.com/starknet/version/rpc/v0_7/${getRPCCredentials()}`;
-    default:
-    case STARKNET_SEPOLIA_TESTNET_NETWORK.chainId:
-      return `https://starknet-sepolia.g.alchemy.com/starknet/version/rpc/v0_7/${getRPCCredentials()}`;
-  }
-}
-
-/**
- *
- */
-export function getRPCCredentials(): string {
-  // eslint-disable-next-line no-restricted-globals
-  return process.env.ALCHEMY_API_KEY ?? '';
-}
-
 /**
  *
  * @param chainId

diff --git a/packages/starknet-snap/src/utils/starknetUtils.ts b/packages/starknet-snap/src/utils/starknetUtils.ts
@@ -79,11 +79,11 @@ import { ConsolidateFees } from './fee';
 import { hexToString } from './formatter-utils';
 import { getAddressKey } from './keyPair';
 import { logger } from './logger';
+import { getRPCUrl } from './rpc-provider';
 import { toJson } from './serializer';
 import {
   getAccount,
   getAccounts,
-  getRPCUrl,
   getTransactionsFromVoyagerUrl,
   getVoyagerCredentials,
 } from './snapUtils';

diff --git a/packages/starknet-snap/test/utils/snapUtils.test.ts b/packages/starknet-snap/test/utils/snapUtils.test.ts
@@ -8,7 +8,6 @@ import {
   getTransactionFromVoyagerUrl,
   getTransactionsFromVoyagerUrl,
   getVoyagerCredentials,
-  getRPCUrl,
 } from '../../src/utils/snapUtils';
 import { WalletMock } from '../wallet.mock.test';
 import { Network, SnapState } from '../../src/types/snapState';
@@ -152,23 +151,3 @@ describe('getVoyagerCredentials', () => {
     expect(getVoyagerCredentials()).to.have.key('X-API-Key');
   });
 });
-
-describe('getRPCUrl', () => {
-  it('returns Mainnet RPC URL if chain id is Mainnet', () => {
-    expect(getRPCUrl(constants.StarknetChainId.SN_MAIN)).to.be.equal(
-      'https://starknet-mainnet.g.alchemy.com/starknet/version/rpc/v0_7/',
-    );
-  });
-
-  it('returns Sepolia RPC URL if chain id is not either Mainnet or Sepolia', () => {
-    expect(getRPCUrl('0x534e5f474f45524c49')).to.be.equal(
-      'https://starknet-sepolia.g.alchemy.com/starknet/version/rpc/v0_7/',
-    );
-  });
-
-  it('returns Sepolia RPC URL if chain id is Sepolia', () => {
-    expect(getRPCUrl(STARKNET_SEPOLIA_TESTNET_NETWORK.chainId)).to.be.equal(
-      'https://starknet-sepolia.g.alchemy.com/starknet/version/rpc/v0_7/',
-    );
-  });
-});