fix: import github.com/zeta-chain/node in Go project

[brewmaster012]

Description

When importing this repo as go module in a Go project, one would encounter errors like:

% go get github.com/zeta-chain/[email protected]
go: github.com/zeta-chain/[email protected]: invalid version: module contains a go.mod file, so module path must match major version ("github.com/zeta-chain/node/v17")

This seems like module version issue.
To fix this, one could try directly importing the module using the commit hash equivalent to the version tag or latest, yet it still yields error:

% go get github.com/zeta-chain/node@8a34fbe7d602865451fb41eb0eaa9564bba8a849
go: downloading github.com/zeta-chain/node v0.0.0-20240606203653-8a34fbe7d602
go: github.com/zeta-chain/node@8a34fbe7d602865451fb41eb0eaa9564bba8a849: create zip: docs/zetaclient/migration_v12.2->v12.3.md: malformed file path "docs/zetaclient/migration_v12.2->v12.3.md": invalid char '>'

This can be fixed by removing the > character in the file path. When this if fixed, there is another error:

% go get github.com/zeta-chain/node@7186fddc83fd56dcb9b773cf23dbf77f788cccf8
go: downloading github.com/zeta-chain/node v0.0.0-20240715220346-7186fddc83fd
go: github.com/zeta-chain/[email protected]: parsing go.mod:
	module declares its path as: github.com/zeta-chain/zetacore
	        but was required as: github.com/zeta-chain/node

This can be fixed by adding a replace directive like so:

require github.com/zeta-chain/zetacore v0.0.0-20240715220346-7186fddc83fd

replace github.com/zeta-chain/zetacore => github.com/zeta-chain/node v0.0.0-20240715220346-7186fddc83fd

How Has This Been Tested?

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

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes (1)

• docs/zetaclient/migration_v12.2-v12.3.md

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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[lumtis]

This can be fixed by removing the > character in the file path. When this if fixed, there is another error:

go: downloading github.com/zeta-chain/node v0.0.0-20240715220346-7186fddc83fd
go: github.com/zeta-chain/[email protected]: parsing go.mod:
	module declares its path as: github.com/zeta-chain/zetacore
	        but was required as: github.com/zeta-chain/node```

We could also consider renaming the package to `node` in `go.mod` so it could be directly imported as node