providers/src/initializeInpageProvider.test.ts at 13d28ce8e2a51baf5f7bc87c9c00f859e561905c · MetaMask/providers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
import { announceWallet, type CAIP294WalletData } from './CAIP294';
import { getBuildType } from './extension-provider/createExternalExtensionProvider';
import {
  announceCaip294WalletData,
  setGlobalProvider,
} from './initializeInpageProvider';
import type { MetaMaskInpageProvider } from './MetaMaskInpageProvider';

jest.mock('./extension-provider/createExternalExtensionProvider');
jest.mock('./CAIP294');

describe('setGlobalProvider', () => {
  it('should call addEventListener once', () => {
    const mockProvider = {} as unknown as MetaMaskInpageProvider;
    const dispatchEvent = jest.spyOn(window, 'dispatchEvent');
    setGlobalProvider(mockProvider);

    expect(dispatchEvent).toHaveBeenCalledTimes(1);
    expect(dispatchEvent).toHaveBeenCalledWith(
      new Event('ethereum#initialized'),
    );
  });

  it('should not throw an error if the global ethereum provider is already set', () => {
    const errorSpy = jest.spyOn(console, 'error');

    const mockProvider = {} as unknown as MetaMaskInpageProvider;
    Object.defineProperty(window, 'ethereum', {
      get() {
        return {};
      },
      set() {
        throw new Error('window.ethereum already set');
      },
      configurable: false,
    });
    expect(() => setGlobalProvider(mockProvider)).not.toThrow();

    expect(errorSpy).toHaveBeenCalledWith(
      'MetaMask encountered an error setting the global Ethereum provider - this is likely due to another Ethereum wallet extension also setting the global Ethereum provider:',
      expect.any(Error),
    );
  });
});

describe('announceCaip294WalletData', () => {
  const mockProvider = {
    request: jest.fn(),
  } as unknown as MetaMaskInpageProvider;
  const mockProviderInfo: CAIP294WalletData = {
    uuid: '123e4567-e89b-12d3-a456-426614174000',
    name: 'Test Wallet',
    icon: 'data:image/png;base64,iVBORw0KGgo=',
    rdns: 'com.testwallet',
  };

  beforeEach(() => {
    jest.clearAllMocks();
  });

  describe('build type is not flask', () => {
    it('should not announce wallet if build type is not flask', async () => {
      (getBuildType as jest.Mock).mockReturnValue('stable');

      await announceCaip294WalletData(mockProvider, mockProviderInfo);

      expect(getBuildType).toHaveBeenCalledWith(mockProviderInfo.rdns);
      expect(announceWallet).not.toHaveBeenCalled();
    });

    it('should not announce wallet if mobile build type is not flask', async () => {
      const mobileMockProviderInfo = {
        ...mockProviderInfo,
        rdns: 'io.metamask.mobile',
      };
      (getBuildType as jest.Mock).mockReturnValue('stable');

      await announceCaip294WalletData(mockProvider, mobileMockProviderInfo);

      expect(getBuildType).toHaveBeenCalledWith(mobileMockProviderInfo.rdns);
      expect(announceWallet).not.toHaveBeenCalled();
    });
  });

  describe('build type is flask', () => {
    it('should announce wallet with caip-348 target for chromium browsers', async () => {
      const extensionId = 'test-extension-id';
      (getBuildType as jest.Mock).mockReturnValue('flask');
      (mockProvider.request as jest.Mock).mockReturnValue({ extensionId });

      await announceCaip294WalletData(mockProvider, mockProviderInfo);

      expect(getBuildType).toHaveBeenCalledWith(mockProviderInfo.rdns);
      expect(announceWallet).toHaveBeenCalledWith({
        ...mockProviderInfo,
        targets: [
          {
            type: 'caip-348',
            value: extensionId,
          },
        ],
      });
    });

    it('should announce wallet without caip-348 target for firefox browser', async () => {
      (getBuildType as jest.Mock).mockReturnValue('flask');
      (mockProvider.request as jest.Mock).mockReturnValue({});

      await announceCaip294WalletData(mockProvider, mockProviderInfo);

      expect(getBuildType).toHaveBeenCalledWith(mockProviderInfo.rdns);
      expect(announceWallet).toHaveBeenCalledWith({
        ...mockProviderInfo,
        targets: [],
      });
    });

    it('should announce wallet with caip-348 target for mobile flask', async () => {
      const extensionId = 'test-extension-id';
      const mobileMockProviderInfo = {
        ...mockProviderInfo,
        rdns: 'io.metamask.mobile.flask',
      };
      (getBuildType as jest.Mock).mockReturnValue('flask');
      (mockProvider.request as jest.Mock).mockReturnValue({ extensionId });

      await announceCaip294WalletData(mockProvider, mobileMockProviderInfo);

      expect(getBuildType).toHaveBeenCalledWith(mobileMockProviderInfo.rdns);
      expect(announceWallet).toHaveBeenCalledWith({
        ...mobileMockProviderInfo,
        targets: [
          {
            type: 'caip-348',
            value: extensionId,
          },
        ],
      });
    });
  });
});