diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1684be1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,42 @@ + + +# CHANGELOG + +An '!' indicates a CLI or schema breaking change. + +## UNRELEASED + +### Improvements +- [#24](https://github.com/KYVENetwork/kyve-dlt/pull/24) Add support for Comet38 `finalize_block_events` in tendermint_preprocessed schema. +- [#25](https://github.com/KYVENetwork/kyve-dlt/pull/25) Rename `tendermint` schema to `height`. + +### Features +- [#22](https://github.com/KYVENetwork/kyve-dlt/pull/22) Add support for ArTurbo Storage Provider. + + +## [v1.0.0](https://github.com/KYVENetwork/kyve-dlt/releases/tag/v1.0.0) - 2024-10-30 + +This is the initial release of the **KYVE Data-Load-Tool (DLT)**! This tool is designed for high-parallelized sync speeds, enabling efficient extraction of data from the KYVE data lake to a specified destination. The DLT supports both single sync operations and daemon mode, allowing for automated, cron-scheduled sync intervals. +Refer to the Readme.md for setup instructions, usage guidelines, and examples of how to configure syncs for different sources and destinations. + +### Features +- **High-Speed Parallelized Sync**: Maximizes data transfer efficiency. +- **Daemon Mode with Cron Scheduling**: Automate your data syncs on a customized schedule. +- **Flexible Destination Support**: Sync data from KYVE to your preferred storage solution. + +#### Supported Sources +- **KYVE Mainnet** +- **Kaon Testnet** +- **Korellia Devnet** + +#### Supported Destinations +- **BigQuery** +- **Postgres** + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d52587f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing + + +Thank you for considering to contribute to this project. KYVE DLT is a light-weight +tool for extracting data from the KYVE Datalake (https://www.kyve.network) and +loading it to a supported destination. + +## Overview + +- The latest state of development is on `main`. +- Releases can be found in `/release/*`. + +## Creating a Pull Request + +- Check out the latest state from main and always keep the PR in sync with main. +- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification). +- Only one feature per pull request. +- Write an entry for the Changelog. + +## Coding Guidelines + +- Write readable and maintainable code. `Premature Optimization Is the Root of All Evil`. + Concentrate on clean interfaces first and only optimize for performance if it is needed. +- The project is structured the following: + - `/cmd` is the entry point for the program. It contains all commands for the + CLI. + - `/destinations` handles the upload and insertion of data rows to a destination. + - `/loader` manages the entire process including the parallel processing. + - `/schema` contains the code for obtaining and extracting the data from the + bundle-format stored on KYVE. It also provides some information to the + destination on how to cluster or partition the data. + - `/utils` contains common functionality used across all modules. + +## Legal + +You agree that your contribution is licenced under the MIT Licence and all +ownership is handed over to the authors named in [LICENSE](https://github.com/KYVENetwork/chain/blob/main/LICENSE). \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72a5c1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022-2023 KYVE Foundation + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/.github/Readme.md b/README.md similarity index 100% rename from .github/Readme.md rename to README.md