Workaround for new XCFramework

Author: csjones

.github/workflows/xcframework-release.yml

@@ -74,6 +74,31 @@ jobs:
               -archive "Archives/P256K-watchOS.xcarchive" -framework P256K.framework \
               -archive "Archives/P256K-watchOS Simulator.xcarchive" -framework P256K.framework \
               -output P256K.xcframework
+
+            # Workaround for Swift issue SR-14195/GitHub #56573:
+            # When a module has the same name as a type it contains (P256K in this case),
+            # Swift generates invalid module interfaces with incorrect type qualifications.
+            # This leads to imports failing with errors like:
+            # "TypeName is not a member type of class ModuleName.ModuleName"
+            #
+            # This script fixes generated .swiftinterface files by:
+            # 1. Removing double-qualification of the P256K type
+            # 2. Fixing references to other types that don't need module qualification
+            # See: https://github.com/swiftlang/swift/issues/56573
+            find P256K.xcframework -name '*.swiftinterface' -print0 \
+              | xargs -0 sed -i '' \
+                  -e 's/extension P256K\.P256K/extension P256K/g' \
+                  -e 's/P256K\.P256K\./P256K\./g' \
+                  -e 's/[[:<:]]P256K\.secp256k1Error[[:>:]]/secp256k1Error/g' \
+                  -e 's/[[:<:]]P256K\.Digest[[:>:]]/Digest/g' \
+                  -e 's/[[:<:]]P256K\.CryptoKitError[[:>:]]/CryptoKitError/g' \
+                  -e 's/[[:<:]]P256K\.CryptoKitASN1Error[[:>:]]/CryptoKitASN1Error/g' \
+                  -e 's/[[:<:]]P256K\.SHA256Digest[[:>:]]/SHA256Digest/g' \
+                  -e 's/[[:<:]]P256K\.XonlyKeyImplementation[[:>:]]/XonlyKeyImplementation/g' \
+                  -e 's/[[:<:]]P256K\.HashDigest[[:>:]]/HashDigest/g' \
+                  -e 's/[[:<:]]P256K\.SharedSecret[[:>:]]/SharedSecret/g' \
+                  -e 's/[[:<:]]P256K\.PublicKeyImplementation[[:>:]]/PublicKeyImplementation/g' \
+                  -e 's/[[:<:]]P256K\.PrivateKeyImplementation[[:>:]]/PrivateKeyImplementation/g'
       - name: 7z XCFramework
         run: |
           7z a -tzip -mx=9 P256K.xcframework.zip P256K.xcframework

Package.swift

@@ -14,7 +14,7 @@ let package = Package(
     dependencies: [
         // Dependencies used for package development
         .package(url: "https://github.com/csjones/lefthook-plugin.git", exact: "1.11.11"),
-        .package(url: "https://github.com/21-DOT-DEV/swift-plugin-tuist.git", exact: "4.43.2"),
+        .package(url: "https://github.com/21-DOT-DEV/swift-plugin-tuist.git", exact: "4.48.1"),
         .package(url: "https://github.com/nicklockwood/SwiftFormat.git", exact: "0.55.5"),
         .package(url: "https://github.com/realm/SwiftLint.git", exact: "0.59.1")
     ],

Projects/Resources/P256K/Release.xcconfig

@@ -80,6 +80,13 @@ VALIDATE_PRODUCT = YES
 
 SKIP_INSTALL = NO
 
+// Build Library for Distribution
+// 
+// Enables Swift's Library Evolution mode, which generates .swiftinterface files.
+// This allows clients to use the library even when compiled with different Swift versions.
+
+BUILD_LIBRARY_FOR_DISTRIBUTION = YES
+
 
 //********************************************//
 //*      Apple Clang - Code Generation       *//

Projects/Resources/P256K/Shared.xcconfig

@@ -1,5 +1,5 @@
 //
-// Debug.xcconfig
+// Shared.xcconfig
 //
 // Generated by BuildSettingExtractor on 1/22/25
 // https://buildsettingextractor.com

Tests/XCFrameworkTests/XCFrameworkTests.swift

@@ -17,7 +17,7 @@ struct XCFrameworkTestSuite {
         let expectedPrivateKey = "7da12cc39bb4189ac72d34fc2225df5cf36aaacdcac7e5a43963299bc8d888ed"
         let expectedPublicKey = "023521df7b94248ffdf0d37f738a4792cc3932b6b1b89ef71cddde8251383b26e7"
         let privateKeyBytes = try! expectedPrivateKey.bytes
-        let privateKey = try! secp256k1.Signing.PrivateKey(dataRepresentation: privateKeyBytes)
+        let privateKey = try! P256K.Signing.PrivateKey(dataRepresentation: privateKeyBytes)
 
         #expect(String(bytes: privateKey.dataRepresentation) == expectedPrivateKey)
         #expect(String(bytes: privateKey.publicKey.dataRepresentation) == expectedPublicKey)

bitrise.yml

@@ -158,6 +158,31 @@ workflows:
               -archive "Archives/P256K-watchOS.xcarchive" -framework P256K.framework \
               -archive "Archives/P256K-watchOS Simulator.xcarchive" -framework P256K.framework \
               -output P256K.xcframework
+
+            # Workaround for Swift issue SR-14195/GitHub #56573:
+            # When a module has the same name as a type it contains (P256K in this case),
+            # Swift generates invalid module interfaces with incorrect type qualifications.
+            # This leads to imports failing with errors like:
+            # "TypeName is not a member type of class ModuleName.ModuleName"
+            #
+            # This script fixes generated .swiftinterface files by:
+            # 1. Removing double-qualification of the P256K type
+            # 2. Fixing references to other types that don't need module qualification
+            # See: https://github.com/swiftlang/swift/issues/56573
+            find P256K.xcframework -name '*.swiftinterface' -print0 \
+              | xargs -0 sed -i '' \
+                  -e 's/extension P256K\.P256K/extension P256K/g' \
+                  -e 's/P256K\.P256K\./P256K\./g' \
+                  -e 's/[[:<:]]P256K\.secp256k1Error[[:>:]]/secp256k1Error/g' \
+                  -e 's/[[:<:]]P256K\.Digest[[:>:]]/Digest/g' \
+                  -e 's/[[:<:]]P256K\.CryptoKitError[[:>:]]/CryptoKitError/g' \
+                  -e 's/[[:<:]]P256K\.CryptoKitASN1Error[[:>:]]/CryptoKitASN1Error/g' \
+                  -e 's/[[:<:]]P256K\.SHA256Digest[[:>:]]/SHA256Digest/g' \
+                  -e 's/[[:<:]]P256K\.XonlyKeyImplementation[[:>:]]/XonlyKeyImplementation/g' \
+                  -e 's/[[:<:]]P256K\.HashDigest[[:>:]]/HashDigest/g' \
+                  -e 's/[[:<:]]P256K\.SharedSecret[[:>:]]/SharedSecret/g' \
+                  -e 's/[[:<:]]P256K\.PublicKeyImplementation[[:>:]]/PublicKeyImplementation/g' \
+                  -e 's/[[:<:]]P256K\.PrivateKeyImplementation[[:>:]]/PrivateKeyImplementation/g'
     - deploy-to-bitrise-io:
         inputs:
         - deploy_path: "$BITRISE_SOURCE_DIR/P256K.xcframework"