Skip to content

Conversation

@snigdha920
Copy link
Contributor

@snigdha920 snigdha920 commented Dec 26, 2024

Summary by Sourcery

New Features:

  • Connect the Graph Middleware directly to a blockchain node.

@linear
Copy link

linear bot commented Dec 26, 2024

ENG-1989 Update graph middleware docs

It doesn't need a smart contract set or storage anymore, update docs accordingly

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 26, 2024

Reviewer's Guide by Sourcery

This 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 process

sequenceDiagram
    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
Loading

File-Level Changes

Change Details Files
Updated the middleware documentation to reflect the changes.
  • Removed references to Smart Contract Sets and IPFS as prerequisites for adding a middleware.
  • Added instructions for connecting to a blockchain node.
  • Removed the steps for selecting a Smart Contract Set and storage provider when adding a middleware.
  • Clarified the process of defining and deploying a subgraph.
  • Updated the list of prerequisites for using the middleware.
  • Updated the code examples to use blockchain nodes instead of Smart Contract Sets and IPFS.
docs/using-platform/11_middleware.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the feat New feature label Dec 26, 2024
Copy link

@sourcery-ai sourcery-ai bot left a 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.

@snigdha920 snigdha920 marked this pull request as draft December 27, 2024 07:56
@snigdha920 snigdha920 marked this pull request as ready for review December 27, 2024 07:56
Copy link

@sourcery-ai sourcery-ai bot left a 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.
Copy link

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.

@roderik roderik merged commit 7b1341e into main Dec 27, 2024
2 of 3 checks passed
@roderik roderik deleted the snigdha/eng-1989-update-graph-middleware-docs branch December 27, 2024 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat New feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants