scoobs
/
cryptools-mirror
mirror of https://github.com/scoobybejesus/cryptools.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improved formatting and readability.

This commit is contained in:
scoobybejesus 2019-10-05 21:04:13 -04:00
parent 6a6c2b0c33
commit c553464423
2 changed files with 42 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
InputFile_CSV.md
View File

@ -2,58 +2,61 @@
// Redistributions must include the license: https://github.com/scoobybejesus/cryptools/blob/master/LEGAL.txt
---
**`input_file.csv`**
## Overview
The key to understanding how to use this software is to understand the input file.
The input file encodes all accounts, including all transactions occurring in and between those accounts.
All income, expenses, gains, and losses (and related like-kind treatment results)
are deterministically calculated based on the input file (and the command-line parameters).
This document aims to tell a user all they need to know about the CSV input file.
This document aims to tell the user all they need to know.
Note: the input file is needed in the *current* version of the software.
Future versions may store the transactional activity in a database or similar file.
At that time, additional transactions perhaps may be entered directly into the software.
For now, however, additional transactions are added to the input file,
At that time, it may be that additional transactions are entered directly into the software.
For now, however, additional transactions must be added to the input file,
and then the input file is imported ***in full*** every time the software is run.
## Overview
## Preface
`cryptools` is a command-line utility that does **not** store data.
`cryptools` is a command-line utility that does not store data.
It is not a bookkeeping tool.
It does **not** store your transactions in a persistent ledger.
It does not store your transactions in a persistent ledger.
You cannot open the software later, load the ledger, and enter new transactions.
Rather, you must maintain the input file outside `cryptools`.
If you have new transactions, you must append them to the input file.
Once you have added new transactions to the input file and wish to view updated reports,
you must run the software again and import the updated input file.
you must run the software again and import the recently-updated input file.
New reports will be generated at that time.
When the software runs, it imports the input file, it processes the transactions, and it prints reports.
When `cryptools` runs, it imports the input file, it processes the transactions, and it prints reports.
The transaction reports reflect income, expenses, realized gains, and realized losses.
At a minimum, the account reports reflect account balances and cost basis of holdings.
Some account reports reflect all movements in every lot in every account, including tracking of cost basis and more.
Some account reports reflect *all* movements in *every* lot in *every* account, including tracking of cost basis and more.
After the reports have been printed/exported, the software stops running and the memory is abandoned/cleared.
Once the software has run, you rely on the reports to tell you everything you need to know.
Keep in mind that aggregating one's entire crypto history is very important!
Cryptocurrency users **cannot** rely on exchanges to provide them with gain/loss information.
At most, an exchange will be able to provide the gross value of their transactions (what `cryptools` calls `proceeds`).
Exchanges have **no way** to track their users' cost basis, though,
and exchanges have **no way** to verify the use of funds they disburse.
Consequently, exchanges will treat all trades and all disbursements as pure gains.
Think about this: exchanges have **no way** to track the cost basis of their users' holdings,
nor can they verify how the funds they disburse are used.
Consequently, exchanges will treat all trades and all disbursements as pure (taxable) gains.
This means it is **up to users** to keep track of their cost basis!
By aggregating all your cryptocurrency activity, this software enables you to track **and prove** your cost basis.
Using these reports, you can walk back in time to track the cost basis used in every gain/loss calculation.
(If you paid cash for any cryptos, proof becomes much more difficult, but at least you have an otherwise complete ledger.)
### A final note before digging in
The input file *can be* intimidating.
Admittedly, some people will have a tough time preparing it correctly or at all.
The trouble tends to come when aggregating a user's entire crypto history long after the fact.
Even so, preparing and maintaining the input file is **not** very complicated.
There are a small, limited number of rules to follow.
The input file is simple to maintain once it is brought current and kept current.
There are a small, limited number of rules to follow, and that's it.
The truth is that the input file is simple to maintain once it is brought current and kept current.
### The rules
#### Rules of the input file
The rules for successfully preparing and maintaining the input file can generally be summarized as follows:
@ -66,7 +69,7 @@ It is **required** in order to properly calculate income/expense/gain/loss.
Keep an eye out for a related project that creates input file pro formas from exchange reports, thus automating some of the process.
---
## Visual representation
In order to be successfully imported, the CSV input file **must** be in a prescribed form that effectively looks like this:

32
README.md
View File

@ -4,21 +4,22 @@
###### (Currently runs as a binary)
The software measures one's cryptocurrency activity (i.e., denominates one's income/expenses/gains/losses) in their home currency.
The default home currency is USD, but anything can be substituted.
This tool is probably most useful when filing one's taxes.
This software calculates income, expenses, realized gains, and realized losses from cryptocurrency activity
and denominates the results in the user's home currency.
The default home currency is USD, but any currency can be substituted.
This tool is probably most useful for filling out a tax return or making tax planning decisions.
---
Given a [CSV input file](https://github.com/scoobybejesus/cryptools/blob/master/InputFile_CSV.md)
containing the user's entire cryptocurrency transaction history, the software will:
* assign cost basis as of the date of purchase/exchange/receipt
* track the original acquisition date and cost basis until the time of disposal
* record every cryptocurrency acquisition and track it until it is disposed
* assign cost basis to every acquisition as of the date of purchase/exchange/receipt
* track the original acquisition date and cost basis (making adjustements for like-kind exchange treatment, if elected)
* compute gain or loss from the sale/exchange/disposal (including whether short-term or long-term)
* record income for incoming transactions and expenses for outgoing transactions
Reports reflecting income/expenses/gains/losses or amount and cost basis of existing holdings may be exported as CSV/TXT files.
* print/export the results as CSV and TXT files
---
@ -40,20 +41,22 @@ Reports reflecting income/expenses/gains/losses or amount and cost basis of exis
the XCP or ETH transaction fee must be reflected in a separate transaction row).
* Manual adjustments may need to be made to the output files in cases, for example,
when the user used appreciated cryptocurrency to make a tax-deductible charitable contribution.
when the uses used appreciated cryptocurrency to make a tax-deductible charitable contribution.
## Installation
1. `cargo build` (include `--release` for a non-debug build)
1. `git clone https://github.com/scoobybejesus/cryptools.git`
2. `cd cryptools`
3. `cargo build` (include `--release` for a non-debug build)
This will build `./target/debug/cryptools` (or `./target/rls/cryptools` for a non-debug build).
## Usage
Run `./target/debug/cryptools` with no arguments (or `--help`, or `-h`) to see usage.
Run `./target/debug/cryptools` with no arguments (or with `--help`, or `-h`) to see usage.
Alternatively, run `cargo run`, in which case command-line arguments for `cryptools` may be entered following `--`, e.g., `cargo run -- -h`.
Running with no arguments will lead the user through a wizard, or all required arguments can be passed as command-line flags/options/args.
Running with no arguments will lead the user through a wizard; or all required arguments can be passed as command-line flags/options/args.
See `/examples/` directory for further guidance,
or jump directly to the [examples.md](https://github.com/scoobybejesus/cryptools/blob/master/examples/examples.md) file.
@ -75,16 +78,15 @@ Additional testers/users are encouraged and welcome.
## A few words from the founder
I have an accounting background, and I live in the US.
I took an interest in cryptocurrency in 2016.
I have an accounting background, I live in the US, and I am interested in cryptocurrencies.
When it came time to file my tax return, I had to come to grips with recording my cryptocurrency activity.
I initially used a spreadsheet to manually process the activity into lots, and it quickly became clear that I needed a software solution.
I initially used a spreadsheet that manually processed the activity into lots, and it quickly became clear that I needed a software solution.
Given my background, I had certain expectations about what this type of software would do, and I tried several online options.
I eventually created this project as a reaction to the inadequate tooling I found online.
Sure, other products have more bells and whistles, but at least I know this produces correct results
(i.e., this software specifically identifies and track all acquired assets, whereas online solutions seems to pool them together).
I am not a formally trained programmer, however I enjoy it very much and learn more whenever I can.
I am not a formally trained programmer, however I have come to enjoy it very much and learn more whenever I can.
I originally tried to learn C++ by myself, and that was frustrating.
My first real progress was with Python, but I still didn't manage to fully develop a working program.
Luckily, I managed to stumble across a mentor who helped me write 80% of an MVP in strongly-typed Swift.