Skip to content

Commit 122132f

Browse files
committed
docs: update some changes in 1.39.0
1 parent d7436dc commit 122132f

27 files changed

+67
-65
lines changed

.vitepress/config.mts

+1
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ export default defineConfig({
6868
{ text: 'Taking Notes In-App', link: '/usage-guides/user-notes' },
6969
{ text: 'Address Book', link: '/usage-guides/address-book' },
7070
{ text: 'Calendar', link: '/usage-guides/calendar' },
71+
{ text: 'On-Chain Transactions', link: '/usage-guides/onchain' },
7172
],
7273
},
7374
{

public/images/add_tx_by_hash.png

5.78 KB
Loading
13 KB
Loading
2.28 KB
Loading

public/images/events_csv_export.png

-139 KB
Loading
19.5 KB
Loading
141 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading

public/images/onchain_send.png

73.3 KB
Loading

public/images/redecode_all_events.png

-117 KB
Loading

public/images/redecode_events.png

12 KB
Loading
16.6 KB
Loading
-1.2 KB
Loading
Loading
Loading

usage-guides/assets.md

+6
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ Users can link assets on exchanges to those recognized by rotki. If you encounte
9090

9191
![Manage centralized exchange asset mapping](/images/rotki_manage_cex_mapping.png)
9292

93+
## Manage Counterparty Mapping
94+
95+
Users can also link assets on any counterparty to those recognized by rotki.
96+
97+
![Manage counterparty asset mapping](/images/rotki_manage_counterparty_mapping.png)
98+
9399
## Newly detected tokens
94100

95101
All newly detected EVM tokens will appear in the list of newly detected tokens. You should inspect this list often and accept valid tokens and reject spam assets by adding them to the ignored tokens list.

usage-guides/historical-events.md

+25-65
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,8 @@
1-
# Historical events
2-
3-
## Exchange Trades
4-
5-
### Adding manual trades
6-
7-
rotki will pull all your trade history from the exchanges whenever it needs it. But most of us have probably also done some OTC trades or taxable events at some point. Such events could even just be mining tokens, depending on your jurisdiction, participating in an ICO or getting paid in crypto.
8-
9-
You can go to this page via `History → Exch. Trades`.
10-
Clicking on the "Add an external trade" button will open a menu like the following.
11-
12-
![Add an external trade](/images/external_trade.png)
13-
14-
To add a new trade, fill in all the fields and press the "Save" button.
15-
16-
In the `amount` field you can register the amount of the base asset bought or sold. The `rate` field represents the rate of quote asset per base asset that was bought or sold. If there was a fee for the trade you should input it in the corresponding box and also enter the currency the fee was paid in. This field is optional so if the Fee was 0 you can leave this field empty. You can optionally provide additional notes or even links to blockchain explorers for each trade.
17-
18-
In the Trades page you can see a table of all your external trades. You can edit or delete a trade by clicking on the appropriate icon at the rightmost part of each trade under the "Actions" column.
19-
20-
Currently rotki tracks your balance by querying the different supported protocols, exchanges and blockchains. If you manually add information about a trade your balances will not be updated since trades are not consulted when updating the accounts' balances. If you want to manually update your balance for an asset please refer to the [manual balances section](/usage-guides/accounts-and-balances.html#adding-manual-balances).
21-
22-
### Filtering trades
23-
24-
rotki supports filtering your trades with a combination of filters. All of the filters are applied at the same time
25-
limiting the trades to the ones that satisfy all the applied filters.
26-
27-
![Filtering trades](/images/sc_history_trades_filter.png)
28-
29-
You can filter using the following keys:
30-
31-
- **base:** the base asset of the trades.
32-
- **quote:** the quote asset of the trades.
33-
- **action:** it can be buy or sell.
34-
- **start:** will only filter any trades from that date onwards.
35-
- **end:** will only filter any trades that happened before the selected date.
36-
- **location:** the location of the trade, e.g. kraken, uniswap etc.
37-
38-
![Trade filter suggestions](/images/sc_history_trades_filter_suggestions.png)
39-
40-
When selecting a filter, by clicking or typing the filter you will get some suggestions based on the available data.
41-
42-
When a suggestion appears you can navigate to the next available suggestion using the tab button or you can also change
43-
the select suggestion using the up/down arrows in your keyboard. You can submit the selected filter by pressing enter.
44-
45-
![Multiple trade filters applied](/images/sc_history_trades_filter_multi.png)
46-
47-
After adding your filters you can press enter to close the menu.
48-
49-
By default, all trades will be processed in accounting, but you can ignore unwanted trades, so they won't be processed.
50-
You can select the checkbox on the left part of each entry and click `Ignore`/`Unignore`.
51-
52-
![Ignore trades](/images/sc_history_trades_ignore.png)
53-
54-
## History Events
1+
# History events
552

563
rotki is capable of pulling and decoding a bunch of different events, ranging from EVM chain transactions to exchanges events and more. When you visit the `History Events` section the process to obtain all the information will start. You will be able to check the status in an informative breakdown per blockchain address. Free users are limited to a number of latest events.
574

58-
---
5+
## Supported events
596

607
Currently, these events are detected automatically by rotki:
618

@@ -65,10 +12,11 @@ Currently, these events are detected automatically by rotki:
6512
- ETH block events
6613
- ETH deposit events
6714
- Asset movement events (deposits and withdrawals).
15+
- Swap events (trades).
6816

6917
Additionally, you can add your custom events.
7018

71-
---
19+
## Events filtering
7220

7321
History events can be filtered if you have a premium subscription activated. You can filter by:
7422

@@ -86,19 +34,19 @@ History events can be filtered if you have a premium subscription activated. You
8634
- Only show customized events
8735
- ... more
8836

89-
![History events query status breakdown](/images/events_query_process.png)
37+
![History events query status](/images/events_query_process.png)
9038

91-
### Ignore events in accounting
92-
93-
By default, all events will be processed in accounting, but you can ignore unwanted events, so they won't be processed. You can click on the three dots to display the options for the group of events, and click `Ignore events in accounting`/`Unignore events in accounting`.
94-
95-
### Export History Events as CSV
39+
## Export history events as CSV
9640

9741
Events can be exported as CSV, click on `Export CSV` button and accept prompt to download exported events.
9842

9943
![Button to download events as csv](/images/events_csv_export.png)
10044

101-
### Redecoding EVM transactions
45+
## Ignore events in accounting
46+
47+
By default, all events will be processed in accounting, but you can ignore unwanted events, so they won't be processed. You can click on the three dots to display the options for the group of events, and click `Ignore events in accounting`/`Unignore events in accounting`.
48+
49+
## Redecoding EVM transactions
10250

10351
It is possible that you need to redecode events for an EVM transaction. To do that you have two options. The first of them is to click on the three dots to display the options for an EVM transaction and click on `Redecode events`. This will start the process to read the transaction's events again and try to understand what happened in them. If there are any custom events in the transaction, there will be one more confirmation, asking whether to also reset these custom events or not.
10452

@@ -118,18 +66,28 @@ You will see the status of the EVM events redecoding.
11866

11967
EVM Transactions and the events can be deleted, but to restore them you will have to either purge all transactions or add by the transaction hash.
12068

121-
### Add transaction by hash
69+
## Delete event
70+
71+
![Menu to delete EVM transactions events](/images/delete_transaction_events.png)
72+
73+
## Add transaction by hash
12274

12375
![Add transaction by hash](/images/add_tx_by_hash.png)
12476

12577
If you want to add a transaction that was either deleted or for some reason missed, or was not found by rotki, you can add it by transaction hash by clicking the menu as seen in the picture.
12678

127-
![Menu to delete EVM transactions events](/images/delete_transaction_events.png)
79+
## Re-Pulling Transactions
80+
81+
You can re-pull EVM transactions for a specific account within a selected time range, in case any past issues prevented events from being retrieved properly.
82+
83+
## Missing accounting rule
12884

12985
If you see this warning button, it means the event won't be processed correctly in accounting. It could be due to improper decoding or a missing accounting rule for that event. You can fix it by editing the event or adding the missing accounting rule. You can also edit the events if they have special meaning to you, such as OTC trades or transfers between accounts.
13086

13187
![The button indicates that the event won't be processed correctly.](/images/event_not_processed.png)
13288

89+
## Add / edit events
90+
13391
There are 6 types of events in rotki:
13492

13593
:::tabs
@@ -180,6 +138,8 @@ Here the non obvious fields are:
180138
== Asset Movement Event
181139
![Asset movement event form](/images/events_asset_movement_form.png)
182140

141+
== Swap Event
142+
![Swap event form](/images/events_swap_event_form.png)
183143
:::
184144

185145
For history event, and EVM history event, if any event was not decoded the way you expected it to be, you can always customize events using the settings described above or file a bug report on our github repository / in our discord server. The customizations that you make also affect how events are processed in accounting.

usage-guides/img.png

93.3 KB
Loading

usage-guides/img_1.png

93.3 KB
Loading

usage-guides/img_2.png

93.3 KB
Loading

usage-guides/img_3.png

93.3 KB
Loading

usage-guides/onchain.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# On-Chain Transactions
2+
3+
rotki allows you to perform on-chain transactions by connecting your wallet (either through a browser wallet or WalletConnect).
4+
Currently, rotki only supports sending native tokens and ERC-20 tokens.
5+
6+
![On chain send tokens](/images/onchain_send.png)
7+
8+
::: info
9+
You can only send tokens from an address that is registered as an EVM account in rotki. Otherwise, rotki won't be able to retrieve the list of tokens.
10+
:::
11+
12+
## Connect to a Browser Wallet from the Electron App
13+
14+
If you're using rotki via the Electron app, you won't be able to connect directly to your browser wallet. Instead, rotki provides a bridge for this purpose. Follow these steps:
15+
16+
1. Click the "Open Browser Wallet Bridge" button. This will open a page in your browser.
17+
![Open browser wallet bridge](/images/onchain_browser_wallet_bridge_1.png)
18+
19+
2. On the bridge page, the first step is to connect it to your browser wallet.
20+
![Connect wallet in browser wallet bridge](/images/onchain_browser_wallet_bridge_2.png)
21+
22+
3. Once connected, the page should display your wallet status.
23+
![Wallet connect bridge connected](/images/onchain_browser_wallet_bridge_3.png)
24+
25+
4. Now you’ll need the `WalletConnect Pair URI`. Go back to the Electron app, click `Connect Wallet`, and choose `WalletConnect`.
26+
![Wallet Connect](/images/onchain_browser_wallet_bridge_4.png)
27+
28+
5. Wait for the QR code to appear, then click `Copy Link`. The Pair URI will be copied to your clipboard. It will look something like this:
29+
`wc:0579c1fee69aad512b6ef19a977a08f6c60b19415661cfa2882039da038a24fb@2?relay-protocol=irn&symKey=55d16a7cfc2198dfc1058254a7862c98aad401814bb86219041687d5b6de4020&expiryTimestamp=1744297123`
30+
![Copy Wallet Connect pairing URI](/images/onchain_browser_wallet_bridge_5.png)
31+
32+
6. Return to the bridge page in your browser, paste the Pair URI, and click `Start Pairing`.
33+
![Wallet Connect bridge start pairing](/images/onchain_browser_wallet_bridge_6.png)
34+
35+
You're now connected and can perform transactions from the Electron app.

0 commit comments

Comments
 (0)