GithubHelp home page GithubHelp logo

jbelke / thewarden Goto Github PK

View Code? Open in Web Editor NEW

This project forked from aussiehash/cryptoblotter

0.0 2.0 0.0 117.16 MB

Open Source Portfolio Tracker for Bitcoin

Home Page: http://www.thewarden.io/

License: MIT License

Python 48.16% JavaScript 30.15% CSS 3.43% HTML 18.23% C 0.03%

thewarden's Introduction

The WARden

IMPORTANT NOTE

Unfortunately I'm short on time to maintain this project right now. Keep in mind that this is alpha software. Expect bugs and keep reporting them to github.

If you are a developer who would like to help maintain this project, let me know.

Version 0.15 Alpha

Found this project useful?
Consider tipping the developer: tippin.me.

Open Source License: LICENSE
Contributing guidelines: CONTRIBUTING.MD
Installation instructions: INSTALL.MD
Telegram group: https://t.me/bitcoin_warden

Important Note for users upgrading from CryptoBlotter

The new version does not offer backward compatibility with previous versions. If you are running an older version and have transactions, make sure to export the transactions as CSV and save them somewhere safe. You can later import these into the new version. This is experimental and errors may occur.

Sample Portfolio View

All trades, bitcoin addresses and other information below are hypothetical only

Front Page

About

The WARden is a portfolio tracking tool. It includes position monitoring and other analytics. One of the reasons that led me to develop this tool is to better manage cash inflows and outflows from digital positions while maintaining my data locally.

The app monitors daily Net Asset Value (NAV). Similar to how a fund calculates performance. So it's always tracking performance relative to current exposure.

Furthermore, using my own node to verify and import transactions was a cumbersome process. By pairing with a Samourai Dojo, you can easily track addresses and import transactions from the blockchain while using your own full node.

Telegram group: https://t.me/bitcoin_warden

Why NAV is important?

NAV is particularly important to anyone #stackingsats since it tracks performance relative to current capital allocated. For example, a portfolio going from $100 to $200 may seem like it 2x but the performance really depends if any new capital was invested or divested during this period. NAV adjusts for cash inflows and outflows.

Using a Bitcoin Full Node

You can now use a full node to monitor addresses and import transactions. This process is done using the Samourai Dojo platform. After researching the different options available, I decided the Dojo was best suited to integrate with the WARden.

Trade Pairs

The app is structured so that, by default, trades are included in pairs. This is similar to accounting entries where a credit and a debit are included as separate entries. This is helpful so you can track your positions (assets) and your cash flows. By doing this, it's easier to see how much fiat was deployed. It's particularly helpful in determining your historical average cost. More info on how to import transactions can be found here: CSV import details. You may also open the database and just paste the transactions.

Readme.1st


Please note that this is ALPHA software. There is no guarantee that the information and analytics are correct. Also expect no customer support. Issues are encouraged to be raised through GitHub but they will be answered on a best efforts basis.

All data is saved locally. Consider a disk encryption. Even though only public addresses and transactions are saved in the database, it's a good idea to password protect your computer and encrypt the hard drive containing the data.

Any issues, suggestions or comments should be done at Github ISSUES page.

Installation instructions

Privacy

Most portfolio tracking tools ask for personal information and may track your IP and other information. My experience is that even those who say they don't, may have log files at their systems that do track your IP and could be easily linked to your data. By cloning CB and running locally you reduce the risk of linkage of your IP, portfolio info and other information.

Asset and Liability tracking

Different than most portfolio tracking tools, CB tracks both sides of transactions: the crypto asset side and the fiat side. This helps in analyzing cost basis, historical cash flows and fiat to crypto conversions along time.

NAV Tracking

Another major difference is the concept of tracking Net Asset Value (NAV). NAV tracks performance based on amount of capital allocated. For example, a portfolio starts at $100.00 on day 0. On day 1, there is a capital inflow of an additional $50.00. Now, if on day 2, the Portfolio value is $200, it's easy to conclude that there's a $50.00 profit. But in terms of % appreciation, there are different ways to calculate performance. CB Calculates a daily NAV (starting at 100 on day zero). In this example:

Day Portfolio Value* Cash Flow NAV Performance
0 $0.00 + $100.00 100 --
1 $110.00 + $50.00 110 +10.00% (1)
2 $200.00 None 125 +25.00% (2)
  • Portfolio Market Value at beginning of day (1) 10% = 110 / 100 - 1 (2) 25% = 200 / (110 + 50) - 1

Tracking NAV is particularly helpful when #stackingsats. It calculates performance based on capital invested at any given time. A portfolio starting at $100 and ending at $200 at a given time frame, at first sight, may seem like is +100% but that depends entirely on amount of capital invested along that time frame.


FAQ

- Why include other Crypto Assets and not only Bitcoin?

We believe CB actually helps users realize the value of a Bitcoin only portfolio. But that's our opinion. We preferred to give users the ability to check their whole portfolio and provide them with the tools to assess how much better (or maybe worse) they would have been with a Bitcoin only portfolio. Most crypto investors go through a period of investing in other assets. The quicker they realize this is a losing strategy, the better. We hope these tools help them learn quicker.

- Why is NAV a better way to track a portfolio?

It takes into account deposits and withdraws. See table at NAV Tracking for more info.

- Is there a mobile version available?

Not at this time.

- Do I need to run it locally or is there a website I can use?

The app needs to be installed locally. Remember, you don't want to be sending all your transactions to unknown couterparties or through the internet. Keeping it local increases your privacy and security.

- Why the DOJO and not other available options?

First and foremost, the Samourai team has shown continued support for open source. Second, our opinion is that they share values very similar to ours in terms of Bitcoin security and its future. Finally, the Dojo seemed like the best suited option for a fairly easy install and back-end integration with this project.

thewarden's People

Contributors

pxsocs avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.