Skip to content

Add support for multiple chains #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpuri merged 6 commits into from
Jan 16, 2024
Merged

Add support for multiple chains #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
14f02cc
Add support for multiple chains
jpuri Jan 12, 2024
e11747e
Update
jpuri Jan 16, 2024
305d4f7
Merge branch 'main' into code_cleanup
jpuri Jan 16, 2024
d645680
update
jpuri Jan 16, 2024
fc1c7fb
Merge branch 'code_cleanup' of github.com:MetaMask/ppom-validator int…
jpuri Jan 16, 2024
9d1d2a9
Update src/ppom-controller.ts
jpuri Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 91 additions & 44 deletions src/ppom-controller.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ describe('PPOMController', () => {
const spy = buildFetchSpy(undefined, undefined, 123);
buildPPOMController();

expect(spy).toHaveBeenCalledTimes(0);
expect(spy).toHaveBeenCalledTimes(1);
jest.runAllTicks();
await flushPromises();
expect(spy).toHaveBeenCalledTimes(5);
Expand Down Expand Up @@ -204,7 +204,7 @@ describe('PPOMController', () => {
return Promise.resolve();
});
}).rejects.toThrow(
'Blockaid validation is available only on ethereum mainnet',
'Blockaid validation not available on network with chainId: 0x2',
);
});

Expand Down Expand Up @@ -263,7 +263,7 @@ describe('PPOMController', () => {
json: () => [
{
name: 'blob',
chainId: '0x1',
chainId: Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET,
version: '1.0.0',
checksum:
'409a7f83ac6b31dc8c77e3ec18038f209bd2f545e0f4177c2e2381aa4e067b49',
Expand Down Expand Up @@ -316,7 +316,7 @@ describe('PPOMController', () => {
onPreferencesChange: (func: any) => {
callBack = func;
},
chainId: '0x1',
chainId: Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET,
});
jest.runOnlyPendingTimers();
await flushPromises();
Expand Down Expand Up @@ -344,6 +344,21 @@ describe('PPOMController', () => {
'Aborting initialising PPOM as not all files could not be downloaded for the network with chainId: 0x1',
);
});

it('should initantiate PPOM instance if not already done', async () => {
buildFetchSpy();
const { ppomController } = buildPPOMController({
chainId: '0x1',
state: {
versionInfo: VERSION_INFO,
},
});

await ppomController.usePPOM(async (ppom: any) => {
expect(ppom).toBeDefined();
return Promise.resolve();
});
});
});

describe('updatePPOM', () => {
Expand Down Expand Up @@ -423,11 +438,11 @@ describe('PPOMController', () => {
const { changeNetwork, ppomController } = buildPPOMController();
jest.runOnlyPendingTimers();
changeNetwork('0x2');
expect(Object.keys(ppomController.state.chainStatus)).toHaveLength(2);
expect(Object.keys(ppomController.state.chainStatus)).toHaveLength(1);
await ppomController.updatePPOM();
jest.runOnlyPendingTimers();
await flushPromises();
expect(spy).toHaveBeenCalledTimes(9);
expect(spy).toHaveBeenCalledTimes(10);
});

it('should not re-throw error if file write fails', async () => {
Expand All @@ -444,7 +459,7 @@ describe('PPOMController', () => {
await ppomController.updatePPOM();
jest.runOnlyPendingTimers();
await flushPromises();
expect(spy).toHaveBeenCalledTimes(9);
expect(spy).toHaveBeenCalledTimes(10);
});

it('should decrease scheduleInterval if its set very high', async () => {
Expand All @@ -454,7 +469,7 @@ describe('PPOMController', () => {
buildPPOMController({
fileFetchScheduleDuration: REFRESH_TIME_INTERVAL * 100,
});
expect(spy).toHaveBeenCalledTimes(0);
expect(spy).toHaveBeenCalledTimes(1);
jest.advanceTimersByTime(REFRESH_TIME_INTERVAL);
await flushPromises();
expect(spy).toHaveBeenCalledTimes(6);
Expand All @@ -466,18 +481,19 @@ describe('PPOMController', () => {
it('should delete network more than a week old from chainStatus', async () => {
buildFetchSpy();
const { changeNetwork, ppomController } = buildPPOMController({
chainId: '0x2',
chainId: Utils.SUPPORTED_NETWORK_CHAINIDS.BSC,
});
jest.runOnlyPendingTimers();
await flushPromises();
const chainIdData1 = ppomController.state.chainStatus['0x2'];
const chainIdData1 =
ppomController.state.chainStatus[Utils.SUPPORTED_NETWORK_CHAINIDS.BSC];
expect(chainIdData1).toBeDefined();
changeNetwork('0x3');
changeNetwork('0x4');
jest.advanceTimersByTime(NETWORK_CACHE_DURATION);
jest.runOnlyPendingTimers();
await flushPromises();
const chainIdData2 = ppomController.state.chainStatus['0x2'];
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.OPTIMISM);
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.POLYGON);
jest.advanceTimersByTime(NETWORK_CACHE_DURATION * 2);
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.ARBITRUM);
const chainIdData2 =
ppomController.state.chainStatus[Utils.SUPPORTED_NETWORK_CHAINIDS.BSC];
expect(chainIdData2).toBeUndefined();
});

Expand All @@ -503,28 +519,28 @@ describe('PPOMController', () => {
it('should add network to chainStatus if not already added', () => {
buildFetchSpy();
const { changeNetwork, ppomController } = buildPPOMController();
changeNetwork('0x1');
const chainIdData1 = ppomController.state.chainStatus['0x1'];
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET);
const chainIdData1 =
ppomController.state.chainStatus[
Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET
];
expect(chainIdData1).toBeDefined();
changeNetwork('0x2');
const chainIdData2 = ppomController.state.chainStatus['0x2'];
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.BSC);
const chainIdData2 =
ppomController.state.chainStatus[Utils.SUPPORTED_NETWORK_CHAINIDS.BSC];
expect(chainIdData2).toBeDefined();
});

it('should trigger file download if preference is enabled', async () => {
const spy = buildFetchSpy({
status: 500,
});
const { changeNetwork } = buildPPOMController({
securityAlertsEnabled: true,
});
const spy = buildFetchSpy();
const { changeNetwork } = buildPPOMController();
jest.runOnlyPendingTimers();
await flushPromises();
expect(spy).toHaveBeenCalledTimes(1);
changeNetwork('0x1');
expect(spy).toHaveBeenCalledTimes(6);
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.BSC);
jest.runOnlyPendingTimers();
await flushPromises();
expect(spy).toHaveBeenCalledTimes(2);
expect(spy).toHaveBeenCalledTimes(8);
});

it('should not trigger file download if preference is not enabled', async () => {
Expand All @@ -547,51 +563,59 @@ describe('PPOMController', () => {

jest.setSystemTime(new Date('2023-01-01'));
const lastVisitedBefore =
ppomController?.state?.chainStatus?.['0x1']?.lastVisited;
ppomController?.state?.chainStatus?.[
Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET
]?.lastVisited;

jest.useFakeTimers().setSystemTime(new Date('2023-01-02'));

changeNetwork('0x2');
changeNetwork('0x1');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.BSC);
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET);
const lastVisitedAfter =
ppomController?.state?.chainStatus?.['0x1']?.lastVisited;
ppomController?.state?.chainStatus?.[
Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET
]?.lastVisited;
expect(lastVisitedBefore !== lastVisitedAfter).toBe(true);
});

it('should delete old network if more than 5 networks are added', async () => {
jest.useFakeTimers().setSystemTime(new Date('2023-01-01'));
buildFetchSpy();
const { changeNetwork, ppomController } = buildPPOMController({
chainId: '0x2',
chainId: Utils.SUPPORTED_NETWORK_CHAINIDS.BSC,
});

expect(Object.keys(ppomController.state.chainStatus)).toHaveLength(1);

jest.useFakeTimers().setSystemTime(new Date('2023-01-02'));
changeNetwork('0x3');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.OPTIMISM);

jest.useFakeTimers().setSystemTime(new Date('2023-01-05'));
changeNetwork('0x5');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.POLYGON);

jest.useFakeTimers().setSystemTime(new Date('2023-01-03'));
changeNetwork('0x4');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.AVALANCHE);

jest.useFakeTimers().setSystemTime(new Date('2023-01-04'));
changeNetwork('0x6');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.ARBITRUM);

expect(Object.keys(ppomController.state.chainStatus)).toHaveLength(5);

jest.useFakeTimers().setSystemTime(new Date('2023-01-06'));
changeNetwork('0x7');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.LINEA_MAINNET);
expect(Object.keys(ppomController.state.chainStatus)).toHaveLength(5);

expect(ppomController.state.chainStatus['0x1']).toBeUndefined();
expect(
ppomController.state.chainStatus[
Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET
],
).toBeUndefined();
});

it('should not throw error if update ppom fails', async () => {
buildFetchSpy();
const { changeNetwork } = buildPPOMController({ chainId: '0x2' });
changeNetwork('0x1');
changeNetwork(Utils.SUPPORTED_NETWORK_CHAINIDS.MAINNET);
await flushPromises();
expect(async () => {
buildFetchSpy({
Expand All @@ -604,6 +628,29 @@ describe('PPOMController', () => {
await flushPromises();
}).not.toThrow();
});

it('should not throw error if reset ppom fails when switching to network not supporting validations', async () => {
buildFetchSpy(undefined, undefined, 123);
const freeMock = jest.fn().mockImplementation(() => {
throw new Error('some error');
});
const { changeNetwork } = buildPPOMController({
ppomProvider: {
ppomInit: async () => {
return Promise.resolve('123');
},
PPOM: new PPOMClass(undefined, freeMock),
},
});
jest.runOnlyPendingTimers();
await flushPromises();
buildFetchSpy({
status: 500,
});
expect(async () => {
changeNetwork('0x2');
}).not.toThrow();
});
});

describe('onPreferencesChange', () => {
Expand Down Expand Up @@ -836,7 +883,7 @@ describe('PPOMController', () => {
});

describe('initialisePPOM', () => {
it('should publich initialisationStateChange events to the messenger', async () => {
it('should publish initialisationStateChange events to the messenger', async () => {
buildFetchSpy();
let callBack: any;
const ppomInitialisationCallbackMock = jest.fn();
Expand All @@ -858,12 +905,12 @@ describe('PPOMController', () => {
);
jest.runOnlyPendingTimers();
await flushPromises();
expect(ppomInitialisationCallbackMock).toHaveBeenCalledTimes(1);
expect(ppomInitialisationCallbackMock).toHaveBeenCalledTimes(2);
callBack({ securityAlertsEnabled: false });
callBack({ securityAlertsEnabled: true });
jest.runOnlyPendingTimers();
await flushPromises();
expect(ppomInitialisationCallbackMock).toHaveBeenCalledTimes(3);
expect(ppomInitialisationCallbackMock).toHaveBeenCalledTimes(4);
});
});
});
Loading