From af6958c3745ea8d911319e1d8cca7e1ce5809e6b Mon Sep 17 00:00:00 2001 From: ZayanKhan-12 <108294002+ZayanKhan-12@users.noreply.github.com> Date: Wed, 22 Jul 2026 12:14:13 -0400 Subject: [PATCH] docs: fix broken links and stale controller names - assets-controllers README: CollectibleDetectionController and CollectiblesController were renamed to NftDetectionController and NftController long ago; update the entries (and keep the list alphabetical), fix a DeFiPositionsController.ts.ts double-extension typo, and point the Real-Time Balance Updates link at the doc's actual location in core-backend/docs. - core-backend real-time-balance-updates-flow doc: links were written relative to the repo root instead of the file's directory. - transaction-pay-controller ARCHITECTURE: absolute /packages/... path doesn't resolve on GitHub. - permission-controller ARCHITECTURE: PermissionController.test.ts lives in src/. - .cursor/BUGBOT.md: AGENTS.md is at the repo root. Co-Authored-By: Claude Fable 5 --- .cursor/BUGBOT.md | 2 +- packages/assets-controllers/README.md | 8 ++++---- .../docs/real-time-balance-updates-flow.md | 10 +++++----- packages/permission-controller/ARCHITECTURE.md | 2 +- packages/transaction-pay-controller/ARCHITECTURE.md | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.cursor/BUGBOT.md b/.cursor/BUGBOT.md index 72511621b35..33ea94ab754 100644 --- a/.cursor/BUGBOT.md +++ b/.cursor/BUGBOT.md @@ -1,3 +1,3 @@ # Guidance for Bugbot -Please read the [agents file](./AGENTS.md) in the root of the project for instructions. +Please read the [agents file](../AGENTS.md) in the root of the project for instructions. diff --git a/packages/assets-controllers/README.md b/packages/assets-controllers/README.md index e112258c4e8..8c2b1b68af8 100644 --- a/packages/assets-controllers/README.md +++ b/packages/assets-controllers/README.md @@ -16,12 +16,12 @@ This package features the following controllers: - [**AccountTrackerController**](src/AccountTrackerController.ts) keeps a updated list of the accounts in the currently selected keychain which is updated automatically on a schedule or on demand. - [**AssetsContractController**](src/AssetsContractController.ts) provides a set of convenience methods that use contracts to retrieve information about tokens, read token balances, and transfer tokens. -- [**CollectibleDetectionController**](src/CollectibleDetectionController.ts) keeps a periodically updated list of ERC-721 tokens assigned to the currently selected address. -- [**CollectiblesController**](src/CollectiblesController.ts) tracks ERC-721 and ERC-1155 tokens assigned to the currently selected address, using OpenSea to retrieve token information. - [**CurrencyRateController**](src/CurrencyRateController.ts) keeps a periodically updated value of the exchange rate from the currently selected "native" currency to another (handling testnet tokens specially). -- [**DeFiPositionsController**](src/DeFiPositionsController/DeFiPositionsController.ts.ts) keeps a periodically updated value of the DeFi positions for the owner EVM addresses. +- [**DeFiPositionsController**](src/DeFiPositionsController/DeFiPositionsController.ts) keeps a periodically updated value of the DeFi positions for the owner EVM addresses. +- [**NftController**](src/NftController.ts) tracks ERC-721 and ERC-1155 tokens assigned to the currently selected address, using OpenSea to retrieve token information. +- [**NftDetectionController**](src/NftDetectionController.ts) keeps a periodically updated list of ERC-721 tokens assigned to the currently selected address. - [**RatesController**](src/RatesController/RatesController.ts) keeps a periodically updated value for the exchange rates for different cryptocurrencies. The difference between the `RatesController` and `CurrencyRateController` is that the second one is coupled to the `NetworksController` and is EVM specific, whilst the first one can handle different blockchain currencies like BTC and SOL. -- [**TokenBalancesController**](src/TokenBalancesController.ts) keeps a periodically updated set of balances for the current set of ERC-20 tokens. It supports real-time balance updates via WebSocket and intelligent polling management. See [Real-Time Balance Updates Flow](./REAL_TIME_BALANCE_UPDATES.md) for details. +- [**TokenBalancesController**](src/TokenBalancesController.ts) keeps a periodically updated set of balances for the current set of ERC-20 tokens. It supports real-time balance updates via WebSocket and intelligent polling management. See [Real-Time Balance Updates Flow](../core-backend/docs/real-time-balance-updates-flow.md) for details. - [**TokenDetectionController**](src/TokenDetectionController.ts) keeps a periodically updated list of ERC-20 tokens assigned to the currently selected address. - [**TokenListController**](src/TokenListController.ts) uses the MetaSwap API to keep a periodically updated list of known ERC-20 tokens along with their metadata. - [**TokenRatesController**](src/TokenRatesController.ts) keeps a periodically updated list of exchange rates for known ERC-20 tokens relative to the currently selected native currency. diff --git a/packages/core-backend/docs/real-time-balance-updates-flow.md b/packages/core-backend/docs/real-time-balance-updates-flow.md index 3884643ab74..b442d76ee4c 100644 --- a/packages/core-backend/docs/real-time-balance-updates-flow.md +++ b/packages/core-backend/docs/real-time-balance-updates-flow.md @@ -246,8 +246,8 @@ When balance updates include previously unknown tokens: ## References -- [`TokenBalancesController.ts`](../packages/assets-controllers/src/TokenBalancesController.ts) - Main controller implementation -- [`AccountActivityService.ts`](../packages/core-backend/src/AccountActivityService.ts) - Account activity monitoring -- [`BackendWebSocketService.ts`](../packages/core-backend/src/BackendWebSocketService.ts) - WebSocket connection management -- [`types.ts`](../packages/core-backend/src/types.ts) - Type definitions -- [Core Backend README](../packages/core-backend/README.md) - Package overview +- [`TokenBalancesController.ts`](../../assets-controllers/src/TokenBalancesController.ts) - Main controller implementation +- [`AccountActivityService.ts`](../src/ws/AccountActivityService.ts) - Account activity monitoring +- [`BackendWebSocketService.ts`](../src/ws/BackendWebSocketService.ts) - WebSocket connection management +- [`types.ts`](../src/types.ts) - Type definitions +- [Core Backend README](../README.md) - Package overview diff --git a/packages/permission-controller/ARCHITECTURE.md b/packages/permission-controller/ARCHITECTURE.md index 786a4c31cc0..eb5464d4026 100644 --- a/packages/permission-controller/ARCHITECTURE.md +++ b/packages/permission-controller/ARCHITECTURE.md @@ -222,7 +222,7 @@ If no merger exists for a caveat that must be merged, the request will fail. ## Examples -In addition to the below examples, the [`PermissionController` unit tests](./PermissionController.test.ts) show how to set up the controller. +In addition to the below examples, the [`PermissionController` unit tests](./src/PermissionController.test.ts) show how to set up the controller. ### Construction diff --git a/packages/transaction-pay-controller/ARCHITECTURE.md b/packages/transaction-pay-controller/ARCHITECTURE.md index 1b7cc23602e..5ac099ab114 100644 --- a/packages/transaction-pay-controller/ARCHITECTURE.md +++ b/packages/transaction-pay-controller/ARCHITECTURE.md @@ -14,7 +14,7 @@ The tokens required by a transaction are automatically identified from various s - Gas Fees - A required native token is generated from the gas limit and gas fee parameters, including estimates from the `GasFeeController`. -See [required-tokens.ts](/packages/transaction-pay-controller/src/utils/required-tokens.ts). +See [required-tokens.ts](./src/utils/required-tokens.ts). ## Payment Token