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

feat: rollback ark_project and wallet_kit renaming #453

Conversation

ptisserand
Copy link
Collaborator

@ptisserand ptisserand commented Feb 13, 2025

publishing pub.dev issues have been fixed so we can rollback ark_project and wallet_kit packages renaming.

Summary by CodeRabbit

  • Documentation

    • Updated installation instructions and example descriptions to reflect standardized dependency naming and clearer project details.
  • Refactor

    • Harmonized naming conventions and integration references across samples, ensuring consistency throughout the codebase.
  • Chore

    • Revised project metadata for the NFT marketplace example to better communicate its purpose.

Copy link

docs-page bot commented Feb 13, 2025

To view this pull requests documentation preview, visit the following URL:

docs.page/focustree/starknet.dart~453

Documentation is deployed and generated using docs.page.

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

This pull request standardizes package naming conventions across documentation, application examples, and package files. The changes include renaming the walletkit dependency to wallet_kit and the arkproject dependency to ark_project in various import statements, configuration files, and code references. Additionally, the NFT marketplace example now initializes an Ark class using an API key from the configuration.

Changes

File(s) Change Summary
docs/.../mobile-wallet.mdx Renamed dependency and import references from walletkit to wallet_kit in installation commands, code snippets, and explanatory text.
examples/nft_marketplace/* Updated import statements: replaced arkproject with ark_project and walletkit with wallet_kit; added Ark class initialization using an API key; updated project description and dependency names in pubspec.yaml.
examples/wallet_app/* Corrected import statements and dependency declarations by changing walletkit to wallet_kit in both code and pubspec.yaml.
packages/ark_project/* Renamed package identifier and import paths from arkproject to ark_project in both example files and pubspec.yaml.
packages/wallet_kit/* Changed package name from walletkit to wallet_kit; updated related import paths (including tests and widget files) and dependency declaration on ark_project in pubspec.yaml.

Sequence Diagram(s)

sequenceDiagram
    participant App as NFT Marketplace App
    participant Config
    participant Ark

    App->>Config: Request API key
    Config-->>App: Return API key
    App->>Ark: Initialize with API key
    Ark-->>App: Initialization complete
Loading

Possibly related PRs

Poem

Hoppin' with joy in the code-filled glen,
I found some names to fix again!
From walletkit to wallet_kit they now align,
And ark_project shines so fine.
A little hop, a carrot cheer—
This bunny sings, "Our code’s now clear!"
🐰🥕 Happy coding all around!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a95c2d and 3e6ea7b.

📒 Files selected for processing (14)
  • docs/examples/mobile-wallet.mdx (5 hunks)
  • examples/nft_marketplace/lib/main.dart (1 hunks)
  • examples/nft_marketplace/lib/screens/home_screen.dart (1 hunks)
  • examples/nft_marketplace/pubspec.yaml (2 hunks)
  • examples/wallet_app/lib/main.dart (1 hunks)
  • examples/wallet_app/lib/screens/home_screen.dart (1 hunks)
  • examples/wallet_app/pubspec.yaml (1 hunks)
  • packages/ark_project/example/ark_example.dart (1 hunks)
  • packages/ark_project/pubspec.yaml (1 hunks)
  • packages/wallet_kit/lib/widgets/nft_details.dart (1 hunks)
  • packages/wallet_kit/lib/widgets/nft_list.dart (1 hunks)
  • packages/wallet_kit/pubspec.yaml (2 hunks)
  • packages/wallet_kit/test/utils/format_address_test.dart (1 hunks)
  • packages/wallet_kit/test/utils/group_by_test.dart (1 hunks)
✅ Files skipped from review due to trivial changes (9)
  • packages/ark_project/pubspec.yaml
  • examples/wallet_app/lib/main.dart
  • packages/wallet_kit/test/utils/format_address_test.dart
  • packages/wallet_kit/lib/widgets/nft_list.dart
  • examples/wallet_app/lib/screens/home_screen.dart
  • packages/wallet_kit/test/utils/group_by_test.dart
  • packages/wallet_kit/lib/widgets/nft_details.dart
  • examples/nft_marketplace/lib/screens/home_screen.dart
  • packages/ark_project/example/ark_example.dart
🔇 Additional comments (11)
examples/nft_marketplace/lib/main.dart (2)

2-3: LGTM! Package imports updated correctly.

Import statements have been updated to use the correct package names:

  • ark_project/ark_project.dart
  • wallet_kit/wallet_kit.dart

Also applies to: 9-9


23-23: LGTM! Proper Ark initialization.

The Ark initialization is correctly implemented using the API key from configuration.

examples/wallet_app/pubspec.yaml (1)

12-12: LGTM! Package dependency updated correctly.

The dependency has been properly renamed from walletkit to wallet_kit while maintaining the version.

packages/wallet_kit/pubspec.yaml (2)

1-2: LGTM! Package metadata updated correctly.

Package name and description have been properly updated:

  • Name changed to wallet_kit
  • Description updated to be more specific

11-11: LGTM! Dependency renamed correctly.

The dependency has been properly renamed from arkproject to ark_project while maintaining the version.

examples/nft_marketplace/pubspec.yaml (2)

2-2: LGTM! Description updated appropriately.

The description has been updated to be more specific and accurately reflects the project's purpose.


31-31: LGTM! Dependencies renamed correctly.

Both dependencies have been properly renamed while maintaining their versions:

  • arkprojectark_project
  • walletkitwallet_kit

Also applies to: 35-35

docs/examples/mobile-wallet.mdx (4)

20-20: LGTM!

The package installation command has been correctly updated to use wallet_kit.


47-47: LGTM!

The package reference in the Android SDK requirements explanation has been correctly updated.


102-102: LGTM!

All import statements have been consistently updated to use wallet_kit.

Also applies to: 147-147, 203-203


198-198: LGTM!

The package reference in the pre-built layouts explanation has been correctly updated.


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
🪧 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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@ptisserand ptisserand merged commit 6127f41 into focustree:main Feb 13, 2025
10 checks passed
@ptisserand ptisserand deleted the rollback-ark_project-wallet_kit-package-renaming branch February 13, 2025 10:13
@coderabbitai coderabbitai bot mentioned this pull request Feb 14, 2025
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.

1 participant