zeta-chain / toolkit

A library of ZetaChain helper utilities, contracts, and Hardhat tasks for smart-contract development
MIT License
43 stars 22 forks source link

feat: add Bitcoin standard memo encoding example for bitSmiley and unit tests #196

Open ws4charlie opened 6 days ago

ws4charlie commented 6 days ago

Added the Javascript files that showcase the Bitcoin memo encoding process.

This is a simplified implementation that enables the revertAddress option (bitSmiley needs this option). @fadeev you can refine and formalize the code (my JS skills are limited) to ship the API in whatever style you deem appropriate. Thanks in advance!

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough This pull request introduces several changes, including the addition of a new test file (`memo.test.js`) for memo encoding functionality, updates to the `package.json` file to enhance testing capabilities, and the introduction of a GitHub Actions workflow (`test.yaml`) for automated testing. Additionally, a new configuration file for Jest (`jest.config.ts`) is added to support TypeScript testing. The encoding functionality is encapsulated in a new module (`encodeToBytes.ts`), which includes classes and enumerations for encoding operations. Finally, the main index file is updated to export the new encoding functionalities. ## Changes | File | Change Summary | |-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | `memo.test.js` | Introduced a test suite for memo encoding with three test functions validating different encoding formats. | | `package.json` | Added a test script, updated dependencies, and introduced new development dependencies for TypeScript testing. | | `.github/workflows/test.yaml` | Added a new GitHub Actions workflow for automated testing on pull requests. | | `jest.config.ts` | Introduced Jest configuration for TypeScript, specifying the test environment and file matching patterns. | | `packages/client/src/encodeToBytes.ts` | Added functionality for encoding data into byte arrays with classes and enums for operation types and encoding formats. | | `packages/client/src/index.ts` | Updated to export all entities from the `encodeToBytes` module. | | `test/memo.test.ts` | Introduced a new test suite for memo encoding using Jest, validating the encoding logic with expected hexadecimal values. | ## Suggested reviewers - andresaiello - GMaiolo

📜 Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 951044de17c4acf2142f63e9c3fc014588b87840 and 0d8fa3e9a34500534b0351bd6a0c7d3763b7ee15.
⛔ Files ignored due to path filters (10) * `typechain-types/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC1155Errors.ts` is excluded by `!typechain-types/**` * `typechain-types/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC20Errors.ts` is excluded by `!typechain-types/**` * `typechain-types/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC721Errors.ts` is excluded by `!typechain-types/**` * `typechain-types/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/index.ts` is excluded by `!typechain-types/**` * `typechain-types/@openzeppelin/contracts/interfaces/index.ts` is excluded by `!typechain-types/**` * `typechain-types/factories/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC1155Errors__factory.ts` is excluded by `!typechain-types/**` * `typechain-types/factories/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC20Errors__factory.ts` is excluded by `!typechain-types/**` * `typechain-types/factories/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC721Errors__factory.ts` is excluded by `!typechain-types/**` * `typechain-types/factories/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/index.ts` is excluded by `!typechain-types/**` * `typechain-types/factories/@openzeppelin/contracts/interfaces/index.ts` is excluded by `!typechain-types/**`
📒 Files selected for processing (1) * `packages/client/src/index.ts` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * packages/client/src/index.ts

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
fadeev commented 6 days ago
fadeev commented 4 days ago

@andresaiello @zeta-chain/fullstack please, review.