docs(katana-node-bindings): add json log docs

[kariy]

Summary by CodeRabbit

• Documentation

  • Added documentation on parsing logs in JSON format and provided an example startup log.

• Refactor

  • Replaced type FieldElement with Felt for better consistency and compatibility.

• Chores

  • Removed license declaration from workspace configuration.

[coderabbitai]

Warning

Rate limit exceeded

@kariy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 50 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 534e4a0 and 6bb9bc2.

Walkthrough

The recent updates to the katana repository primarily entail the replacement of the FieldElement type with the newer Felt type across several modules for fields like address and chain_id. Additionally, the changes include adding documentation for JSON logs and removing a license declaration from the workspace configuration.

Changes

File Path	Summary
crates/katana/node-bindings/Cargo.toml	Removed the license declaration from the workspace configuration.
crates/katana/node-bindings/src/json.rs	Added documentation for parsing logs in JSON format when running katana with --json-log.
crates/katana/node-bindings/src/lib.rs	Replaced FieldElement with Felt for types of address, chain_id, and related fields.
crates/katana/runner/src/lib.rs	Updated type from FieldElement to Felt for managing contracts in KatanaRunner.

Poem

In fields of code where changes dwell,
From FieldElement to Felt, we tell,
Logs in JSON bloom to show,
Katana's growth, a steady flow.
Licensing fades, the bindings glide,
With cleaner code, we ride the tide. 🌾🚀

---

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4d33374 and 30b3eb8.

Files selected for processing (1)

• crates/katana/node-bindings/src/json.rs (1 hunks)

Files skipped from review due to trivial changes (1)

• crates/katana/node-bindings/src/json.rs

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 30b3eb8 and 534e4a0.

Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

Files selected for processing (4)

• crates/katana/node-bindings/Cargo.toml (1 hunks)
• crates/katana/node-bindings/src/json.rs (1 hunks)
• crates/katana/node-bindings/src/lib.rs (9 hunks)
• crates/katana/runner/src/lib.rs (3 hunks)

Files skipped from review due to trivial changes (1)

• crates/katana/node-bindings/Cargo.toml

Files skipped from review as they are similar to previous changes (1)

• crates/katana/node-bindings/src/json.rs

Additional comments not posted (12)

crates/katana/runner/src/lib.rs (4)

14-14: Update import statement to use Felt instead of FieldElement

The import statement has been updated to replace FieldElement with Felt. This is consistent with the changes mentioned in the summary.

---

26-26: Update struct field to use Felt instead of FieldElement

The contract field in the KatanaRunner struct has been updated to use Felt instead of FieldElement.

---

153-154: Update method signature to use Felt instead of FieldElement

The set_contract method's parameter type has been updated to Felt instead of FieldElement. This change ensures consistency with the updated type usage.

---

158-158: Update method return type to use Felt instead of FieldElement

The contract method's return type has been updated to Felt instead of FieldElement. This change ensures consistency with the updated type usage.

crates/katana/node-bindings/src/lib.rs (8)

16-16: Update import statement to use Felt instead of FieldElement

The import statement has been updated to replace FieldElement with Felt. This is consistent with the changes mentioned in the summary.

---

32-33: Update struct field to use Felt instead of FieldElement

The address field in the Account struct has been updated to use Felt instead of FieldElement.

---

45-45: Update struct field to use Felt instead of FieldElement

The chain_id field in the KatanaInstance struct has been updated to use Felt instead of FieldElement.

---

65-65: Update method return type to use Felt instead of FieldElement

The chain_id method's return type has been updated to Felt instead of FieldElement. This change ensures consistency with the updated type usage.

---

338-338: Update builder method parameter type to use Felt instead of FieldElement

The chain_id builder method's parameter type has been updated to Felt instead of FieldElement. This change ensures consistency with the updated type usage.

---

511-512: Update parsing to use Felt instead of FieldElement

The parsing of the address and private key has been updated to use Felt instead of FieldElement. This change ensures consistency with the updated type usage.

---

550-550: Update parsing to use Felt instead of FieldElement

The parsing of the address has been updated to use Felt instead of FieldElement. This change ensures consistency with the updated type usage.

---

569-569: Update parsing to use Felt instead of FieldElement

The parsing of the private key has been updated to use Felt instead of FieldElement. This change ensures consistency with the updated type usage.

[glihm]

🚀