Update README.md to describe new ecotone-scalar decode flag

[roberto-bayardo]

Description

The ecotone-scalar utility was updated in #10547 to support value decoding but didn't include an update to this documentation.

[coderabbitai]

Walkthrough

Walkthrough

The recent update to the ecotone-scalar utility introduces a new feature enabling the decoding of versioned values into their components. This enhancement enhances the utility's capabilities by incorporating decoding functionality while maintaining compatibility with existing exported or public entity declarations.

Changes

Files	Change Summary
op-chain-ops/cmd/ecotone-scalar/README.md	Added a summary section detailing the new functionality for decoding versioned values.
op-chain-ops/cmd/ecotone-scalar/main.go	Modified the SetString method for uint256 in big.Int to use base 0 instead of base 10 in the main function.

---

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ce31849 and 102e391.

Files selected for processing (1)

• op-chain-ops/cmd/ecotone-scalar/main.go (1 hunks)

Additional comments not posted (1)

op-chain-ops/cmd/ecotone-scalar/main.go (1)

40-40: LGTM! The change to use base 0 in SetString allows automatic base detection, which is a useful improvement.

---

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.

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

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

Out of diff range and nitpick comments (4)

op-chain-ops/cmd/ecotone-scalar/README.md (4)

Line range hint 10-10: Remove the redundant phrase "of".

- Inside of `/op-chain-ops`, run:
+ Inside `/op-chain-ops`, run:

---

Line range hint 8-8: Correct the heading level to ensure proper structure.

- #### Usage
+ ## Usage

---

Line range hint 11-11: Add a blank line before the fenced code block for better readability.

- Build and run using the [Makefile](../../Makefile) `ecotone-scalar` target. Inside `/op-chain-ops`, run:
+ Build and run using the [Makefile](../../Makefile) `ecotone-scalar` target. Inside `/op-chain-ops`, run:

---

Line range hint 13-13: Add a blank line after the fenced code block for better readability.

- to create a binary in [../../bin/ecotone-scalar](../../bin/ecotone-scalar) that can
+ to create a binary in [../../bin/ecotone-scalar](../../bin/ecotone-scalar) that can

[protolambda]

LGTM, one small request

[semgrep-app]

Semgrep found 1 avoid-bind-to-all-interfaces finding:

• indexer/node/client_test.go
  • L14 - Triage

Detected a network listener listening on 0.0.0.0 or an empty string. This could unexpectedly expose the server publicly as it binds to all available interfaces. Instead, specify another IP address that is not 0.0.0.0 nor the empty string.

_{Ignore this finding from avoid-bind-to-all-interfaces.}

Semgrep found 1 err-nil-check finding:

• indexer/client/client.go
  • L119-123 - Triage

superfluous nil err check before return

_{Ignore this finding from err-nil-check.}