search

vechain / x-app-template

Vechain VeBetterDAO X-App template
388 stars 367 forks source link

readme

Watch the Tutorial

Watch the video

X-App Template for VeBetterDAO 🚀

                                 #######
                            ################
                          ####################
                        ###########   #########
                       #########      #########
     #######          #########       #########
     #########       #########      ##########
      ##########     ########     ####################
       ##########   #########  #########################
         ################### ############################
          #################  ##########          ########
            ##############      ###              ########
             ############                       #########
               ##########                     ##########
                ########                    ###########
                  ###                    ############
                                     ##############
                               #################
                              ##############
                              #########

[!TIP] Impatient? Check out the QuickStart to instantly run the app template.

Unlock the potential of decentralized application development on Vechain with our X-App template for VeBetterDAO. Designed for the Vechain Thor blockchain, this template integrates cutting-edge technologies such as React, TypeScript, Hardhat, and Express, ensuring a seamless and efficient DApp development experience. 🌟

Read more about the implementation and key features of this template in our Developer Docs.

This template uses the VeBetterDAO ecosystem to distribute rewards to users. To learn more about VeBetterDAO, visit our documentation.

When using the solo node you can import the following mnemonic into your wallet and have access to 10 pre-funded accounts:

denial kitchen pet squirrel other broom bar gas better priority spoil cross

Requirements

Ensure your development environment is set up with the following:

Project Structure

Frontend (apps/frontend) 🌐

A blazing-fast React application powered by Vite:

Backend (apps/backend) 🔙

An Express server crafted with TypeScript for robust API development:

Contracts (apps/contracts) 📜

Smart contracts in Solidity, managed with Hardhat for deployment on the Vechain Thor network.

Packages 📦

Shared configurations and utility functions to unify and simplify your development process.

Environment Variables ⚙️

Configure your environment variables for seamless integration:

Backend

Store your environment-specific .env files in apps/backend. .env.development.local & .env.production.local allow for custom environment variables based on the environment:

Contracts

Manage deployment parameters and network configurations in hardhat.config.js under apps/contracts:

Getting Started 🏁

Clone the repository and install dependencies with ease:

yarn install # Run this at the root level of the project

Run locally

Deploy contracts

To start deploying contract locally you must run a local instance of the Vechain Thor blockchain. You can do this by running the following command:

yarn contracts:solo-up

This command will also start a local instance of the tools Insight (http://localhost:8080/) and Inspector (http://localhost:8081/).

At this point you can deploy the contracts to the local network by running:

yarn contracts:deploy:solo

Once the deployment is completed successfully you can go ahead and start the frontend and backend:

⚠️ Warning: Remember to set the OPENAI_API_KEY env variable in the backend .env.development.local file. Refer to the Environment Variables section for more information.

yarn dev

At this point you can access the frontend at http://localhost:8082/.

Start uploading a receipt!

Deploying on Testnet 🚀

To distribute rewards this contract needs of a valid APP_ID provided by VeBetterDAO when joining the ecosystem. In testnet you can generate the APP_ID by using the VeBetterDAO sandbox. This contract can be initially deployed without this information and DEFAULT_ADMIN_ROLE can update it later through {EcoEarn-setAppId}.

This contract must be set as a rewardDistributor inside the X2EarnApps contract to be able to send rewards to users and withdraw.

For deploying on Testnet you should check that you have the correct addresses in the config-contracts package (generated on the VeBetterDAO sandbox).

When deploying on the SOLO network the script will deploy for you the mocked VeBetterDAO contracts and generate an APP_ID.

Once everything is set up you can deploy the contracts to the testnet by running:

yarn contracts:deploy:testnet

Triggering Cycles and Setting the Rewards

The deployment scripts will configure the 1st cycle for you with a reward of 1000 tokens.

To start a new cycle and set the rewards you can follow the steps below:

Testnet

Read the VeBetterDAO documentation to learn how to set up rewards for your users and use the Testnet environment.

Test environment: https://dev.testnet.governance.vebetterdao.org/

TEST ENVIRONMENT DEMO

Thanks to the test environment you will be able to mint and deposit B3TR tokens int the rewards pool that you will use to distribute rewards to users.

Now you just need to trigger cycles and set amount of rewards per cycle on your EcoEarn contract.

  1. Go to our online inspector app that you can use to interact with your contracts. Be sure to select the correct network (Testnet).

  2. Add the EcoEarn contract to the inspector app. Get the address from config-contracts package and the ABI from the apps/contracts/artifacts/contracts/EcoEarn.sol/EcoEarn.json file. image

  3. Set how many rewards you want to distribute per cycle: image

  4. Trigger a cycle: image

Solo Network

Since the Solo network is a local network with mocked VeBetterDAO contracts you can use the following steps to set up available rewards to distribute to users:

  1. Ensure you are using a wallet with imported pre-funded accounts mnemonic into your wallet. Mnemonic:
denial kitchen pet squirrel other broom bar gas better priority spoil cross

  1. Copy the APP_ID generated by the contracts:deploy:solo script and logged in the console.

  2. Open the inspector app, running on localhost, that you can use to interact with your contracts.

  3. Open the Inspector tab and perform the following actions:

  4. Add the B3TR_Mock contract (get the address from the console logs and ABI from the apps/contracts/artifacts/contracts/mock/B3TR_Mock.sol/B3TR_Mock.json file) image

  5. Add the X2EarnRewardsPool contract (get the address from the console logs and ABI from the apps/contracts/artifacts/contracts/mock/X2EarnRewardsPoolMock.sol/X2EarnRewardsPoolMock.json file) image

  6. You should now have the following setup: image

  7. To recharge the rewards pool you will need to mint some mocked B3TR tokens, then deposit them into the rewards pool. Perform the following actions:

    • Mint some tokens by calling the mint function on the B3TR_Mock contract image
    • Approve the X2EarnRewards contract to spend the tokens by calling the approve function on the B3TR_Mock contract image
    • Deposit the tokens into the rewards pool by calling the deposit function on the X2EarnRewardsPool contract image

  8. Now you just need to set how many rewards you want to distribute per cycle and trigger the start of the cycle

NB: Values are in wei, use this tool to convert to VET: https://eth-converter.com/

Disclaimer ⚠️

This template serves as a foundational starting point and should be thoroughly reviewed and customized to suit your project’s specific requirements. Pay special attention to configurations, security settings, and environment variables to ensure a secure and efficient deployment.

Embrace the power of VeBetterDAO's X-Apps template and transform your DApp development experience. Happy coding! 😄