👩🏻💻 CLI based tool to fetch balances from all supported protocols from Zapper formatted to JSON and exported to CSV or Google Spreadsheet Node.js projects.
🏃🏽 Instant Value: All basic tools included and configured:
- TypeScript 4.5
- ESLint with some initial rules recommendation
- Jest for fast unit testing and code coverage
- Type definitions for Node.js and Jest
- Prettier to enforce consistent code style
- NPM scripts for common operations
- Simple example of TypeScript code and unit test
- .editorconfig for consistent file format
- Reproducible environments thanks to Volta
🤲 Free as in speech: available under the APLv2 license.
This project is intended to be used with the latest Active LTS release of Node.js.
To clone the repository, use the following commands:
git clone https://github.com/ankurdaharwal/crypto-portfolio-tracker
cd crypto-portfolio-tracker
yarn installcp .env.example .env
Enter the API keys and Spreadsheet ID (For Google Spreadsheet)
# Google Spreadsheet API and Sheet ID
GOOGLE_API=
SHEET_ID=
# ZAPPER API KEY
ZAPPER_API=
start- start the projectclean- remove coverage data, Jest cache and transpiled files,prebuild- lint source files and tests before building,build- transpile TypeScript to ES6,build:watch- interactive watch mode to automatically transpile source files,lint- lint source files and tests,test- run tests,test:watch- interactive watch mode to automatically re-run tests
yarn start -a <ETHEREUM ACCOUNT ADDRESS>- start the project
-
Prerequisite JQ formatter:
npm i -g jq -
Query Balances and Display JSON output
cd scripts
. ./zapper.sh -a<ETHEREUM ACCOUNT ADDRESS>
cat <ETHERUM ACCOUNT ADDRESS>.json | jq
Volta’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's used by engineers at LinkedIn to standardize tools and have reproducible development environments.
I recommend to install Volta and use it to manage your project's toolchain.
Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.
This is optional, but if you want to learn how to write JavaScript tests for TypeScript modules, read the corresponding wiki page.
Support this project by becoming a sponsor.
Licensed under the APLv2. See the LICENSE file for details.