Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pat-s/ppcryptoparser

Crypto currency staking rewards parser for Portfolio Performance
https://github.com/pat-s/ppcryptoparser

cardano cryptocurrency kusama parser polkadot portfolio-performance

Last synced: about 4 hours ago
JSON representation

Crypto currency staking rewards parser for Portfolio Performance

Host: GitHub
URL: https://github.com/pat-s/ppcryptoparser
Owner: pat-s
License: other
Created: 2021-10-03T05:48:23.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2021-12-07T08:58:46.000Z (about 3 years ago)
Last Synced: 2024-11-05T02:42:37.385Z (about 2 months ago)
Topics: cardano, cryptocurrency, kusama, parser, polkadot, portfolio-performance
Language: R
Homepage: https://pat-s.github.io/ppcryptoparser
Size: 626 KB
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
# ppcryptoparser

[![CRAN status](https://www.r-pkg.org/badges/version/ppcryptoparser)](https://CRAN.R-project.org/package=ppcryptoparser)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![R-CMD-check](https://github.com/pat-s/ppcryptoparser/workflows/R-CMD-check/badge.svg)](https://github.com/pat-s/ppcryptoparser/actions)



The goal of {ppcryptoparser} is to simplify the import of staking reward from various altcoins into [Portfolio Performance](https://www.portfolio-performance.info/).

## Installation

You need a working installation of [R](https://www.r-project.org/).

Windows: `scoop install r` or [download from CRAN](https://cran.r-project.org/).

macOS: `brew install --cask r` or [download from CRAN](https://cran.r-project.org/).

Ubuntu: `apt install r-base`

You can then install `ppcryptoparser` from GitHub with:

``` r

install.packages("remotes")

remotes::install_github("pat-s/ppcryptoparser")

```

## Example

Spin up an R session by calling "R" in a terminal and then run

```r

library("ppcryptoparser")

parse_polkadot(
, )

```

Please also consult the help files for each function, either on the command line via `?` or by looking at the [pkgdown](https://pat-s.github.io/ppcryptoparser) page of this package.

## Supported Coins

- Cardano (ADA)

- Polkadot (DOT)

- Kusama (KSM)

- Solana (SOL) - [API Key needed!](#solana)

## Planned Support

- Terra (LUNA)

- Polygon (MATIC)

## Language & Currency

The default language is set to (US) English (`"EN"`).

The language setting should match the language used in Portfolio Performance.

## Viewing statistics in Portfolio Performance

Staking statistics for inbound deliveries can be viewed under "Payments -> Savings" (German: "Zahlungen -> Ersparnisse").

To only see the staking rewards in this menu, **you need to book the staking rewards to a dedicated depot which only contains the staking rewards**.

Then you can select this depot via the filter option.

Otherwise, when selecting your complete portfolio, also buy actions will be included in this overview and blur the statistics.

## Encoding & Windows

I've seen that on Windows machines, the encoding might be set to something else than "UTF-8", causing issues in the processing.

Also Windows seems to set the decimal separator to `.` instead of `,`, which causes a wrong import of the data.

In this case, edit the resulting `.csv` file and change the decimal separators from `,` to `.` and check whether the import is working as intended.

I might add an argument to the functions to account for this within the R package.

## CSV Import

When importing, ensure to choose the type "Depotumsätze" / "Portfolio Transactions":

![Screenshot showing how to import CSV](man/figures/readme-1.png)

## Coin-specific Infos

### Kusama

Kusama pays out rewards every six hours.

`parse_kusama()` comes with an argument `"by_day" which aggregates rewards by day.

### Solana

Solana data is queried from https://solanabeach.io which requires an API key.

Instructions how to ask for an API key can be found [on their GitHub README](https://github.com/solana-beach/api).

Solana staking account cannot be topped up, hence often more than one staking account exists.

`parse_solana()` is able to account for this by merging the rewards from multiple addresses.

To do so, one needs to pass the addresses as a vector like this 

```r

parse_solana(c("", ""), by_day = TRUE)

```