2019-09-21 00:27:13 +00:00
|
|
|
# cryptools
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-08-26 01:49:22 +00:00
|
|
|
### Accounting library for cryptocurrency transaction activity.
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-10-28 01:25:23 +00:00
|
|
|
###### (The package produces a binary that makes use of the library)
|
2019-08-28 02:33:06 +00:00
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
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.
|
2019-09-21 18:41:11 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2019-09-21 22:11:26 +00:00
|
|
|
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:
|
2019-08-30 02:45:48 +00:00
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
* 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)
|
2019-08-30 02:45:48 +00:00
|
|
|
* 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
|
2019-10-06 01:04:13 +00:00
|
|
|
* print/export the results as CSV and TXT files
|
2019-08-30 02:45:48 +00:00
|
|
|
|
2019-08-30 02:51:33 +00:00
|
|
|
---
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-10-06 01:26:37 +00:00
|
|
|
### Features
|
2019-08-30 02:45:48 +00:00
|
|
|
|
|
|
|
|
* Two methods each of LIFO or FIFO (with intentions to add more)
|
|
|
|
|
|
|
|
|
|
* Ability to perform like-kind exchange treatment
|
|
|
|
|
|
2019-09-01 04:49:00 +00:00
|
|
|
* Compatible with any home currency
|
|
|
|
|
|
2019-10-06 01:26:37 +00:00
|
|
|
### Constraints
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-09-21 22:11:26 +00:00
|
|
|
* *All* cryptocurrency-related activity for the user generally must be included in the
|
|
|
|
|
[CSV input file](https://github.com/scoobybejesus/cryptools/blob/master/InputFile_CSV.md).
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-09-21 18:56:43 +00:00
|
|
|
* There can only be either one or two accounts used in a given transaction
|
|
|
|
|
(i.e., if a Counterparty token or Ethereum token transaction must be recorded,
|
|
|
|
|
the XCP or ETH transaction fee must be reflected in a separate transaction row).
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-09-21 18:56:43 +00:00
|
|
|
* Manual adjustments may need to be made to the output files in cases, for example,
|
2019-10-06 01:26:37 +00:00
|
|
|
when appreciated cryptocurrency was used to make a tax-deductible charitable contribution.
|
2019-08-25 23:57:07 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
1. `git clone https://github.com/scoobybejesus/cryptools.git`
|
|
|
|
|
2. `cd cryptools`
|
|
|
|
|
3. `cargo build` (include `--release` for a non-debug build)
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-10-28 01:25:23 +00:00
|
|
|
This will build `./target/debug/cryptools` (or `./target/release/cryptools` for a non-debug build).
|
2019-08-25 23:57:07 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
Run `./target/debug/cryptools` with no arguments (or with `--help`, or `-h`) to see usage.
|
2019-09-21 00:27:13 +00:00
|
|
|
Alternatively, run `cargo run`, in which case command-line arguments for `cryptools` may be entered following `--`, e.g., `cargo run -- -h`.
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
Running with no arguments will lead the user through a wizard; or all required arguments can be passed as command-line flags/options/args.
|
2019-09-05 02:42:19 +00:00
|
|
|
See `/examples/` directory for further guidance,
|
2019-09-21 00:27:13 +00:00
|
|
|
or jump directly to the [examples.md](https://github.com/scoobybejesus/cryptools/blob/master/examples/examples.md) file.
|
2019-08-30 02:45:48 +00:00
|
|
|
|
2019-08-28 02:33:06 +00:00
|
|
|
## Development state
|
|
|
|
|
|
2019-09-21 22:11:26 +00:00
|
|
|
As of summer 2019, the code does not *require* additional features in order for it to serve the project's founder.
|
|
|
|
|
At the same time, there are plenty of bells and whistles, creature comforts, etc. that are desired and may be added.
|
2019-08-28 02:33:06 +00:00
|
|
|
Additionally, the code could use factoring or general re-working in several areas.
|
2019-08-30 02:45:48 +00:00
|
|
|
In fact, it may be nice to use the business logic as a library instead of running a full binary.
|
2019-08-28 02:33:06 +00:00
|
|
|
|
2019-09-21 22:11:26 +00:00
|
|
|
The software has been tested on Mac and Linux.
|
|
|
|
|
Additional testers/users are encouraged and welcome.
|
|
|
|
|
|
2019-08-25 23:57:07 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
* Contributors welcome. New authors should add themselves to the `AUTHORS` file.
|
|
|
|
|
|
2019-09-21 00:27:13 +00:00
|
|
|
* Roadmap and todos: we're working through items in [Issues](https://github.com/scoobybejesus/cryptools/issues); feel free to tackle or add issues.
|
2019-08-25 23:57:07 +00:00
|
|
|
|
2019-09-21 22:11:26 +00:00
|
|
|
## A few words from the founder
|
|
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
I have an accounting background, I live in the US, and I am interested in cryptocurrencies.
|
2019-09-21 22:11:26 +00:00
|
|
|
When it came time to file my tax return, I had to come to grips with recording my cryptocurrency activity.
|
2019-10-06 01:04:13 +00:00
|
|
|
I initially used a spreadsheet that manually processed the activity into lots, and it quickly became clear that I needed a software solution.
|
2019-09-21 22:11:26 +00:00
|
|
|
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).
|
|
|
|
|
|
2019-10-06 01:04:13 +00:00
|
|
|
I am not a formally trained programmer, however I have come to enjoy it very much and learn more whenever I can.
|
2019-09-21 22:11:26 +00:00
|
|
|
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.
|
|
|
|
|
We coded our way into a corner, but I had learned enough to take the code apart and put it back together correctly and complete it.
|
|
|
|
|
I really enjoyed Swift, but I wanted something even more performant (and cross-platform), and Rust seemed to fit the bill.
|
|
|
|
|
I rewrote the code in Rust (also with a bit of help from my mentor), and it has turned out to be a great choice.
|
|
|
|
|
|
2019-08-25 23:57:07 +00:00
|
|
|
## Legal
|
|
|
|
|
|
|
|
|
|
See LEGAL.txt
|
