feat: cardano wallet api (#522)

* feat: add catalyst_cardano wallet api * feat: add error handling * fix: tests * docs: update toc * docs: fix readme * fix: decrement package version --------- Co-authored-by: Dominik Toton <[email protected]>
input-output-hk · Jun 4, 2024 · 0a11853 · 0a11853
1 parent 57c6e5b
commit 0a11853
Show file tree

Hide file tree

Showing 40 changed files with 1,648 additions and 72 deletions.
diff --git a/.config/dictionaries/project.dic b/.config/dictionaries/project.dic
@@ -202,3 +202,5 @@ xctest
 xctestrun
 xcworkspace
 yoroi
+multiasset
+unawaited
diff --git a/catalyst_voices/lib/app/view/app_page.dart b/catalyst_voices/lib/app/view/app_page.dart
@@ -36,7 +36,17 @@ final class _AppState extends State<App> {
   }
 
   Future<void> _init() async {
-    await Dependencies.instance.init();
+    try {
+      await Dependencies.instance.init();
+    } catch (error, stackTrace) {
+      // TODO(dtscalac): FutureBuilder that uses this future silences all
+      // errors, replace it here with proper logging solution.
+      FlutterError.dumpErrorToConsole(
+        FlutterErrorDetails(exception: error, stack: stackTrace),
+      );
+
+      rethrow;
+    }
   }
 
   List<BlocProvider> _multiBlocProviders() {

diff --git a/catalyst_voices/pubspec.yaml b/catalyst_voices/pubspec.yaml
@@ -10,8 +10,12 @@ environment:
 dependencies:
   animated_text_kit: ^4.2.2
   animations: ^2.0.11
+  catalyst_cardano:
+    path: ../catalyst_voices_packages/catalyst_cardano/catalyst_cardano
   catalyst_cardano_serialization:
     path: ../catalyst_voices_packages/catalyst_cardano_serialization
+  catalyst_cardano_web:
+    path: ../catalyst_voices_packages/catalyst_cardano/catalyst_cardano_web
   catalyst_voices_assets:
     path: ./packages/catalyst_voices_assets
   catalyst_voices_blocs:
@@ -30,7 +34,9 @@ dependencies:
     path: ./packages/catalyst_voices_view_models
   flutter:
     sdk: flutter
-  flutter_adaptive_scaffold: ^0.1.7+2
+  # TODO(dtscalac): allow newer versions when we migrate to flutter 3.22.x,
+  # the package already uses APIs from 3.22.x which are not available in current (3.19.x) flutter
+  flutter_adaptive_scaffold: 0.1.10+2
   flutter_bloc: ^8.1.3
   flutter_localized_locales: ^2.0.5
   flutter_web_plugins:
@@ -46,9 +52,9 @@ dev_dependencies:
   build_verify: ^3.1.0
   catalyst_analysis:
     git:
-        url: https://github.com/input-output-hk/catalyst-voices.git
-        path: catalyst_voices_packages/catalyst_analysis
-        ref: 3431f7b
+      url: https://github.com/input-output-hk/catalyst-voices.git
+      path: catalyst_voices_packages/catalyst_analysis
+      ref: 3431f7b
   flutter_test:
     sdk: flutter
   go_router_builder: ^2.4.1

diff --git a/catalyst_voices/web/index.html b/catalyst_voices/web/index.html
@@ -32,6 +32,7 @@
 
   <title>Catalyst Voices</title>
   <link rel="manifest" href="manifest.json">
+  <script type="module" src="/assets/packages/catalyst_cardano_web/assets/js/catalyst_cardano.js"></script>
 </head>
 
 <body>

diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/CHANGELOG.md b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/CHANGELOG.md
@@ -1,3 +1,3 @@
-# 1.0.0
+# 0.1.0
 
 * Initial release.
diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/README.md b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/README.md
@@ -1 +1,6 @@
 # catalyst_cardano
+
+## TODO(dtscalac): document plugin setup
+
+* This line is needed in index.html:
+* `<script type="module" src="/assets/packages/catalyst_cardano_web/assets/js/catalyst_cardano.js"></script>`
diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/.gitignore b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/.gitignore
@@ -0,0 +1,43 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/.metadata b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/.metadata
@@ -0,0 +1,30 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "300451adae589accbece3490f4396f10bdf15e6e"
+  channel: "stable"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 300451adae589accbece3490f4396f10bdf15e6e
+      base_revision: 300451adae589accbece3490f4396f10bdf15e6e
+    - platform: web
+      create_revision: 300451adae589accbece3490f4396f10bdf15e6e
+      base_revision: 300451adae589accbece3490f4396f10bdf15e6e
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'
diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/README.md b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/README.md
@@ -0,0 +1,3 @@
+# catalyst_cardano_example
+
+Demonstrates usage of catalyst_cardano plugin
diff --git a/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/analysis_options.yaml b/catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/analysis_options.yaml
@@ -0,0 +1,12 @@
+include: package:catalyst_analysis/analysis_options.1.0.0.yaml
+
+analyzer:
+  exclude: [
+    build/**,
+    lib/*.g.dart,
+    lib/generated/**
+  ]
+
+linter:
+  rules:
+    public_member_api_docs: false