Git Product home page Git Product logo

chaingers-2021 / hodltogether-docs Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 227 KB

HodlTogether is an Innovative Defi+NFT Project that allows users to Hodl their tokens, donate some amount to NGOs and gain rewards! Winner of Runner-up position at Chainlink Hackathon Spring 2021

License: MIT License

aave chainlink the-graph hodl ipfs pools ethereum social-impact nft erc1155 truffle web3 reactjs defi chainlink-oracle

hodltogether-docs's Introduction

Build Status Website https://hodltogether.on.fleek.co/ PyPI license

Welcome to the COOLEST Defi+NFT Hodling Pool!


Introduction

We introduce you to the coolest community hodling pool on Ethereum- HodlTogether, which is a spicy amalgamation of the Defi, NFTs and NGOs. HodlTogether uniquely incentivizes the users to Hodl their tokens which can be of any type such as LINK, ZRX, BAT, SRX, etc. for a long period of time. By doing so, they also contribute to the betterment of society and community development, as they donate a certain amount of their Hodled tokens to the NGO associated with the Hodling pool.

Aim of the Project

The ongoing pandemic has certainly tested our resolve but it has also presented to us the world of cryptocurrencies. Number of people holding cryptocurrencies and digital assets has risen exponentially and the crypto community has benefitted from this rise as more of them want to explore the possibilities in this space.

Many amateur traders who just started exploring this space buy tokens and sell it as soon as there is a small rise in the prices as there always remains this fear that the market may crash anytime (emotional trading). Due to this, they lose the opportunity to truly gain from holding their tokens long term. Also, the tokens sit idle in their wallets which can actually be put to better use when invested in different protocols and projects.

Our platform allows creation of pools by anyone wherein they can hold their tokens until a target price is reached (this is determined beforehand by the pool creator). Their idle assets collect interest using the Aave protocol. A portion of their earnings is given to NGOs or charities vetted by the community or developers. The hodlers are rewarded with exciting NFTs created by these non-profit organisations.

Incentivisation Method

When a person joins a pool, they are expected to hold their tokens until the target price of the pool is achieved. If they wish to withdraw their tokens before the target price is achieved, they can do so but a percentage of their withdrawal amount is given to the pool members and the NGOs. Upon achieving the target price of the pool, there is no withdrawal fee and the amount returned includes the interest accrued in Aave protocol. The hodlers are also eligible to receive NFTs created by partner NGOs. Distribution of NFTs can be done on a lottery basis or by leaderboard rankings. This simple theory discourages emotional trading and makes hodling exciting and rewarding.

Pools

Each pool consists of a token type and a target price. Ex: A pool for LINK token or a pool for BAT token. There are two types of a pool:

  1. Public pools

These types of pools are created by the developers and the target price is set ideally as the all time high value of the token that pool represents. If the mood around the token price is bearish then developers can choose to set the price lower than the ATH as necessary. There is no barrier to entry in these types of pools. A Unique thing about HodlTogether's Public pools is that it also awards NFTs to the top 5 Hodlers of each Public pool. These NFTs are of ERC-1155 standard and are different for each type of token.

  1. Private pools

These types of pools can be created by anyone and the target price can be set as desired beforehand. These pools can be made for any type of token that the user desires. To participate/join in these pools, one needs to have a private key/invitation which is only known to the pool creator. This key isn’t stored anywhere and is shown only once after the creation of the pool. This private key is only required once for verification purposes but otherwise, deposition and withdrawal of tokens can be done without this key.

During deposition, each user is charged a minimal amount of fee equivalent to 1% of the total deposition amount. This fee amount is distributed equally amongst the NGOs that are associated with the platform. A user can withdraw his/her tokens from these pools anytime, but he will need to pay a 5% withdrawal fee that will be distributed among the NGOs and the pool members. A user can avoid this withdrawal fee entirely if he/she chooses to hodl his/her tokens in the pool until the pool breaks (target price is achieved) automatically. Thus, the users are incentivized to deposit and hodl their tokens together.

So, the private pools gives the users the ability to create a personal pool which they can share only with the people whom they want to invite. But unlike public pools, the private pools do not have the ERC-1155 token rewards for the top hodlers of the pool.

When does the pool break?

The public pools break i.e. get closed when the token in the pool reaches its all time high or when it reaches its week's highest price. In case of private pools, the creator of the pool himself sets the price point of when the pool should break. So he needs to be careful in choosing the right price when he thinks the pool should break as setting this value too high can result in the pools never breaking. The token rewards are freely distributed amongst the participants without any withdrawal fee only after the pools breaks.

Repositories

Here are the github repo links for front-end and smart contracts of our project.

Demo Video

hodltogether-docs's People

Contributors

anupam-io avatar rashtrakoff avatar shanzson avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.