# сryptocurrency_parser

- crate: https://crates.io/crates/cryptocurrency_parser
- docs:

## Description
This project implements a parser that parses data of different types of cryptocurrencies, such as ETH, SOL, BTC etc.

## Technical description
The parser reades structured data from a file using grammar rules and then outputs parsed result to a json file.

## Grammar rules

- digit: Matches any single ASCII digit (0-9)
- year: Matches a four-digit year by concatenating four digit rules (e.g., 2024)
- month:  Matches a 2-digit month, e.g., "05" for May.
- day: Matches a two-digit day (e.g., 01, 23).
- date: Matches various date formats, e.g.,  08.11.2024, 11/08/2024
- blockchain_name: Matches specific blockchain names: SOL, BTC, or ETH. This ensures only these blockchain names are parsed as valid
- currency: Matches specific currency codes: USD, EUR, or UAH
- number: Matches a numeric value, potentially with thousands separators (e.g., 1,000,000) and optional decimal places (e.g., 123.45)
- number_and_currency: Matches a number followed by a currency
- entry: Matches a complete entry for a blockchain record, which includes: name, date, open, close, high, low, and volume fields
- name: Matches a line that includes the blockchain name (BTC, SOL, ETH)
- date_entry: Matches a line containing the date
- open: Matches the opening price line 
- close:  Matches the closing price line
- high: Matches the high price
- low: Matches the low price 
- volume: Matches the volume line. This represents the value of tokens traded over the last 24 hours

```pest
WHITESPACE = _{ " " | "\t" | "\n" }
digit = _{ ASCII_DIGIT }

year = { digit ~ digit ~ digit ~ digit }
month = { digit ~ digit }
day = { digit ~ digit }

date = @{ (day ~ "." ~ month ~ "." ~ year) | (month ~ "/" ~ day ~ "/" ~ year) }
blockchain_name = @{ "SOL" | "BTC" | "ETH" }
currency = @{ "USD" | "EUR" | "UAH" }
number = @{ ASCII_DIGIT+ ~ ("," ~ ASCII_DIGIT{3})* ~ ("." ~ ASCII_DIGIT+)? }
number_and_currency = @{number ~ WHITESPACE ~ currency}

entry = ${name ~ WHITESPACE ~ date_entry ~ WHITESPACE ~ open ~ WHITESPACE ~ close ~ WHITESPACE ~ high ~ WHITESPACE ~ low ~ WHITESPACE ~ volume}
name = ${ "Name:" ~ WHITESPACE ~ blockchain_name ~ ";"}
date_entry = ${ "Date:" ~ WHITESPACE ~ date ~ ";"}
open = ${ "Open:" ~ WHITESPACE ~ number_and_currency ~ ";"}
close = ${ "Close:" ~ WHITESPACE ~ number_and_currency ~ ";"}
high = ${ "High:" ~ WHITESPACE ~ number_and_currency ~ ";"}
low = ${ "Low:" ~ WHITESPACE ~ number_and_currency ~ ";"}
volume = ${ "Volume:" ~ WHITESPACE ~ number_and_currency ~ ";"}
```

## CLI commands

- parse <input_file> <output_file>:

This command reads data from the input file, parses it, and saves the results in the specified output file in JSON format.
It takes two arguments:
<input_file> — the path to the input file containing data to parse (e.g., data.txt).
<output_file> — the path to the output JSON file where the parsed results will be saved (e.g., output.json).

- help

Displays helpful information on how to use the program and the available commands.
It describes the input format required for the parse command and provides an example of the data structure that can be parsed.

- credits

Shows information about the project`s name and author of the program.

## Applying
This parser can be used in applications related to blockchain and financial data processing

- The parser can be used to extract structured data from text files or logs that record blockchain or cryptocurrency market data. This is useful for preparing datasets for further analysis or storage in databases

- The parser can be used to read historical blockchain data from files and convert it into a structured format, such as CSV. Analysts can then use this data to identify trends, patterns, or perform time-series analysis

- This parser can be utilized in applications that help manage cryptocurrency portfolios by parsing data that includes market metrics like open, close, high, and low prices, and volumes for specific dates