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

revert from using abigen! macro #599

Merged
merged 4 commits into from
Aug 20, 2024
Merged

revert from using abigen! macro #599

merged 4 commits into from
Aug 20, 2024

Conversation

kariy
Copy link
Member

@kariy kariy commented Aug 20, 2024

basically a revert of #562 because of an issue during the abigen! proc macro expansion, where downstream crates arent able to resolve the path correctly because the path in

  abigen!(
        Controller,
        "packages/account_sdk/compiled/controller.contract_class.json",
        ...
  )

gets resolved relative to the downstream crate during compilation which results in file not found error.

another approach to allow using abigen! macro is to use the #![feature(proc_macro_expand)] feature which requires nightly rust.

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive implementation of the ERC-20 token standard for the StarkNet blockchain, allowing users to interact with tokens through core functionalities like transfer, approval, and querying balances.
    • Added an Erc20Reader for read-only access to token states, enhancing user experience with efficient querying capabilities.
  • Bug Fixes

    • Removed outdated module structures in the account SDK, streamlining the code and potentially reducing errors in token interaction.
  • Refactor

    • Simplified module declarations for controller and erc_20, indicating a shift in how contract bindings will be managed in the future.

Copy link

vercel bot commented Aug 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
cartridge-starknet-react-next ✅ Ready (Inspect) Visit Preview Aug 20, 2024 5:54pm
docs ✅ Ready (Inspect) Visit Preview Aug 20, 2024 5:54pm
keychain ✅ Ready (Inspect) Visit Preview Aug 20, 2024 5:54pm
ui ✅ Ready (Inspect) Visit Preview Aug 20, 2024 5:54pm
ui-next ✅ Ready (Inspect) Visit Preview Aug 20, 2024 5:54pm

Copy link

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent changes introduce a comprehensive implementation of the ERC-20 token standard for the StarkNet blockchain, encapsulated in a new erc_20.rs file. This implementation includes core functionalities for managing token state, event handling, and contract interactions, while also separating read and write operations for enhanced efficiency. Additionally, the controller and erc_20 modules in mod.rs were simplified to empty declarations, indicating a significant shift in the overall architecture of the SDK.

Changes

File(s) Change Summary
packages/account_sdk/src/abigen/erc_20.rs Introduced a new comprehensive implementation of the ERC-20 token standard, including core functionalities, state management, event handling, and a read-only access structure.
packages/account_sdk/src/abigen/mod.rs Simplified controller and erc_20 modules to empty declarations, removing previous type aliases and event bindings, indicating a shift in module utilization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Erc20
    participant StarkNet

    User->>Erc20: Create new token instance
    Erc20->>StarkNet: Set contract address
    User->>Erc20: Call balanceOf
    Erc20->>StarkNet: Query balance
    StarkNet-->>Erc20: Return balance
    Erc20-->>User: Provide balance info
    User->>Erc20: Transfer tokens
    Erc20->>StarkNet: Execute transfer
    StarkNet-->>Erc20: Confirm transfer
    Erc20-->>User: Transfer successful
Loading

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.

@kariy kariy requested review from broody and glihm August 20, 2024 15:28
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

packages/account_sdk/src/abigen/erc_20.rs Show resolved Hide resolved
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.

2 participants