Skip to content

Commit

Permalink
Merge branch 'chore/update-eth-keyring-controller' of github.com:Meta…
Browse files Browse the repository at this point in the history 
…Mask/core into chore/update-eth-keyring-controller
  • Loading branch information
@mikesposito
mikesposito committed Jul 18, 2023
2 parents d69df21 + a7b7045 commit 0ff5406
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 18 deletions.
156 changes: 151 additions & 5 deletions packages/assets-controllers/src/TokenRatesController.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ describe('TokenRatesController', () => {
expect(mock).not.toThrow();
});

it('should update exchange rates when tokens change while polling is active', async () => {
it('should update exchange rates when tokens change', async () => {
sinon.useFakeTimers({ now: Date.now() });
let tokenStateChangeListener: (state: any) => void;
const onTokensStateChange = sinon.stub().callsFake((listener) => {
Expand Down Expand Up @@ -343,6 +343,52 @@ describe('TokenRatesController', () => {
expect(updateExchangeRatesStub.callCount).toBe(1);
});

it('should not update exchange rates when token state changes without "all tokens" or "all detected tokens" changing', async () => {
sinon.useFakeTimers({ now: Date.now() });
let tokenStateChangeListener: (state: any) => void;
const onTokensStateChange = sinon.stub().callsFake((listener) => {
tokenStateChangeListener = listener;
});
const onNetworkStateChange = sinon.stub();
const allTokens = {
[toHex(1)]: {
[defaultSelectedAddress]: [
{ address: 'foo', decimals: 0, symbol: '', aggregators: [] },
],
},
};
const allDetectedTokens = {};
const controller = new TokenRatesController(
{
chainId: toHex(1),
ticker: NetworksTicker.mainnet,
selectedAddress: defaultSelectedAddress,
onPreferencesStateChange: sinon.stub(),
onTokensStateChange,
onNetworkStateChange,
},
{
interval: 10,
allDetectedTokens,
allTokens,
},
);
await controller.start();
const updateExchangeRatesStub = sinon.stub(
controller,
'updateExchangeRates',
);

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
tokenStateChangeListener!({
allDetectedTokens,
allTokens,
tokens: [{ address: 'bar', decimals: 0, symbol: '', aggregators: [] }],
});

expect(updateExchangeRatesStub.callCount).toBe(0);
});

it('should not update exchange rates when tokens change while polling is inactive', async () => {
let tokenStateChangeListener: (state: any) => void;
const onTokensStateChange = sinon.stub().callsFake((listener) => {
Expand Down Expand Up @@ -391,7 +437,39 @@ describe('TokenRatesController', () => {
expect(updateExchangeRatesStub.callCount).toBe(0);
});

it('should update exchange rates when ticker changes while polling is active', async () => {
it('should update exchange rates when ticker changes', async () => {
sinon.useFakeTimers({ now: Date.now() });
let networkStateChangeListener: (state: any) => void;
const onTokensStateChange = sinon.stub();
const onNetworkStateChange = sinon.stub().callsFake((listener) => {
networkStateChangeListener = listener;
});
const controller = new TokenRatesController(
{
chainId: toHex(1337),
ticker: 'TEST',
selectedAddress: defaultSelectedAddress,
onPreferencesStateChange: sinon.stub(),
onTokensStateChange,
onNetworkStateChange,
},
{ interval: 10 },
);
await controller.start();
const updateExchangeRatesStub = sinon.stub(
controller,
'updateExchangeRates',
);

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
networkStateChangeListener!({
providerConfig: { chainId: toHex(1), ticker: NetworksTicker.mainnet },
});

expect(updateExchangeRatesStub.callCount).toBe(1);
});

it('should not update exchange rates when network state changes without a ticker/chain id change', async () => {
sinon.useFakeTimers({ now: Date.now() });
let networkStateChangeListener: (state: any) => void;
const onTokensStateChange = sinon.stub();
Expand All @@ -417,10 +495,10 @@ describe('TokenRatesController', () => {

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
networkStateChangeListener!({
providerConfig: { chainId: toHex(1), ticker: 'dai' },
providerConfig: { chainId: toHex(1), ticker: NetworksTicker.mainnet },
});

expect(updateExchangeRatesStub.callCount).toBe(1);
expect(updateExchangeRatesStub.callCount).toBe(0);
});

it('should not update exchange rates when ticker changes while polling is inactive', async () => {
Expand Down Expand Up @@ -453,7 +531,7 @@ describe('TokenRatesController', () => {
expect(updateExchangeRatesStub.callCount).toBe(0);
});

it('should update exchange rates when selected address changes while polling is active', async () => {
it('should update exchange rates when selected address changes', async () => {
sinon.useFakeTimers({ now: Date.now() });
nock(COINGECKO_API)
.get(`${COINGECKO_ETH_PATH}`)
Expand Down Expand Up @@ -507,6 +585,74 @@ describe('TokenRatesController', () => {
});
});

it('should not update exchange rates when preferences state changes without selected address changing', async () => {
sinon.useFakeTimers({ now: Date.now() });
nock(COINGECKO_API)
.get(`${COINGECKO_ETH_PATH}`)
.query({ contract_addresses: '0x02,0x03', vs_currencies: 'eth' })
.reply(200, {
'0x02': {
eth: 0.001, // token value in terms of ETH
},
'0x03': {
eth: 0.002,
},
});
const secondCall = nock(COINGECKO_API)
.get(`${COINGECKO_ETH_PATH}`)
.query({ contract_addresses: '0x02,0x03', vs_currencies: 'eth' })
.reply(200, {
'0x02': {
eth: 0.002, // token value in terms of ETH
},
'0x03': {
eth: 0.003,
},
});
let preferencesStateChangeListener: (state: any) => void;
const onPreferencesStateChange = sinon.stub().callsFake((listener) => {
preferencesStateChangeListener = listener;
});
const controller = new TokenRatesController(
{
chainId: toHex(1),
ticker: NetworksTicker.mainnet,
selectedAddress: defaultSelectedAddress,
onPreferencesStateChange,
onTokensStateChange: sinon.stub(),
onNetworkStateChange: sinon.stub(),
},
{
interval: 10,
allTokens: {
[toHex(1)]: {
[defaultSelectedAddress]: [
{ address: '0x02', decimals: 0, symbol: '', aggregators: [] },
{ address: '0x03', decimals: 0, symbol: '', aggregators: [] },
],
},
},
},
);
await controller.start();
expect(controller.state.contractExchangeRates).toStrictEqual({
'0x02': 0.001,
'0x03': 0.002,
});

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
await preferencesStateChangeListener!({
selectedAddress: defaultSelectedAddress,
exampleConfig: 'exampleValue',
});

expect(controller.state.contractExchangeRates).toStrictEqual({
'0x02': 0.001,
'0x03': 0.002,
});
expect(secondCall.isDone()).toBe(false);
});

it('should not update exchange rates when selected address changes while polling is inactive', async () => {
sinon.useFakeTimers({ now: Date.now() });
let preferencesStateChangeListener: (state: any) => void;
Expand Down
39 changes: 26 additions & 13 deletions packages/assets-controllers/src/TokenRatesController.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,28 +230,41 @@ export class TokenRatesController extends BaseController<
this.#updateTokenList();

onPreferencesStateChange(async ({ selectedAddress }) => {
this.configure({ selectedAddress });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
if (this.config.selectedAddress !== selectedAddress) {
this.configure({ selectedAddress });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
}
}
});

onTokensStateChange(async ({ allTokens, allDetectedTokens }) => {
this.configure({ allTokens, allDetectedTokens });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
// These two state properties are assumed to be immutable
if (
this.config.allTokens !== allTokens ||
this.config.allDetectedTokens !== allDetectedTokens
) {
this.configure({ allTokens, allDetectedTokens });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
}
}
});

onNetworkStateChange(async ({ providerConfig }) => {
const { chainId, ticker } = providerConfig;
this.update({ contractExchangeRates: {} });
this.configure({ chainId, nativeCurrency: ticker });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
if (
this.config.chainId !== chainId ||
this.config.nativeCurrency !== ticker
) {
this.update({ contractExchangeRates: {} });
this.configure({ chainId, nativeCurrency: ticker });
this.#updateTokenList();
if (this.#pollState === PollState.Active) {
await this.updateExchangeRates();
}
}
});
}
Expand Down

0 comments on commit 0ff5406

Please sign in to comment.