fix: asset tokenization

[bl0up]

Summary by Sourcery

Refactor the asset tokenization smart contract to consolidate asset metadata, streamline initialization, and improve function parameter consistency. Update the documentation to reflect these changes and enhance clarity in the asset tokenization guide.

Enhancements:

• Refactor the Asset struct in the Solidity contract to include name, symbol, and assetUri fields, consolidating asset metadata within the struct.
• Remove unnecessary comments and imports from the Solidity contract to streamline the code.
• Modify the initialize function to remove parameters and set default values, simplifying contract initialization.
• Update the mint and mintBatch functions to improve error messages and ensure consistency in parameter naming.
• Refactor the burnBatch function to improve parameter naming consistency.
• Change the uri function to return the assetUri from the Asset struct, enhancing metadata retrieval.

Documentation:

• Update the asset tokenization guide to correct terminology and improve clarity in instructions, including changes to file paths and deployment steps.

Summary by CodeRabbit

• Documentation

  • Improved clarity and functionality of the asset tokenization guide.
  • Enhanced instructional text for adding storage and deploying smart contracts.
  • Streamlined Solidity code section with refined comments and improved formatting.
  • Restructured instructions for better flow in asset tokenization processes.

• New Features

  • Expanded Asset struct to include name, symbol, and assetUri for comprehensive asset definitions.
  • Updated createAsset function to accept new parameters, enhancing the asset creation process.

• Bug Fixes

  • Clarified error messages for better user feedback during execution.

[coderabbitai]

Walkthrough

The document on asset tokenization has been revised to enhance clarity and functionality. Key changes include updates to the Asset struct, modifications to the initialization and asset creation functions, and improved error messages. Additionally, the parameter naming conventions for batch operations have been standardized. Overall, the restructuring and formatting of the document aim to provide clearer guidance for users interacting with smart contracts.

Changes

File Path	Change Summary
docs/developer-guides/asset-tokenization.md	Revised instructional text for clarity; updated Asset struct to include new fields; modified initialize and createAsset functions to improve asset creation process; refined error messages and parameter naming conventions.
src/AssetTokenization.sol	Updated struct Asset to include name, symbol, and assetUri; changed initialize function to remove parameters; modified createAsset to accept new parameters; standardized batch function parameter names.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SmartContract as SC
    User->>SC: createAsset(assetId, name, symbol, maxSupply, faceValue, maturityTimestamp, assetUri)
    SC->>SC: Validate parameters
    SC->>SC: Store asset details
    SC-->>User: Asset created successfully

Loading

🐇 "In a world of tokens bright,
Clarity now takes its flight.
With names and symbols all in place,
Our assets dance in cyberspace!
So hop along, let’s celebrate,
For tokenized dreams await!" 🌟

---

Note

Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.

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

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.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements several improvements and updates to the asset tokenization smart contract and its associated documentation. The changes focus on enhancing the contract's functionality, improving code organization, and updating the deployment and interaction processes.

File-Level Changes

Change	Details	Files
Updated the AssetTokenization smart contract with new fields and functions	Added 'name', 'symbol', and 'assetUri' fields to the Asset struct Updated the createAsset function to include new parameters Removed the setURI function and updated the uri function to use assetUri Updated the _update function to emit AssetTransferEvent Removed console.sol import and unused comments	docs/developer-guides/asset-tokenization.md
Modified the deployment configuration and process	Replaced the deployment file '00_deploy_example.ts' with 'main.ts' in the 'ignition' folder Updated instructions for compiling and deploying the smart contract Added information about finding the contract address in 'deployed_addresses.json'	docs/developer-guides/asset-tokenization.md
Updated the integration template and interaction process	Modified the ABI in the integration template to match the updated smart contract Removed the 'Get Maturity Time' step from the interaction process Updated the order of steps for interacting with the smart contract	docs/developer-guides/asset-tokenization.md
Improved documentation clarity and formatting	Fixed typos and improved wording in various sections Updated code block formatting for better readability Removed unnecessary whitespace and adjusted heading levels	docs/developer-guides/asset-tokenization.md

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @bl0up - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Review instructions: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Your trial expires on September 2, 2024. Please upgrade to continue using Sourcery ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

question (documentation): Changed behavior of uri function

This is a significant change in the uri function's behavior. Could you explain the rationale and any potential impacts on existing integrations?