Merge branch 'release/v0.0.2'

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to `cryptocredible` will be documented in this file
+
+## v0.0.2 - 2021-11-30
+- Update readme.
+
+## v0.0.1 - 2021-11-30
+- Initial beta release with Coinbase and Coinbase Pro exchange connections.

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

README.md

@@ -1 +1,114 @@
-coming soon
+# CryptoCredible
+#### The missing crypto-exchange data exporter
+
+###### _tldr: run locally to export your crypto tx data from popular exchanges via api connections._
+
+Ever tried to export your crypto transactions from an exchange only to find out there's missing data? 🙄<br>
+...or that the file format is completely different from every other exchange? 🙄<br>
+...or that they didn't account for the fees, so your tax is now too high? 🙄
+
+Well, this tool is for you...
+
+Install locally, and with a single command, CryptoCredible will safely and securely fetch **all** your transaction data, and output a csv file with nothing missing, in a single standard format.
+
+What's better is the output is designed to work perfectly with the amazing open source tax software [BittyTax](https://github.com/BittyTax/BittyTax).
+
+#### Supported exchanges
+* [Coinbase](https://github.com/leeovery/cryptocredible/tree/develop#coinbase)
+* [Coinbase Pro](https://github.com/leeovery/cryptocredible/tree/develop#coinbase-pro)
+* _...with more coming soon!_
+
+## Installation
+
+To run CryptoCredible you will first need to install php locally on your system. 
+
+#### Apple
+For Mac users this is easy. 
+
+Install HomeBrew using their instructions [here](https://brew.sh/), then install php by entering this command into a Terminal window:
+
+```bash
+brew install php
+```
+
+#### Windows
+Windows is a little more complex. 
+
+A standalone phar file will be supported soon, but for  now, you could use [Docker](https://docs.docker.com/desktop/windows/install/) or [WSL2](https://www.sitepoint.com/wsl2/).
+
+## Usage
+
+First you need to configure your api connections with your crypto exchange(s) - see below. 
+
+Once that's done, open up a terminal window and run the command suitable for your exchange(s):
+
+#### Coinbase 
+
+Login into your [Coinbase](https://www.coinbase.com/settings/api) account to create new api credentials, selecting all the permissions with `:read` in them. Paste the credentials into the `.env` file at the root of the project directory using the following structure:
+
+```bash
+COINBASE_API_KEY=[api key here]
+COINBASE_API_SECRET=[api secret here]
+```
+
+Then run this command in a terminal window from the root directory of this project:
+
+``` php
+php cryptocredible sync:coinbase
+```
+
+#### Coinbase Pro
+
+Login into your [Coinbase Pro](https://pro.coinbase.com/profile/api) account and create new **view** api credentials. Paste them into the `.env` file at the root of the project directory:
+
+```bash
+COINBASE_PRO_API_KEY=[api secret here]
+COINBASE_PRO_API_SECRET=[api secret here]
+COINBASE_PRO_API_PASSPHRASE=[api passphrase here]
+```
+
+Then run this command in a terminal window from the root directory of this project:
+
+``` php
+php cryptocredible sync:coinbase-pro
+```
+
+### Options
+
+Each command accepts the follow options:
+
+| Argument | Shortcut | Description | default |
+|---|---|---|---|
+| --output-dir | -o | Provide a dir on local file system to output csv to | ./../ |
+| --json | -j | Provide a json file rather than fetch txs via api. | n/a |
+| --dump | n/a | Dump all the transactions fetched via the api into a json file. | n/a |
+
+### Is it safe?
+
+Yes, but you are using it without warranty, and at your own risk. Having said that, here are some strong points which make this safe: 
+* It runs locally on your own computer, and you have total control over the data and even the code.
+* The exchange connections are configured via the `.env` file using **read-only** api credentials. These credentials never leave your system in a usable format.
+* The code is open-source, so feel free to poke around and ensure it's safe. Other people have probably poked around too. Safety in numbers. 
+
+_Trust but verify._
+
+### Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Credits
+
+- [Lee Overy](https://github.com/leeovery)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

app/ValueObjects/Transaction.php

@@ -68,21 +68,21 @@ public function setType(TransactionType $type): static
         return $this;
     }
 
-    public function setSellAmount(Amount $sellAmount): static
+    public function setSellAmount(?Amount $sellAmount): static
     {
         $this->sellAmount = $sellAmount;
 
         return $this;
     }
 
-    public function setBuyAmount(Amount $buyAmount): static
+    public function setBuyAmount(?Amount $buyAmount): static
     {
         $this->buyAmount = $buyAmount;
 
         return $this;
     }
 
-    public function setFee($fee): static
+    public function setFee(?Amount $fee): static
     {
         $this->fee = $fee;