Skip to content

Retrieve global provider and block tracker dynamically #4004

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

Draft
matthewwalsh0 wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Retrieve global provider and block tracker dynamically #4004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dcd86f0
Remove provider and block tracker constructor options
matthewwalsh0 Feb 29, 2024
8df4f82
Generate selected network client using proxy objects and provider config
matthewwalsh0 Feb 29, 2024
5ee8f99
Merge branch 'main' into feat/dynamic-global-provider-block-tracker
matthewwalsh0 Mar 19, 2024
6d6cfb4
Fix unit tests
matthewwalsh0 Mar 20, 2024
8adaf82
Merge branch 'main' into feat/dynamic-global-provider-block-tracker
matthewwalsh0 Mar 20, 2024
1f423f2
Update coverage targets
matthewwalsh0 Mar 20, 2024
4fcdcbd
Merge branch 'main' into feat/dynamic-global-provider-block-tracker
legobeat May 29, 2024
ece1ce1
lint:fix
legobeat May 29, 2024
f27ebf6
Merge branch 'main' into feat/dynamic-global-provider-block-tracker
dbrans Jun 3, 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
5 changes: 4 additions & 1 deletion packages/permission-controller/src/SubjectMetadataController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,8 @@ export class SubjectMetadataController extends BaseController<
this.subjectsWithoutPermissionsEncounteredSinceStartup.add(origin);

this.update((draftState) => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore something about string-indexing
draftState.subjectMetadata[origin] = newMetadata;
if (typeof originToForget === 'string') {
delete draftState.subjectMetadata[originToForget];
Expand All @@ -231,7 +233,8 @@ export class SubjectMetadataController extends BaseController<
*/
trimMetadataState(): void {
this.update((draftState) => {
// @ts-expect-error ts(2589)
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore infinite type-resursion srsly
return SubjectMetadataController.getTrimmedState(
draftState,
this.subjectHasPermissions,
Expand Down
188 changes: 25 additions & 163 deletions packages/transaction-controller/src/TransactionController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import type {
Provider,
} from '@metamask/network-controller';
import { NetworkClientType, NetworkStatus } from '@metamask/network-controller';
import * as NonceTrackerPackage from '@metamask/nonce-tracker';
import { errorCodes, providerErrors, rpcErrors } from '@metamask/rpc-errors';
import { createDeferredPromise } from '@metamask/utils';
import assert from 'assert';
Expand Down Expand Up @@ -294,9 +293,6 @@ function waitForTransactionFinished(

const MOCK_PREFERENCES = { state: { selectedAddress: 'foo' } };
const INFURA_PROJECT_ID = '341eacb578dd44a1a049cbc5f6fd4035';
const GOERLI_PROVIDER = new HttpProvider(
`https://goerli.infura.io/v3/${INFURA_PROJECT_ID}`,
);
const MAINNET_PROVIDER = new HttpProvider(
`https://mainnet.infura.io/v3/${INFURA_PROJECT_ID}`,
);
Expand Down Expand Up @@ -331,24 +327,6 @@ const MOCK_NETWORK: MockNetwork = {
},
subscribe: () => undefined,
};
const MOCK_NETWORK_WITHOUT_CHAIN_ID: MockNetwork = {
provider: GOERLI_PROVIDER,
blockTracker: buildMockBlockTracker('0x102833C'),
state: {
selectedNetworkClientId: NetworkType.goerli,
networksMetadata: {
[NetworkType.goerli]: {
EIPS: { 1559: false },
status: NetworkStatus.Available,
},
},
providerConfig: {
type: NetworkType.goerli,
} as NetworkState['providerConfig'],
networkConfigurations: {},
},
subscribe: () => undefined,
};
const MOCK_MAINNET_NETWORK: MockNetwork = {
provider: MAINNET_PROVIDER,
blockTracker: buildMockBlockTracker('0x102833C'),
Expand Down Expand Up @@ -572,11 +550,14 @@ describe('TransactionController', () => {
);

const { messenger: givenRestrictedMessenger, ...otherOptions } = {
blockTracker: network.blockTracker,
disableHistory: false,
disableSendFlowHistory: false,
disableSwaps: false,
getCurrentNetworkEIP1559Compatibility: async () => false,
getGlobalProviderAndBlockTracker: () => ({
provider: network.provider,
blockTracker: network.blockTracker,
}),
getNetworkState: () => network.state,
// TODO: Replace with a real type
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand All @@ -586,7 +567,6 @@ describe('TransactionController', () => {
isMultichainEnabled: false,
hooks: {},
onNetworkStateChange: network.subscribe,
provider: network.provider,
sign: async (transaction: TypedTransaction) => transaction,
transactionHistoryLimit: 40,
...givenOptions,
Expand Down Expand Up @@ -780,21 +760,25 @@ describe('TransactionController', () => {
return pendingTransactionTrackerMock;
});

multichainTrackingHelperClassMock.mockImplementation(({ provider }) => {
multichainTrackingHelperMock = {
getEthQuery: jest.fn().mockImplementation(() => {
return new EthQuery(provider);
}),
getProvider: jest.fn().mockImplementation(() => {
return provider;
}),
checkForPendingTransactionAndStartPolling: jest.fn(),
getNonceLock: getNonceLockSpy,
initialize: jest.fn(),
has: jest.fn().mockReturnValue(false),
} as unknown as jest.Mocked<MultichainTrackingHelper>;
return multichainTrackingHelperMock;
});
multichainTrackingHelperClassMock.mockImplementation(
({ getGlobalProviderAndBlockTracker }) => {
multichainTrackingHelperMock = {
getEthQuery: jest.fn().mockImplementation(() => {
return new EthQuery(
getGlobalProviderAndBlockTracker()?.provider as Provider,
);
}),
getProvider: jest.fn().mockImplementation(() => {
return getGlobalProviderAndBlockTracker()?.provider as Provider;
}),
checkForPendingTransactionAndStartPolling: jest.fn(),
getNonceLock: getNonceLockSpy,
initialize: jest.fn(),
has: jest.fn().mockReturnValue(false),
} as unknown as jest.Mocked<MultichainTrackingHelper>;
return multichainTrackingHelperMock;
},
);

defaultGasFeeFlowClassMock.mockImplementation(() => {
defaultGasFeeFlowMock = {
Expand Down Expand Up @@ -882,117 +866,6 @@ describe('TransactionController', () => {
pendingTransactionTrackerMock.startIfPendingTransactions,
).toHaveBeenCalledTimes(1);
});

describe('nonce tracker', () => {
it('uses external pending transactions', async () => {
const nonceTrackerMock = jest
.spyOn(NonceTrackerPackage, 'NonceTracker')
.mockImplementation();

const externalPendingTransactions = [
{
from: '0x1',
},
{ from: '0x2' },
];

const getExternalPendingTransactions = jest
.fn()
.mockReturnValueOnce(externalPendingTransactions);

setupController({
options: {
getExternalPendingTransactions,
state: {
transactions: [
{
...TRANSACTION_META_MOCK,
chainId: MOCK_NETWORK.state.providerConfig.chainId,
status: TransactionStatus.submitted,
},
],
},
},
});

const pendingTransactions =
nonceTrackerMock.mock.calls[0][0].getPendingTransactions(
ACCOUNT_MOCK,
);

expect(nonceTrackerMock).toHaveBeenCalledTimes(1);
expect(pendingTransactions).toStrictEqual([
expect.any(Object),
...externalPendingTransactions,
]);
expect(getExternalPendingTransactions).toHaveBeenCalledTimes(1);
expect(getExternalPendingTransactions).toHaveBeenCalledWith(
ACCOUNT_MOCK,
// This is undefined for the base nonceTracker
undefined,
);
});
});

describe('onBootCleanup', () => {
afterEach(() => {
updateGasMock.mockReset();
updateGasFeesMock.mockReset();
});

it('submits approved transactions for all chains', async () => {
const mockTransactionMeta = {
from: ACCOUNT_MOCK,
status: TransactionStatus.approved,
txParams: {
from: ACCOUNT_MOCK,
to: ACCOUNT_2_MOCK,
},
};
const mockedTransactions = [
{
id: '123',
history: [{ ...mockTransactionMeta, id: '123' }],
chainId: toHex(5),
...mockTransactionMeta,
},
{
id: '456',
history: [{ ...mockTransactionMeta, id: '456' }],
chainId: toHex(1),
...mockTransactionMeta,
},
{
id: '789',
history: [{ ...mockTransactionMeta, id: '789' }],
chainId: toHex(16),
...mockTransactionMeta,
},
];

const mockedControllerState = {
transactions: mockedTransactions,
methodData: {},
lastFetchedBlockNumbers: {},
};

const { controller } = setupController({
options: {
// TODO: Replace `any` with type
// eslint-disable-next-line @typescript-eslint/no-explicit-any
state: mockedControllerState as any,
},
});

await flushPromises();

const { transactions } = controller.state;

expect(transactions[0].status).toBe(TransactionStatus.submitted);
expect(transactions[1].status).toBe(TransactionStatus.submitted);
expect(transactions[2].status).toBe(TransactionStatus.submitted);
});
});
});

describe('estimateGas', () => {
Expand Down Expand Up @@ -1441,6 +1314,8 @@ describe('TransactionController', () => {
to: ACCOUNT_MOCK,
});

await flushPromises();

const expectedInitialSnapshot = {
actionId: undefined,
chainId: expect.any(String),
Expand Down Expand Up @@ -2001,19 +1876,6 @@ describe('TransactionController', () => {
await expectTransactionToFail(controller, 'No sign method defined');
});

it('if no chainId defined', async () => {
const { controller } = setupController({
network: MOCK_NETWORK_WITHOUT_CHAIN_ID,
messengerOptions: {
addTransactionApprovalRequest: {
state: 'approved',
},
},
});

await expectTransactionToFail(controller, 'No chainId defined');
});

it('if unexpected status', async () => {
const { controller, messenger } = setupController();

Expand Down
Loading