chore: comments + docs

Author: JeneaVranceanu

Sources/web3swift/HookedFunctions/Web3+Wallet.swift

@@ -9,11 +9,15 @@ import Web3Core
 
 extension Web3.Web3Wallet {
 
+    /// A list of addresses available in the attached keystore.
+    /// - Returns: a list of addresses or an error.
     public func getAccounts() throws -> [EthereumAddress] {
         guard let keystoreManager = self.web3.provider.attachedKeystoreManager else {
+            // TODO: add the following error message: Missing `attachedKeystoreManager`.
             throw Web3Error.walletError
         }
         guard let ethAddresses = keystoreManager.addresses else {
+            // TODO: add the following error message: Missing attached keystore is empty.
             throw Web3Error.walletError
         }
         return ethAddresses
@@ -42,6 +46,12 @@ extension Web3.Web3Wallet {
         }
     }
 
+    /// Execute `personal_sign` for given arbitrary message.
+    /// - Parameters:
+    ///   - personalMessage: message. Must be HEX formatted: message -> to 'UTF-8 bytes' -> to hex string!
+    ///   - account: signer address.
+    ///   - password: web3 attached keystore password.
+    /// - Returns: signature for the given message or throws an error.
     public func signPersonalMessage(_ personalMessage: String, account: EthereumAddress, password: String ) throws -> Data {
         guard let data = Data.fromHex(personalMessage) else {
             throw Web3Error.dataError

Sources/web3swift/Web3/Web3+Contract.swift

@@ -47,7 +47,7 @@ extension Web3 {
 
         // MARK: Writing Data flow
         // FIXME: Rewrite this to CodableTransaction
-        /// Deploys a constact instance using the previously provided  ABI, some bytecode, constructor parameters and options.
+        /// Deploys a contract instance using the previously provided ABI, some bytecode, constructor parameters and options.
         /// If extraData is supplied it is appended to encoded bytecode and constructor parameters.
         ///
         /// Returns a "Transaction intermediate" object.

Tests/web3swiftTests/localTests/PersonalSignatureTests.swift

@@ -69,8 +69,9 @@ class PersonalSignatureTests: XCTestCase {
         let expectedAddress = keystoreManager.addresses![0]
 
         let signature = try await web3.personal.signPersonalMessage(message: Data.fromHex(messageToSign)!, from: expectedAddress, password: "")
-        // ATTENTION: web3.wallet.signPersonalMessage accepts a raw string instead but expects it
-        // ATTENTION: to be a hex string!
+        // ATTENTION: web3.wallet.signPersonalMessage accepts a raw string
+        // ATTENTION: instead of the message hash but expects it to be
+        // ATTENTION: 'string' -> to 'UTF-8 bytes' -> to hex string converted!
         let signature_walletObj = try web3.wallet.signPersonalMessage(messageToSign, account: expectedAddress, password: "")
         let signer = web3.personal.recoverAddress(message: Data.fromHex(messageToSign)!, signature: signature)