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

Add chainId support to TokenRatesController #476

Merged
merged 13 commits into from
Jul 5, 2021
Merged

Add chainId support to TokenRatesController #476

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
84ac2fd
Initial proposal for chainId support of TokenRatesController
wachunei May 24, 2021
b720274
Default to ethereum mainnet chain
wachunei May 24, 2021
efddcdf
Get chainSlugIdentifier on update
wachunei May 25, 2021
8ad4be4
Merge branch 'main' into feature/token-rate-chainid
wachunei Jun 2, 2021
f3524f6
Add supportedChains and chainCache
wachunei Jun 5, 2021
4830c33
Cache response instead of individual slugs
wachunei Jun 11, 2021
1774012
Merge branch 'main' into feature/token-rate-chainid
wachunei Jun 17, 2021
0db47bd
Update interval test
wachunei Jun 23, 2021
204ff43
Merge branch 'main' into feature/token-rate-chainid
wachunei Jun 23, 2021
bca002a
Use 6 hours threshold
wachunei Jun 24, 2021
e4bc0d1
Merge branch 'main' into feature/token-rate-chainid
wachunei Jul 1, 2021
1aa1bfb
Rename COINGECKO_API to CoinGeckoApi
wachunei Jul 2, 2021
120f654
Merge branch 'main' into feature/token-rate-chainid
wachunei Jul 2, 2021
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
125 changes: 97 additions & 28 deletions src/assets/TokenRatesController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,58 @@ import { AssetsController } from './AssetsController';
import { AssetsContractController } from './AssetsContractController';

const COINGECKO_HOST = 'https://api.coingecko.com';
const COINGECKO_PATH = '/api/v3/simple/token_price/ethereum';
const COINGECKO_ETH_PATH = '/api/v3/simple/token_price/ethereum';
const COINGECKO_BSC_PATH = '/api/v3/simple/token_price/binance-smart-chain';
const COINGECKO_ASSETS_PATH = '/api/v3/asset_platforms';
const ADDRESS = '0x01';

describe('TokenRatesController', () => {
beforeEach(() => {
nock(COINGECKO_HOST)
.get(COINGECKO_ASSETS_PATH)
.reply(200, [
{
id: 'binance-smart-chain',
chain_identifier: 56,
name: 'Binance Smart Chain',
shortname: 'BSC',
},
{
id: 'ethereum',
chain_identifier: 1,
name: 'Ethereum',
shortname: '',
},
])
.get(
`${COINGECKO_PATH}?contract_addresses=0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359,${ADDRESS}&vs_currencies=eth`,
`${COINGECKO_ETH_PATH}?contract_addresses=0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359,${ADDRESS}&vs_currencies=eth`,
)
.reply(200, {
'0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359': { eth: 0.00561045 },
})
.get(`${COINGECKO_PATH}?contract_addresses=${ADDRESS}&vs_currencies=eth`)
.get(
`${COINGECKO_ETH_PATH}?contract_addresses=${ADDRESS}&vs_currencies=eth`,
)
.reply(200, {})
.get(`${COINGECKO_PATH}?contract_addresses=bar&vs_currencies=eth`)
.get(`${COINGECKO_ETH_PATH}?contract_addresses=bar&vs_currencies=eth`)
.reply(200, {})
.get(`${COINGECKO_PATH}?contract_addresses=${ADDRESS}&vs_currencies=gno`)
.get(
`${COINGECKO_ETH_PATH}?contract_addresses=${ADDRESS}&vs_currencies=gno`,
)
.reply(200, {})
.get(
`${COINGECKO_BSC_PATH}?contract_addresses=0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359,${ADDRESS}&vs_currencies=eth`,
)
.reply(200, {
'0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359': { eth: 0.00561045 },
})
.get(`${COINGECKO_BSC_PATH}?contract_addresses=0xfoO&vs_currencies=eth`)
.reply(200, {})
.get(`${COINGECKO_BSC_PATH}?contract_addresses=bar&vs_currencies=eth`)
.reply(200, {})
.get(`${COINGECKO_BSC_PATH}?contract_addresses=0xfoO&vs_currencies=gno`)
.reply(200, {})

.persist();

nock('https://min-api.cryptocompare.com')
Expand All @@ -41,56 +75,76 @@ describe('TokenRatesController', () => {
const controller = new TokenRatesController({
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
});
expect(controller.state).toStrictEqual({
contractExchangeRates: {},
supportedChains: {
data: null,
timestamp: 0,
},
});
expect(controller.state).toStrictEqual({ contractExchangeRates: {} });
});

it('should initialize with the default config', () => {
const controller = new TokenRatesController({
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
});
expect(controller.config).toStrictEqual({
disabled: false,
interval: 180000,
nativeCurrency: 'eth',
chainId: '',
tokens: [],
threshold: 21600000,
});
});

it('should throw when tokens property is accessed', () => {
const controller = new TokenRatesController({
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
});
expect(() => console.log(controller.tokens)).toThrow(
'Property only used for setting',
);
});

it('should poll and update rate in the right interval', async () => {
await new Promise<void>((resolve) => {
const mock = stub(TokenRatesController.prototype, 'fetchExchangeRate');
new TokenRatesController(
{ onAssetsStateChange: stub(), onCurrencyRateStateChange: stub() },
{
interval: 10,
tokens: [{ address: 'bar', decimals: 0, symbol: '' }],
},
);
expect(mock.called).toBe(true);
expect(mock.calledTwice).toBe(false);
setTimeout(() => {
expect(mock.calledTwice).toBe(true);
mock.restore();
resolve();
}, 15);
const pollSpy = jest.spyOn(TokenRatesController.prototype, 'poll');
const interval = 100;
const times = 5;
new TokenRatesController(
{
onAssetsStateChange: jest.fn(),
onCurrencyRateStateChange: jest.fn(),
onNetworkStateChange: jest.fn(),
},
{
interval,
tokens: [{ address: 'bar', decimals: 0, symbol: '' }],
},
);

expect(pollSpy).toHaveBeenCalledTimes(1);
expect(pollSpy).not.toHaveBeenCalledTimes(times);
await new Promise((resolve) => {
setTimeout(resolve, interval * (times - 0.5));
});
expect(pollSpy).toHaveBeenCalledTimes(times);
pollSpy.mockClear();
});

it('should not update rates if disabled', async () => {
const controller = new TokenRatesController(
{ onAssetsStateChange: stub(), onCurrencyRateStateChange: stub() },
{
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
},
{
interval: 10,
},
Expand All @@ -104,7 +158,11 @@ describe('TokenRatesController', () => {
it('should clear previous interval', async () => {
const mock = stub(global, 'clearTimeout');
const controller = new TokenRatesController(
{ onAssetsStateChange: stub(), onCurrencyRateStateChange: stub() },
{
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
},
{ interval: 1337 },
);
await new Promise<void>((resolve) => {
Expand Down Expand Up @@ -134,8 +192,9 @@ describe('TokenRatesController', () => {
{
onAssetsStateChange: (listener) => assets.subscribe(listener),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: (listener) => network.subscribe(listener),
},
{ interval: 10 },
{ interval: 10, chainId: '1' },
);
const address = '0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359';
expect(controller.state.contractExchangeRates).toStrictEqual({});
Expand All @@ -156,7 +215,11 @@ describe('TokenRatesController', () => {

it('should handle balance not found in API', async () => {
const controller = new TokenRatesController(
{ onAssetsStateChange: stub(), onCurrencyRateStateChange: stub() },
{
onAssetsStateChange: stub(),
onCurrencyRateStateChange: stub(),
onNetworkStateChange: stub(),
},
{ interval: 10 },
);
stub(controller, 'fetchExchangeRate').throws({
Expand All @@ -176,18 +239,21 @@ describe('TokenRatesController', () => {
assetStateChangeListener = listener;
});
const onCurrencyRateStateChange = stub();
const onNetworkStateChange = stub();
const controller = new TokenRatesController(
{
onAssetsStateChange,
onCurrencyRateStateChange,
onNetworkStateChange,
},
{ interval: 10 },
);

const updateExchangeRatesStub = stub(controller, 'updateExchangeRates');
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
assetStateChangeListener!({ tokens: [] });
expect(updateExchangeRatesStub.callCount).toStrictEqual(1);
// FIXME: This is now being called twice
expect(updateExchangeRatesStub.callCount).toStrictEqual(2);
});

it('should update exchange rates when native currency changes', async () => {
Expand All @@ -196,17 +262,20 @@ describe('TokenRatesController', () => {
const onCurrencyRateStateChange = stub().callsFake((listener) => {
currencyRateStateChangeListener = listener;
});
const onNetworkStateChange = stub();
const controller = new TokenRatesController(
{
onAssetsStateChange,
onCurrencyRateStateChange,
onNetworkStateChange,
},
{ interval: 10 },
);

const updateExchangeRatesStub = stub(controller, 'updateExchangeRates');
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
currencyRateStateChangeListener!({ nativeCurrency: 'dai' });
expect(updateExchangeRatesStub.callCount).toStrictEqual(1);
// FIXME: This is now being called twice
expect(updateExchangeRatesStub.callCount).toStrictEqual(2);
});
});
Loading