-
Notifications
You must be signed in to change notification settings - Fork 0
feat: graph middleware not dependant on SCS and IPFS anymore #109
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
Conversation
ENG-1989 Update graph middleware docs
It doesn't need a smart contract set or storage anymore, update docs accordingly |
Reviewer's Guide by SourceryThis pull request decouples the Graph Middleware from Smart Contract Sets and IPFS, allowing it to connect directly to blockchain nodes. This simplifies the process of adding a middleware by removing the need to select a Smart Contract Set and storage provider. Sequence diagram: Simplified middleware setup processsequenceDiagram
actor User
participant Platform
participant Middleware
participant Blockchain
Note over User,Blockchain: New simplified process
User->>Platform: Add middleware
User->>Platform: Select blockchain node
User->>Platform: Configure deployment plan
Platform->>Middleware: Deploy middleware
Middleware->>Blockchain: Connect directly
Platform-->>User: Middleware ready
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @snigdha920 - I've reviewed your changes - here's some feedback:
Overall Comments:
- The warning section no longer mentions the private key requirement - please clarify if this is still needed and add it back to the warning section if it is
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Hey @snigdha920 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| 2. Choose a **Middleware name**. Choose one that will be easily recognizable in your dashboards. | ||
| 3. Select the **blockchain node** you want to connect to. This is the blockchain node that will be used to index the blockchain data. | ||
| 4. Choose a **deployment plan**. Select the type, cloud provider, region and resource pack. [More about deployment plans.](../launch-platform/managed-cloud-deployment/13_deployment-plans.md) | ||
| 5. You see the **resource cost** for this middleware displayed at the bottom of the form. Click **Confirm** to add the smart contract set. |
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.
issue: Incorrect reference to "smart contract set"
The text refers to adding the "smart contract set", but it should be adding the middleware. Please correct this.
Summary by Sourcery
New Features: