Rust: SargonOS &Drivers more Profile Logic | Swift: Shared State (working example app)!

.github/attention.md

@@ -0,0 +1,5 @@
+Hey 👋 You DID in fact read my fancy PR description BEFORE you started reviewing the code, right? Else switch back to description now and read it in full:
+
+https://github.com/radixdlt/sargon/pull/131
+
+Thank you! Happy review! 🙏

.github/workflows/test.yml

@@ -122,7 +122,7 @@ jobs:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           rustup target add aarch64-apple-darwin
-          sh ./scripts/ios/test.sh --codecov ${{ env.SWIFT_CODE_COV_REPORT_PATH }}
+          sh ./scripts/ios/test.sh --build --codecov ${{ env.SWIFT_CODE_COV_REPORT_PATH }}
 
       - name: Upload to CodeCov.io
         uses: RDXWorks-actions/codecov-action@main
@@ -204,7 +204,7 @@ jobs:
         uses: RDXWorks-actions/cargo-install@main
         with:
           crate: cargo-tarpaulin
-          tag: 0.27.3
+          tag: 0.30.0
           locked: true
 
       - name: Code Coverage - Generate

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sargon"
-version = "1.0.2"
+version = "1.1.0"
 edition = "2021"
 build = "build.rs"
 
@@ -172,17 +172,18 @@ aes-gcm = { git = "https://github.com/RustCrypto/AEADs", rev = "7e82b01cd4901f6a
 # hkdf = "0.12.4"
 hkdf = { git = "https://github.com/RustCrypto/KDFs/", rev = "1ac16e8b9d4ee7a67613c9396c6cc1327652eaba" }
 
+# reqwest = "0.12.3"
+reqwest = { git = "https://github.com/seanmonstar/reqwest", rev = "0720159f6369f54e045a1fd315e0f24b7a0b4a39", default-features = false, features = [
+    "native-tls-vendored",
+] }
+
+
 [dev-dependencies]
 # uniffi = "0.27.1"
 uniffi = { git = "https://github.com/mozilla/uniffi-rs/", rev = "6f33088e8100a2ea9586c8c3ecf98ab51d5aba62", features = [
     "bindgen-tests",
 ] }
 
-# reqwest = "0.12.3"
-reqwest = { git = "https://github.com/seanmonstar/reqwest", rev = "0720159f6369f54e045a1fd315e0f24b7a0b4a39", default-features = false, features = [
-    "native-tls-vendored",
-] }
-
 # actix-rt = "3.3.0"
 actix-rt = { git = "https://github.com/actix/actix-net", rev = "57fd6ea8098d1f2d281c305fc331216c4fe1992e" }
 

Package.resolved

@@ -1,5 +1,23 @@
 {
   "pins" : [
+    {
+      "identity" : "asyncextensions",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/sideeffect-io/AsyncExtensions",
+      "state" : {
+        "revision" : "1f0729e4f1f6c7166acfac3cec43b3cbe83be0e6",
+        "version" : "0.5.2"
+      }
+    },
+    {
+      "identity" : "swift-collections",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-collections.git",
+      "state" : {
+        "revision" : "94cf62b3ba8d4bed62680a282d4c25f9c63c2efb",
+        "version" : "1.1.0"
+      }
+    },
     {
       "identity" : "swift-custom-dump",
       "kind" : "remoteSourceControl",
@@ -23,8 +41,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
       "state" : {
-        "revision" : "b13b1d1a8e787a5ffc71ac19dcaf52183ab27ba2",
-        "version" : "1.1.1"
+        "revision" : "6f30bdba373bbd7fbfe241dddd732651f2fbd1e2",
+        "version" : "1.1.2"
       }
     }
   ],

Package.swift

@@ -7,7 +7,6 @@ var swiftSettings: [SwiftSetting] = [
 	.enableExperimentalFeature("StrictConcurrency")
 ]
 
-
 let sargonBinaryTargetName = "SargonCoreRS"
 let binaryTarget: Target
 let useLocalFramework = true
@@ -42,8 +41,21 @@ let package = Package(
 		)
 	],
 	dependencies: [
+        // We use XCTestDynamicOverlay to have different `description` of e.g. Decimal192
+		// for tests vs not tests (we use a .test `Locale`)
+		.package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.1.2"),
+
+		// `XCTAssertNoDifference` used in test
 		.package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "1.3.0"),
+
+        // Hopefully only temporary! We use `SwiftJSON` to be able to mark some Sargon models
+        // as `Swift.Codable`. See the SargonObjectCodable protocol for details.
+        // In the future hopefully no JSON coding happens in wallets,
+        // i.e. Sargon does ALL JSON coding, then we can remove this.
 		.package(url: "https://github.com/SwiftyJSON/SwiftyJSON", from: "5.0.2"),
+
+		// Multicast / Share of notifications in EventBus
+		.package(url: "https://github.com/sideeffect-io/AsyncExtensions", exact: "0.5.2"),
 	],
 	targets: [
 		binaryTarget,
@@ -57,6 +69,8 @@ let package = Package(
 			dependencies: [
 				.target(name: "SargonUniFFI"),
 				"SwiftyJSON",
+				.product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
+				"AsyncExtensions"
 			],
 			path: "apple/Sources/Sargon",
 			swiftSettings: swiftSettings
@@ -67,8 +81,7 @@ let package = Package(
 				.target(name: "Sargon"),
 				.product(name: "CustomDump", package: "swift-custom-dump"),
 			],
-			path: "apple/Tests",
-			swiftSettings: swiftSettings
+			path: "apple/Tests"
 		),
 	]
 )

README.md

@@ -56,6 +56,10 @@ This repo contains a [`.pre-commit-config.yaml`](./.pre-commit-config.yaml) whic
 pre-commit install
 ```
 
+## `direnv`
+
+Install [`direnv`](https://direnv.net) to automatically load env variables when you change directory to Sargon dir. This repo contains an `.envrc` which exports `RUST_LOG=info` so that logs are shown when running unit tests. When you run `cargo test` those logs will show up. Prefer using `nextest` below if you dont wanna see logs, and want prettier test result output.
+
 ### `nextest`
 
 [Nextest](https://nexte.st/index.html) is a nice test runner for Rust!

apple/Sources/Sargon/Drivers/EntropyProvider/EntropyProvider+RandomData.swift

@@ -0,0 +1,34 @@
+//
+//  File.swift
+//
+//
+//  Created by Alexander Cyon on 2024-05-03.
+//
+
+import Foundation
+import SargonUniFFI
+
+// Makes it possible to type `.shared` on an initalizer/func taking
+// `some EntropyProviderDriver` as parameter.
+extension EntropyProviderDriver where Self == EntropyProvider {
+	/// Singleton `EntropyProviderDriver` of type `EntropyProvider`,
+	/// being an `actor` that uses CSRNG `SystemRandomNumberGenerator`
+	public static var shared: Self { Self.shared }
+}
+
+/// An `EntropyProviderDriver` actor which uses CSRNG `SystemRandomNumberGenerator`
+/// to generate 32 bytes.
+public final actor EntropyProvider {
+	internal init() {}
+
+	/// Singleton `EntropyProviderDriver` of type `EntropyProvider`,
+	/// being an `actor` that uses CSRNG `SystemRandomNumberGenerator`
+	public static let shared = EntropyProvider()
+}
+
+extension EntropyProvider: EntropyProviderDriver {
+	/// Generates 32 bytes using CSRNG `SystemRandomNumberGenerator`
+	nonisolated public func generateSecureRandomBytes() -> Entropy32Bytes {
+		Entropy32Bytes.generate()
+	}
+}

apple/Sources/Sargon/Drivers/EventBus/EventBus.swift

@@ -0,0 +1,67 @@
+//
+//  File.swift
+//  
+//
+//  Created by Alexander Cyon on 2024-05-05.
+//
+
+import Foundation
+import SargonUniFFI
+import AsyncExtensions
+
+// Makes it possible to type `.shared` on an initalizer/func taking
+// `some EventBusDriver` as parameter.
+extension EventBusDriver where Self == EventBus {
+
+	/// Singleton `EventBusDriver` of type `EventBus` being an `actor`  which forwards `EventNotification`s
+	/// originally emitted by `SargonOS` (Rust side).
+	public static var shared: Self { Self.shared }
+}
+
+/// An `EventBusDriver` actor which handles incoming
+/// `EventNotifications` and forwards them to any
+/// subscriber of `notifications()`, being a multicasted
+/// async sequence.
+public final actor EventBus {
+	/// A stream we multicast on.
+	private let stream = AsyncThrowingPassthroughSubject<Element, any Error>()
+	private let subject: Subject
+#if DEBUG
+	public init() {
+		subject = .init()
+	}
+#else
+	private init() {
+		subject = .init()
+	}
+#endif
+}
+
+extension EventBus {
+
+	public typealias Element = EventNotification
+	public typealias Subject = AsyncPassthroughSubject<Element>
+
+	/// Singleton `EventBusDriver` of type `EventBus` being an `actor` which forwards `EventNotification`s
+	/// originally emitted by `SargonOS` (Rust side).
+	public static let shared = EventBus()
+
+	/// A multicasted async sequence of `EventNotification` values
+	/// over time, originally emitted by `SargonOS` (Rust side).
+	public func notifications() -> AsyncMulticastSequence<EventBus.Subject, AsyncThrowingPassthroughSubject<EventBus.Element, any Error>> {
+		subject
+		 .multicast(stream)
+		 .autoconnect()
+	}
+}
+
+extension EventBus: EventBusDriver {
+	/// This method is called by `SargonOS` (Rust side) and we should
+	/// "forward" the events to subscribers (Swift swide), i.e. `@SharedReader`s of profile values,
+	/// which uses `notifications()` to subscribe to these
+	/// values.
+	public func handleEventNotification(eventNotification: EventNotification) async {
+		log.debug("Handle event: \(String(describing: eventNotification.event))")
+		subject.send(eventNotification)
+	}
+}