Fixed visibility, added more marks

Author: posplaw

SubstrateClientSwift/Classes/Extrinsics/Call.swift

@@ -19,12 +19,15 @@
 import Foundation
 
 /// An extrinsic call
-public class Call<T: Codable> {
-    let moduleName: String
-    let name: String
-    let value: T
+open class Call<T: Codable> {
+    /// Pallet name
+    public let moduleName: String
+    /// Call name
+    public let name: String
+    /// Call value
+    public let value: T
 
-    init(moduleName: String, name: String, value: T) {
+    public init(moduleName: String, name: String, value: T) {
         self.moduleName = moduleName
         self.name = name
         self.value = value

SubstrateClientSwift/Classes/Extrinsics/Era.swift

@@ -29,6 +29,7 @@ public enum Era: Equatable, Codable {
     case mortal(value: Mortal)
 }
 
+/// Mortal era value
 public struct Mortal: Equatable, Codable {
     public let period: UInt64
     public let phase: UInt64

SubstrateClientSwift/Classes/Extrinsics/ExtrinsicAdditional.swift

@@ -19,7 +19,7 @@
 import Foundation
 
 /// Extrinsic possible errors
-enum ExtrinsicError: Error {
+public enum ExtrinsicError: Error {
     // used in service
     case runtimeVersionNotLoaded
     case genesisHashNotLoaded(RpcError?)

SubstrateClientSwift/Classes/Extrinsics/ExtrinsicError.swift

@@ -24,7 +24,7 @@ struct DefaultHashersProvider: HashersProvider {
     /// - Parameters:
     ///     - storage: Runtime module storage for which storage hashing interface is returned
     /// - Returns: Storage hashing interface for a runtime module
-    func getStorageHasher(storage: RuntimeModuleStorage) -> StorageHashing {
+    func storageHasher(for storage: RuntimeModuleStorage) -> StorageHashing {
         StorageHasher(storage: storage)
     }
 }

SubstrateClientSwift/Classes/Hashers/DefaultHashersProvider.swift

@@ -24,5 +24,5 @@ protocol HashersProvider {
     /// - Parameters:
     ///     - storage: The module storage which needs to be hashed
     /// - Returns: A storage hasher
-    func getStorageHasher(storage: RuntimeModuleStorage) -> StorageHashing
+    func storageHasher(for storage: RuntimeModuleStorage) -> StorageHashing
 }

SubstrateClientSwift/Classes/Hashers/HashersProvider.swift

@@ -19,6 +19,8 @@
 import Foundation
 import ScaleCodecSwift
 
+// MARK: - Protocol
+
 /// An interface for chain client
 public protocol ChainModule: AnyObject {
     /// Gets block hash using the provided number as a parameter for `RPC` request
@@ -28,6 +30,8 @@ public protocol ChainModule: AnyObject {
     func blockHash(number: UInt) async throws -> String?
 }
 
+// MARK: - Implementation
+
 /// Handles chain block hash fetching
 final class ChainModuleClient: ChainModule {
     private weak var rpcClient: Rpc?

SubstrateClientSwift/Classes/Modules/Chain/ChainModule.swift

@@ -18,13 +18,15 @@
 
 import Foundation
 
-struct AddMemo: Codable {
-    let index: UInt32
-    let memo: Data
+/// crowdloan/addMemo call value
+public struct AddMemo: Codable {
+    public let index: UInt32
+    public let memo: Data
 }
 
-final class AddMemoCall: Call<AddMemo> {
-    init(value: AddMemo) {
+/// crowdloan/addMemo call
+public final class AddMemoCall: Call<AddMemo> {
+    public init(value: AddMemo) {
         super.init(moduleName: "crowdloan", name: "add_memo", value: value)
     }
 }

SubstrateClientSwift/Classes/Substrate/Support/Extrinsics/AddMemo.swift renamed to SubstrateClientSwift/Classes/Modules/Crowdloan/Calls/AddMemo.swift

@@ -21,11 +21,11 @@ import ScaleCodecSwift
 
 /// Default module provider
 final class DefaultModuleProvider: InternalModuleProvider {
-    weak var constants: SubstrateConstants?
-    weak var storage: SubstrateStorage?
-    weak var codec: ScaleCoder?
-    let rpcClient: Rpc // Holder of rpc client
-    let hashersProvider: HashersProvider
+    internal weak var constants: SubstrateConstants?
+    internal weak var storage: SubstrateStorage?
+    private weak var codec: ScaleCoder?
+    private let rpcClient: Rpc // Holder of rpc client
+    private let hashersProvider: HashersProvider
 
     init(
         codec: ScaleCoder,

SubstrateClientSwift/Classes/Modules/DefaultModuleProvider.swift

@@ -19,6 +19,8 @@
 import Foundation
 import ScaleCodecSwift
 
+// MARK: - Protocol
+
 /// An interface for getting a query fee details response
 public protocol PaymentModule {
     /// Gets query fee details for a payload
@@ -28,6 +30,8 @@ public protocol PaymentModule {
     func queryFeeDetails(payload: Payload) async throws -> QueryFeeDetails?
 }
 
+// MARK: - Implementation
+
 /// Handles payment query fee details fetching
 final class PaymentModuleClient: PaymentModule {
     private weak var rpcClient: Rpc?

SubstrateClientSwift/Classes/Modules/Payment/PaymentModule.swift

@@ -27,7 +27,7 @@ public struct QueryFeeDetails: Decodable {
     public let adjustedWeightFee: Balance
 }
 
-class QueryFeeDetailsResponse: Codable {
+final class QueryFeeDetailsResponse: Codable {
     let inclusionFee: InclusionFee
 
     init(inclusionFee: InclusionFee) {

SubstrateClientSwift/Classes/Modules/Payment/Types/QueryFeeDetails.swift

@@ -20,6 +20,8 @@ import Foundation
 import ScaleCodecSwift
 import CommonSwift
 
+// MARK: - Protocol
+
 /// Interface for getting Runtime metadata and fetching Storage Items
 public protocol StateModule: AnyObject {
     /// Gets runtime metadata
@@ -58,6 +60,8 @@ public protocol StateModule: AnyObject {
     ) async throws -> T?
 }
 
+// MARK: - Implementation
+
 /// State module client which handles fetching storage item and runtime metadata
 final class StateModuleClient: StateModule {
     weak var codec: ScaleCoder?
@@ -81,7 +85,7 @@ final class StateModuleClient: StateModule {
         item: RuntimeModuleStorageItem,
         storage: RuntimeModuleStorage
     ) async throws -> T? {
-        let key = try hashersProvider.getStorageHasher(storage: storage).hash(storageItem: item, keys: [])
+        let key = try hashersProvider.storageHasher(for: storage).hash(storageItem: item, keys: [])
         return try await fetchStorageItem(key: key)
     }
 
@@ -90,7 +94,7 @@ final class StateModuleClient: StateModule {
         key: Data,
         storage: RuntimeModuleStorage
     ) async throws -> T? {
-        let key = try hashersProvider.getStorageHasher(storage: storage).hash(storageItem: item, keys: [key])
+        let key = try hashersProvider.storageHasher(for: storage).hash(storageItem: item, keys: [key])
         return try await fetchStorageItem(key: key)
     }
 
@@ -99,7 +103,7 @@ final class StateModuleClient: StateModule {
         keys: [Data],
         storage: RuntimeModuleStorage
     ) async throws -> T? {
-        let key = try hashersProvider.getStorageHasher(storage: storage).hash(storageItem: item, keys: keys)
+        let key = try hashersProvider.storageHasher(for: storage).hash(storageItem: item, keys: keys)
         return try await fetchStorageItem(key: key)
     }
 

SubstrateClientSwift/Classes/Modules/State/StateModule.swift

@@ -20,6 +20,8 @@ import EncryptingSwift
 import Foundation
 import HashingSwift
 
+// MARK: - Protocol
+
 /// An interface for fetching runtime version and account
 public protocol SystemModule: AnyObject {
     /// Gets runtime version
@@ -57,6 +59,8 @@ public protocol SystemModule: AnyObject {
     func account(keyPair: KeyPair) async throws -> Account?
 }
 
+// MARK: - Implementation
+
 final class SystemModuleClient: SystemModule {
     enum Error: Swift.Error {
         case hexDecodeFailed

SubstrateClientSwift/Classes/Modules/System/SystemModule.swift

@@ -18,6 +18,5 @@
 
 import Foundation
 
-/// An "empty" object representing nothing
-public struct Nothing: Codable {
-}
+/// An "empty" object representing nothing, used in RPC client for empty requests or responses
+public struct Nothing: Codable {}

SubstrateClientSwift/Classes/RPC/Nothing.swift

@@ -18,13 +18,17 @@
 
 import Foundation
 
+// MARK: - Error
+
 /// Possible RPC errors
 public enum RpcError: Error {
     case failedToPrepareRequest
     case bodyEncodingFailed(Error)
     case responseError(RpcResponseError)
 }
 
+// MARK: - Protocol
+
 /// An interface for RPC client that handles sending requests
 public protocol Rpc: AnyObject {
     /// Sends a ready `RpcRequest`.
@@ -89,6 +93,8 @@ public protocol Rpc: AnyObject {
     ) async throws -> Response?
 }
 
+// MARK: - Implementation
+
 /// RPC client that handles sending requests
 public final class RpcClient: Rpc {
     private enum Constants {

SubstrateClientSwift/Classes/RPC/RpcClient.swift

@@ -31,7 +31,6 @@ final class DynamicAdapter<T>: ScaleCodecAdapter<T> {
         super.init()
     }
 
-    // MARK: - ScaleCodecAdapter
     /// Decodes data dynamically to a specified generic type `T` using the provided `DataReader`
     /// - Parameters:
     ///     - type: Generic type `T` to which the data should be decoded

SubstrateClientSwift/Classes/Scale/DynamicAdapter.swift

@@ -19,7 +19,7 @@
 import Foundation
 
 /// Dynamic adapter errors
-enum DynamicAdapterError: Error {
+public enum DynamicAdapterError: Error {
     case dynamicAdapterGivenInvalidType
     case typeIsNotDynamicException
     case typeIsNotFoundInRuntimeMetadataException