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

chore: payments subgraph Alchemy URLs: ZkSync Era, Avalanche, and Fantom #1449

Conversation

MantisClone
Copy link
Member

@MantisClone MantisClone commented Sep 6, 2024

Description of the changes

  • chore: payments subgraph Alchemy URLs: ZkSync Era, Avalanche, and Fantom
    • Previously used Subgraph Studio URLs

Summary by CodeRabbit

  • New Features
    • Expanded blockchain network support in the payment detection functionality, now including 'zksyncera', 'avalanche', and 'fantom' alongside existing networks. This enhancement increases the versatility of the application for users interacting with various blockchain environments.

Copy link

coderabbitai bot commented Sep 6, 2024

Walkthrough

The changes to the defaultGetTheGraphClient function expand its support to include three additional blockchain networks: 'zksyncera', 'avalanche', and 'fantom'. This update modifies the control flow to accommodate a total of seven networks when determining the appropriate URL for creating the Graph client, while maintaining the existing logic that utilizes the getTheGraphEvmClient function.

Changes

Files Change Summary
packages/payment-detection/src/thegraph/client.ts Expanded defaultGetTheGraphClient function to support three additional networks: 'zksyncera', 'avalanche', and 'fantom', increasing the total to seven supported networks.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@MantisClone MantisClone marked this pull request as ready for review September 6, 2024 22:05
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 8d41f35 and a3f33af.

Files selected for processing (1)
  • packages/payment-detection/src/thegraph/client.ts (1 hunks)
Additional comments not posted (1)
packages/payment-detection/src/thegraph/client.ts (1)

116-119: Approve addition of new networks but verify URL formation.

The changes to include 'zksyncera', 'avalanche', and 'fantom' in the defaultGetTheGraphClient function follow the established pattern and are correctly implemented. However, ensure that the URLs formed with these network names are valid and accessible.

Run the following script to verify the URL formation:

Verification successful

URLs for new networks are correctly formed and accessible.

The URLs for the networks 'zksyncera', 'avalanche', and 'fantom' are correctly formed and accessible, as confirmed by the HTTP 200 responses. This verifies that the changes to the defaultGetTheGraphClient function are correctly implemented. No further action is needed.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the URL formation for the new networks.

# Test: Check if the URLs for the new networks are correctly formed and accessible.
for network in zksyncera avalanche fantom; do
  echo "Testing URL for $network:"
  curl -I "${THE_GRAPH_ALCHEMY_URL.replace('$NETWORK', network)}"
done

Length of output: 226


Script:

#!/bin/bash
# Description: Verify the URL formation for the new networks using correct bash syntax.

# Check if THE_GRAPH_ALCHEMY_URL is set
if [ -z "${THE_GRAPH_ALCHEMY_URL}" ]; then
  echo "THE_GRAPH_ALCHEMY_URL is not set."
  exit 1
fi

# Test: Check if the URLs for the new networks are correctly formed and accessible.
for network in zksyncera avalanche fantom; do
  url="${THE_GRAPH_ALCHEMY_URL/\$NETWORK/$network}"
  echo "Testing URL for $network: $url"
  curl -I "$url"
done

Length of output: 101


Script:

#!/bin/bash
# Description: Search for the definition or initialization of THE_GRAPH_ALCHEMY_URL in the codebase.

# Search for THE_GRAPH_ALCHEMY_URL in the codebase
rg 'THE_GRAPH_ALCHEMY_URL' --context 5

Length of output: 1792


Script:

#!/bin/bash
# Description: Verify the URL formation for the new networks using the constant from the codebase.

# Define the constant as per the codebase
THE_GRAPH_ALCHEMY_URL='https://subgraph.satsuma-prod.com/e2e4905ab7c8/request-network--434873/request-payments-$NETWORK/api'

# Test: Check if the URLs for the new networks are correctly formed and accessible.
for network in zksyncera avalanche fantom; do
  url="${THE_GRAPH_ALCHEMY_URL/\$NETWORK/$network}"
  echo "Testing URL for $network: $url"
  curl -I "$url"
done

Length of output: 4085

@MantisClone MantisClone self-assigned this Sep 19, 2024
@MantisClone MantisClone merged commit bcfcb78 into master Sep 19, 2024
25 checks passed
@MantisClone MantisClone deleted the add-zksyncera-fantom-and-avalanche-payments-subgraph-alchemy-urls branch September 19, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants