Merge pull request #4 from swift-libp2p/soundness

Soundness

Author: btoms20

.license_header_template

@@ -0,0 +1,13 @@
+@@===----------------------------------------------------------------------===@@
+@@
+@@ This source file is part of the swift-libp2p open source project
+@@
+@@ Copyright (c) YEARS swift-libp2p project authors
+@@ Licensed under MIT
+@@
+@@ See LICENSE for license information
+@@ See CONTRIBUTORS for the list of swift-libp2p project authors
+@@
+@@ SPDX-License-Identifier: MIT
+@@
+@@===----------------------------------------------------------------------===@@

.licenseignore

@@ -0,0 +1,10 @@
+.github/workflows/configs/.flake8
+**/*.yml
+*.md
+*.txt
+Package.swift
+Package.resolved
+.gitignore
+.swift-format
+.licenseignore
+.license_header_template

.swift-format

@@ -0,0 +1,68 @@
+{
+  "version" : 1,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 120,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "noAssignmentInExpressions" : {
+    "allowedFunctions" : [
+      "XCTAssertNoThrow",
+      "XCTAssertThrowsError"
+    ]
+  },
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2025 swift-libp2p
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

Package.swift

@@ -1,43 +1,58 @@
-// swift-tools-version: 5.4
-// The swift-tools-version declares the minimum version of Swift required to build this package.
+// swift-tools-version: 5.5
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-libp2p open source project
+//
+// Copyright (c) 2022-2025 swift-libp2p project authors
+// Licensed under MIT
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of swift-libp2p project authors
+//
+// SPDX-License-Identifier: MIT
+//
+//===----------------------------------------------------------------------===//
 
 import PackageDescription
 
 let package = Package(
     name: "swift-libp2p-mplex",
     platforms: [
         .macOS(.v10_15),
-        .iOS(.v13)
+        .iOS(.v13),
     ],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
             name: "LibP2PMPLEX",
-            targets: ["LibP2PMPLEX"]),
+            targets: ["LibP2PMPLEX"]
+        )
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        
+
         // LibP2P Core Modules
         .package(url: "https://github.com/swift-libp2p/swift-libp2p.git", .upToNextMinor(from: "0.1.0")),
-        
+
         // NIO Test Utils
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.0.0"),
-        
+
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "LibP2PMPLEX",
             dependencies: [
-                .product(name: "LibP2P", package: "swift-libp2p"),
-            ]),
+                .product(name: "LibP2P", package: "swift-libp2p")
+            ]
+        ),
         .testTarget(
             name: "LibP2PMPLEXTests",
             dependencies: [
                 "LibP2PMPLEX",
                 .product(name: "NIOTestUtils", package: "swift-nio"),
-            ]),
+            ]
+        ),
     ]
 )

Sources/LibP2PMPLEX/LibP2PMPLEX.swift

@@ -1,29 +1,43 @@
-import NIO
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-libp2p open source project
+//
+// Copyright (c) 2022-2025 swift-libp2p project authors
+// Licensed under MIT
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of swift-libp2p project authors
+//
+// SPDX-License-Identifier: MIT
+//
+//===----------------------------------------------------------------------===//
+
 import LibP2P
 import LibP2PCore
+import NIO
 
 protocol MessageExtractable {
     func messageBytes() -> ByteBuffer
 }
 
-protocol MessageExtractableHandler:ChannelInboundHandler where InboundOut:MessageExtractable { }
+protocol MessageExtractableHandler: ChannelInboundHandler where InboundOut: MessageExtractable {}
 
 public struct MPLEX: MuxerUpgrader {
-    
-    public static let key:String = MPLEXStreamMultiplexer.protocolCodec
-    let application:Application
+
+    public static let key: String = MPLEXStreamMultiplexer.protocolCodec
+    let application: Application
 
     public func upgradeConnection(_ conn: Connection, muxedPromise: EventLoopPromise<Muxer>) -> EventLoopFuture<Void> {
-        return conn.channel.pipeline.addHandlers(
+        conn.channel.pipeline.addHandlers(
             [
                 ByteToMessageHandler(MPLEXFrameDecoder()),
                 MessageToByteHandler(MPLEXFrameEncoder()),
-                MPLEXStreamMultiplexer(connection: conn, muxedPromise: muxedPromise, supportedProtocols: [])
+                MPLEXStreamMultiplexer(connection: conn, muxedPromise: muxedPromise, supportedProtocols: []),
             ],
             position: .last
         )
     }
-    
+
     public func printSelf() {
         application.logger.notice("Hi I'm MPLEX v6.7.0")
     }

Sources/LibP2PMPLEX/MPLEX/MPLEXErrorCode.swift

@@ -1,5 +1,19 @@
 //===----------------------------------------------------------------------===//
 //
+// This source file is part of the swift-libp2p open source project
+//
+// Copyright (c) 2022-2025 swift-libp2p project authors
+// Licensed under MIT
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of swift-libp2p project authors
+//
+// SPDX-License-Identifier: MIT
+//
+//===----------------------------------------------------------------------===//
+//
+//===----------------------------------------------------------------------===//
+//
 // This source file is part of the SwiftNIO open source project
 //
 // Copyright (c) 2017-2021 Apple Inc. and the SwiftNIO project authors
@@ -11,12 +25,6 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 //===----------------------------------------------------------------------===//
-//
-//  MPLEXErrorCode.swift
-//
-//
-//  Modified by Brandon Toms on 5/1/22.
-//
 
 import NIOCore
 
@@ -25,7 +33,7 @@ public struct MPLEXErrorCode {
     /// The underlying network representation of the error code.
     public var networkCode: Int {
         get {
-            return Int(self._networkCode)
+            Int(self._networkCode)
         }
         set {
             self._networkCode = UInt32(newValue)
@@ -85,9 +93,9 @@ public struct MPLEXErrorCode {
 
 }
 
-extension MPLEXErrorCode: Equatable { }
+extension MPLEXErrorCode: Equatable {}
 
-extension MPLEXErrorCode: Hashable { }
+extension MPLEXErrorCode: Hashable {}
 
 extension MPLEXErrorCode: CustomDebugStringConvertible {
     public var debugDescription: String {
@@ -121,28 +129,28 @@ extension MPLEXErrorCode: CustomDebugStringConvertible {
     }
 }
 
-public extension UInt32 {
+extension UInt32 {
     /// Create a 32-bit integer corresponding to the given `MPLEXErrorCode`.
-    init(mplexErrorCode code: MPLEXErrorCode) {
+    public init(mplexErrorCode code: MPLEXErrorCode) {
         self = code._networkCode
     }
 }
 
-public extension Int {
+extension Int {
     /// Create an integer corresponding to the given `MPLEXErrorCode`.
-    init(mplexErrorCode code: MPLEXErrorCode) {
+    public init(mplexErrorCode code: MPLEXErrorCode) {
         self = code.networkCode
     }
 }
 
-public extension ByteBuffer {
+extension ByteBuffer {
     /// Serializes a `MPLEXErrorCode` into a `ByteBuffer` in the appropriate endianness
     /// for use in MPLEX.
     ///
     /// - parameters:
     ///     - code: The `MPLEXErrorCode` to serialize.
     /// - returns: The number of bytes written.
-    mutating func write(mplexErrorCode code: MPLEXErrorCode) -> Int {
-        return self.writeInteger(UInt32(mplexErrorCode: code))
+    public mutating func write(mplexErrorCode code: MPLEXErrorCode) -> Int {
+        self.writeInteger(UInt32(mplexErrorCode: code))
     }
 }