-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
05528e2
commit 42fdf5c
Showing
1 changed file
with
83 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# VeBetterDAO Smart Contracts Repository π | ||
|
||
####### | ||
################ | ||
#################### | ||
########### ######### | ||
######### ######### | ||
####### ######### ######### | ||
######### ######### ########## | ||
########## ######## #################### | ||
########## ######### ######################### | ||
################### ############################ | ||
################# ########## ######## | ||
############## ### ######## | ||
############ ######### | ||
########## ########## | ||
######## ########### | ||
### ############ | ||
############## | ||
################# | ||
############## | ||
######### | ||
|
||
Welcome to the VeBetterDAO Smart Contracts repository! This open-source repository houses the smart contracts powering the decentralized VeBetterDAO on the Vechain Thor blockchain. Dive into a world of transparent and auditable governance mechanisms, leveraging Solidity, Hardhat, and more to ensure robust decentralized operations. | ||
|
||
## Requirements | ||
|
||
Before contributing or deploying, ensure your environment meets the following specifications: | ||
|
||
- **Node.js (v20 or later):** [Download Node.js](https://nodejs.org/en/download/package-manager) π₯ | ||
- **Docker:** [Install Docker](https://docs.docker.com/get-docker/) for running isolated contract environments π³ | ||
- **Hardhat:** Essential for smart contract compilation and deployment. [Start with Hardhat](https://hardhat.org/getting-started/) βοΈ | ||
|
||
## Repository Structure | ||
|
||
### Contracts (contracts/) π | ||
|
||
Core smart contracts written in Solidity. Managed with Hardhat, these contracts are ready for deployment on the Vechain Thor blockchain. | ||
|
||
### Artifacts (artifacts/) πΊ | ||
|
||
Automatically generated contract artifacts post-compilation. Contains ABI and contract bytecode. | ||
|
||
### TypeChain Types (typechain-types/) π | ||
|
||
TypeScript typings for smart contracts, generated to enhance developer experience by providing strong typing for contract interactions. | ||
|
||
## Environment Setup βοΈ | ||
|
||
Set up your environment to integrate smoothly with the blockchain: | ||
|
||
- **MNEMONIC:** Store the mnemonic for the deploying wallet in a `.env` file at the root to maintain security and ease of use. | ||
|
||
## Getting Started π | ||
|
||
Clone the repository and install dependencies with ease: | ||
```bash | ||
yarn install # Run this at the root level of the project | ||
``` | ||
|
||
## Compilation and Testing π οΈ | ||
|
||
Compile contracts and generate necessary artifacts and types: | ||
|
||
```bash | ||
yarn compile | ||
``` | ||
|
||
### Testing on Hardhat Network | ||
|
||
```bash | ||
yarn test:hardhat | ||
``` | ||
|
||
### Testing on Thor Solo Network | ||
|
||
```bash | ||
yarn test:thor-solo | ||
``` | ||
|
||
# Disclaimer | ||
|
||
This repository is for educational and demonstration purposes. Please review and test the code thoroughly before using it in a production environment. The maintainers are not liable for any misuse or faults within the code. |