Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: update README to specify that a relayer can be run to an existing contract #601

Merged
merged 2 commits into from
Nov 20, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Nov 20, 2023

Overview

Closes #599

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated the README with alternative options for posting commitments on an EVM chain, including running a relayer to an existing Blobstream contract.
    • Reorganized and updated links to relayer and deployment documentation for better clarity.

@rach-id rach-id added the documentation Improvements or additions to documentation label Nov 20, 2023
@rach-id rach-id requested a review from rootulp November 20, 2023 11:37
@rach-id rach-id self-assigned this Nov 20, 2023
@rach-id rach-id requested a review from evan-forbes as a code owner November 20, 2023 11:37
Copy link
Contributor

coderabbitai bot commented Nov 20, 2023

Walkthrough

The README.md has been updated to include instructions for relaying to pre-deployed Blobstream contracts on an EVM chain. This update provides users with the flexibility to connect to existing contracts without the need to deploy new ones, streamlining the process for users who wish to use the Blobstream infrastructure that is already in place.

Changes

File Change Summary
README.md Added instructions for running a relayer to an already deployed Blobstream contract, with updated links to documentation.

Assessment against linked issues

Objective Addressed Explanation
Determine if the current implementation supports relaying to pre-deployed blobstream contracts without redeploying them (#599)
Clarify the process for a relayer to connect to and use existing contracts on a network (#599)

Poem

As winter whispers, code does leap,
Across the chains where bytes do sleep.
No need for new, the old will do,
A rabbit's touch makes all things new. 🐰✨


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7071a5d and a74dde4.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a74dde4 and 705abf2.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

@rach-id rach-id merged commit ea4706f into main Nov 20, 2023
18 checks passed
@rach-id rach-id deleted the deployment-readme-docs branch November 20, 2023 14:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Question about relaying to already deployed contracts
2 participants