Release 16 PR

[bpolania]

Description

Merging from Dev to Main the following PRs

#223
#226

Summary by CodeRabbit

• New Features

  • Introduced new methods across various client classes for encoding transaction data, enhancing smart contract interactions.
  • Added an optional property encodedTxDataOnly to transaction options, allowing retrieval of encoded transaction data without execution.

• Bug Fixes

  • Modified response types to make txHash optional, improving flexibility in handling responses.

• Tests

  • Added new test cases for the ipAssetClient to verify encoded transaction data functionality.

• Documentation

  • Expanded documentation to include newly introduced types and methods for better developer understanding.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates to the core-sdk enhance the interaction with smart contracts and improve transaction handling by introducing a new encoding feature. This allows for flexibility in transaction submissions, enabling developers to retrieve encoded transaction data without executing transactions. The version update indicates ongoing refinements, while expanded type definitions and enhanced client methods ensure a more robust and user-friendly SDK experience.

Changes

File	Change Summary
packages/core-sdk/package.json	Version updated from 1.0.0-rc.15 to 1.0.0-rc.16.
packages/core-sdk/src/abi/generated.ts	Added new encoding methods for contract functions, introduced EncodedTxData type.
packages/core-sdk/src/index.ts	New export EncodedTxData added to type exports.
packages/core-sdk/src/resources/dispute.ts	Refactored DisputeClient to use consolidated request objects, added encodedTxDataOnly option.
packages/core-sdk/src/resources/ipAccount.ts	Enhanced transaction execution logic with new request structure and encodedTxDataOnly option.
packages/core-sdk/src/resources/ipAsset.ts	Added encodedTxDataOnly option for transaction requests.
packages/core-sdk/src/resources/license.ts	Introduced encodedTxDataOnly option for license transactions.
packages/core-sdk/src/resources/nftClient.ts	Refactored createCollection method to support encodedTxDataOnly.
packages/core-sdk/src/resources/permission.ts	Improved request handling for permissions with structured request data and encodedTxDataOnly option.
packages/core-sdk/src/resources/royalty.ts	Enhanced royalty handling with encodedTxDataOnly option for transaction processing.
packages/core-sdk/src/types/options.ts	Added optional encodedTxDataOnly property to TxOptions type.
packages/core-sdk/src/types/resources/dispute.ts	Modified response types to include optional txHash and new encodedTxData.
packages/core-sdk/src/types/resources/ipAccount.ts	Updated response types to make txHash optional and add encodedTxData.
packages/core-sdk/src/types/resources/ipAsset.ts	Updated response types to include encodedTxData and modify txHash.
packages/core-sdk/src/types/resources/license.ts	Added encodedTxData to licensing response types and made txHash optional.
packages/core-sdk/src/types/resources/nftClient.ts	Updated CreateNFTCollectionResponse to make txHash optional and include encodedTxData.
packages/core-sdk/src/types/resources/permission.ts	Modified SetPermissionsResponse to make txHash optional and add encodedTxData.
packages/core-sdk/src/types/resources/royalty.ts	Updated response types to include encodedTxData and change txHash to optional.
packages/core-sdk/test/unit/resources/ipAsset.test.ts	Added tests for ipAssetClient related to encoded transaction data retrieval.
packages/wagmi-generator/sdk.ts	Introduced generateContractDataFunction for encoding contract data, added EncodedTxData export type.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SDK
    participant Contract

    Client->>SDK: Request transaction (with encodedTxDataOnly)
    SDK->>Contract: Prepare transaction data
    Contract-->>SDK: Return encoded transaction data
    SDK-->>Client: Provide encoded transaction data

Loading

Poem

🐰 In the meadow, changes bloom,
New paths for contracts, dispelling gloom.
Encoded treasure, a data delight,
Hopping through code, we soar to new height!
With each tweak, our tools grow bright,
Let's celebrate with joy and light! 🌼✨

---

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