Skip to content

Commit

Permalink
fix: rename MultichainAssetsRatesController
Browse files Browse the repository at this point in the history
  • Loading branch information
salimtb committed Feb 18, 2025
1 parent b9cb503 commit aad1467
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { InternalAccount } from '@metamask/keyring-internal-api';
import { KeyringClient } from '@metamask/keyring-snap-client';
import { useFakeTimers } from 'sinon';

import { MultiChainAssetsRatesController } from '.';
import { MultichainAssetsRatesController } from '.';
import {
type AllowedActions,
type AllowedEvents,
Expand Down Expand Up @@ -81,7 +81,7 @@ const setupController = ({
accountsAssets = [fakeNonEvmAccount, fakeEvmAccount, fakeEvmAccount2],
}: {
config?: Partial<
ConstructorParameters<typeof MultiChainAssetsRatesController>[0]
ConstructorParameters<typeof MultichainAssetsRatesController>[0]
>;
accountsAssets?: InternalAccount[];
} = {}) => {
Expand Down Expand Up @@ -118,7 +118,7 @@ const setupController = ({
}));

const multiChainAssetsRatesControllerMessenger = messenger.getRestricted({
name: 'MultiChainAssetsRatesController',
name: 'MultichainAssetsRatesController',
allowedActions: [
'AccountsController:listMultichainAccounts',
'SnapController:handleRequest',
Expand All @@ -135,15 +135,15 @@ const setupController = ({
});

return {
controller: new MultiChainAssetsRatesController({
controller: new MultichainAssetsRatesController({
messenger: multiChainAssetsRatesControllerMessenger,
...config,
}),
messenger,
};
};

describe('MultiChainAssetsRatesController', () => {
describe('MultichainAssetsRatesController', () => {
let clock: sinon.SinonFakeTimers;

const mockedDate = 1705760550000;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ import type {
} from '../MultichainAssetsController';

/**
* The name of the MultiChainAssetsRatesController.
* The name of the MultichainAssetsRatesController.
*/
const controllerName = 'MultiChainAssetsRatesController';
const controllerName = 'MultichainAssetsRatesController';

/**
* State used by the MultiChainAssetsRatesController to cache token conversion rates.
* State used by the MultichainAssetsRatesController to cache token conversion rates.
*/
export type MultichainAssetsRatesControllerState = {
conversionRates: Record<CaipAssetType, AssetConversion>;
};

/**
* Returns the state of the MultiChainAssetsRatesController.
* Returns the state of the MultichainAssetsRatesController.
*/
export type MultichainAssetsRatesControllerGetStateAction =
ControllerGetStateAction<
Expand All @@ -63,7 +63,7 @@ export type MultichainAssetsRatesControllerGetStateAction =
*/
export type MultichainAssetsRatesControllerUpdateRatesAction = {
type: `${typeof controllerName}:updateAssetsRates`;
handler: MultiChainAssetsRatesController['updateAssetsRates'];
handler: MultichainAssetsRatesController['updateAssetsRates'];
};

/**
Expand All @@ -79,7 +79,7 @@ export function getDefaultMultichainAssetsRatesControllerState(): MultichainAsse
}

/**
* Event emitted when the state of the MultiChainAssetsRatesController changes.
* Event emitted when the state of the MultichainAssetsRatesController changes.
*/
export type MultichainAssetsRatesControllerStateChange =
ControllerStateChangeEvent<
Expand All @@ -88,14 +88,14 @@ export type MultichainAssetsRatesControllerStateChange =
>;

/**
* Actions exposed by the MultiChainAssetsRatesController.
* Actions exposed by the MultichainAssetsRatesController.
*/
export type MultichainAssetsRatesControllerActions =
| MultichainAssetsRatesControllerGetStateAction
| MultichainAssetsRatesControllerUpdateRatesAction;

/**
* Events emitted by MultiChainAssetsRatesController.
* Events emitted by MultichainAssetsRatesController.
*/
export type MultichainAssetsRatesControllerEvents =
MultichainAssetsRatesControllerStateChange;
Expand All @@ -119,7 +119,7 @@ export type AllowedEvents =
| MultichainAssetsControllerStateChangeEvent;

/**
* Messenger type for the MultiChainAssetsRatesController.
* Messenger type for the MultichainAssetsRatesController.
*/
export type MultichainAssetsRatesControllerMessenger = RestrictedMessenger<
typeof controllerName,
Expand All @@ -130,9 +130,9 @@ export type MultichainAssetsRatesControllerMessenger = RestrictedMessenger<
>;

/**
* The input for starting polling in MultiChainAssetsRatesController.
* The input for starting polling in MultichainAssetsRatesController.
*/
export type MultiChainAssetsRatesPollingInput = {
export type MultichainAssetsRatesPollingInput = {
accountId: string;
};

Expand All @@ -145,7 +145,7 @@ const metadata = {
*
* This controller polls for token conversion rates and updates its state.
*/
export class MultiChainAssetsRatesController extends StaticIntervalPollingController<MultiChainAssetsRatesPollingInput>()<
export class MultichainAssetsRatesController extends StaticIntervalPollingController<MultichainAssetsRatesPollingInput>()<
typeof controllerName,
MultichainAssetsRatesControllerState,
MultichainAssetsRatesControllerMessenger
Expand All @@ -159,7 +159,7 @@ export class MultiChainAssetsRatesController extends StaticIntervalPollingContro
#isUnlocked = true;

/**
* Creates an instance of MultiChainAssetsRatesController.
* Creates an instance of MultichainAssetsRatesController.
*
* @param options - Constructor options.
* @param options.interval - The polling interval in milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ export type {
} from './MultichainAssetsRatesController';

export {
MultiChainAssetsRatesController,
MultichainAssetsRatesController,
getDefaultMultichainAssetsRatesControllerState,
} from './MultichainAssetsRatesController';
2 changes: 1 addition & 1 deletion packages/assets-controllers/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export type {
} from './MultichainAssetsController';

export {
MultiChainAssetsRatesController,
MultichainAssetsRatesController,
getDefaultMultichainAssetsRatesControllerState,
} from './MultichainAssetsRatesController';

Expand Down

0 comments on commit aad1467

Please sign in to comment.