forked from storyprotocol/protocol-periphery
-
Notifications
You must be signed in to change notification settings - Fork 39
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
Introduce Workflows and Group IPA Features #43
Merged
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
sebsadface
requested review from
kingster-will,
Ramarti,
leeren,
jdubpark,
Spablob,
LeoHChen and
AndyBoWu
as code owners
August 31, 2024 01:46
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good PR. couple comments.
kingster-will
approved these changes
Aug 31, 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.
Description
This PR initiates the process of breaking down the monolithic
StoryProtocolGateway
contract into smaller, specialized contracts, each responsible for a specific interaction stream with the core protocol. We refer to these contracts as "workflows." This restructuring aims to manage the growing functionalities of SPG while adhering to the size limits for a single contract.Additionally, this PR introduces a new
GroupingWorkflows
contract to support Group IPA features from protocol core (see PR#192). This contract allow the following operations in a single call:Key Changes
BaseWorkflow
contract to encapsulate shared variables, modifiers, and functions across different workflows.BaseWorkflow
and utilize the new internal library contracts.GroupingWorkflows
contract, inheriting fromBaseWorkflow
, to support Group IPA features.Test Plan
New tests have been added to cover the Group IPA features. All new and existing tests pass locally.
Related Issues
This PR closes #35 and #42.
Note
The current deploy and upgrade script does not yet include deployment or upgrade logic for the
GroupingWorkflows
contract. This will be addressed in a future PR.