View source for DeFiChain-Portfolio

[[File:Defi-portfolio-logo.png|alt=|border|right|frameless|167x167px]]

==Community==
If you have ideas for new features, bug reports or questions do not hesitate to create an issue on [https://github.com/DeFi-PortfolioManagement/defi-portfolio/issues GitHub] or contact the [https://t.me/DeFiChainPortfolio Telegram Community]

For an introduction to DeFiChain-Portfolio, we recommend the [https://www.youtube.com/watch?v=86xO3_oFXAQ video from Crypto Explained on YouTube]
==General==
Use DeFi-Portfolio to export, analyse and visualize your transactions, rewards and commissions of your liquidity mining pools or DEX transactions to interact with DeFiChain. The current version of DeFi-Portfolio is released [https://github.com/DeFi-PortfolioManagement/defi-portfolio/releases/ here] on Github.

== Minimum Requirements ==
RAM: 4GB

OS: macOS 10.14, Windows 10, Ubuntu LTS 18 and above

==Getting started==

* Install and run the DeFi-Portfolio for [https://defichain-wiki.com/wiki/DeFiChain-Portfolio#Installation_Windows Windows], [https://defichain-wiki.com/wiki/DeFiChain-Portfolio#Installation_Mac Mac] or [https://defichain-wiki.com/wiki/DeFiChain-Portfolio#Installation_Linux Linux].
* Click on update database (left bottom corner) When you load the data for the first time you have to allow access.
[[File:FirewallPermission.png|alt=|border|center|frameless|362x362px]]
* Now your big data will imported and you can look on the raw data, export them or analyse your rewards and commissions.
* After closing close the defid.exe. (If not then maybe you need a full resync the next time)

== Installation Windows ==
Download the latest version for windows: [https://github.com/DeFi-PortfolioManagement/defi-portfolio/releases/download/1.4.1/defi-portfolio-Setup-1.4.1.exe DeFi-Portfolio 1.4.1]

When you start the installer Windows Defender will block the installation. Just click on "more info" and "run anyway".

Once the installation is done a shortcut of the DeFi-Portfolio will be available on the desktop.<gallery mode="packed" heights="350">
File:WindowsConfig2.jpg
File:WindowsConfig.jpg
</gallery>

== Installation Mac ==
Download the latest version for mac: [https://github.com/DeFi-PortfolioManagement/defi-portfolio/releases/download/1.4.1/defi-portfolio-1.4.1-mac.tar DeFi-Portfolio 1.4.1]

Open the app. The first time you open the DeFi-Portfolio, you will be presented with a security prompt. Press OK to dismiss it. Go to System Preferences and click on Security & Privacy. <gallery mode="packed" heights="350">
File:Mac Ok.png
File:MacSystemPreferences.png
</gallery>Then click on the Open Anyway. Click Open on the confirmation popup. DeFi-Portfolio will launch automatically when the installation is complete.<gallery mode="packed" heights="350">
File:MacSecurityAndPrivacy.png
File:Macopen.png
</gallery>'''Move defi-portfolio to applications'''    [[File:MacInstallation.jpg|center|frameless|505x505px]]

== Installation Linux ==
Download the latest version for linux: [https://github.com/DeFi-PortfolioManagement/defi-portfolio/releases/download/1.4.1/DeFi-Portfolio-1.4.1-linux.tar DeFi-Portfolio 1.4.1]

Once you have downloaded the .tar package you have to extract the files. In the "DeFiPortfolio" folder there is the file "launchDeFiPortfolio". Before you can launch the program it must be made executable. Right click on "launchDeFiPortfolio" and cklick in properties. Switch to the tab Permissions and allow executing file as program.

Once this is done you can launch the tool. <gallery mode="packed" heights="300">
File:LinuxInstallation1 .png
File:LinuxInstallation2.png
</gallery>
==Functionality description==

===='''Update Database:'''====
Before you can analyse your rewards and commissions the database must be updated. With the update database button the transactions will be read out and saved locally (appdata). While updating the database the connection to the node will be established (command line window). This will automatically close once the local data are up to date.
[[File:UpdateDatabase.png|border|center|frameless|821x821px]]

===='''Raw Data:'''====
All transactions are shown here in tabular form. When clicking on Blockheight, Blockhash, Owner or Transaction-Hash the Blockchain Explorer will be opened with the respective value. The table can be exported as a csv file. To do this, right-click on the corresponding sub-functions.
[[File:Rawdata.jpg|center|frameless|585x585px]]

===='''Analyse Data:'''====

====='''Portfolio:'''=====

In the first pie chart your tokens are displayed with the fiat value from the latest update. The second pie chart show the liquidity mining tokens also with the fiat value from the latest update. In the table on the right side the tokens and the liquidity mining tokens are summarized. It is displayed the amount of tokens and also the value in fiat.

'''Total amount:''' Balance of complete wallet in choosen FIAT currency

'''Total yield:''' All rewards and commissions calculated in choosen FIAT currency (Price at date of the last Update '''not''' daily calculated like in the other tabs)

'''Rewards yield:''' All rewards calculated in choosen FIAT currency (Price at date of the last Update '''not''' daily calculated like in the other tabs)

'''Commissions yield:''' All commissions calculated in choosen FIAT currency (Price at date of the last Update '''not''' daily calculated like in the other tabs)
[[File:PortfolioOverview.jpg|center|frameless|761x761px]]'''Column description:'''

"Token" Name of Token or Liquidity Mining Token 

"Crypto value" Amount of token in wallet or LM Token with for example how much BTC or DFI it is

"FIAT value (FIAT)" Same like "Crypto value" but shown in choosen FIAT currency

====='''Rewards''': =====

The rewards are displayed in graphical form. You can choose the start date and the end date. In addition, the interval (daily, weekly, monthly, yearly) can be selected and the pool share can be choosen. The plot can be switched between individual and cumulative view. The table can be also exported as a csv file. To do this, right-click on the corresponding sub-functions.<gallery heights="300" perrow="500" mode="packed">
File:AnalyseRewards Commissions.jpg
File:Rewardscummulated.jpg
</gallery>'''Column description:'''

"Date" Day, week, month or year (Depend on choosen intervall) 

"Pool Pair" LM Pool from which you get the rewards or comissions

"DFI" How many DFI rewards you get on this intervall of the line

"DFI (FIAT)" same like "DFI" but converted to choosen FIAT currency (with daily calculated price of coingecko API)

====='''Commissions''': =====
The commissions are displayed in graphical form. The setting options are the same as for rewards. You can select the start date and the end date. In addition, the interval (daily, weekly, monthly, yearly) can be selected and the pool share can be choosen. The plot can be switched between individual and cumulative view.
[[File:Commissions.jpg|center|581x581px|alt=|frameless|






]]'''Column description:'''

"Date" Day, week, month or year (Depend on choosen intervall) 

"Pool Pair" LM Pool from which you get the rewards or comissions

"DFI" How many DFI commissions you get on this intervall of the line

"DFI (FIAT)" same like "DFI" but converted to choosen FIAT currency (with daily calculated price of coingecko API)

"2nd commission of choosen Pool Pair eg. BTC" is how many commissions you get on this intercall of the line in second pool pair

"BTC (FIAT)" same like "2nd commission of choosen Pool Pair eg. BTC"  but converted to choosen FIAT currency (with daily calculated price of coingecko API)

"Total (FIAT)" Total of all commissions of this line (intervall) in choosen FIAT currency

====='''Overview''': =====
The overview is displayed in graphical form. The rewards and commissions are combined in one plot. You can choose the start date and the end date.You can also select the interval (daily, weekly, monthly, yearly).
[[File:Overview.jpg|center|frameless|557x557px|


]]'''Column description:'''

"Date" Day, week, month or year (Depend on choosen intervall) 

"Pool Pair" LM Pool from which you get the rewards or comissions

"Rewards" How many DFI rewards you get on this intervall of the line

"Rewards (USD)" same like "Rewards" but converted to choosen FIAT currency (with daily calculated price of coingecko API)

"Commissions DFI" is how many DFI commissions you get on this intercall of the line

"Commissions DFI (USD)" same like "Commissions DFI" but converted to choosen FIAT currency (with daily calculated price of coingecko API)

"Commissions 2" is how many BTC, ETH, LTC... etc commission you earned on the intervall of the line... for example on Pool BTC-DFI is commission2 = BTC

"Commissions 2 (USD)" same like "Commissions 2" but converted to FIAT currency  (with daily calculated price of coingecko API)

"Total" Total of reward and all commissions of this line (intervall) in choosen FIAT currency

== Settings ==
The following settings can be made in the Settings menu:

* '''Language''': Switch between english and german.
* '''Preferred Currency''': Euro, US-Dollar, Swiss franc
* '''Design''': Light Mode and dark Mode
* '''Launch "Node" on tool start:''' When starting the Node on tool start the synchronization of the local data will be done. This shortens the time needed for synchronization with update data
* '''Delete local Portfolio data''': You can delete the local transaction data which are generated by the DeFi-Portfolio. Before you click on "update Data" you have to restart the tool.
[[File:Settings.png|border|center|frameless|363x363px]]

== Help ==
In the help menu you will find the link to the [https://github.com/DeFi-PortfolioManagement/defi-portfolio/blob/master/README.md GitHub repository] as well as the link to our [https://t.me/DeFiChainPortfolio Telegram community]. With the youtube link you will get to the [https://www.youtube.com/watch?v=86xO3_oFXAQ video about DeFiPortfolio] from crypto explained. There is also the possibility to open the [https://defichain.com/ DeFiChain website].Furthermore a link to this wiki is available and a link to the [https://defichain-explained.com/ DeFiChainExplained] website.  
[[File:HelpMenu.png|alt=|center|frameless|602x602px]]

== FAQs ==
'''Q: The defid is not closing after update data. How can I close it?'''

A: If the defid does not close automatically, then an error occurred during the update process. You must <u>not</u> close the defid (mostly white or black cmd/terminal) by clicking on the x/o-symbol (close), otherwise a reindex is necessary. There are two ways to close the defid safely: 

Click with the left mouse button on the defid and press <code>[CTRL]</code> + <code>[c]</code> on the keyboard or click the button close defid in the settings menu (min v1.4.2).

'''Q: Where can I find the logfile?'''

A: In the logfile there are hints why the Defi-Portfolio app does not work properly. This information helps the developers to make the tool more stable. The logfile can be found here: 

Windows: ''<code>C:\Users\Username\AppData\Roaming\defi-portfolio\log.txt</code>''

Mac (right click on the app and open package informationen): ''<code>defi-portfolio.app/Contents/Resources/PortfolioData/log.txt</code>''

Linux: Folder where you unzipped the .tar: ''<code>PortfolioData/log.txt</code>''

'''Q: Where is the installation folder?'''

A: The program files are copied during the installation into following folder: 

Windows: ''<code>C:\Users\Username\AppData\Local\Programs\defi-portfolio\</code>''

Mac (right click on the app and open package informationen): ''<code>defi-portfolio.app/Contents/Resources/</code>''

Linux: Folder where you unzipped the .tar:

'''Q: Where is the application data stored?'''

A: The application folder can be found here: 

Windows: ''<code>C:\Users\Username\AppData\Roaming\defi-portfolio\log.txt</code>''

Mac (right click on the app and open package informationen): ''<code>defi-portfolio.app/Contents/Resources/PortfolioData/log.txt</code>''

Linux: Folder where you unzipped the .tar: ''<code>PortfolioData/log.txt</code>''

In the application folder follwoing files are available: TransactionData (all data from DeFi Wallet), PortfolioData/defid (node),PortfolioData/defi.conf (config for node), Settings, Logfile, CoinPriceData (stored coinprices)

'''Q: Do I need to uninstall the old version when a new version is available?'''

A:  No,you do not need to uninstall the old version. During the installation process the files of the old version will be replaced with the files of the new version

== Projects interact with DeFiChain Portfolio ==

=== DeFiPortfolio2Cointracking ===
Convertion of CSV Export from DeFiChain Portfolio to a Cointracking format

Download: [https://www.dropbox.com/s/qpqu9xqjjc72etk/DeFiChainPortfolio2CoinTracking.xlsm?dl=0 v1.3.4]

Telegram Channel: https://t.me/joinchat/xs2tRCnHojVkNWQy

== Roadmap 2021 ==

==== 2021 - Q2: ====

* Overview and export of masternode & anchoring rewards
* Import CSV from DeFi Wallet and Cake to display an overall view of invests
* Export transactions to a cointracking format together with Jörg Leidinger (Developer of community project DeFiPortfolio2Cointracking)
* Cross-check between all transactions and the portfolio value to verify whether you have all transactions or which are missing. If there are known errors, then try to find the missing transactions via different APIs 
* Amount,yield and pool share percentage of liquidity-tokens during the time
* Migration from Java to JS/TS (Help from community member Raphael) and maybe Python (API with Backend) to be able to process the large amount of data and have more synergies with DeFi Analytics (Daniel Zirkel’s new dashboard)

==== 2021 - Q3: ====

* Generic Export Function: User can create his own template to get a personalised export of his data
* Standard templates for „Generic Export Function“ like Cointracking, Accointing, Blockfolio, Cryptotax … etc.

==== 2021 - Q4: ====

* Host servers with fullnodes to get all information via API (Accessable for all other users/developer to be more decentralized and give possibility to create a web or mobile application)

[[Category:Defi-portfolio]]
[[Category:Portfolio]]
[[Category:Defichain]]
[[Category:Csvexport]]