Merge branch 'refactor/pwn-3297' into refactor/fix-protection-level

Author: TrGiLong

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Swift
+
+on:
+  push:
+    branches: [ refactor/pwn-3297 ]
+    paths:
+      - 'Sources/**/*'
+
+jobs:
+  docs:
+    runs-on: macos-12
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: fwcd/swift-docc-action@v1
+      with:
+        target: SolanaSwift
+        output: ./docs
+        hosting-base-path: solana-swift
+        disable-indexing: 'true'
+        transform-for-static-hosting: 'true'
+
+    - name: Init new repo for docs
+      run: |
+        cd docs
+        git init
+        git add -A
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git commit -m 'deploy'
+
+    - name: Force push to destination branch
+      uses: ad-m/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: docs
+        force: true
+        directory: ./docs

.github/workflows/unit-test.yml

@@ -0,0 +1,13 @@
+name: On pull request
+
+on: [ pull_request ]
+
+jobs:
+  unit-test:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build source code
+        run: swift build
+      - name: Run tests
+        run: swift test --filter "SolanaSwiftUnitTests"

.gitignore

@@ -42,4 +42,4 @@ Carthage/Build
 OrcaSwapTransitiveTests-Secret.swift
 
 .build
-.idea
+.idea

Package.resolved

@@ -6,8 +6,8 @@
         "repositoryURL": "https://github.com/bigearsenal/loggerswift.git",
         "state": {
           "branch": null,
-          "revision": "bbb62757aca270f8bb6489de50b48ae424daf913",
-          "version": "1.0.0"
+          "revision": "779dbd11a9a2fea3c82943f69a30ca75f4596fc8",
+          "version": "1.0.2"
         }
       },
       {
@@ -19,13 +19,22 @@
           "version": "0.1.6"
         }
       },
+      {
+        "package": "SwiftDocCPlugin",
+        "repositoryURL": "https://github.com/apple/swift-docc-plugin",
+        "state": {
+          "branch": null,
+          "revision": "3303b164430d9a7055ba484c8ead67a52f7b74f6",
+          "version": "1.0.0"
+        }
+      },
       {
         "package": "Task_retrying",
         "repositoryURL": "https://github.com/bigearsenal/task-retrying-swift.git",
         "state": {
           "branch": null,
-          "revision": "1e83e99e412b27a5b1f2123493ed7ae4f2df7413",
-          "version": "1.0.1"
+          "revision": "c93fef795874cf31b7b0f8f6e9c23f4f15188dec",
+          "version": "1.0.2"
         }
       },
       {

Package.swift

@@ -21,8 +21,11 @@ let package = Package(
         .package(name: "secp256k1", url: "https://github.com/Boilertalk/secp256k1.swift.git", from: "0.1.0"),
         .package(name: "TweetNacl", url: "https://github.com/bitmark-inc/tweetnacl-swiftwrap.git", from: "1.0.2"),
 
-        .package(name: "Task_retrying", url: "https://github.com/bigearsenal/task-retrying-swift.git", from: "1.0.1"),
-        .package(name: "LoggerSwift", url: "https://github.com/bigearsenal/loggerswift.git", from: "1.0.0")
+        .package(name: "Task_retrying", url: "https://github.com/bigearsenal/task-retrying-swift.git", from: "1.0.2"),
+        .package(name: "LoggerSwift", url: "https://github.com/bigearsenal/loggerswift.git", from: "1.0.2"),
+        
+        // Docs generator
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -38,9 +41,14 @@ let package = Package(
 //            resources: [ .process("Resources") ]
         ),
         .testTarget(
-            name: "SolanaSwiftTests",
+            name: "SolanaSwiftUnitTests",
             dependencies: ["SolanaSwift"]
 //            resources: [ .process("Resources") ]
         ),
+        .testTarget(
+            name: "SolanaSwiftIntegrationTests",
+            dependencies: ["SolanaSwift"]
+//            resources: [ .process("Resources") ]
+        )
     ]
 )

README.md

@@ -5,6 +5,7 @@ Solana-blockchain client, written in pure swift.
 [![Version](https://img.shields.io/cocoapods/v/SolanaSwift.svg?style=flat)](https://cocoapods.org/pods/SolanaSwift)
 [![License](https://img.shields.io/cocoapods/l/SolanaSwift.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0.html)
 [![Platform](https://img.shields.io/cocoapods/p/SolanaSwift.svg?style=flat)](https://cocoapods.org/pods/SolanaSwift)
+[![Documentation Status](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://p2p-org.github.io/solana-swift/documentation/solanaswift)
 
 ## Features
 - [x] Key pairs generation

Sources/SolanaSwift/APIClient/APIClient+Extension.swift

@@ -183,4 +183,28 @@ extension SolanaAPIClient {
         }
         return knownWallets + wallets
     }
+    
+    /// Wait until transaction is confirmed, return even when there is one or more confirmations and request timed out
+    /// - Parameters:
+    ///   - signature: signature of the transaction
+    ///   - ignoreStatus: ignore status and return true even when observation is timed out
+    public func waitForConfirmation(signature: String, ignoreStatus: Bool, timeout: Int = 60, delay: Int = 2) async throws {
+        var statuses = [TransactionStatus]()
+        for try await status in observeSignatureStatus(signature: signature, timeout: timeout, delay: delay) {
+            statuses.append(status)
+        }
+        
+        // if the status is important
+        if !ignoreStatus {
+            guard let lastStatus = statuses.last else {
+                throw SolanaError.transactionHasNotBeenConfirmed
+            }
+            switch lastStatus {
+            case .confirmed, .finalized:
+                return
+            default:
+                throw SolanaError.transactionHasNotBeenConfirmed
+            }
+        }
+    }
 }

Sources/SolanaSwift/APIClient/APIClient.swift

@@ -243,7 +243,23 @@ public protocol SolanaAPIClient {
     ///
     func observeSignatureStatus(signature: String, timeout: Int, delay: Int) -> AsyncStream<TransactionStatus>
 
+    /// Returns a recent block hash from the ledger, and a fee schedule that can be used to compute the cost of submitting a transaction using it.
+    /// - Parameters:
+    ///  - commitment: (optional) Commitment
+    /// - Throws: APIClientError
+    /// - SeeAlso https://docs.solana.com/developing/clients/jsonrpc-api#getrecentblockhash
+    ///
     func getRecentBlockhash(commitment: Commitment?) async throws -> String
+    
+    /// Returns signatures for confirmed transactions that include the given address in their accountKeys list.
+    /// Returns signatures backwards in time from the provided signature or most recent confirmed block
+    /// - Parameters:
+    ///  - address: account address as base-58 encoded string
+    ///  - configs: (optional) Configuration object
+    /// - Throws: APIClientError
+    /// - SeeAlso https://docs.solana.com/developing/clients/jsonrpc-api#getrecentblockhash
+    ///
+    func getSignaturesForAddress(address: String, configs: RequestConfiguration?) async throws -> [SignatureInfo]
 
 }
 

Sources/SolanaSwift/APIClient/Networking/JSONRPCAPIClient.swift

@@ -178,6 +178,10 @@ public class JSONRPCAPIClient: SolanaAPIClient {
         }
     }
 
+    public func getSignaturesForAddress(address: String, configs: RequestConfiguration? = nil) async throws -> [SignatureInfo] {
+        try await self.get(method: "getSignaturesForAddress", params: [address, configs])
+    }
+    
     public func simulateTransaction(transaction: String, configs: RequestConfiguration = RequestConfiguration(encoding: "base64")!) async throws -> SimulationResult {
         let result: Rpc<SimulationResult> = try await self.get(method: "simulateTransaction", params: [transaction, configs])
         if let err = result.value.err {

Sources/SolanaSwift/BlockchainClient/Helpers/AskCoin-HD/SwiftBigInteger/SMP Bignum Extensions.swift

@@ -15,7 +15,7 @@ public typealias Bignum = BInt
 extension Bignum
 {
 	/// Representation as Data
-	var data: Data {
+	public var data: Data {
 		let n = limbs.count
 		var data = Data(count: n * 8)
 		data.withUnsafeMutableBytes { (ptr: UnsafeMutablePointer<UInt8>) -> Void in

Sources/SolanaSwift/BlockchainClient/Helpers/BIP39/Mnemonic.swift

@@ -8,7 +8,6 @@
 //
 
 import Foundation
-import CryptoKit
 import CommonCrypto
 
 public class Mnemonic {

Sources/SolanaSwift/BlockchainClient/Helpers/Borsh/BinaryReader.swift

@@ -11,8 +11,11 @@ public struct BinaryReader {
 }
 
 extension BinaryReader {
-    mutating func read(count: UInt32) -> [UInt8] {
+    mutating public func read(count: UInt32) throws -> [UInt8] {
         let newPosition = cursor + Int(count)
+        guard bytes.count >= newPosition else {
+            throw SolanaError.couldNotRetrieveAccountInfo
+        }
         let result = bytes[cursor..<newPosition]
         cursor = newPosition
         return Array(result)

Sources/SolanaSwift/BlockchainClient/Helpers/Borsh/BorshDeserialize.swift

@@ -11,7 +11,7 @@ enum DeserializationError: Error {
 public extension FixedWidthInteger {
   init(from reader: inout BinaryReader) throws {
     var value: Self = .zero
-    let bytes = reader.read(count: UInt32(MemoryLayout<Self>.size))
+    let bytes = try reader.read(count: UInt32(MemoryLayout<Self>.size))
     let size = withUnsafeMutableBytes(of: &value, { bytes.copyBytes(to: $0) })
     assert(size == MemoryLayout<Self>.size)
     self = Self(littleEndian: value)
@@ -32,7 +32,7 @@ extension Int128: BorshDeserializable {}
 extension Float32: BorshDeserializable {
   public init(from reader: inout BinaryReader) throws {
     var value: Self = .zero
-    let bytes = reader.read(count: UInt32(MemoryLayout<Self>.size))
+    let bytes = try reader.read(count: UInt32(MemoryLayout<Self>.size))
     let size = withUnsafeMutableBytes(of: &value, { bytes.copyBytes(to: $0) })
     assert(size == MemoryLayout<Self>.size)
     assert(!value.isNaN, "For portability reasons we do not allow to deserialize NaNs.")
@@ -43,7 +43,7 @@ extension Float32: BorshDeserializable {
 extension Float64: BorshDeserializable {
   public init(from reader: inout BinaryReader) throws {
     var value: Self = .zero
-    let bytes = reader.read(count: UInt32(MemoryLayout<Self>.size))
+    let bytes = try reader.read(count: UInt32(MemoryLayout<Self>.size))
     let size = withUnsafeMutableBytes(of: &value, { bytes.copyBytes(to: $0) })
     assert(size == MemoryLayout<Self>.size)
     assert(!value.isNaN, "For portability reasons we do not allow to deserialize NaNs.")
@@ -54,7 +54,7 @@ extension Float64: BorshDeserializable {
 extension Bool: BorshDeserializable {
   public init(from reader: inout BinaryReader) throws {
     var value: Self = false
-    let bytes = reader.read(count: UInt32(MemoryLayout<Self>.size))
+    let bytes = try reader.read(count: UInt32(MemoryLayout<Self>.size))
     let size = withUnsafeMutableBytes(of: &value, { bytes.copyBytes(to: $0) })
     assert(size == MemoryLayout<Self>.size)
     self = value
@@ -74,7 +74,7 @@ extension Optional where Wrapped: BorshDeserializable {
 extension String: BorshDeserializable {
   public init(from reader: inout BinaryReader) throws {
     let count: UInt32 = try .init(from: &reader)
-    let bytes = reader.read(count: count)
+    let bytes = try reader.read(count: count)
     guard let value = String(bytes: bytes, encoding: .utf8) else {throw DeserializationError.noData}
     self = value
   }

Sources/SolanaSwift/Helpers/URLSession+Async.swift

@@ -1,8 +1,9 @@
 import Foundation
 
 @available(iOS, deprecated: 15.0, message: "Use the built-in API instead")
+@available(macOS, deprecated: 12.0, message: "Use the built-in API instead")
 extension URLSession {
-    func data(from url: URL) async throws -> (Data, URLResponse) {
+    func data(for url: URL) async throws -> (Data, URLResponse) {
         try await withCheckedThrowingContinuation { continuation in
             let task = self.dataTask(with: url) { data, response, error in
                 guard let data = data, let response = response else {
@@ -17,7 +18,7 @@ extension URLSession {
         }
     }
 
-    func data(from urlRequest: URLRequest) async throws -> (Data, URLResponse) {
+    func data(for urlRequest: URLRequest) async throws -> (Data, URLResponse) {
         try await withCheckedThrowingContinuation { continuation in
             let task = self.dataTask(with: urlRequest) { data, response, error in
                 guard let data = data, let response = response else {

Sources/SolanaSwift/Helpers/URLSession+NetworkManager.swift

@@ -4,11 +4,7 @@ extension URLSession: NetworkManager {
 
     public func requestData(request: URLRequest) async throws -> Data {
         let (data, _): (Data, URLResponse)
-        if #available(iOS 15.0, macOS 12.0, *) {
-            (data, _) = try await self.data(for: request)
-        } else {
-            (data, _) = try await self.data(from: request)
-        }
+        (data, _) = try await self.data(for: request)
         return data
     }
 }

Sources/SolanaSwift/Models/BufferLayout/BufferLayout.swift

@@ -3,9 +3,7 @@ import Foundation
 public enum BufferLayoutError: Error {
     case NotImplemented
 }
-public protocol BufferLayout: Codable, BorshCodable {
-    static var BUFFER_LENGTH: UInt64 { get }
-}
+public protocol BufferLayout: Codable, BorshCodable {}
 
 extension BufferLayout {
     public init(from decoder: Decoder) throws {
@@ -19,21 +17,17 @@ extension BufferLayout {
 
         // Unable to get parsed data, fallback to decoding base64
         let stringData = (try? container.decode([String].self).first) ?? (try? container.decode(String.self))
-        guard let string = stringData,
-              let data = Data(base64Encoded: string)
-        else {
+        guard let string = stringData else {
             throw SolanaError.couldNotRetrieveAccountInfo
         }
 
         if string.isEmpty && !(Self.self == EmptyInfo.self) {
             throw SolanaError.couldNotRetrieveAccountInfo
         }
 
-        do {
-            var reader = BinaryReader(bytes: data.bytes)
-            try self.init(from: &reader)
-        } catch {
-            throw SolanaError.couldNotRetrieveAccountInfo
-        }
+        let data = Data(base64Encoded: string) ?? Data(Base58.decode(string))
+        
+        var reader = BinaryReader(bytes: data.bytes)
+        try self.init(from: &reader)
     }
 }

Sources/SolanaSwift/Models/Models.swift

@@ -11,6 +11,14 @@ public struct Response<T: Decodable>: Decodable {
     public let result: T?
     public let error: ResponseError?
     public let method: String?
+    
+    // socket
+    public let params: SocketParams<T>?
+}
+
+public struct SocketParams<T: Decodable>: Decodable {
+    public let result: Rpc<T>?
+    public let subscription: UInt64?
 }
 
 public struct ResponseError: Decodable {
@@ -145,6 +153,14 @@ public struct BufferInfo<T: BufferLayout>: Decodable {
     public let rentEpoch: UInt64
 }
 
+public struct BufferInfoParsed<T: Decodable>: Decodable {
+    public let lamports: Lamports
+    public let owner: String
+    public let data: T?
+    public let executable: Bool
+    public let rentEpoch: UInt64
+}
+
 public struct PerformanceSample: Decodable {
     public let numSlots: UInt64
     public let numTransactions: UInt64

Sources/SolanaSwift/Models/SolanaError.swift

@@ -40,6 +40,9 @@ public enum SolanaError: Swift.Error, Equatable {
     // Socket error
     case socket(Swift.Error)
 
+    // Transaction has not been confirmed
+    case transactionHasNotBeenConfirmed
+    
     // Other
     case other(String)
     case unknown
@@ -48,4 +51,8 @@ public enum SolanaError: Swift.Error, Equatable {
     public static var couldNotRetrieveAccountInfo: Self {
         .other("Could not retrieve account info")
     }
+    
+    public static var couldNotRetrieveBuffer: Self {
+        .other("Could not retrieve buffer")
+    }
 }