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.

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

Refactor RPC getAccounts usage #5620

Merged
merged 2 commits into from
Apr 6, 2023
Merged

Refactor RPC getAccounts usage #5620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecc33fc
Refactor RPC `getAccounts` usage
Gudahtt Jan 26, 2023
2029c06
Add unit tests
Gudahtt Apr 5, 2023
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
19 changes: 2 additions & 17 deletions app/core/Engine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,23 +111,8 @@ class Engine {
};

const networkController = new NetworkController(networkControllerOpts);
networkController.providerConfig = {
getAccounts: (
end: (arg0: null, arg1: any[]) => void,
payload: { hostname: string | number },
) => {
const { approvedHosts } = store.getState();
const isEnabled = approvedHosts[payload.hostname];
const { KeyringController } = this.context;
const isUnlocked = KeyringController.isUnlocked();
const selectedAddress =
this.context.PreferencesController.state.selectedAddress;
end(
null,
isUnlocked && isEnabled && selectedAddress ? [selectedAddress] : [],
);
},
};
// This still needs to be set because it has the side-effect of initializing the provider
networkController.providerConfig = {};
const assetsContractController = new AssetsContractController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
Expand Down
137 changes: 137 additions & 0 deletions app/core/RPCMethods/RPCMethodMiddleware.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,143 @@ describe('getRpcMethodMiddleware', () => {
expect(response.result).toBe('success');
});

const accountMethods = [
'eth_accounts',
'eth_coinbase',
'parity_defaultAccount',
];
for (const method of accountMethods) {
describe(method, () => {
describe('browser', () => {
it('returns permitted accounts for connected site', async () => {
const mockAddress1 = '0x0000000000000000000000000000000000000001';
const mockAddress2 = '0x0000000000000000000000000000000000000001';
setupGlobalState({
permittedAccounts: { 'example.metamask.io': [mockAddress1] },
selectedAddress: mockAddress2,
});
const middleware = getRpcMethodMiddleware({
...getMinimalBrowserOptions(),
hostname: 'example.metamask.io',
});
const request = {
jsonrpc,
id: 1,
method,
};

const response = await callMiddleware({ middleware, request });

expect((response as JsonRpcFailure).error).toBeUndefined();
expect((response as JsonRpcSuccess<string>).result).toStrictEqual([
mockAddress1,
]);
});

it('returns an empty array for an unconnected site', async () => {
const mockAddress = '0x0000000000000000000000000000000000000001';
setupGlobalState({
permittedAccounts: {},
selectedAddress: mockAddress,
});
const middleware = getRpcMethodMiddleware({
...getMinimalBrowserOptions(),
hostname: 'example.metamask.io',
});
const request = {
jsonrpc,
id: 1,
method,
};

const response = await callMiddleware({ middleware, request });

expect((response as JsonRpcFailure).error).toBeUndefined();
expect((response as JsonRpcSuccess<string>).result).toStrictEqual([]);
});
});

describe('WalletConnect', () => {
it('returns the selected account', async () => {
const mockAddress1 = '0x0000000000000000000000000000000000000001';
const mockAddress2 = '0x0000000000000000000000000000000000000001';
setupGlobalState({
permittedAccounts: { 'example.metamask.io': [mockAddress1] },
selectedAddress: mockAddress2,
});
const middleware = getRpcMethodMiddleware({
...getMinimalWalletConnectOptions(),
hostname: 'example.metamask.io',
});
const request = {
jsonrpc,
id: 1,
method,
};

const response = await callMiddleware({ middleware, request });

expect((response as JsonRpcFailure).error).toBeUndefined();
expect((response as JsonRpcSuccess<string>).result).toStrictEqual([
mockAddress2,
]);
});
});

describe('SDK', () => {
it('returns the selected account for an approved host', async () => {
const mockAddress1 = '0x0000000000000000000000000000000000000001';
const mockAddress2 = '0x0000000000000000000000000000000000000001';
setupGlobalState({
permittedAccounts: { 'example.metamask.io': [mockAddress1] },
selectedAddress: mockAddress2,
});
const middleware = getRpcMethodMiddleware({
...getMinimalSDKOptions(),
hostname: 'example.metamask.io',
getApprovedHosts: () => ({ 'example.metamask.io': true }),
});
const request = {
jsonrpc,
id: 1,
method,
};

const response = await callMiddleware({ middleware, request });

expect((response as JsonRpcFailure).error).toBeUndefined();
expect((response as JsonRpcSuccess<string>).result).toStrictEqual([
mockAddress2,
]);
});

it('returns an empty array for an unapproved host', async () => {
const mockAddress1 = '0x0000000000000000000000000000000000000001';
const mockAddress2 = '0x0000000000000000000000000000000000000001';
setupGlobalState({
permittedAccounts: { 'example.metamask.io': [mockAddress1] },
selectedAddress: mockAddress2,
});
const middleware = getRpcMethodMiddleware({
...getMinimalSDKOptions(),
hostname: 'example.metamask.io',
getApprovedHosts: () => ({}),
});
const request = {
jsonrpc,
id: 1,
method,
};

const response = await callMiddleware({ middleware, request });

expect((response as JsonRpcFailure).error).toBeUndefined();
expect((response as JsonRpcSuccess<string>).result).toStrictEqual([]);
});
});
});
}

describe('eth_sendTransaction', () => {
describe('browser', () => {
it('sends the transaction and returns the resulting hash', async () => {
Expand Down
1 change: 1 addition & 0 deletions app/core/RPCMethods/RPCMethodMiddleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,7 @@ export const getRpcMethodMiddleware = ({
},
eth_accounts: getEthAccounts,
eth_coinbase: getEthAccounts,
parity_defaultAccount: getEthAccounts,
Gudahtt marked this conversation as resolved.
Show resolved Hide resolved
eth_sendTransaction: async () => {
checkTabActive();
const { TransactionController } = Engine.context;
Expand Down