Implement lint for GraphQL core function objects

Author: Marcus Arnett

Sources/SuiKit/Types/Structs/GraphQL/GraphQLClient.swift

@@ -1,16 +1,40 @@
 //
-//  File.swift
-//  
+//  GraphQLClient.swift
+//  SuiKit
 //
-//  Created by Marcus Arnett on 12/19/23.
+//  Copyright (c) 2023 OpenDive
+//
+//  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.
 //
 
 import Foundation
 import Apollo
 import ApolloAPI
 
-public struct GraphQLClient {
-    public static func fetchQuery<T: GraphQLQuery>(client: ApolloClient, query: T) async throws -> GraphQLResult<T.Data> {
+/// A wrapper struct for being able to query data from the GraphQL node.
+internal struct GraphQLClient {
+    /// Given the Apollo client and a query that conforms to the GraphQLQuery type, fetch data from that endpoint and return the conformed object representing the data.
+    /// - Parameters:
+    ///   - client: The Apollo client used for sending the query out.
+    ///   - query: The query itself containing information such as user inputs parameters, the endpoint itself, and various other metadata for making the GraphQL client functional.
+    /// - Returns: A GraphQLResult object of either T.Data type, or throws an error.
+    internal static func fetchQuery<T: GraphQLQuery>(client: ApolloClient, query: T) async throws -> GraphQLResult<T.Data> {
         return try await withCheckedThrowingContinuation { (con: CheckedContinuation<GraphQLResult<T.Data>, Error>) in
             let _ = client.fetch(query: query) { result in
                 switch result {

Sources/SuiKit/Types/Structs/Provider/GraphQLSuiProvider.swift

@@ -1,5 +1,5 @@
 //
-//  SuiProvider.swift
+//  GraphQLSuiProvider.swift
 //  SuiKit
 //
 //  Copyright (c) 2023 OpenDive
@@ -235,6 +235,7 @@ public struct GraphQLSuiProvider {
         return "\(result.data!.checkpoint!.sequenceNumber)"
     }
 
+    // TODO: Implement function when write becomes available
     /// Retrieves the loaded child objects associated with a given digest from the Sui blockchain.
     /// - Parameter digest: The digest string of the parent object.
     /// - Throws: A `SuiError` if an error occurs during the JSON RPC call or if there are errors in the response data.
@@ -407,6 +408,7 @@ public struct GraphQLSuiProvider {
         return BigInt(data.checkpoint!.networkTotalTransactions!)
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the transaction response object.
     /// - Parameters:
     ///   - digest: A `String` representing the digest of the queried transaction.
@@ -454,6 +456,7 @@ public struct GraphQLSuiProvider {
         }
     }
 
+    // TODO: Implement function when write becomes available
     /// Returns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds `QUERY_MAX_RESULT_LIMIT`.
     /// - Parameters:
     ///   - digests: An array of `String` representing the digests of the transaction blocks to be retrieved.
@@ -499,6 +502,7 @@ public struct GraphQLSuiProvider {
         return .versionFound(SuiObjectData(graphql: data.object!, showBcs: options?.showBcs ?? false))
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the object information for a specified version.
     ///
     /// There is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies.
@@ -618,6 +622,7 @@ public struct GraphQLSuiProvider {
         )
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the committee information for the asked `epoch`.
     /// - Parameter epoch: he epoch of interest. If None, default to the latest epoch.
     /// - Returns: A `CommitteeInfo` object containing the information of the committee for the specified epoch.
@@ -628,6 +633,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the dynamic field object information for a specified object.
     /// - Parameters:
     ///   - parentId: The ID of the queried parent object.
@@ -641,6 +647,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the dynamic field object information for a specified object.
     /// - Parameters:
     ///   - parentId: The ID of the queried parent object.
@@ -674,6 +681,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Return the latest SUI system state object on-chain.
     /// - Returns: A `JSON` object containing the information of the latest Sui system state.
     /// - Throws: `SuiError.rpcError` if there are errors in the JSON RPC response.
@@ -739,6 +747,7 @@ public struct GraphQLSuiProvider {
         return BigInt(data.epoch!.referenceGasPrice!, radix: 10)!
     }
 
+    // TODO: Implement function when write becomes available
     /// Retrieves the staking information for a given owner.
     /// - Parameter owner: The address of the owner whose staking information is to be retrieved.
     /// - Returns: An array of `DelegatedStake` objects representing the staking information.
@@ -749,6 +758,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Retrieves the staking information for given stake IDs.
     ///
     /// If a Stake was withdrawn its status will be Unstaked.
@@ -844,6 +854,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Resolves a nameservice address to its corresponding account address.
     /// - Parameter name: A string representing the nameservice address to resolve.
     /// - Returns: An `AccountAddress` representing the resolved account address.
@@ -853,7 +864,6 @@ public struct GraphQLSuiProvider {
     }
 
     // TODO: Implement Resolve Name Service Names
-
     /// Waits for a transaction to be processed and retrieves the transaction block.
     /// - Parameters:
     ///   - tx: A string representing the transaction hash.
@@ -867,6 +877,7 @@ public struct GraphQLSuiProvider {
         throw SuiError.notImplemented
     }
 
+    // TODO: Implement function when write becomes available
     /// Checks if a transaction block is valid by ensuring it has a timestamp.
     /// - Parameters:
     ///   - tx: A string representing the transaction hash.

Sources/SuiKit/Types/Structs/Provider/Responses/DisplayFieldsResponse.swift

@@ -36,7 +36,7 @@ public struct DisplayFieldsResponse: Equatable  {
     /// An optional instance of `ObjectResponseError` representing any error that occurred while generating the response.
     /// This will be `nil` if there is no error to report.
     public var error: ObjectResponseError?
-    
+
     public init(data: [String : String]? = nil, error: ObjectResponseError? = nil) {
         self.data = data
         self.error = error

Sources/SuiKit/Types/Structs/Provider/Responses/Object/SuiObjectData.swift

@@ -76,7 +76,7 @@ public struct SuiObjectData: Equatable  {
         self.type = graphql.asMoveObject!.ifShowType != nil ? graphql.asMoveObject!.ifShowType!.contents!.type.repr : nil
         self.version = "\(graphql.version)"
     }
-    
+
     public init(graphql: GetObjectQuery.Data.Object, showBcs: Bool = false) {
         self.bcs = showBcs ? RawData(graphql: graphql.asMoveObject!, version: "\(graphql.version)") : nil
         self.content = graphql.asMoveObject!.ifShowContent != nil ? SuiParsedData(graphql: graphql.asMoveObject!) : nil

Sources/SuiKit/Types/Structs/Provider/Responses/PaginatedObjectsResponse.swift

@@ -40,7 +40,8 @@ public struct PaginatedObjectsResponse {
     /// An optional string representing the cursor for the next page of objects.
     /// `nil` if there are no more pages available.
     public var nextCursor: String?
-    
+
+    /// Page info object for the given Object Response page.
     public var pageInfo: PageInfo?
 
     public init(data: [SuiObjectResponse], pageInfo: PageInfo? = nil, hasNextPage: Bool? = nil, nextCursor: String? = nil) {

Sources/SuiKit/Types/Structs/Provider/Responses/ValidatorApys.swift

@@ -42,7 +42,7 @@ public struct ValidatorApys: Equatable {
         self.apys = input["apys"].arrayValue.map { ValidatorApy(input: $0) }
         self.epoch = input["epoch"].stringValue
     }
-    
+
     public init(graphql: GetValidatorsApyQuery.Data) {
         self.apys = graphql.epoch!.validatorSet!.activeValidators!.map { validator in
             ValidatorApy(