Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Doge-is-Dope committed Nov 17, 2024
1 parent 0758514 commit c652220
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 27 deletions.
68 changes: 41 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,64 @@
# Drip Protocol
# Drip

A decentralized challenge and profile management system built on Ethereum.
A revolutionary decentralized incentive learning system built on-chain.

## Overview

Drip Protocol is a smart contract system that enables users to create and manage challenges, maintain profiles, and handle token vaults. The protocol consists of several key components:
Drip enables users to create and manage challenges, maintain user profiles, and handle tokenized vaults. The system is composed of several key components:

- Challenge: Manages individual challenges
- ChallengeManager: Orchestrates challenge creation and management
- DripProfile: Handles user profiles and their associated data
- DripVault: Manages token deposits and withdrawals
- DripProfile: An ERC-721 that governs user profiles and associated data.
- Challenge: An ERC-721 to manage individual challenges.
- ChallengeManager: Coordinates the creation and lifecycle management of challenges.
- DripVault: An ERC-4626-compliant vault that handles token deposits and withdrawals.

## How It Works

1. Initiate a Challenge:
- Learners can start a challenge within a predefined timeframe, choosing an amount to deposit as a commitment.
2. Receive a Progress-Tracking NFT:
- Upon creation, the learner is issued an NFT that records their challenge progress.
3. Daily Task Completion:
- Learners complete assigned tasks daily. Task progress is automatically updated and reflected in the NFT.
4. Challenge Outcome:
- For Successful Days: Learners retrieve their deposited amount corresponding to the days completed successfully.
- For Unsuccessful Days: The deposits for incomplete days are allocated to the reward pool to incentivize successful participants.
- Additional Rewards: Successful learners earn an additional reward from the share of the reward pool accumulated from the deposits of all incomplete days across participants.

## Architecture

The protocol consists of four main contracts:

1. **Challenge.sol**: Core contract for challenge creation and management
**Challenge.sol**: Foundational contract for challenge operations.

- Facilitates challenge creation.
- Manages the state of individual challenges.
- Retrieves challenges for a specific epoch.

- Creates new challenges
- Manages challenge states
- Retrieves challenges for a given epoch
**ChallengeManager.sol**: Orchestration layer for challenge lifecycles.

2. **ChallengeManager.sol**: Orchestration layer for challenges management
- Establishes new epochs.
- Manages the lifecycle of epochs.
- Oversees epoch rewards using the DripVault.

- Creates new epochs
- Manages epoch lifecycle
- Manages epoch rewards
**DripProfile.sol**: User profiles management and engagement.

3. **DripProfile.sol**: User profile management
- Enables profile creation.
- Maintains and updates profile data.
- Tracks and records daily completions.

- Creates new profiles
- Manages profile data
- Submits daily completions
**DripVault.sol**: Tokenized asset management of epoch rewards.

4. **DripVault.sol**: Token management
- Manages token deposits & withdrawals
- Facilitates deposits and withdrawals of tokens.

## Contract Addresses
## Deployed Contract Addresses

Unified CREATE2 addresses:
Unified CREATE2 addresses for multi-chain deployment:

- Challenge: 0xaDcaAe61b8983940FB2c8098BDe112e507A0e1f0
- ChallengeManager: 0xB3084eF0Dc7440e32A6cD64e2E5072FBCd9AEEeE
- DripProfile: 0x0E69Ba1FF53c36D0fbb4fccC0e9B732D58593B2f
- Challenge: `0xaDcaAe61b8983940FB2c8098BDe112e507A0e1f0`
- ChallengeManager: `0xB3084eF0Dc7440e32A6cD64e2E5072FBCd9AEEeE`
- DripProfile: `0x0E69Ba1FF53c36D0fbb4fccC0e9B732D58593B2f`

The contracts are deployed on the following networks:
The contracts are live on the following testnets:

- Base Sepolia
- Mantle Sepolia
Expand Down
Binary file added assets/reward_additional_rewards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reward_claimable_deposits.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reward_total.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c652220

Please sign in to comment.