Skip to content

Commit

Permalink
docs: add guide for export import accounts and addressbook
Browse files Browse the repository at this point in the history
  • Loading branch information
lukicenturi authored and kelsos committed Dec 11, 2024
1 parent 3570767 commit 97d9e11
Show file tree
Hide file tree
Showing 7 changed files with 97 additions and 16 deletions.
27 changes: 24 additions & 3 deletions components/CsvTable.vue
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,17 @@ onMounted(async () => {
</script>

<template>
<h3 v-if="title">
{{ title }}
</h3>
<div class="title-section">
<h3 v-if="title">
{{ title }}
</h3>
<a
:href="csvUrl"
download
>
[Download CSV Example]
</a>
</div>
<table>
<thead>
<tr>
Expand All @@ -66,3 +74,16 @@ onMounted(async () => {
</tbody>
</table>
</template>

<style scoped>
.title-section {
display: flex;
justify-content: space-between;
gap: 1rem;
margin-top: 1rem;
}
.title-section h3 {
margin-top: 0;
}
</style>
5 changes: 5 additions & 0 deletions public/files/address_book_entries.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
address,name,blockchain,location
0xa83114a443da1cecefc50368531cace9f37fcccb,harvey,,
0x388c818ca8b9251b393131c08a736a67ccb19297,donna,,global
0xdac17f958d2ee523a2206206994597c13d831ec7,mike,arbitrum_one,
bc1q2t0ad9cqars69ge9v7v7td7rpg3p7etgqfe0zn,rachel,btc,private
13 changes: 13 additions & 0 deletions public/files/blockchain-accounts.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
address,address extras,chain,label,tags
0x99A91871b93E13F53D8209529B5E390664bf25d8,,evm,eth with validators,eth-1;eth-with-validators
0x9DBE4Eb4A0a41955E1DC733E322f84295a0aa5c0,,evm,hahaha,evm-tag
0xc37b40ABdB939635068d3c5f13E7faF686F03B65,,evm,,
bc1qdf3av8da4up78shctfual6j6cv3kyvcw6qk3fz,,btc,bitcoin-1,bitcoin-1
qz5hccuhr036drq7m3mah3qf5x3f5phv05v5rtu5z2,,bch,bitcoin-cash-1,bitcoin-cash-1
EbEjgkw4Z2jFtaDad7zj59LrfmyuznXJzCmQh2qUfMvjiUj,,ksm,kusama-1,kusama-1
14rw69gBpjYwdiw5MzvsZCSYVnHqubpUSHC5QPNBY5MPAoRi,,dot,polkadot-1,polkadot-1
xpub6CcGTthbwnbxsMRuEF3XoYdekGtnGTsbiZ4ZKeqMC1UuqPYqh2xQj9hbEQj8AB9EuGeFHz4o3hWayZm5ahr5fyV2SNfNyA6htsZngM1DFBz,,btc,xpub-1,xpub-1
0x80858247aa14f2c23e9a83b65d2a3e3de22f16ddaaf3fad0fee52601d3f67f71ccb72b196a4789a9d0aa057721745996,,eth2,,
0x918583458bae9b00cfb9d78497d58f9678cf91755a08682410756909de021666208ecf84e97ac5abddbf5f17af5fb11d,ownershipPercentage=50.00,eth2,,
0xab423fb58c3498a8014bcc115be96bea77c99004fb59d3580d75fff0054e113d126ee6dd65faa027732f7cf38fdb4dd2,ownershipPercentage=22.00,eth2,,
0xa49152b5babd0130d9e5e3480eb9d17dfad5c090e6a7b6849e14b6baba0d47444fdd454303bfd202b6ae895654f678c0,ownershipPercentage=33.00,eth2,,
Binary file added public/images/import_addressbook_entries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 29 additions & 13 deletions usage-guides/accounts-and-balances.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ For now, the following chains are supported in rotki (and the list will be growi

- **EVM Chains**:

- Ethereum
- Optimism
- Polygon PoS
- Arbitrum One
- Base
- Gnosis
- Scroll
- Avalanche
- zkSync Lite
- Ethereum (eth)
- Optimism (optimism)
- Polygon PoS (polygon_pos)
- Arbitrum One (arbitrum_one)
- Base (base)
- Gnosis (gnosis)
- Scroll (scroll)
- Avalanche (avax)
- zkSync Lite (zksync_lite)

- **Bitcoin Chains**:

- Bitcoin
- Bitcoin Cash
- Bitcoin (btc)
- Bitcoin Cash (bch)

- **Substrate Chains**:
- Polkadot
- Kusama
- Polkadot (dot)
- Kusama (ksm)

To add or modify an account navigate to the `Blockchain Balances` sub-page and click the "**Add Account**" button on the top right. Now choose the blockchain on which you want to add an account. Then type or paste the address in the "Account" textbox and press the "Save" Button. Note that you can add multiple accounts if you click the "**Add multiple addresses**" checkbox and provide a comma separated list of addresses.

Expand Down Expand Up @@ -93,6 +93,22 @@ For EVM accounts, it is possible to trigger the process of detecting tokens befo

3. To re-detect tokens for only one account, click the refresh button in the corresponding row.

## Import and Export Blockchain Accounts (CSV)

You can export your blockchain accounts to CSV and then import them again into another rotki account (if you need to do it for your tax accountant, etc.). Also, if you have many accounts that you want to add to rotki, you can create your CSV and import it into rotki.

You can do it in the menu `Accounts & Balances > Blockchain Balances` by clicking the three-dot menu.

![Import and Export Blockchain Accounts](/images/import_and_export_blockchain_accounts.png)

<CsvTable title="Blockchain Accounts CSV" csvUrl="/files/blockchain-accounts.csv" />

1. The `address` field is **required**. For an xpub, input the xpub address. For a validator, input the publicKey.
2. The `address extras` field is **optional**. You can specify `ownershipPercentage=xx` for validators and `derivationPath=xx` for xpubs.
3. The `chain` field is **required**. You can find supported chain IDs in the [supported blockchain](#adding-and-removing-blockchain-accounts) section. Use `evm` to add to all EVM chains.
4. The `label` field is **optional**.
5. The `tags` field is **optional**. Multiple tags should be separated by semicolons (`;`).

## Checking Exchange Balances

You can check all of the asset balances that you have in each connected exchange in the "Exchange Balances" sub-page. Clicking the "Add exchange" button takes you to the API Keys page where you can manage your exchange connections (see [Adding an exchange](/usage-guides/importing-data.html#adding-an-exchange)).
Expand Down
26 changes: 26 additions & 0 deletions usage-guides/address-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,29 @@ rotki provides an address book for blockchains. This replaces addresses with nam
> 4. Ethereum Tokens
> 5. Hardcoded Mappings
> 6. ENS names.
## Import multiple address books (CSV)

You can add multiple address book entries at once with CSV import. You can find the menu in the three-dots menu here.

![Import Address Book Entries](/images/import_addressbook_entries.png)

<CsvTable title="Address Book Entries CSV" csvUrl="/files/address_book_entries.csv" />

1. The `address` field is **required**.
2. The `name` field is **required**.
3. The `blockchain` field is **optional**. You can find supported chain IDs in the [supported blockchains](/usage-guides/accounts-and-balances#adding-and-removing-blockchain-accounts) section. Leave it blank to add the entry to all chains.
4. The `location` field is **optional**. You can set it to either `global` or `private`. By default, it will be saved as `private`.

## Import multiple address books (CSV)

You can add multiple address book entries at once with CSV import. You can find the menu in the three-dots menu here.

![Import Address Book Entries](/images/import_addressbook_entries.png)

<CsvTable title="Address Book Entries CSV" csvUrl="/files/address_book_entries.csv" />

1. The `address` field is **required**.
2. The `name` field is **required**.
3. The `blockchain` field is **optional**. You can find supported chain IDs in the [supported blockchain](/usage-guides/accounts-and-balances#adding-and-removing-blockchain-accounts) section. Leave it blank to add it to all chains.
4. The `location` field is **optional**. You can either set it to `global` or `private`. By default it will be saved as `private`.

0 comments on commit 97d9e11

Please sign in to comment.