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

fix!: rename ark_project into arkproject and wallet_kit into walletkit #443

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/examples/mobile-wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Run it locally with `flutter run` to make sure it is properly configured.
3. Add necessary dependencies

```bash
flutter pub add wallet_kit hive_flutter hooks_riverpod flutter_dotenv
flutter pub add walletkit hive_flutter hooks_riverpod flutter_dotenv
```

4. Create a `.env` file in the root of your wallet_app project
Expand All @@ -44,7 +44,7 @@ Here is the value for `starknet-devnet 0.2.0`

6. Update Android minimun SDK version

`secure_store` package used by `wallet_kit` require Android minimum SDK version set to at least 23, you need to modify `android/app/build.gradle`:
`secure_store` package used by `walletkit` require Android minimum SDK version set to at least 23, you need to modify `android/app/build.gradle`:
```
defaultConfig {
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
Expand Down Expand Up @@ -93,13 +93,13 @@ Future<void> main() async {
}
```

Now let's intialize `wallet_kit` and `hive` in our `main` function
Now let's intialize `walletkit` and `hive` in our `main` function

```dart
import 'package:flutter/material.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
Expand Down Expand Up @@ -144,7 +144,7 @@ import 'package:flutter/services.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

import './screens/home_screen.dart';

Expand Down Expand Up @@ -195,12 +195,12 @@ class WalletApp extends HookConsumerWidget {
}
```

Create a `screens/` folder and add `home_screen.dart` file with a pre-built layout from `wallet_kit`, as well as `WalletSelector`, `AccountAddress`, `WalletBody` and `SendEthButton`:
Create a `screens/` folder and add `home_screen.dart` file with a pre-built layout from `walletkit`, as well as `WalletSelector`, `AccountAddress`, `WalletBody` and `SendEthButton`:

```dart
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

class HomeScreen extends HookConsumerWidget {
const HomeScreen({super.key});
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Then kill the devnet, that's it the `assets/devnet-dump.json` has been updated!
- `starknet` contains the core logic with crypto hash functions and the main utility classes.
- `starknet_provider` contains the main package that we use to interact with the Starknet rpc nodes.
- `secure_store` manages the secure storage of the private key using different methods depending on the platform.
- `wallet_kit` is a higher level ui kit to manage wallets and transactions in a flutter app.
- `walletkit` is a higher level ui kit to manage wallets and transactions in a flutter app.
- `/examples` contains examples of apps using the packages. They should be accompanied by a tutorial in the docs to reproduce the app from scratch.
- `/docs` contains the documentation of the project. Docs are automatically deployed when we merge to main.

Expand All @@ -119,7 +119,7 @@ Tools need to be at the right version to avoid any incompability:

- [Cairo Compiler Version](https://github.com/starkware-libs/cairo/releases): `2.6.2`
- [Scarb](https://github.com/software-mansion/scarb/releases): `2.6.2`
- [Starknet Devnet](https://github.com/0xSpaceShard/starknet-devnet-rs/releases): `0.5.0`
- [Starknet Devnet](https://github.com/0xSpaceShard/starknet-devnet-rs/releases): `0.1.2`
- [Starkli](https://github.com/xJonathanLEI/starkli/releases): `0.2.9`
- [Sierra](https://docs.starknet.io/documentation/starknet_versions/version_notes/): `1.5.0`
- [Starknet](https://docs.starknet.io/documentation/starknet_versions/version_notes/): `0.13.1.1`
Expand Down
4 changes: 2 additions & 2 deletions examples/nft_marketplace/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import 'package:go_router/go_router.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'package:nft_marketplace/config.dart';
import 'package:nft_marketplace/screens/home_screen.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:ark_project/ark_project.dart';
import 'package:walletkit/wallet_kit.dart';
import 'package:arkproject/arkproject.dart';

void main() async {
await init();
Expand Down
4 changes: 2 additions & 2 deletions examples/nft_marketplace/lib/screens/home_screen.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import 'package:ark_project/ark_project.dart';
import 'package:arkproject/arkproject.dart';
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:go_router/go_router.dart';
import 'package:nft_marketplace/config.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

part 'home_screen.g.dart';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import webview_flutter_wkwebview
func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
SecureStorePlugin.register(with: registry.registrar(forPlugin: "SecureStorePlugin"))
FLTWebViewFlutterPlugin.register(with: registry.registrar(forPlugin: "FLTWebViewFlutterPlugin"))
WebViewFlutterPlugin.register(with: registry.registrar(forPlugin: "WebViewFlutterPlugin"))
}
4 changes: 2 additions & 2 deletions examples/nft_marketplace/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ environment:
# the latest version available on pub.dev. To see which dependencies have newer
# versions available, run `flutter pub outdated`.
dependencies:
ark_project: ^0.1.0+2
arkproject: ^0.1.0+2
starknet: ^0.1.1
starknet_provider: ^0.1.1
secure_store: ^0.1.2+1
wallet_kit: ^0.0.3
walletkit: ^0.0.3

flutter:
sdk: flutter
Expand Down
2 changes: 1 addition & 1 deletion examples/wallet_app/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import 'package:flutter/services.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

import './screens/home_screen.dart';

Expand Down
2 changes: 1 addition & 1 deletion examples/wallet_app/lib/screens/home_screen.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:walletkit/wallet_kit.dart';

class HomeScreen extends HookConsumerWidget {
const HomeScreen({super.key});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import webview_flutter_wkwebview
func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
SecureStorePlugin.register(with: registry.registrar(forPlugin: "SecureStorePlugin"))
FLTWebViewFlutterPlugin.register(with: registry.registrar(forPlugin: "FLTWebViewFlutterPlugin"))
WebViewFlutterPlugin.register(with: registry.registrar(forPlugin: "WebViewFlutterPlugin"))
}
2 changes: 1 addition & 1 deletion examples/wallet_app/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ environment:
dependencies:
flutter:
sdk: flutter
wallet_kit: ^0.0.3
walletkit: ^0.0.3
cupertino_icons: ^1.0.2
hive_flutter: ^1.1.0
hooks_riverpod: ^2.6.1
Expand Down
2 changes: 1 addition & 1 deletion packages/ark_project/example/ark_example.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import 'package:ark_project/ark_project.dart';
import 'package:arkproject/arkproject.dart';
import 'package:dotenv/dotenv.dart';

final env = DotEnv(includePlatformEnvironment: true)..load();
Expand Down
2 changes: 1 addition & 1 deletion packages/ark_project/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ark_project
name: arkproject
description: Ark SDK for Dart and Flutter apps.
version: 0.1.0+2
repository: https://github.com/focustree/starknet.dart
Expand Down
6 changes: 3 additions & 3 deletions packages/wallet_kit/ios/Runner/GeneratedPluginRegistrant.m
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
@import secure_store;
#endif

#if __has_include(<webview_flutter_wkwebview/FLTWebViewFlutterPlugin.h>)
#import <webview_flutter_wkwebview/FLTWebViewFlutterPlugin.h>
#if __has_include(<webview_flutter_wkwebview/WebViewFlutterPlugin.h>)
#import <webview_flutter_wkwebview/WebViewFlutterPlugin.h>
#else
@import webview_flutter_wkwebview;
#endif
Expand All @@ -36,7 +36,7 @@ + (void)registerWithRegistry:(NSObject<FlutterPluginRegistry>*)registry {
[PathProviderPlugin registerWithRegistrar:[registry registrarForPlugin:@"PathProviderPlugin"]];
[PointerInterceptorIosPlugin registerWithRegistrar:[registry registrarForPlugin:@"PointerInterceptorIosPlugin"]];
[SecureStorePlugin registerWithRegistrar:[registry registrarForPlugin:@"SecureStorePlugin"]];
[FLTWebViewFlutterPlugin registerWithRegistrar:[registry registrarForPlugin:@"FLTWebViewFlutterPlugin"]];
[WebViewFlutterPlugin registerWithRegistrar:[registry registrarForPlugin:@"WebViewFlutterPlugin"]];
}

@end
3 changes: 2 additions & 1 deletion packages/wallet_kit/lib/services/wallet_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import 'package:starknet/starknet.dart' as s;
import 'package:starknet_provider/starknet_provider.dart';
import 'package:uuid/uuid.dart';
import 'package:bip39/bip39.dart' as bip39;
import 'package:wallet_kit/wallet_kit.dart';

import '../wallet_kit.dart';

class WalletService {
static Future<Wallet> addWallet({
Expand Down
4 changes: 3 additions & 1 deletion packages/wallet_kit/lib/ui/button.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:wallet_kit/ui/index.dart';

import 'icon.dart';
import 'theme.dart';

class PrimaryButton extends CustomButton {
const PrimaryButton({
Expand Down
3 changes: 2 additions & 1 deletion packages/wallet_kit/lib/ui/input.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'package:flutter/material.dart';
import 'package:wallet_kit/wallet_kit.dart';

import 'theme.dart';

class TextInput extends StatelessWidget {
final TextEditingController? controller;
Expand Down
3 changes: 2 additions & 1 deletion packages/wallet_kit/lib/ui/modal.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'package:flutter/material.dart';
import 'package:wallet_kit/wallet_kit.dart';

import 'button.dart';

Future<T?> showBottomModal<T>({
required BuildContext context,
Expand Down
3 changes: 2 additions & 1 deletion packages/wallet_kit/lib/wallet_kit.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ library wallet_kit;
import 'package:flutter/material.dart';
import 'package:starknet/starknet.dart';
import 'package:starknet_provider/starknet_provider.dart';
import 'package:wallet_kit/wallet_kit.dart';

import 'wallet_screens/password_screen.dart';

export 'wallet_state/index.dart';
export 'wallet_screens/index.dart';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../services/wallet_service.dart';
import '../ui/index.dart';
import 'create_wallet_screen.dart';
import 'recover_wallet_screen.dart';

class AddWalletScreen extends StatelessWidget {
const AddWalletScreen({Key? key}) : super(key: key);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import 'protect_wallet_screen.dart';

const space = SizedBox(height: 16);

Expand Down
4 changes: 3 additions & 1 deletion packages/wallet_kit/lib/wallet_screens/password_screen.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:secure_store/secure_store.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import '../wallet_state/wallet_provider.dart';

Future<String?> showPasswordModal(BuildContext context) async {
return showBottomModal<String>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:secure_store/secure_store.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import '../wallet_state/index.dart';
import 'password_screen.dart';

class ProtectWalletScreen extends HookConsumerWidget {
final String seedPhrase;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import '../wallet_state/index.dart';
import '../widgets/icon.dart';
import 'protect_wallet_screen.dart';

class RecoverWalletScreen extends HookConsumerWidget {
const RecoverWalletScreen({super.key});
Expand Down
4 changes: 3 additions & 1 deletion packages/wallet_kit/lib/wallet_screens/settings_screen.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import '../wallet_state/index.dart';

class SettingsScreen extends HookConsumerWidget {
const SettingsScreen({super.key});
Expand Down
5 changes: 3 additions & 2 deletions packages/wallet_kit/lib/wallet_state/wallet_provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:secure_store/secure_store.dart';
import 'package:starknet/starknet.dart' as s;
import 'package:starknet_provider/starknet_provider.dart' as sp;
import 'package:wallet_kit/utils/persisted_notifier_state.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../utils/persisted_notifier_state.dart';
import '../wallet_kit.dart';

part 'wallet_provider.g.dart';

Expand Down
3 changes: 2 additions & 1 deletion packages/wallet_kit/lib/wallet_state/wallet_state.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:secure_store/secure_store.dart';
import 'package:starknet/starknet.dart';
import 'package:wallet_kit/utils/persisted_notifier_state.dart';

import '../utils/persisted_notifier_state.dart';

part 'wallet_state.freezed.dart';
part 'wallet_state.g.dart';
Expand Down
5 changes: 4 additions & 1 deletion packages/wallet_kit/lib/widgets/account_address.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../ui/index.dart';
import '../utils/index.dart';
import '../wallet_state/index.dart';

class AccountAddress extends HookConsumerWidget {
const AccountAddress({super.key});
Expand Down
5 changes: 3 additions & 2 deletions packages/wallet_kit/lib/widgets/icon.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import 'package:flutter/widgets.dart';
import 'package:flutter_svg/flutter_svg.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../wallet_state/wallet_state.dart';

class WalletTypeIcon extends StatelessWidget {
final WalletType type;
Expand All @@ -23,7 +24,7 @@ class WalletTypeIcon extends StatelessWidget {
@override
Widget build(BuildContext context) {
return SvgPicture.asset(
"packages/wallet_kit/assets/images/wallets/${type.name}.svg",
"packages/walletkit/assets/images/wallets/${type.name}.svg",
width: width,
fit: fit,
// ignore: deprecated_member_use
Expand Down
5 changes: 3 additions & 2 deletions packages/wallet_kit/lib/widgets/nft_details.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import 'package:ark_project/ark_project.dart';
import 'package:arkproject/arkproject.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:starknet/starknet.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../wallet_kit.dart';

part 'nft_details.g.dart';

Expand Down
5 changes: 3 additions & 2 deletions packages/wallet_kit/lib/widgets/nft_list.dart
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import 'package:ark_project/ark_project.dart';
import 'package:arkproject/arkproject.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:wallet_kit/wallet_kit.dart';

import '../wallet_state/index.dart';

part 'nft_list.g.dart';

Expand Down
6 changes: 5 additions & 1 deletion packages/wallet_kit/lib/widgets/send_eth_button.dart
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wallet_kit/wallet_kit.dart';
import 'package:starknet/starknet.dart' as s;

import '../services/index.dart';
import '../ui/index.dart';
import '../wallet_screens/index.dart';
import '../wallet_state/index.dart';

final recipientAddress = s.Felt.fromHexString(
'0x0367c0c4603A29Bc5aCa8E07C6a2776d7c0D325945aBB4F772F448b345Ca4cF7');

Expand Down
Loading