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

feat(zetacore): add chain static information for bitcoin signet testnet #2883

Merged
merged 8 commits into from
Sep 17, 2024

Conversation

kingpinXD
Copy link
Contributor

@kingpinXD kingpinXD commented Sep 16, 2024

Description

Closes : #2884

How Has This Been Tested?

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • New Features

    • Added support for the Bitcoin Signet Testnet, enhancing documentation and API capabilities.
    • Introduced btc_signet_testnet to the list of valid chain names in the API.
    • Updated configurations to include Bitcoin Signet Testnet for better management and usability.
  • Bug Fixes

    • Improved clarity and maintainability of Bitcoin chain parameters and configurations.
  • Documentation

    • Enhanced changelog and API documentation to reflect new functionalities related to Bitcoin Signet Testnet.

Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The pull request introduces support for the Bitcoin Signet testnet across multiple components of the codebase. Key changes include the addition of chain static information, updates to OpenAPI specifications, modifications to chain parameters, and enhancements to testing frameworks. The documentation is improved to reflect these updates, ensuring that developers have the necessary information to work with the Bitcoin Signet environment effectively.

Changes

File Path Change Summary
changelog.md Added entry for chain static information for Bitcoin Signet testnet.
docs/openapi/openapi.swagger.yaml Added btc_signet_testnet to ChainName definition in OpenAPI specification.
pkg/chains/chain.go Replaced hardcoded chain IDs with constants for Bitcoin networks, including Signet Testnet.
pkg/chains/chain_test.go Enhanced test coverage by adding test cases for Bitcoin Signet Testnet in various functions.
pkg/chains/chains.go Introduced BitcoinSignetTestnet struct with relevant properties for the testnet.
proto/zetachain/zetacore/pkg/chains/chains.proto Added btc_signet_testnet to ChainName enum with value 24.
zetaclient/config/types.go Updated BTCConfig struct to include "signet" as a network option in RPCParams.

Possibly related issues

Possibly related PRs

Suggested labels

zetaclient, chain:solana


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 generate interesting stats about this repository and render them as a table.
    -- @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.

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.

@kingpinXD kingpinXD changed the title feat: add chain information for bitcoin signet testnet feat: add chain static information for bitcoin signet testnet Sep 16, 2024
Copy link
Contributor

@ws4charlie ws4charlie left a comment

Choose a reason for hiding this comment

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

overall looks good. minor comment

@kingpinXD kingpinXD marked this pull request as ready for review September 17, 2024 07:18
Copy link

codecov bot commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.86%. Comparing base (28305be) to head (2c2326d).
Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #2883   +/-   ##
========================================
  Coverage    66.85%   66.86%           
========================================
  Files          378      378           
  Lines        21103    21108    +5     
========================================
+ Hits         14108    14113    +5     
  Misses        6330     6330           
  Partials       665      665           
Files with missing lines Coverage Δ
pkg/chains/chain.go 94.39% <100.00%> (+0.21%) ⬆️
pkg/chains/chains.go 93.68% <100.00%> (+0.06%) ⬆️
zetaclient/config/types.go 11.62% <ø> (ø)

@kingpinXD kingpinXD changed the title feat: add chain static information for bitcoin signet testnet feat(zetacore): add chain static information for bitcoin signet testnet Sep 17, 2024
@kingpinXD kingpinXD enabled auto-merge September 17, 2024 18:20
@kingpinXD kingpinXD added this pull request to the merge queue Sep 17, 2024
Merged via the queue into develop with commit 3bf36b9 Sep 17, 2024
31 checks passed
@kingpinXD kingpinXD deleted the add-signet-chain branch September 17, 2024 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add static data for signet testnet
3 participants