Skip to content
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.

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

Dynamic provider split test providers #4389

Draft
wants to merge 6 commits into
base: dbrans/dynamic-provider
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -862,15 +862,16 @@ describe('NftDetectionController', () => {

it('should return true if mainnet is detected', async () => {
const mockAddNft = jest.fn();
const provider = new FakeProvider();
const mockNetworkClient: NetworkClient = {
configuration: {
chainId: ChainId.mainnet,
rpcUrl: 'https://test.network',
ticker: 'TEST',
type: NetworkClientType.Custom,
},
provider: new FakeProvider(),
blockTracker: new FakeBlockTracker(),
provider,
blockTracker: new FakeBlockTracker({ provider }),
destroy: () => {
// do nothing
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7574,7 +7574,7 @@ function buildFakeClient(
rpcUrl: 'https://test.network',
},
provider,
blockTracker: new FakeBlockTracker(),
blockTracker: new FakeBlockTracker({ provider }),
destroy: () => {
// do nothing
},
Expand Down
5 changes: 3 additions & 2 deletions packages/network-controller/tests/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ function buildFakeNetworkClient({
configuration: NetworkClientConfiguration;
providerStubs?: FakeProviderStub[];
}): NetworkClient {
const provider = new FakeProvider({ stubs: providerStubs });
return {
configuration,
provider: new FakeProvider({ stubs: providerStubs }),
blockTracker: new FakeBlockTracker(),
provider,
blockTracker: new FakeBlockTracker({ provider }),
destroy: () => {
// do nothing
},
Expand Down
1 change: 1 addition & 0 deletions packages/transaction-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"devDependencies": {
"@babel/runtime": "^7.23.9",
"@metamask/auto-changelog": "^3.4.4",
"@metamask/eth-json-rpc-provider": "^4.0.0",
"@metamask/ethjs-provider-http": "^0.3.0",
"@types/bn.js": "^5.1.5",
"@types/jest": "^27.4.1",
Expand Down
50 changes: 32 additions & 18 deletions packages/transaction-controller/src/TransactionController.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
BUILT_IN_NETWORKS,
ORIGIN_METAMASK,
} from '@metamask/controller-utils';
import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
import EthQuery from '@metamask/eth-query';
import HttpProvider from '@metamask/ethjs-provider-http';
import type {
Expand Down Expand Up @@ -245,10 +246,14 @@ function buildMockEthQuery(): EthQuery {
*
* @param latestBlockNumber - The block number that the block tracker should
* always return.
* @param provider - json rpc provider
* @returns The mocked block tracker.
*/
function buildMockBlockTracker(latestBlockNumber: string): BlockTracker {
const fakeBlockTracker = new FakeBlockTracker();
function buildMockBlockTracker(
latestBlockNumber: string,
provider: SafeEventEmitterProvider,
): BlockTracker {
const fakeBlockTracker = new FakeBlockTracker({ provider });
fakeBlockTracker.mockLatestBlockNumber(latestBlockNumber);
return fakeBlockTracker;
}
Expand Down Expand Up @@ -293,12 +298,21 @@ function waitForTransactionFinished(

const MOCK_PREFERENCES = { state: { selectedAddress: 'foo' } };
const INFURA_PROJECT_ID = '341eacb578dd44a1a049cbc5f6fd4035';
const MAINNET_PROVIDER = new HttpProvider(
`https://mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
);
const PALM_PROVIDER = new HttpProvider(
`https://palm-mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
);
const HTTP_PROVIDERS = {
mainnet: new HttpProvider(
`https://mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
),
goerli: new HttpProvider(
`https://palm-mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
),
linea: new HttpProvider(
`https://palm-mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
),
linea_goerli: new HttpProvider(
`https://palm-mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
),
custom: new HttpProvider(`http://127.0.0.123:456/ethrpc?apiKey=foobar`),
};

type MockNetwork = {
provider: Provider;
Expand All @@ -308,8 +322,8 @@ type MockNetwork = {
};

const MOCK_NETWORK: MockNetwork = {
provider: MAINNET_PROVIDER,
blockTracker: buildMockBlockTracker('0x102833C'),
provider: HTTP_PROVIDERS.mainnet,
blockTracker: buildMockBlockTracker('0x102833C', HTTP_PROVIDERS.mainnet),
state: {
selectedNetworkClientId: NetworkType.goerli,
networksMetadata: {
Expand All @@ -328,8 +342,8 @@ const MOCK_NETWORK: MockNetwork = {
subscribe: () => undefined,
};
const MOCK_MAINNET_NETWORK: MockNetwork = {
provider: MAINNET_PROVIDER,
blockTracker: buildMockBlockTracker('0x102833C'),
provider: HTTP_PROVIDERS.mainnet,
blockTracker: buildMockBlockTracker('0x102833C', HTTP_PROVIDERS.mainnet),
state: {
selectedNetworkClientId: NetworkType.mainnet,
networksMetadata: {
Expand All @@ -349,8 +363,8 @@ const MOCK_MAINNET_NETWORK: MockNetwork = {
};

const MOCK_LINEA_MAINNET_NETWORK: MockNetwork = {
provider: PALM_PROVIDER,
blockTracker: buildMockBlockTracker('0xA6EDFC'),
provider: HTTP_PROVIDERS.linea,
blockTracker: buildMockBlockTracker('0xA6EDFC', HTTP_PROVIDERS.linea),
state: {
selectedNetworkClientId: NetworkType['linea-mainnet'],
networksMetadata: {
Expand All @@ -370,8 +384,8 @@ const MOCK_LINEA_MAINNET_NETWORK: MockNetwork = {
};

const MOCK_LINEA_GOERLI_NETWORK: MockNetwork = {
provider: PALM_PROVIDER,
blockTracker: buildMockBlockTracker('0xA6EDFC'),
provider: HTTP_PROVIDERS.linea_goerli,
blockTracker: buildMockBlockTracker('0xA6EDFC', HTTP_PROVIDERS.linea_goerli),
state: {
selectedNetworkClientId: NetworkType['linea-goerli'],
networksMetadata: {
Expand All @@ -391,8 +405,8 @@ const MOCK_LINEA_GOERLI_NETWORK: MockNetwork = {
};

const MOCK_CUSTOM_NETWORK: MockNetwork = {
provider: PALM_PROVIDER,
blockTracker: buildMockBlockTracker('0xA6EDFC'),
provider: HTTP_PROVIDERS.custom,
blockTracker: buildMockBlockTracker('0xA6EDFC', HTTP_PROVIDERS.custom),
state: {
selectedNetworkClientId: 'uuid-1',
networksMetadata: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ export class MultichainTrackingHelper {
networkClientId?: NetworkClientId;
chainId?: Hex;
} = {}): EthQuery | undefined {
if (!networkClientId && !chainId) {
if ((!networkClientId && !chainId) || !this.#isMultichainEnabled) {
const globalProvider = this.#getGlobalProviderAndBlockTracker()?.provider;
return globalProvider ? new EthQuery(globalProvider) : undefined;
}
Expand Down
7 changes: 3 additions & 4 deletions tests/fake-block-tracker.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { PollingBlockTracker } from '@metamask/eth-block-tracker';
import { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
import { JsonRpcEngine } from '@metamask/json-rpc-engine';
import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';

/**
* Acts like a PollingBlockTracker, but doesn't start the polling loop or
Expand All @@ -9,9 +8,9 @@ import { JsonRpcEngine } from '@metamask/json-rpc-engine';
export class FakeBlockTracker extends PollingBlockTracker {
#latestBlockNumber = '0x0';

constructor() {
constructor({ provider }: { provider: SafeEventEmitterProvider }) {
super({
provider: new SafeEventEmitterProvider({ engine: new JsonRpcEngine() }),
provider,
});
// Don't start the polling loop
// TODO: Replace `any` with type
Expand Down
1 change: 1 addition & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3145,6 +3145,7 @@ __metadata:
"@metamask/auto-changelog": ^3.4.4
"@metamask/base-controller": ^6.0.0
"@metamask/controller-utils": ^11.0.0
"@metamask/eth-json-rpc-provider": ^4.0.0
"@metamask/eth-query": ^4.0.0
"@metamask/ethjs-provider-http": ^0.3.0
"@metamask/gas-fee-controller": ^17.0.0
Expand Down
Loading