Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prepare for migration to zcf atomicTransfer() #798

Open
Chris-Hibbert opened this issue May 4, 2023 · 2 comments · May be fixed by #1266
Open

prepare for migration to zcf atomicTransfer() #798

Chris-Hibbert opened this issue May 4, 2023 · 2 comments · May be fixed by #1266
Labels

Comments

@Chris-Hibbert
Copy link
Collaborator

@erights came up with a new approach to managing reallocation in contracts (6577) that we have been very happy with. We have been planning to migrate the temporary helper into ZCF (6679) and remove the old approach, but we neglected to warn the developers that this major change was coming.

We should, ASAP, prepare documentation on use of the atomicTransfer helper, and explain that it will be moved into ZCF shortly, but more importantly, we should add deprecation annotations to the existing incrementBy and decrementBy ZCF functions so our developers know what to expect.

Luckily, all our contracts are now written in the interim style, so anyone reading our code will see examples of the new approach.

@Chris-Hibbert
Copy link
Collaborator Author

zcfSeat.getStagedAllocation() and zcfSeat.hasStagedAllocation() should also be deprecated. They'll go away when we remove the old approach, and aren't needed while using the interim approach.

@Chris-Hibbert
Copy link
Collaborator Author

We did deprecate the methods at their declarations, so it's better than I said. Developers (at least those using IDEs) would have seen the deprecation warning if they tried to use the old methods.

It's still a problem that we haven't documented the new approach or updated the documentation to show the deprecation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants