test: getWeb3Provider options

Author: PierreJeanjacquot

packages/sdk/tests/unit/getWeb3Provider.test.ts

@@ -0,0 +1,53 @@
+import { describe, it, expect } from '@jest/globals';
+import { Wallet } from 'ethers';
+import { getWeb3Provider } from '../../src/index.js';
+
+describe('getWeb3Provider()', () => {
+  const { privateKey, address } = Wallet.createRandom();
+  it('should use the wallet', async () => {
+    const provider = getWeb3Provider(privateKey);
+    const providerAddress = await provider.getAddress();
+    expect(providerAddress).toBe(address);
+  });
+
+  it('should use bellecour by default', async () => {
+    const provider = getWeb3Provider(privateKey);
+    const network = await provider.provider.getNetwork();
+    expect(network.name).toBe('bellecour');
+  });
+
+  it('should accept RPC URL as host', () => {
+    expect(
+      getWeb3Provider(privateKey, { host: 'https://bellecour.iex.ec' })
+    ).toBeDefined();
+  });
+
+  it('should accept chainId as host', () => {
+    expect(getWeb3Provider(privateKey, { host: 134 })).toBeDefined();
+  });
+
+  it('should accept chain name as host', () => {
+    expect(getWeb3Provider(privateKey, { host: 'bellecour' })).toBeDefined();
+  });
+
+  describe('When instantiating SDK with an experimental network', () => {
+    describe('Without allowExperimentalNetworks', () => {
+      it('should throw a configuration error', () => {
+        expect(() =>
+          getWeb3Provider(privateKey, { host: 'arbitrum-sepolia-testnet' })
+        ).toThrow('Invalid provider host name or url');
+      });
+    });
+
+    describe('With allowExperimentalNetworks: true', () => {
+      it('should use the specified network', async () => {
+        const provider = getWeb3Provider(privateKey, {
+          host: 'arbitrum-sepolia-testnet',
+          allowExperimentalNetworks: true,
+        });
+        const network = await provider.provider.getNetwork();
+        expect(network.name).toBe('arbitrum-sepolia');
+      });
+    });
+  });
+});