Merge pull request #1 from swift-libp2p/ssh-route

Initial Implementation

Author: btoms20

.gitignore

@@ -11,3 +11,4 @@ Package.resolved
 /public
 /docs
 .benchmarkBaselines
+Tests/LibP2PYAMUXTests/IntegrationTests.swift

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -1,5 +1,3 @@
-MIT License
-
 Copyright (c) 2025 swift-libp2p
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -12,10 +10,10 @@ 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.
+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

@@ -0,0 +1,58 @@
+// swift-tools-version: 6.0
+//===----------------------------------------------------------------------===//
+//
+// 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-yamux",
+    platforms: [
+        .macOS(.v10_15),
+        .iOS(.v13),
+    ],
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "LibP2PYAMUX",
+            targets: ["LibP2PYAMUX"]
+        )
+    ],
+    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.3.2")),
+
+        // NIO Test Utils
+        .package(url: "https://github.com/apple/swift-nio.git", .upToNextMajor(from: "2.0.0")),
+
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .target(
+            name: "LibP2PYAMUX",
+            dependencies: [
+                .product(name: "LibP2P", package: "swift-libp2p")
+            ]
+        ),
+        .testTarget(
+            name: "LibP2PYAMUXTests",
+            dependencies: [
+                "LibP2PYAMUX",
+                .product(name: "NIOTestUtils", package: "swift-nio"),
+            ]
+        ),
+    ]
+)

README.md

@@ -34,7 +34,7 @@ let package = Package(
     ...
     dependencies: [
         ...
-        .package(url: "https://github.com/swift-libp2p/swift-libp2p-yamux.git", .upToNextMinor(from: "0.0.1"))
+        .package(url: "https://github.com/swift-libp2p/swift-libp2p-yamux.git", .upToNextMinor(from: "0.2.0"))
     ],
         ...
         .target(
@@ -71,8 +71,8 @@ Contributions are welcomed! This code is very much a proof of concept. I can gua
 Let's make this code better together! 🤝
 
 ## Credits
-This repo is just a gnarly fork of the beautiful http2 code by the swift nio team below...
-- [Swift NIO HTTP/2](https://github.com/apple/swift-nio-http2.git)
+This repo is just a modified fork of the beautiful swift-nio-ssh repo...
+- [Swift NIO SSH](https://github.com/apple/swift-nio-ssh)
 - [YAMUX Spec](https://github.com/libp2p/specs/blob/master/yamux/README.md) 
 
 ## License

Sources/LibP2PYAMUX/ByteBuffer+Helpers.swift

@@ -0,0 +1,37 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 NIOCore
+
+//extension ByteBuffer {
+//    /// A helper function for complex readers that will reset a buffer on nil or on error, as though the read
+//    /// never occurred.
+//    internal mutating func rewindOnNilOrError<T>(_ body: (inout ByteBuffer) throws -> T?) rethrows -> T? {
+//        let originalSelf = self
+//
+//        let returnValue: T?
+//        do {
+//            returnValue = try body(&self)
+//        } catch {
+//            self = originalSelf
+//            throw error
+//        }
+//
+//        if returnValue == nil {
+//            self = originalSelf
+//        }
+//
+//        return returnValue
+//    }
+//}