Multi-signatures collector integration (#235)

* Transfer SignaturesCollectorDependencies into sargon

* WIP

* Add passphrase factor source kind

* Add passphrase factor source

* Add FactorSourceIDFromHash samples

* Implement custom HDFactorSourceIdFromHash to keep track of the factor source id and the mnemonic it was created with

* Remove custom struct

* Add petition_for_factors

* Add Implement a general role with hd factor instances

* Add securified variant in EntitySecurityState

* Fix tests in petition_for_entity

* Transfer petition_for_transaction

* WIP more files

* Transfer SignaturesCollectorPreprocessor

* Implement transaction intent initializer that accepts account and identity addresses requiring auth

* Allow signing inputs in tests from associated mnemonics

* Transfer signatures collector tests

* Transfer remaining signatures_collector tests

* Include integration tests

* Rebase with main

* Remove Ord impl for Persona and Account

* Address todo comments

* Format code

* Fix errors in swift tests

* Remove comment

* Fix ide errors

* Add doc

* Add doc

* Remove doc

* Associate entity samples with entity address samples

* Add doc

* Rename

* Remove doc

* Destructure value

* Hide from function

* Rename function

* Rename general role samples

* Create HDFactorInstance directly from derivation path's params

* Rename parameter

* Expose role kind

* Add new constructor

* Return result when creating a new role

* Add apple tests for passphrase factor source

* Add doc

* Bump version

* Fix test

* Run clippy

* Run fmt

apple/Sources/Sargon/Extensions/Methods/Profile/Factor/PassphraseFactorSource+Functions.swift

@@ -0,0 +1,18 @@
+//
+//  File.swift
+//
+//
+//  Created by Alexander Cyon on 2024-06-02.
+//
+
+import Foundation
+import SargonUniFFI
+
+extension PassphraseFactorSource {
+
+	public init(
+		mnemonicWithPassphrase mwp: MnemonicWithPassphrase
+	) {
+		self = newPassphraseFactorSourceFromMnemonicWithPassphrase(mwp: mwp)
+	}
+}

apple/Sources/Sargon/Extensions/SampleValues/Crypto/Derivation/BIP39/Mnemonic+SampleValues.swift

@@ -17,7 +17,9 @@ extension Mnemonic {
 	public static let sampleOffDeviceMnemonicOther: Self = newMnemonicSampleOffDeviceOther()
 	public static let sampleSecurityQuestions: Self = newMnemonicSampleSecurityQuestions()
 	public static let sampleSecurityQuestionsOther: Self = newMnemonicSampleSecurityQuestionsOther()
-
+	public static let samplePassphrase: Self = newMnemonicSamplePassphrase()
+	public static let samplePassphraseOther: Self = newMnemonicSamplePassphraseOther()
+
     public static let sample24ZooVote: Self = try! Self(phrase: "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo vote")
 
 	public static let sampleValues: [Self] = [
@@ -32,7 +34,9 @@ extension Mnemonic {
 		.sampleOffDeviceMnemonic,
 		.sampleOffDeviceMnemonicOther,
 		.sampleSecurityQuestions,
-		.sampleSecurityQuestionsOther
+		.sampleSecurityQuestionsOther,
+		.samplePassphrase,
+		.samplePassphraseOther
 	]
 }
 #endif // DEBUG

apple/Sources/Sargon/Extensions/SampleValues/Profile/Factor/FactorSource/PassphraseFactorSource+SampleValues.swift

@@ -0,0 +1,19 @@
+//
+//  PassphraseFactorSource+SampleValues.swift
+//
+//
+//  Created by Michael Bakogiannis on 7/10/24.
+//
+
+import Foundation
+import SargonUniFFI
+
+#if DEBUG
+extension PassphraseFactorSource {
+	public static let sample: Self = newPassphraseFactorSourceSample()
+
+	public static let sampleOther: Self = newPassphraseFactorSourceSampleOther()
+}
+
+#endif // DEBUG
+

apple/Sources/Sargon/Extensions/Swiftified/Profile/Factor/FactorSource/FactorSource+Swiftified.swift

@@ -18,6 +18,7 @@ extension FactorSource: Identifiable {
 		case let .ledger(value): value.id.asGeneral
 		case let .offDeviceMnemonic(value): value.id.asGeneral
 		case let .trustedContact(value): value.id.asGeneral
+		case let .passphrase(value): value.id.asGeneral
 		}
 	}
 }
@@ -35,6 +36,7 @@ extension FactorSource: BaseFactorSourceProtocol {
 		case let .arculusCard(value): value.factorSourceKind
 		case let .offDeviceMnemonic(value): value.factorSourceKind
 		case let .trustedContact(value): value.factorSourceKind
+		case let .passphrase(value): value.factorSourceKind
 		}
 	}
 
@@ -47,6 +49,7 @@ extension FactorSource: BaseFactorSourceProtocol {
 			case let .arculusCard(value): value.common
 			case let .offDeviceMnemonic(value): value.common
 			case let .trustedContact(value): value.common
+			case let .passphrase(value): value.common
 			}
 		}
 		set {
@@ -69,6 +72,9 @@ extension FactorSource: BaseFactorSourceProtocol {
 			case var .trustedContact(source):
 				source.common = newValue
 				self = .trustedContact(value: source)
+			case var .passphrase(source):
+				source.common = newValue
+				self = .passphrase(value: source)
 			}
 		}
 	}
@@ -112,4 +118,7 @@ extension FactorSource: BaseFactorSourceProtocol {
 	public var asTrustedContact: TrustedContactFactorSource? {
 		extract()
 	}
+	public var asPassphrase: PassphraseFactorSource? {
+        extract()
+    }
 }

apple/Sources/Sargon/Extensions/Swiftified/Profile/Factor/FactorSource/PassphraseFactorSource+Swiftified.swift

@@ -0,0 +1,38 @@
+//
+//  PassphraseFactorSource+Swiftified.swift
+//
+//
+//  Created by Michael Bakogiannis on 7/10/24.
+//
+
+import Foundation
+import SargonUniFFI
+
+extension PassphraseFactorSource: SargonModel {}
+extension PassphraseFactorSource: Identifiable {
+	public typealias ID = FactorSourceIDFromHash
+}
+
+extension PassphraseFactorSource: FactorSourceProtocol {
+	public static let kind: FactorSourceKind = .passphrase
+
+	public static func extract(from someFactorSource: some BaseFactorSourceProtocol) -> Self? {
+		guard case let .passphrase(factorSource) = someFactorSource.asGeneral else { return nil }
+		return factorSource
+	}
+
+	public var asGeneral: FactorSource {
+		.passphrase(value: self)
+	}
+
+	public var factorSourceID: FactorSourceID {
+		id.asGeneral
+	}
+
+	public var factorSourceKind: FactorSourceKind {
+		.passphrase
+	}
+
+	public var supportsOlympia: Bool { asGeneral.supportsOlympia }
+	public var supportsBabylon: Bool { asGeneral.supportsBabylon }
+}

apple/Sources/Sargon/Protocols/EntityProtocol.swift

@@ -45,13 +45,17 @@ extension EntityBaseProtocol {
 				factorInstances.insert(authSigning)
 			}
 			return factorInstances
+		case .securified(value: let value):
+			return []
 		}
 	}
 
 	public var hasAuthenticationSigningKey: Bool {
 		switch securityState {
 		case let .unsecured(unsecuredEntityControl):
 			unsecuredEntityControl.authenticationSigning != nil
+		case .securified(value: let value):
+			false // TODO handle that in the future
 		}
 	}
 
@@ -64,6 +68,8 @@ extension EntityBaseProtocol {
 			}
 
 			return factorSourceID
+		case .securified(value: _):
+			return nil // TODO handle that in the future
 		}
 	}
 }

apple/Tests/TestCases/Profile/EntitySecurityStateTests.swift

@@ -12,19 +12,3 @@ import SargonUniFFI
 import XCTest
 
 final class EntitySecurityStateTests: Test<EntitySecurityState> {}
-
-#if DEBUG
-extension EntitySecurityState {
-	public var unsecured: UnsecuredEntityControl {
-		get {
-			switch self {
-			case let .unsecured(value):
-				return value
-			}
-		}
-		set {
-			self = .unsecured(value: newValue)
-		}
-	}
-}
-#endif // DEBUG