refactor: Launchpad Architecture Refactoring #451
Conversation
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
notJoon
changed the title
dongwon8247
reviewed
Jan 5, 2025
| return totalAmount, nil | ||
| } | ||
|
|
||
| func CollectDepositGns() uint64 { |
There was a problem hiding this comment.
Don't we need to check if the launchpad program is finished or not?
Deposited GNS is only claimable when the longest tier in a launchpad program is finished. (project token rewards are always claimable regardless of this)
There was a problem hiding this comment.
It seems that condition checks has been removed in somewhere in the commits. But I can't find where it was.
launchpad/deposit.gno
Outdated
Comment on lines
539
to
541
| // Deprecated: use satisfyDepositConditions instead | ||
| func checkDepositConditions(project Project) { | ||
| if project.conditions == nil { | ||
| return | ||
| } | ||
|
|
||
| caller := std.PrevRealm().Addr() | ||
| for _, condition := range project.conditions { | ||
| if condition.minAmount == 0 { | ||
| continue | ||
| } | ||
|
|
||
| // check balance | ||
| var balance uint64 | ||
| if condition.tokenPath == consts.GOV_XGNS_PATH { | ||
| balance = xgns.BalanceOf(a2u(caller)) | ||
| } else { | ||
| balance = common.BalanceOf(condition.tokenPath, caller) | ||
| } | ||
| if balance < condition.minAmount { | ||
| panic(addDetailToError( | ||
| errNotEnoughBalance, | ||
| ufmt.Sprintf("insufficient balance(%d) for token(%s)", balance, condition.tokenPath), | ||
| )) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Deprecated: use isProjectActive instead | ||
| func checkProjectActive(project Project) bool { | ||
| if project.started.height > uint64(std.GetHeight()) { | ||
| // not started yet | ||
| return false | ||
| } | ||
|
|
||
| if project.ended.height < uint64(std.GetHeight()) { | ||
| // already ended | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| // Deprecated: use isTierActive instead | ||
| func checkTierActive(project Project, tier Tier) bool { | ||
| if tier.ended.height < uint64(std.GetHeight()) { | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } |
There was a problem hiding this comment.
r3v4s
reviewed
Jan 6, 2025
Comment on lines
+18
to
+28
| // depositId -> deposit | ||
| deposits = make(map[string]Deposit) | ||
|
|
||
| // proejct -> tier -> []depositId | ||
| depositsByProject = make(map[string]map[string][]string) | ||
|
|
||
| // user -> []depositId | ||
| depositsByUser = make(map[std.Address][]string) | ||
|
|
||
| // user -> project -> []depositId | ||
| depositsByUserByProject = make(map[std.Address]map[string][]string) |
There was a problem hiding this comment.
The launchpad's map type wasn't modified to AVL since the values used inside the existing map type are primitive types. (This answer applies to all similar comments below)
There was a problem hiding this comment.
@onlyhyde Are we keeping primitive maps?
r3v4s
reviewed
Jan 6, 2025
Comment on lines
+33
to
+36
| Deposits map[string]Deposit | ||
| DepositsByProject map[string]map[string][]string | ||
| DepositsByUser map[std.Address][]string | ||
| DepositsByUserProject map[std.Address]map[string][]string |
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
| @@ -30,7 +30,7 @@ func TestCreateProjectSingleRecipient(t *testing.T) { | |||
| testCreateProject(t) | |||
| testMockProtocolFee(t) | |||
| testDepositGnsToTier30(t) | |||
| testCollectProtocolFee(t) | |||
| // testCollectProtocolFee(t) | |||
r3v4s
reviewed
Jan 6, 2025
r3v4s
previously approved these changes
Jan 6, 2025
r3v4s
reviewed
Jan 6, 2025
There was a problem hiding this comment.
Left few comments.
- FYI, I'm aware of feat: add reward cacheing logic to launchpad and governance #455 going on.
- If there are plan to fix things in feat: add reward cacheing logic to launchpad and governance #455, reply it in conversation please.
onlyhyde
force-pushed
the
refactor-launchpad
branch
from
189add5 to
5504b2e
Compare
|
r3v4s
reviewed
Jan 10, 2025
| ) | ||
|
|
||
| func currentBalance() uint64 { | ||
| func getCurrentBalance() uint64 { | ||
| // TODO: implement this after checking gns distribution is working |
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
| } | ||
|
|
||
| /// XXXX |
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
| if currentHeight > self.EndHeight { | ||
| currentHeight = self.EndHeight | ||
| } | ||
|
|
||
| // ????? height 차이에 의한 오차 고 |
r3v4s
reviewed
Jan 10, 2025
| return u256.Zero().Rsh(self.PriceAccumulation, 128).Uint64() | ||
| } | ||
|
|
||
|
|
||
| // amount MUST be less than or equal to the amount of xGNS staked | ||
| // This function does not check it |
There was a problem hiding this comment.
if this function doesn't check, then which function verify it??
r3v4s
reviewed
Jan 10, 2025
r3v4s
reviewed
Jan 10, 2025
| @@ -32,11 +33,27 @@ func currentBalance() uint64 { | |||
| return currentGNSBalance | |||
| } | |||
|
|
|||
| func getCurrentProtocolFeeBalance() map[string]uint64 { | |||
| gotAccuProtocolFee := pf.GetAccuTransferToGovStaker() | |||
There was a problem hiding this comment.
maybe missing pf.DistributeProtocolFee() ??
or remove this function and uncomment L#23
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a comprehensive refactoring of the Launchpad contract architecture, focusing on optimizing reward calculations and improving data structure efficiency. The main goals are to reduce computational overhead, enhance gas efficiency, and improve the overall maintainability of the codebase.
Key Changes
Architectural Improvements
ProjectInput,ProjectTierInfo,DepositState)Code Structure
Major Refactored Components
Project Management (
launchpad_init.gno->launchpad.gno)validateProjectInputcreateTierReward Handling (
launchpad_reward.gno->reward.gno)Deposit Management (
launchpad_deposit.gno)DepositStatefor better state managementvalidateDepositCollection)Simplified and More Organized Types
TimeInfo: Consolidated height and timestamp pairsProjectStats: Grouped project statistics fieldsRefundInfo: Consolidated refund-related fieldsProject Structure Improvements
Projectstruct for better maintainability:map[uint64]Tier)tiersRatiosmap for cleaner ratio managementTimeInfoProjectStatsRefundInfoBenefits of New Structure
Memory Optimization
Performance Considerations
Future Improvements