Skip to content

Commit 0758514

Browse files
committed
docs: update README
1 parent 54b9355 commit 0758514

3 files changed

Lines changed: 25 additions & 40 deletions

File tree

README.md

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -11,60 +11,41 @@ Drip Protocol is a smart contract system that enables users to create and manage
1111
- DripProfile: Handles user profiles and their associated data
1212
- DripVault: Manages token deposits and withdrawals
1313

14-
## Contract Addresses
15-
16-
Challenge: 0xaDcaAe61b8983940FB2c8098BDe112e507A0e1f0
17-
ChallengeManager: 0xB3084eF0Dc7440e32A6cD64e2E5072FBCd9AEEeE
18-
DripProfile: 0x0E69Ba1FF53c36D0fbb4fccC0e9B732D58593B2f
19-
20-
### Testnet (Goerli)
21-
22-
- Challenge: [Contract Address]
23-
- ChallengeManager: [Contract Address]
24-
- DripProfile: [Contract Address]
25-
- DripVault: [Contract Address]
26-
2714
## Architecture
2815

2916
The protocol consists of four main contracts:
3017

3118
1. **Challenge.sol**: Core contract for challenge creation and management
3219

33-
- Handles challenge parameters
20+
- Creates new challenges
3421
- Manages challenge states
35-
- Processes challenge completion
22+
- Retrieves challenges for a given epoch
3623

37-
2. **ChallengeManager.sol**: Orchestration layer for challenges
24+
2. **ChallengeManager.sol**: Orchestration layer for challenges management
3825

39-
- Creates new challenges
40-
- Manages challenge lifecycle
41-
- Handles challenge verification
26+
- Creates new epochs
27+
- Manages epoch lifecycle
28+
- Manages epoch rewards
4229

4330
3. **DripProfile.sol**: User profile management
4431

45-
- Stores user information
46-
- Tracks challenge participation
47-
- Manages user achievements
32+
- Creates new profiles
33+
- Manages profile data
34+
- Submits daily completions
4835

4936
4. **DripVault.sol**: Token management
50-
- Handles token deposits
51-
- Processes withdrawals
52-
- Manages challenge stakes
53-
54-
## Libraries
55-
56-
### TimeLib
37+
- Manages token deposits & withdrawals
5738

58-
Utility library for time-based calculations and validations used throughout the protocol.
59-
60-
### Types
61-
62-
Contains core data structures and custom types used across the protocol.
39+
## Contract Addresses
6340

64-
## Security
41+
Unified CREATE2 addresses:
6542

66-
This protocol has been designed with security in mind. However, it has not been audited yet. Use at your own risk.
43+
- Challenge: 0xaDcaAe61b8983940FB2c8098BDe112e507A0e1f0
44+
- ChallengeManager: 0xB3084eF0Dc7440e32A6cD64e2E5072FBCd9AEEeE
45+
- DripProfile: 0x0E69Ba1FF53c36D0fbb4fccC0e9B732D58593B2f
6746

68-
## License
47+
The contracts are deployed on the following networks:
6948

70-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
49+
- Base Sepolia
50+
- Mantle Sepolia
51+
- Polygon zkEVM Cardona

deploy.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
CONFIGS=(
55
"base-sepolia|https://base-sepolia.blockscout.com"
66
"mantle-sepolia|https://explorer.sepolia.mantle.xyz"
7+
"polygonzkevm-cardona|https://explorer-ui.cardona.zkevm-rpc.com"
78
)
89

910
# Function to display usage
@@ -41,7 +42,9 @@ deploy_to_chain() {
4142
--rpc-url "$rpc_url" \
4243
--verify \
4344
--verifier blockscout \
44-
--verifier-url "$verifier_url/api/"
45+
--verifier-url "$verifier_url/api/" \
46+
--sender 0x8D0B05b837FB0e28e78b8939dDaD8CE7B91b678D \
47+
--legacy
4548
}
4649

4750
# Validate the option number

foundry.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ libs = ["lib"]
77
[rpc_endpoints]
88
sepolia = "${RPC_SEPOLIA}"
99
base-sepolia = "${RPC_BASE_SEPOLIA}"
10-
mantle-sepolia = "${RPC_MANTLE_SEPOLIA}"
10+
mantle-sepolia = "${RPC_MANTLE_SEPOLIA}"
11+
polygonzkevm-cardona = "${RPC_POLYGONZKEVM_CARDONA}"

0 commit comments

Comments
 (0)