Skip to content

Export missing network-specific types #161

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

Merged
merged 5 commits into from
Mar 20, 2025

Conversation

fracek
Copy link
Contributor

@fracek fracek commented Mar 20, 2025

Some types were not exported but they are useful when implement indexers.

This PR exports all filter and block types.

Copy link

coderabbitai bot commented Mar 20, 2025

📝 Walkthrough

Walkthrough

This PR introduces new JSON metadata files for prerelease versions of the @apibara/beaconchain, @apibara/evm, and @apibara/starknet packages. Each JSON file documents package-specific changes (e.g., exporting missing types) along with metadata such as package name, author email, and dependent change type. In addition, several source files across these packages have been updated with new type exports for existing structures. These modifications enhance type definitions and annotations without altering runtime behavior.

Changes

File(s) Change Summary
change/@apibara-beaconchain-*.json,
change/@apibara-evm-*.json,
change/@apibara-starknet-*.json
New JSON metadata files added for prerelease versions; include package name, author email, comment ("export missing types"), and mark dependent change type as patch.
packages/beaconchain/src/block.ts,
packages/beaconchain/src/common.ts
Added new type exports for existing structures: Validator, Blob, and ValidatorStatus to enhance type management in the Beaconchain package.
packages/evm/src/block.ts,
packages/evm/src/common.ts,
packages/evm/src/filter.ts
Introduced type exports for block structures (e.g., Bloom, Withdrawal, etc.), common numeric types (B256, U256, U128), and Topic to improve type safety in EVM code.
packages/starknet/src/block.ts,
packages/starknet/src/filter.ts
Added extensive type exports for various transaction, block, state, and filter structures to increase type clarity and checking within the Starknet package.

Possibly related PRs

  • Update DNA definitions #101: The changes in the main PR involve adding a new JSON file for the @apibara/beaconchain package, which is related to the retrieved PR as both introduce new JSON files for different @apibara packages that specify metadata for prerelease versions, including comments about exporting missing types.
  • Update beta to 2.1.0-beta.x #146: The changes in the main PR involve adding a new JSON file for the @apibara/beaconchain package that specifies a prerelease version and exports missing types, while the retrieved PR also introduces a new JSON file for the same package but focuses on updating the version to 2.1.0-beta.0.
  • ci: fix release workflow #103: The changes in the main PR, which involve adding a new JSON file for the @apibara/beaconchain package, are related to the retrieved PR as both involve the introduction of new JSON files for different packages within the same @apibara namespace, specifically focusing on prerelease metadata.

Poem

Oh, I’m a rabbit with a joyful leap,
Hopping through code where new types sleep.
JSON files with secrets, metadata in sight,
Types exported boldly, making our code just right.
I nibble on changes with a merry little tune,
Celebrating updates under the coding moon! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0865596 and 7b0886f.

📒 Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/release.yml (1)

31-31: Ensure Build Filters Are Correctly Configured.
The updated build command now excludes the ./examples/cli-drizzle, ./examples/cli-instrumentation, and ./examples/cli-js directories. Please confirm that these filters are intentional and align with the updated exclusion requirements—ensuring that only the desired example directories are omitted from the build process in light of the new network-specific type exports.


🪧 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 generate docstrings to generate docstrings for this 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.

@fracek fracek requested a review from jaipaljadeja March 20, 2025 16:11
Copy link
Member

@jaipaljadeja jaipaljadeja left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks

@jaipaljadeja jaipaljadeja merged commit e2d3973 into apibara:main Mar 20, 2025
2 checks passed
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.

2 participants