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

Updated README.

This commit is contained in:
scoobybejesus 2019-08-27 22:33:06 -04:00
parent b73552057d
commit 2f9b41e7e1
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,8 +3,9 @@
### Accounting library for cryptocurrency transaction activity. ### Accounting library for cryptocurrency transaction activity.
The software provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used). The software provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used).
Given a CSV file reflecting the user's entire cryptocurrency transaction history, the software will process that activity in a way that assigns cost basis at the date of purchase/exchange/receipt, preserves the character (date purchased and cost basis, most notably) of all holdings up until the time they are disposed, and when holdings are disposed the gain or loss from sale/exchange/disposal will be computed (including whether the gain or loss is short-term or long-term).
Reports that reflect income/expense/gains/losses may be exported as CSV files, and the user can supply the desired relative or absolute path for where the reports are saved. Given a CSV file reflecting the user's entire cryptocurrency transaction history, the software will assign cost basis at the date of purchase/exchange/receipt, preserve the character (date purchased and cost basis, most notably) of all holdings up until the time they are disposed, and when holdings are disposed the gain or loss from sale/exchange/disposal will be computed (including whether the gain or loss is short-term or long-term).
Reports that reflect income/expenses/gains/losses may be exported as CSV files, and the user can supply the desired relative or absolute path for where the reports are saved.
The activity that gets imported **must** be in a prescribed form (a CSV file) that effectively looks like this: The activity that gets imported **must** be in a prescribed form (a CSV file) that effectively looks like this:
@ -33,10 +34,10 @@ The activity that gets imported **must** be in a prescribed form (a CSV file) th
* **txDate** is currently set to parse dates of the format MM/dd/YY. * **txDate** is currently set to parse dates of the format MM/dd/YY.
* **proceeds** may seem tricky. * **proceeds** This is the value transferred in the transaction.
The way to understand it, since it can apply to any transaction (aside from transfers from one owned-account to another owned-account), is that this is the value transferred in the transaction. For example, if one spends 0.01 BTC at a time when BTC/USD is $10,000/BTC, then the user received value of $100, therefore the proceeds of that transaction would be $100.
For example, if one spends 0.01 BTC for an item at a time when BTC/USD is $10,000/BTC, then the user received value of $100, therefore the proceeds of that transaction would be $100. When transfering to oneself (i.e., not changing currencies), this value is irrelevant and ignored.
This field is ignored when the user's home currency is used to purchase cryptocurrency. This value is also ignored when the user's home currency is spent.
* **memo** is useful for evaluating the final output but isn't important. * **memo** is useful for evaluating the final output but isn't important.
Currently, commas in the memo are **not** supported. Currently, commas in the memo are **not** supported.
@ -57,6 +58,9 @@ The quote account is the market.
The quote account's ticker requires a different formatting. The quote account's ticker requires a different formatting.
For example, when using BTC to long XMR, the BTC account must be reflected with the ticker BTC_xmr. For example, when using BTC to long XMR, the BTC account must be reflected with the ticker BTC_xmr.
* Margin gain or loss is accounted for when there is activity in the 'spot' account.
For example, you won't reflect a loss until you actually spend your holdings to pay off your loans.
#### Constraints #### Constraints
* *All* cryptocurrency-related activity for the user generally must be included in the input CSV file. * *All* cryptocurrency-related activity for the user generally must be included in the input CSV file.
@ -76,6 +80,12 @@ This will build `./target/debug/cryptools-rs`.
Run `./target/debug/cryptools-rs` with no arguments (or `--help`, or `-h`) to see usage. Run `./target/debug/cryptools-rs` with no arguments (or `--help`, or `-h`) to see usage.
Alternatively, run `cargo run`, in which case command-line arguments for `cryptools-rs` may be entered following `--`, e.g., `cargo run -- -h`. Alternatively, run `cargo run`, in which case command-line arguments for `cryptools-rs` may be entered following `--`, e.g., `cargo run -- -h`.
## Development state
As of summer 2019, the code is "feature complete" in the sense that it requires no additional features in order for it to serve the needs of the original author.
At the same time, there are plenty of bells and whistles, creature comforts, etc. that may be added at any time.
Additionally, the code could use factoring or general re-working in several areas.
## Contributing ## Contributing
* Contributors welcome. New authors should add themselves to the `AUTHORS` file. * Contributors welcome. New authors should add themselves to the `AUTHORS` file.