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

docs: create README for shared package #64

Merged
merged 3 commits into from
Oct 21, 2024
Merged

docs: create README for shared package #64

merged 3 commits into from
Oct 21, 2024

Conversation

0xyaco
Copy link
Collaborator

@0xyaco 0xyaco commented Oct 17, 2024

🤖 Linear

Closes GRT-218

Description

  • Create a README for shared package
  • Rename:
    • Address service to HexUtils
    • NormalizedAddress type to NormalizedHex

Copy link

linear bot commented Oct 17, 2024

Copy link
Collaborator

@0xnigir1 0xnigir1 left a comment

Choose a reason for hiding this comment

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

LGTM, just one comment

Comment on lines 2 to 3
export { HexUtils as AddressUtils, Caip2Utils, Logger } from "./services/index.js";
export { InvalidHex as InvalidAddress, InvalidChainId } from "./exceptions/index.js";
Copy link
Collaborator

Choose a reason for hiding this comment

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

are these X as Y correct? i see that in the other packages you're using HexUtils, not AddressUtils

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Whoops, refactoring made wrong

Copy link
Collaborator

Choose a reason for hiding this comment

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

💎

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm just standing on the shoulders of READMEs/repo boilerplate giants

@0xyaco 0xyaco requested a review from 0xnigir1 October 17, 2024 13:41
Copy link
Collaborator

@jahabeebs jahabeebs left a comment

Choose a reason for hiding this comment

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

nice 👍🏻

@@ -0,0 +1,68 @@
# ebo-agent: shared package

Shared lib that for EBO agent libraries.
Copy link
Collaborator

Choose a reason for hiding this comment

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

*Shared lib for EBO agent libraries

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oooh nice catch! 🔭 I'll fix it in the next docs PR

@0xyaco 0xyaco merged commit 3024057 into dev Oct 21, 2024
5 checks passed
@0xyaco 0xyaco deleted the docs/shared-module branch October 21, 2024 08:26
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.

4 participants