chore: pre-release candidate v0.0.1 #10
Merged
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
note: see #5 to watch it fail
- deprecates the CLI, not needed and adds maintenance efforts
- deprecates the changing of ownership of a vest / lockup (not needed and causes edge-cases) - also erases related JS codebase to call it
The original codebase corresponds to a Vesting Contract between A and B, in which A gives tokens to B in a scheduled way. The intended behaviour of this proposal is for A to lock tokens, that only A can withdraw. Following that intended behaviour, we deprecate the concept of "destination" from every call (as it will be same as the source).
The original codebase https://github.com/Bonfida/token-vesting supports an array of Dates to define a Vesting Contract. In that way, it can say: "unlock 10 at May 10, 10 at May 20, ..." and so on. The intended behaviour is to have only 1 Date per vesting / lockup, this PR replaces the Schedules<> array for a single Schedule, and deprecates the variable `number_of_schedules`
The underlying codebase requires the user to decide at lockup the Date of withdrawal. The intended behaviour, is that the user can decide to lock the tokens in an "unlocked with withdrawal period" mode, in which it would require the user to first "initiate the withdrawal", to be able to actually withdraw the tokens (e.g.) 7 days later. This is achieved by: - reverting on withdrawal when locking Date is 0 - adding a new method, identical in arguments to "unlock", that would revert if Date != 0 - when user calls this method, the locking Date should be `now() + 7 days`
Only a set of possible time-deltas should be allowed (e.g.) 0 (for unlocked with withdrawal period), 1 month, 3 months, and so on... The locking method should revert if the user tries to lock for a different amount of time. This PR replaces the concept of Dates when creating a lockup, since the user will be inputting a TimeDelta, and internally we should calculate the Date, to keep the same infra as it was.
wei3erHase
changed the title
0xGorilla
approved these changes
Oct 1, 2024
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.
No description provided.