Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 2.43 KB

readme.md

File metadata and controls

93 lines (59 loc) · 2.43 KB

Parraton Restaker

Parraton is a decentralized, permission-less, open-source yield optimization protocol on TON blockchain. Visit parraton.org for more information.

Parraton consists of these components:

Contract: The smart contract code that is running on-chain.

Webapp: The web application that helps users with deposits and withdrawals.

Restaker: The off-chain bot that restakes rewards to generate more yield for depositors. The code is available here on this repository.

Table of Contents

Overview

Parraton Bot handles the automation of reward distributions and other operational tasks for the Parraton platform. It integrates with several services, including DeDust and the TON blockchain, to perform its functions.

Getting Started

Prerequisites

Ensure you have the following installed on your local development machine:

  • Node.js (>= 14.0.0)
  • pnpm (>= 6.0.0)

Installation

  1. Clone the repository:

    git clone https://github.com/parraton/parraton-bot.git

  2. Navigate to the project directory:

    cd parraton-bot

  3. Install the dependencies:

    pnpm install

Configuration

  1. Create a .env file in the root directory of the project.
  2. Add the necessary environment variables to the .env file. Refer to the .env.example file for the required variables.

Running the Bot

To start the bot, run:

pnpm start

Scripts

  • start: Runs the bot using ts-node.

Dependencies

Parraton Bot uses a variety of dependencies to integrate with DeDust, TON blockchain, and other services. Key dependencies include:

  • DeDust SDK
  • TON blockchain libraries
  • Pinata SDK for IPFS
  • Node-cron for task scheduling
  • TypeScript for type safety

Contributing

Contributions are welcome! Please follow the established code style and conventions. For major changes, open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT license.

See LICENSE for more information.