@metamask-previews/token-search-discovery-controller 3.5.1-preview-9fa15fd0 → 4.0.0-preview-55f130d1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -1
- package/dist/token-search-discovery-controller.cjs +2 -2
- package/dist/token-search-discovery-controller.cjs.map +1 -1
- package/dist/token-search-discovery-controller.d.cts +3 -11
- package/dist/token-search-discovery-controller.d.cts.map +1 -1
- package/dist/token-search-discovery-controller.d.mts +3 -11
- package/dist/token-search-discovery-controller.d.mts.map +1 -1
- package/dist/token-search-discovery-controller.mjs +2 -2
- package/dist/token-search-discovery-controller.mjs.map +1 -1
- package/package.json +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [4.0.0]
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6495](https://github.com/MetaMask/core/pull/6495))
|
|
15
|
+
- Previously, `TokenSearchDiscoveryController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
|
|
16
|
+
- **BREAKING:** Metadata property `anonymous` renamed to `includeInDebugSnapshot` ([#6495](https://github.com/MetaMask/core/pull/6495))
|
|
17
|
+
- Bump `@metamask/base-controller` from `^8.4.2` to `^9.0.0` ([#6962](https://github.com/MetaMask/core/pull/6962))
|
|
18
|
+
|
|
10
19
|
## [3.5.1]
|
|
11
20
|
|
|
12
21
|
### Changed
|
|
@@ -105,7 +114,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
105
114
|
- This service is responsible for making search related requests to the Portfolio API
|
|
106
115
|
- Specifically, it handles the `tokens-search` endpoint which returns a list of tokens based on the provided query parameters
|
|
107
116
|
|
|
108
|
-
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@
|
|
117
|
+
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@4.0.0...HEAD
|
|
118
|
+
[4.0.0]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@3.5.1...@metamask/token-search-discovery-controller@4.0.0
|
|
109
119
|
[3.5.1]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@3.5.0...@metamask/token-search-discovery-controller@3.5.1
|
|
110
120
|
[3.5.0]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@3.4.0...@metamask/token-search-discovery-controller@3.5.0
|
|
111
121
|
[3.4.0]: https://github.com/MetaMask/core/compare/@metamask/token-search-discovery-controller@3.3.0...@metamask/token-search-discovery-controller@3.4.0
|
|
@@ -20,13 +20,13 @@ const tokenSearchDiscoveryControllerMetadata = {
|
|
|
20
20
|
recentSearches: {
|
|
21
21
|
includeInStateLogs: true,
|
|
22
22
|
persist: true,
|
|
23
|
-
|
|
23
|
+
includeInDebugSnapshot: false,
|
|
24
24
|
usedInUi: true,
|
|
25
25
|
},
|
|
26
26
|
lastSearchTimestamp: {
|
|
27
27
|
includeInStateLogs: true,
|
|
28
28
|
persist: true,
|
|
29
|
-
|
|
29
|
+
includeInDebugSnapshot: false,
|
|
30
30
|
usedInUi: true,
|
|
31
31
|
},
|
|
32
32
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"token-search-discovery-controller.cjs","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"token-search-discovery-controller.cjs","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAKmC;AAiBnC,kBAAkB;AAElB,MAAM,cAAc,GAAG,gCAAgC,CAAC;AASxD,MAAM,sCAAsC,GAC1C;IACE,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,mBAAmB,EAAE;QACnB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAgDJ;;;;;;;GAOG;AACH,SAAgB,6CAA6C;IAC3D,OAAO;QACL,cAAc,EAAE,EAAE;QAClB,mBAAmB,EAAE,IAAI;KAC1B,CAAC;AACJ,CAAC;AALD,sGAKC;AAED;;;GAGG;AACH,MAAa,8BAA+B,SAAQ,gCAInD;IAKC,YAAY,EACV,kBAAkB,EAClB,qBAAqB,EACrB,KAAK,GAAG,EAAE,EACV,SAAS,GAMV;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,sCAAsC;YAChD,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,6CAA6C,EAAE,EAAE,GAAG,KAAK,EAAE;SACxE,CAAC,CAAC;QApBI,qEAAmD;QAEnD,wEAAyD;QAoBhE,uBAAA,IAAI,sDAAuB,kBAAkB,MAAA,CAAC;QAC9C,uBAAA,IAAI,yDAA0B,qBAAqB,MAAA,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,iBAAoC;QAEpC,MAAM,OAAO,GACX,MAAM,uBAAA,IAAI,0DAAoB,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAEjE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,0BAAsD;QAEtD,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0DAAoB,CAAC,qBAAqB,CAClE,0BAA0B,CAC3B,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,0BAAsD;QAEtD,OAAO,uBAAA,IAAI,0DAAoB,CAAC,qBAAqB,CACnD,0BAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAA4B;QAE5B,OAAO,uBAAA,IAAI,6DAAuB,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAwB;QAExB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAAuB;QAEvB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAAsB;QAEtB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;CACF;AA3FD,wEA2FC","sourcesContent":["import {\n BaseController,\n type ControllerGetStateAction,\n type ControllerStateChangeEvent,\n type StateMetadata,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { AbstractTokenDiscoveryApiService } from './token-discovery-api-service/abstract-token-discovery-api-service';\nimport type { AbstractTokenSearchApiService } from './token-search-api-service/abstract-token-search-api-service';\nimport type {\n TokenSearchParams,\n TokenSearchResponseItem,\n MoralisTokenResponseItem,\n TrendingTokensParams,\n TopGainersParams,\n TopLosersParams,\n BlueChipParams,\n SwappableTokenSearchParams,\n TokenSearchFormattedParams,\n} from './types';\n\n// === GENERAL ===\n\nconst controllerName = 'TokenSearchDiscoveryController';\n\n// === STATE ===\n\nexport type TokenSearchDiscoveryControllerState = {\n recentSearches: TokenSearchResponseItem[];\n lastSearchTimestamp: number | null;\n};\n\nconst tokenSearchDiscoveryControllerMetadata: StateMetadata<TokenSearchDiscoveryControllerState> =\n {\n recentSearches: {\n includeInStateLogs: true,\n persist: true,\n includeInDebugSnapshot: false,\n usedInUi: true,\n },\n lastSearchTimestamp: {\n includeInStateLogs: true,\n persist: true,\n includeInDebugSnapshot: false,\n usedInUi: true,\n },\n };\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link TokenSearchDiscoveryController}.\n */\nexport type TokenSearchDiscoveryControllerGetStateAction =\n ControllerGetStateAction<\n typeof controllerName,\n TokenSearchDiscoveryControllerState\n >;\n\n/**\n * All actions that {@link TokenSearchDiscoveryController} registers, to be\n * called externally.\n */\nexport type TokenSearchDiscoveryControllerActions =\n TokenSearchDiscoveryControllerGetStateAction;\n\n/**\n * The event that {@link TokenSearchDiscoveryController} publishes when updating\n * state.\n */\nexport type TokenSearchDiscoveryControllerStateChangeEvent =\n ControllerStateChangeEvent<\n typeof controllerName,\n TokenSearchDiscoveryControllerState\n >;\n\n/**\n * All events that {@link TokenSearchDiscoveryController} publishes, to be\n * subscribed to externally.\n */\nexport type TokenSearchDiscoveryControllerEvents =\n TokenSearchDiscoveryControllerStateChangeEvent;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link TokenSearchDiscoveryController}.\n */\nexport type TokenSearchDiscoveryControllerMessenger = Messenger<\n typeof controllerName,\n TokenSearchDiscoveryControllerActions,\n TokenSearchDiscoveryControllerEvents\n>;\n\n/**\n * Constructs the default {@link TokenSearchDiscoveryController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link TokenSearchDiscoveryController} state.\n */\nexport function getDefaultTokenSearchDiscoveryControllerState(): TokenSearchDiscoveryControllerState {\n return {\n recentSearches: [],\n lastSearchTimestamp: null,\n };\n}\n\n/**\n * The TokenSearchDiscoveryController manages the retrieval of token search results and token discovery.\n * It fetches token search results and discovery data from the Portfolio API.\n */\nexport class TokenSearchDiscoveryController extends BaseController<\n typeof controllerName,\n TokenSearchDiscoveryControllerState,\n TokenSearchDiscoveryControllerMessenger\n> {\n readonly #tokenSearchService: AbstractTokenSearchApiService;\n\n readonly #tokenDiscoveryService: AbstractTokenDiscoveryApiService;\n\n constructor({\n tokenSearchService,\n tokenDiscoveryService,\n state = {},\n messenger,\n }: {\n tokenSearchService: AbstractTokenSearchApiService;\n tokenDiscoveryService: AbstractTokenDiscoveryApiService;\n state?: Partial<TokenSearchDiscoveryControllerState>;\n messenger: TokenSearchDiscoveryControllerMessenger;\n }) {\n super({\n name: controllerName,\n metadata: tokenSearchDiscoveryControllerMetadata,\n messenger,\n state: { ...getDefaultTokenSearchDiscoveryControllerState(), ...state },\n });\n\n this.#tokenSearchService = tokenSearchService;\n this.#tokenDiscoveryService = tokenDiscoveryService;\n }\n\n async searchTokens(\n tokenSearchParams: TokenSearchParams,\n ): Promise<TokenSearchResponseItem[]> {\n const results =\n await this.#tokenSearchService.searchTokens(tokenSearchParams);\n\n this.update((state) => {\n state.recentSearches = results;\n state.lastSearchTimestamp = Date.now();\n });\n\n return results;\n }\n\n async searchSwappableTokens(\n swappableTokenSearchParams: SwappableTokenSearchParams,\n ): Promise<TokenSearchResponseItem[]> {\n const results = await this.#tokenSearchService.searchSwappableTokens(\n swappableTokenSearchParams,\n );\n\n this.update((state) => {\n state.recentSearches = results;\n state.lastSearchTimestamp = Date.now();\n });\n\n return results;\n }\n\n async searchTokensFormatted(\n tokenSearchFormattedParams: TokenSearchFormattedParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenSearchService.searchTokensFormatted(\n tokenSearchFormattedParams,\n );\n }\n\n async getTrendingTokens(\n params: TrendingTokensParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTrendingTokensByChains(params);\n }\n\n async getTopGainers(\n params: TopGainersParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTopGainersByChains(params);\n }\n\n async getTopLosers(\n params: TopLosersParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTopLosersByChains(params);\n }\n\n async getBlueChipTokens(\n params: BlueChipParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getBlueChipTokensByChains(params);\n }\n}\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import {
|
|
1
|
+
import { BaseController, type ControllerGetStateAction, type ControllerStateChangeEvent } from "@metamask/base-controller";
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
3
|
import type { AbstractTokenDiscoveryApiService } from "./token-discovery-api-service/abstract-token-discovery-api-service.cjs";
|
|
4
4
|
import type { AbstractTokenSearchApiService } from "./token-search-api-service/abstract-token-search-api-service.cjs";
|
|
5
5
|
import type { TokenSearchParams, TokenSearchResponseItem, MoralisTokenResponseItem, TrendingTokensParams, TopGainersParams, TopLosersParams, BlueChipParams, SwappableTokenSearchParams, TokenSearchFormattedParams } from "./types.cjs";
|
|
@@ -18,10 +18,6 @@ export type TokenSearchDiscoveryControllerGetStateAction = ControllerGetStateAct
|
|
|
18
18
|
* called externally.
|
|
19
19
|
*/
|
|
20
20
|
export type TokenSearchDiscoveryControllerActions = TokenSearchDiscoveryControllerGetStateAction;
|
|
21
|
-
/**
|
|
22
|
-
* All actions that {@link TokenSearchDiscoveryController} calls internally.
|
|
23
|
-
*/
|
|
24
|
-
type AllowedActions = never;
|
|
25
21
|
/**
|
|
26
22
|
* The event that {@link TokenSearchDiscoveryController} publishes when updating
|
|
27
23
|
* state.
|
|
@@ -32,15 +28,11 @@ export type TokenSearchDiscoveryControllerStateChangeEvent = ControllerStateChan
|
|
|
32
28
|
* subscribed to externally.
|
|
33
29
|
*/
|
|
34
30
|
export type TokenSearchDiscoveryControllerEvents = TokenSearchDiscoveryControllerStateChangeEvent;
|
|
35
|
-
/**
|
|
36
|
-
* All events that {@link TokenSearchDiscoveryController} subscribes to internally.
|
|
37
|
-
*/
|
|
38
|
-
type AllowedEvents = never;
|
|
39
31
|
/**
|
|
40
32
|
* The messenger which is restricted to actions and events accessed by
|
|
41
33
|
* {@link TokenSearchDiscoveryController}.
|
|
42
34
|
*/
|
|
43
|
-
export type TokenSearchDiscoveryControllerMessenger =
|
|
35
|
+
export type TokenSearchDiscoveryControllerMessenger = Messenger<typeof controllerName, TokenSearchDiscoveryControllerActions, TokenSearchDiscoveryControllerEvents>;
|
|
44
36
|
/**
|
|
45
37
|
* Constructs the default {@link TokenSearchDiscoveryController} state. This allows
|
|
46
38
|
* consumers to provide a partial state object when initializing the controller
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"token-search-discovery-controller.d.cts","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"token-search-discovery-controller.d.cts","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAEhC,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,gCAAgC,EAAE,+EAA2E;AAC3H,OAAO,KAAK,EAAE,6BAA6B,EAAE,yEAAqE;AAClH,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,oBAAgB;AAIjB,QAAA,MAAM,cAAc,mCAAmC,CAAC;AAIxD,MAAM,MAAM,mCAAmC,GAAG;IAChD,cAAc,EAAE,uBAAuB,EAAE,CAAC;IAC1C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC,CAAC;AAoBF;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GACtD,wBAAwB,CACtB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC/C,4CAA4C,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,8CAA8C,GACxD,0BAA0B,CACxB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAC9C,8CAA8C,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,cAAc,EACrB,qCAAqC,EACrC,oCAAoC,CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,6CAA6C,IAAI,mCAAmC,CAKnG;AAED;;;GAGG;AACH,qBAAa,8BAA+B,SAAQ,cAAc,CAChE,OAAO,cAAc,EACrB,mCAAmC,EACnC,uCAAuC,CACxC;;gBAKa,EACV,kBAAkB,EAClB,qBAAqB,EACrB,KAAU,EACV,SAAS,GACV,EAAE;QACD,kBAAkB,EAAE,6BAA6B,CAAC;QAClD,qBAAqB,EAAE,gCAAgC,CAAC;QACxD,KAAK,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAC;QACrD,SAAS,EAAE,uCAAuC,CAAC;KACpD;IAYK,YAAY,CAChB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAY/B,qBAAqB,CACzB,0BAA0B,EAAE,0BAA0B,GACrD,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAa/B,qBAAqB,CACzB,0BAA0B,EAAE,0BAA0B,GACrD,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAMhC,iBAAiB,CACrB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,aAAa,CACjB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,YAAY,CAChB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,iBAAiB,CACrB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,wBAAwB,EAAE,CAAC;CAGvC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import {
|
|
1
|
+
import { BaseController, type ControllerGetStateAction, type ControllerStateChangeEvent } from "@metamask/base-controller";
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
3
|
import type { AbstractTokenDiscoveryApiService } from "./token-discovery-api-service/abstract-token-discovery-api-service.mjs";
|
|
4
4
|
import type { AbstractTokenSearchApiService } from "./token-search-api-service/abstract-token-search-api-service.mjs";
|
|
5
5
|
import type { TokenSearchParams, TokenSearchResponseItem, MoralisTokenResponseItem, TrendingTokensParams, TopGainersParams, TopLosersParams, BlueChipParams, SwappableTokenSearchParams, TokenSearchFormattedParams } from "./types.mjs";
|
|
@@ -18,10 +18,6 @@ export type TokenSearchDiscoveryControllerGetStateAction = ControllerGetStateAct
|
|
|
18
18
|
* called externally.
|
|
19
19
|
*/
|
|
20
20
|
export type TokenSearchDiscoveryControllerActions = TokenSearchDiscoveryControllerGetStateAction;
|
|
21
|
-
/**
|
|
22
|
-
* All actions that {@link TokenSearchDiscoveryController} calls internally.
|
|
23
|
-
*/
|
|
24
|
-
type AllowedActions = never;
|
|
25
21
|
/**
|
|
26
22
|
* The event that {@link TokenSearchDiscoveryController} publishes when updating
|
|
27
23
|
* state.
|
|
@@ -32,15 +28,11 @@ export type TokenSearchDiscoveryControllerStateChangeEvent = ControllerStateChan
|
|
|
32
28
|
* subscribed to externally.
|
|
33
29
|
*/
|
|
34
30
|
export type TokenSearchDiscoveryControllerEvents = TokenSearchDiscoveryControllerStateChangeEvent;
|
|
35
|
-
/**
|
|
36
|
-
* All events that {@link TokenSearchDiscoveryController} subscribes to internally.
|
|
37
|
-
*/
|
|
38
|
-
type AllowedEvents = never;
|
|
39
31
|
/**
|
|
40
32
|
* The messenger which is restricted to actions and events accessed by
|
|
41
33
|
* {@link TokenSearchDiscoveryController}.
|
|
42
34
|
*/
|
|
43
|
-
export type TokenSearchDiscoveryControllerMessenger =
|
|
35
|
+
export type TokenSearchDiscoveryControllerMessenger = Messenger<typeof controllerName, TokenSearchDiscoveryControllerActions, TokenSearchDiscoveryControllerEvents>;
|
|
44
36
|
/**
|
|
45
37
|
* Constructs the default {@link TokenSearchDiscoveryController} state. This allows
|
|
46
38
|
* consumers to provide a partial state object when initializing the controller
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"token-search-discovery-controller.d.mts","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"token-search-discovery-controller.d.mts","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAEhC,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,gCAAgC,EAAE,+EAA2E;AAC3H,OAAO,KAAK,EAAE,6BAA6B,EAAE,yEAAqE;AAClH,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,oBAAgB;AAIjB,QAAA,MAAM,cAAc,mCAAmC,CAAC;AAIxD,MAAM,MAAM,mCAAmC,GAAG;IAChD,cAAc,EAAE,uBAAuB,EAAE,CAAC;IAC1C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC,CAAC;AAoBF;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GACtD,wBAAwB,CACtB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC/C,4CAA4C,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,8CAA8C,GACxD,0BAA0B,CACxB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAC9C,8CAA8C,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,cAAc,EACrB,qCAAqC,EACrC,oCAAoC,CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,6CAA6C,IAAI,mCAAmC,CAKnG;AAED;;;GAGG;AACH,qBAAa,8BAA+B,SAAQ,cAAc,CAChE,OAAO,cAAc,EACrB,mCAAmC,EACnC,uCAAuC,CACxC;;gBAKa,EACV,kBAAkB,EAClB,qBAAqB,EACrB,KAAU,EACV,SAAS,GACV,EAAE;QACD,kBAAkB,EAAE,6BAA6B,CAAC;QAClD,qBAAqB,EAAE,gCAAgC,CAAC;QACxD,KAAK,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAC;QACrD,SAAS,EAAE,uCAAuC,CAAC;KACpD;IAYK,YAAY,CAChB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAY/B,qBAAqB,CACzB,0BAA0B,EAAE,0BAA0B,GACrD,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAa/B,qBAAqB,CACzB,0BAA0B,EAAE,0BAA0B,GACrD,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAMhC,iBAAiB,CACrB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,aAAa,CACjB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,YAAY,CAChB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIhC,iBAAiB,CACrB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,wBAAwB,EAAE,CAAC;CAGvC"}
|
|
@@ -17,13 +17,13 @@ const tokenSearchDiscoveryControllerMetadata = {
|
|
|
17
17
|
recentSearches: {
|
|
18
18
|
includeInStateLogs: true,
|
|
19
19
|
persist: true,
|
|
20
|
-
|
|
20
|
+
includeInDebugSnapshot: false,
|
|
21
21
|
usedInUi: true,
|
|
22
22
|
},
|
|
23
23
|
lastSearchTimestamp: {
|
|
24
24
|
includeInStateLogs: true,
|
|
25
25
|
persist: true,
|
|
26
|
-
|
|
26
|
+
includeInDebugSnapshot: false,
|
|
27
27
|
usedInUi: true,
|
|
28
28
|
},
|
|
29
29
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"token-search-discovery-controller.mjs","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"token-search-discovery-controller.mjs","sourceRoot":"","sources":["../src/token-search-discovery-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,cAAc,EAIf,kCAAkC;AAiBnC,kBAAkB;AAElB,MAAM,cAAc,GAAG,gCAAgC,CAAC;AASxD,MAAM,sCAAsC,GAC1C;IACE,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,mBAAmB,EAAE;QACnB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAgDJ;;;;;;;GAOG;AACH,MAAM,UAAU,6CAA6C;IAC3D,OAAO;QACL,cAAc,EAAE,EAAE;QAClB,mBAAmB,EAAE,IAAI;KAC1B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,8BAA+B,SAAQ,cAInD;IAKC,YAAY,EACV,kBAAkB,EAClB,qBAAqB,EACrB,KAAK,GAAG,EAAE,EACV,SAAS,GAMV;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,sCAAsC;YAChD,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,6CAA6C,EAAE,EAAE,GAAG,KAAK,EAAE;SACxE,CAAC,CAAC;QApBI,qEAAmD;QAEnD,wEAAyD;QAoBhE,uBAAA,IAAI,sDAAuB,kBAAkB,MAAA,CAAC;QAC9C,uBAAA,IAAI,yDAA0B,qBAAqB,MAAA,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,iBAAoC;QAEpC,MAAM,OAAO,GACX,MAAM,uBAAA,IAAI,0DAAoB,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAEjE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,0BAAsD;QAEtD,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0DAAoB,CAAC,qBAAqB,CAClE,0BAA0B,CAC3B,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,0BAAsD;QAEtD,OAAO,uBAAA,IAAI,0DAAoB,CAAC,qBAAqB,CACnD,0BAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAA4B;QAE5B,OAAO,uBAAA,IAAI,6DAAuB,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAwB;QAExB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAAuB;QAEvB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAAsB;QAEtB,OAAO,uBAAA,IAAI,6DAAuB,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;CACF","sourcesContent":["import {\n BaseController,\n type ControllerGetStateAction,\n type ControllerStateChangeEvent,\n type StateMetadata,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { AbstractTokenDiscoveryApiService } from './token-discovery-api-service/abstract-token-discovery-api-service';\nimport type { AbstractTokenSearchApiService } from './token-search-api-service/abstract-token-search-api-service';\nimport type {\n TokenSearchParams,\n TokenSearchResponseItem,\n MoralisTokenResponseItem,\n TrendingTokensParams,\n TopGainersParams,\n TopLosersParams,\n BlueChipParams,\n SwappableTokenSearchParams,\n TokenSearchFormattedParams,\n} from './types';\n\n// === GENERAL ===\n\nconst controllerName = 'TokenSearchDiscoveryController';\n\n// === STATE ===\n\nexport type TokenSearchDiscoveryControllerState = {\n recentSearches: TokenSearchResponseItem[];\n lastSearchTimestamp: number | null;\n};\n\nconst tokenSearchDiscoveryControllerMetadata: StateMetadata<TokenSearchDiscoveryControllerState> =\n {\n recentSearches: {\n includeInStateLogs: true,\n persist: true,\n includeInDebugSnapshot: false,\n usedInUi: true,\n },\n lastSearchTimestamp: {\n includeInStateLogs: true,\n persist: true,\n includeInDebugSnapshot: false,\n usedInUi: true,\n },\n };\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link TokenSearchDiscoveryController}.\n */\nexport type TokenSearchDiscoveryControllerGetStateAction =\n ControllerGetStateAction<\n typeof controllerName,\n TokenSearchDiscoveryControllerState\n >;\n\n/**\n * All actions that {@link TokenSearchDiscoveryController} registers, to be\n * called externally.\n */\nexport type TokenSearchDiscoveryControllerActions =\n TokenSearchDiscoveryControllerGetStateAction;\n\n/**\n * The event that {@link TokenSearchDiscoveryController} publishes when updating\n * state.\n */\nexport type TokenSearchDiscoveryControllerStateChangeEvent =\n ControllerStateChangeEvent<\n typeof controllerName,\n TokenSearchDiscoveryControllerState\n >;\n\n/**\n * All events that {@link TokenSearchDiscoveryController} publishes, to be\n * subscribed to externally.\n */\nexport type TokenSearchDiscoveryControllerEvents =\n TokenSearchDiscoveryControllerStateChangeEvent;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link TokenSearchDiscoveryController}.\n */\nexport type TokenSearchDiscoveryControllerMessenger = Messenger<\n typeof controllerName,\n TokenSearchDiscoveryControllerActions,\n TokenSearchDiscoveryControllerEvents\n>;\n\n/**\n * Constructs the default {@link TokenSearchDiscoveryController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link TokenSearchDiscoveryController} state.\n */\nexport function getDefaultTokenSearchDiscoveryControllerState(): TokenSearchDiscoveryControllerState {\n return {\n recentSearches: [],\n lastSearchTimestamp: null,\n };\n}\n\n/**\n * The TokenSearchDiscoveryController manages the retrieval of token search results and token discovery.\n * It fetches token search results and discovery data from the Portfolio API.\n */\nexport class TokenSearchDiscoveryController extends BaseController<\n typeof controllerName,\n TokenSearchDiscoveryControllerState,\n TokenSearchDiscoveryControllerMessenger\n> {\n readonly #tokenSearchService: AbstractTokenSearchApiService;\n\n readonly #tokenDiscoveryService: AbstractTokenDiscoveryApiService;\n\n constructor({\n tokenSearchService,\n tokenDiscoveryService,\n state = {},\n messenger,\n }: {\n tokenSearchService: AbstractTokenSearchApiService;\n tokenDiscoveryService: AbstractTokenDiscoveryApiService;\n state?: Partial<TokenSearchDiscoveryControllerState>;\n messenger: TokenSearchDiscoveryControllerMessenger;\n }) {\n super({\n name: controllerName,\n metadata: tokenSearchDiscoveryControllerMetadata,\n messenger,\n state: { ...getDefaultTokenSearchDiscoveryControllerState(), ...state },\n });\n\n this.#tokenSearchService = tokenSearchService;\n this.#tokenDiscoveryService = tokenDiscoveryService;\n }\n\n async searchTokens(\n tokenSearchParams: TokenSearchParams,\n ): Promise<TokenSearchResponseItem[]> {\n const results =\n await this.#tokenSearchService.searchTokens(tokenSearchParams);\n\n this.update((state) => {\n state.recentSearches = results;\n state.lastSearchTimestamp = Date.now();\n });\n\n return results;\n }\n\n async searchSwappableTokens(\n swappableTokenSearchParams: SwappableTokenSearchParams,\n ): Promise<TokenSearchResponseItem[]> {\n const results = await this.#tokenSearchService.searchSwappableTokens(\n swappableTokenSearchParams,\n );\n\n this.update((state) => {\n state.recentSearches = results;\n state.lastSearchTimestamp = Date.now();\n });\n\n return results;\n }\n\n async searchTokensFormatted(\n tokenSearchFormattedParams: TokenSearchFormattedParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenSearchService.searchTokensFormatted(\n tokenSearchFormattedParams,\n );\n }\n\n async getTrendingTokens(\n params: TrendingTokensParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTrendingTokensByChains(params);\n }\n\n async getTopGainers(\n params: TopGainersParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTopGainersByChains(params);\n }\n\n async getTopLosers(\n params: TopLosersParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getTopLosersByChains(params);\n }\n\n async getBlueChipTokens(\n params: BlueChipParams,\n ): Promise<MoralisTokenResponseItem[]> {\n return this.#tokenDiscoveryService.getBlueChipTokensByChains(params);\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask-previews/token-search-discovery-controller",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0-preview-55f130d1",
|
|
4
4
|
"description": "Manages token search and discovery through the Portfolio API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"MetaMask",
|
|
@@ -47,7 +47,8 @@
|
|
|
47
47
|
"since-latest-release": "../../scripts/since-latest-release.sh"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@metamask/base-controller": "^
|
|
50
|
+
"@metamask/base-controller": "^9.0.0",
|
|
51
|
+
"@metamask/messenger": "^0.3.0",
|
|
51
52
|
"@metamask/utils": "^11.8.1"
|
|
52
53
|
},
|
|
53
54
|
"devDependencies": {
|