Skip to content

Commit

Permalink
docs: redetect tokens guide
Browse files Browse the repository at this point in the history
docs: testing UI library in the app

docs: improve token detection guide per comments

docs: finalize token detection guide
  • Loading branch information
cleanerzkp committed Nov 21, 2024
1 parent a36f3f0 commit add2cb0
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 1 deletion.
61 changes: 61 additions & 0 deletions contribution-guides/vue-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,64 @@ instead of:
}
}
```

## Working with UI Library

### Testing Component Changes

To test unpublished UI library changes in the main application:

1. **Build the Library**

```sh
pnpm run build:prod
```

2. **Link to Application**
- Open `package.json` in rotki main directory `frontend/app/package.json`
- Change UI library version to point to local build:
```json
{
"dependencies": {
"@rotki/ui-library": "file:../../../ui-library" // adjust path based on your UI library location
}
}
```
3. **Update Application**

```sh
pnpm install
```

4. **Refresh Changes**
- Rebuild library after changes
- Run `pnpm install` in frontend directory
- Restart development server

### Troubleshooting

If experiencing display issues:

1. Clean modules:

```sh
pnpm run clean:modules
```

2. Reinstall dependencies:

```sh
pnpm install
```

3. Restart development server
```sh
pnpm run dev
```

### Branch Compatibility

- UI Library: `main` branch
- Rotki App: `develop` branch

These branches should be compatible. If encountering issues, try cleaning and reinstalling modules to resolve caching problems.
Binary file added public/images/manage-assets-refresh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/redetect-per-chain-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/redetect-tokens-chain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/redetect-tokens-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions usage-guides/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,36 @@ To solve this problem we added a whitelist which you can add assets to as can be

![Whitelist asset](/images/asset_whitelist_menu.png)

## Whitelisting and Re-detecting Missing Tokens

If a token doesn't appear in your balances, there are several ways to troubleshoot this. First you should check if it's been automatically or manually ignored. And then run a manual token detection.

### Check Token is not Ignored or Marked as Spam

Go to the Manage Assets -> Assets page. Use the search to find the token by name or address. Verify if the token is ignored. If ignored, unignore it. If you did not ignore it on purpose click to whitelist it so the spam detection algorithm does not falsely flag it as spam.

![Example of managing assets and whitelisting a token in the Manage Assets page.](/images/manage-assets-refresh.png)

### Token Detection Methods

**Single Account Per-Chain Detection**

The best way to detect tokens for a single address is to go to blockchain & accounts balances, scroll down to the EVM accounts view, expand the dropdown at the account, go to the per chain tab and click on the detect tokens toggle πŸ”ƒ.

![Example of detecting tokens for a specific chain](/images/redetect-per-chain-view.png)

**All Accounts Per-Chain Detection**

Go to Account & Balances -> Blockchain Balances. Scroll down to EVM accounts and click on Re-detect tokens (πŸ”ƒ). Here you can select specific chains to detect tokens for all your wallets. This will take a bit of time depending on tracked addresses per chain. The slowest chain for detection is ethereum.

![Example of re-detecting tokens for all EVM chains in the Blockchain Balances section.](/images/redetect-tokens-chain.png)

**Dashboard Full Detection**

For a complete re-detection of all tokens across all your addresses and all supported chains, use the re-detect toggle (πŸ”ƒ) in the main dashboard view. This will perform a full scan of your addresses on every chain but will probably take quite a long time depending on amount of tracked addresses and chains.

![Example of performing a full token detection using the re-detect toggle on the dashboard.](/images/redetect-tokens-dashboard.png)

## Adding/editing an asset

![Add or edit an asset](/images/rotki_add_edit_asset.png)
Expand Down
4 changes: 3 additions & 1 deletion usage-guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ If you just registered your ENS name and you don't see the name and/or avatar be

If your asset is not showing in rotki, even though you are sure that you have a balance, you need to first ensure that the asset is present on the list of assets (read [inspecting list of assets](/usage-guides/assets.html#inspecting-list-of-assets)).

If you still cannot find your asset, it might be ignored. By default, rotki only displays un-ignored assets in the table. To also show the ignored assets, choose the `Filter by ignored status β†’ Show all`, and then unignore the asset manually. Additionally, you can whitelist the asset to prevent it from being automatically ignored by rotki's spam detection. (read: [whitelisting of ignored assets](/usage-guides/assets.html#whitelisting-of-ignored-assets))
If you still cannot find your asset, it might be ignored. By default, rotki only displays un-ignored assets in the table. To also show the ignored assets, choose the `Filter by ignored status β†’ Show all`, and then unignore the asset manually. Additionally, you can whitelist the asset to prevent it from being automatically ignored by rotki's spam detection (read: [whitelisting of ignored assets](/usage-guides/assets.html#whitelisting-of-ignored-assets)).

After whitelisting the token, you may need to re-detect it to see it in your balances (read: [token detection methods](/usage-guides/assets.html#whitelisting-and-re-detecting-missing-tokens)).

If the asset is still not showing, you may need to add it manually.

0 comments on commit add2cb0

Please sign in to comment.