Fix typos

This commit is contained in:
Dimitris Apostolou 2022-12-31 12:50:16 +02:00
parent 3c3b97ca42
commit 6c3423181d
No known key found for this signature in database
GPG Key ID: 4B5D20E938204A8A
35 changed files with 75 additions and 78 deletions

View File

@ -36,12 +36,12 @@ Please provide a general summary of the issue you're experiencing
Tell us what should happen
### Actual behaviour + errors
Tell us what happens instead including any noticable error output (any messages
Tell us what happens instead including any noticeable error output (any messages
displayed on-screen when e.g. a crash occurred)
<!-- Note: please do not include sensitive information. blur, scratch or annotate any
information like addresses, usernames, amounts or anything other that you might consider sensitive and it's not relevant to the problem you are reporting. -->
- App Version:
- App Version:
- iOS Version:
- Device: (if applies)

View File

@ -1,6 +1,6 @@
# Overall:
- Does the contribution referece an existing Issue?
- Does the contribution reference an existing Issue?
- Are the requirements well defined?

View File

@ -76,7 +76,7 @@ in the project's lifetime in a given context. A good record of the changes that
occurred during the project's life helps to guarantee that it can outlive its
stakeholders no matter how foundational or crucial these individuals (or
groups) were. As any reading material, it is best appreciated and comprehended
when there's a visible structure that readers can follow and reason about.
when there's a visible structure that readers can follow and reason about.
For that we've defined a structure for commit messages that all contributors must
follow to maintain coherence on the project's commit log. The proposed format
@ -86,29 +86,29 @@ has been inspired by [this great article](https://cbea.ms/git-commit/)
### Preparing to contribute to the project
The first thing you should look for is an existing issue. It is possible
that the contribution you are planning to work on was already discussed
by other users and/or contributors in the past. If not present, file an
issue following the criteria described in the preceeding sections.
by other users and/or contributors in the past. If not present, file an
issue following the criteria described in the preceding sections.
Every contribution must reference an existing Issue. This issue is important
since it will be directly referenced in the title of your commit.
since it will be directly referenced in the title of your commit.
Although we prefer small PR's. We encourage our contributors to use Squash
commits extensively. Maintainers prefer avoiding _merge commits_ when possible.
commits extensively. Maintainers prefer avoiding _merge commits_ when possible.
It is very much likely that _if accepted_, your contribution will be _squash merged_.
When squashing commits, use your best judgement. In some situations, a refactoring may
be done before actual behavior changes are implemented. It is reasonable to keep such
a refactoring as a separate commit as it both makes review easier and allows for
a refactoring as a separate commit as it both makes review easier and allows for
these refactoring commit SHAs to be added to `.git-blame-ignore-revs`.
### Structuring a PR Commit
#### Commit Title
The first line of your commit message constitutes its _title_. Maintainers will
The first line of your commit message constitutes its _title_. Maintainers will
use commit titles to create release notes. Your contribution will be featured
in a public release of the project. Think of it as a newspaper headline. It
should be descriptive and provide the reader a broad idea of what the commit is
about. You can use a related github issue if it matches this criterion.
about. You can use a related github issue if it matches this criterion.
**Preferred title format**
@ -155,7 +155,7 @@ Date: some date
Add //TODO comment with the permanent fix for the problem
````
When you open a PR with a commit like this one the first line will land on the GUI's title field,
When you open a PR with a commit like this one the first line will land on the GUI's title field,
and the body will be added as the description of the PR.
Adding the text `Closes #{issue_number}` will tell GitHub to close the issue when the PR is merged.

View File

@ -809,10 +809,10 @@
</objects>
<point key="canvasLocation" x="1792.753623188406" y="-1148.4375"/>
</scene>
<!--Get Addreses-->
<!--Get Addresses-->
<scene sceneID="zFi-Pu-g6Q">
<objects>
<viewController title="Get Addreses" id="Rx9-1X-8Gi" customClass="GetAddressViewController" customModule="ZcashLightClientSample" customModuleProvider="target" sceneMemberID="viewController">
<viewController title="Get Addresses" id="Rx9-1X-8Gi" customClass="GetAddressViewController" customModule="ZcashLightClientSample" customModuleProvider="target" sceneMemberID="viewController">
<view key="view" contentMode="scaleToFill" id="5WU-Pu-1e9">
<rect key="frame" x="0.0" y="0.0" width="390" height="844"/>
<autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>

View File

@ -28,8 +28,8 @@ removed `public func getAddress(index account: Int = 0) -> String`
### Wallet Types
`UnifiedSpendingKey` to represent Unified Spending Keys. This is a binary
encoded not meant to be stored or backed up. This only serves the purpuse
of letting clients use the least priviledge keys at all times for every
encoded not meant to be stored or backed up. This only serves the purpose
of letting clients use the least privilege keys at all times for every
operation.
### Synchronizer
@ -74,10 +74,8 @@ public extension UnifiedAddress {
## Notes on Structured Concurrency
`CompactBlockProcessor` is now an Swift Actor. This makes it more robust and have its own
async environment.
SDK Clients will likely be affected by some `async` methods on `SDKSynchronizer`.
We recommend clients that don't support structured concurrency features, to work around this by surrounding the these function calls either in @MainActor contexts either by marking callers as @MainActor or launching tasks on that actor with `Task { @MainActor in ... }`
async environment.
SDK Clients will likely be affected by some `async` methods on `SDKSynchronizer`.
We recommend clients that don't support structured concurrency features, to work around this by surrounding the these function calls either in @MainActor contexts either by marking callers as @MainActor or launching tasks on that actor with `Task { @MainActor in ... }`

View File

@ -544,7 +544,7 @@ public actor CompactBlockProcessor {
Rewinds to provided height.
If nil is provided, it will rescan to nearest height (quick rescan)
If this is called while sync is in progress then `CompactBlockProcessorError.rewindAttemptWhileProcessing` is throwed.
If this is called while sync is in progress then `CompactBlockProcessorError.rewindAttemptWhileProcessing` is thrown.
*/
public func rewindTo(_ height: BlockHeight?) async throws -> BlockHeight {
guard shouldStart else { throw CompactBlockProcessorError.rewindAttemptWhileProcessing }
@ -712,7 +712,7 @@ public actor CompactBlockProcessor {
func severeFailure(_ error: Error) {
cancelableTask?.cancel()
LoggerProxy.error("show stoppper failure: \(error)")
LoggerProxy.error("show stopper failure: \(error)")
self.backoffTimer?.invalidate()
self.retryAttempts = config.retries
self.processingError = error
@ -1114,7 +1114,7 @@ extension CompactBlockProcessorError: LocalizedError {
case .maxAttemptsReached(let attempts):
return "Compact Block failed \(attempts) times and reached the maximum amount of retries it was set up to do"
case .missingDbPath(let path):
return "CompactBlockProcessor was set up with path \(path) but thath location couldn't be reached"
return "CompactBlockProcessor was set up with path \(path) but that location couldn't be reached"
case let .networkMismatch(expected, found):
// swiftlint:disable:next line_length
return "A server was reached, but it's targeting the wrong network Type. App Expected \(expected) but found \(found). Make sure you are pointing to the right server"
@ -1128,7 +1128,7 @@ extension CompactBlockProcessorError: LocalizedError {
case let .wrongConsensusBranchId(expectedLocally, found):
// swiftlint:disable:next line_length
return "The remote server you are connecting to is publishing a different branch ID \(found) than the one your App is expecting to be (\(expectedLocally)). This could be caused by your App being out of date or the server you are connecting you being either on a different network or out of date after a network upgrade."
case .unknown: return "Unknown error occured."
case .unknown: return "Unknown error occurred."
}
}

View File

@ -98,7 +98,7 @@ public enum ZcashSDK {
public static var defaultRetries: Int = 5
/// The default maximum amount of time to wait during retry backoff intervals. Failed loops will never wait longer than
/// this before retyring.
/// this before retrying.
public static var defaultMaxBackOffInterval: TimeInterval = 600
/// Default number of blocks to rewind when a chain reorg is detected. This should be large enough to recover from the

View File

@ -98,7 +98,7 @@ public protocol AbstractTransaction {
}
/**
Capabilites of a signed transaction
Capabilities of a signed transaction
*/
public protocol SignedTransactionEntity {
var raw: Data? { get set }
@ -116,7 +116,7 @@ Attributes that a Mined transaction must have
*/
public protocol MinedTransactionEntity: AbstractTransaction, RawIdentifiable {
/**
height on which this transaction was mined at. Convention is that -1 is retuned when it has not been mined yet
height on which this transaction was mined at. Convention is that -1 is returned when it has not been mined yet
*/
var minedHeight: Int { get set }

View File

@ -19,9 +19,9 @@ extension SynchronizerError: LocalizedError {
case .connectionFailed(message: let message):
return "Connection Failed. Error: \(message)"
case .generalError(message: let message):
return "An error ocurred when syncing. Message: \(message)"
return "An error occurred when syncing. Message: \(message)"
case .maxRetryAttemptsReached(attempts: let attempts):
return "An error occured. We made \(attempts) retry attempts."
return "An error occurred. We made \(attempts) retry attempts."
case .connectionError(status: let status, message: let message):
return "There's a connection error. Status #\(status). Message: \(message)"
case .networkTimeout:
@ -29,13 +29,13 @@ extension SynchronizerError: LocalizedError {
case .uncategorized(underlyingError: let underlyingError):
return "Uncategorized Error. Underlying Error: \(underlyingError)"
case .criticalError:
return "A critical Error Ocurred"
return "A critical Error Occurred"
case .parameterMissing(underlyingError: let underlyingError):
return "Sapling parameters are not present or couldn't be downloaded. Error: \(underlyingError)."
case .rewindError(underlyingError: let underlyingError):
return "Error when rescanning. Error: \(underlyingError)"
case .rewindErrorUnknownArchorHeight:
return "Error when rescanning. We couldn't find a point in time to rewing. Please attempt a full re-scan"
return "Error when rescanning. We couldn't find a point in time to rewind. Please attempt a full re-scan"
case .invalidAccount:
return "We couldn't find this account number."
case .lightwalletdValidationFailed(underlyingError: let underlyingError):

View File

@ -8,7 +8,7 @@
import Foundation
/// SDK's tool for the measurement of metrics.
/// The barebone API of the `SDKMetrics` is all about turning it on/off, pushing new reports in and poping RAW data out.
/// The barebone API of the `SDKMetrics` is all about turning it on/off, pushing new reports in and popping RAW data out.
/// The processing of data is either left to the user of `SDKMetrics` or anybody can take an advantage of extension APIs
/// providing useful structs and reports.
///

View File

@ -748,18 +748,18 @@ extension FFIBinaryKey {
.init(
network: network,
bytes: self.encoding.toByteArray(
lenght: Int(self.encoding_len)),
length: Int(self.encoding_len)),
account: self.account_id
)
}
}
extension UnsafeMutablePointer where Pointee == UInt8 {
/// copies the bytes poined on
func toByteArray(lenght: Int) -> [UInt8] {
/// copies the bytes pointed on
func toByteArray(length: Int) -> [UInt8] {
var bytes = [UInt8]()
for index in 0 ..< lenght {
for index in 0 ..< length {
bytes.append(self.advanced(by: index).pointee)
}

View File

@ -283,7 +283,7 @@ protocol ZcashRustBackendWelding {
/// Validates the if the given string is a valid Sapling Extended Spending Key
/// - Returns: `true` when the Sapling Extended Spending Key is valid, false in any other case.
/// - Throws: Error when the key is semantically valid but it belongs to another network
/// - parameter key: String encoded Extendeed Spending Key
/// - parameter key: String encoded Extended Spending Key
/// - parameter networkType: `NetworkType` signaling testnet or mainnet
static func isValidSaplingExtendedSpendingKey(_ key: String, networkType: NetworkType) -> Bool
@ -308,7 +308,7 @@ protocol ZcashRustBackendWelding {
/// - Throws: Error when there's another problem not related to validity of the string in question
static func isValidUnifiedFullViewingKey(_ ufvk: String, networkType: NetworkType) -> Bool
/// initialize the blocks table from a given checkpoint (heigh, hash, time, saplingTree and networkType)
/// initialize the blocks table from a given checkpoint (height, hash, time, saplingTree and networkType)
/// - Parameters:
/// - dbData: location of the data db
/// - height: represents the block height of the given checkpoint
@ -429,7 +429,7 @@ protocol ZcashRustBackendWelding {
/// - value: the value of the UTXO
/// - height: the mined height for the UTXO
/// - networkType: the network type
/// - Returns: true if the operation succeded or false otherwise
/// - Returns: true if the operation succeeded or false otherwise
static func putUnspentTransparentOutput(
dbData: URL,
txid: [UInt8],

View File

@ -148,7 +148,7 @@ public protocol Synchronizer {
/// - Parameter kind: Transaction Kind expected from this PaginatedTransactionRepository
func paginatedTransactions(of kind: TransactionKind) -> PaginatedTransactionRepository
/// Returns a list of confirmed transactions that preceed the given transaction with a limit count.
/// Returns a list of confirmed transactions that precede the given transaction with a limit count.
/// - Parameters:
/// - from: the confirmed transaction from which the query should start from or nil to retrieve from the most recent transaction
/// - limit: the maximum amount of items this should return if available
@ -189,7 +189,7 @@ public protocol Synchronizer {
/// `SynchronizerError.rewindError(CompactBlockProcessorError.rewindAttemptWhileProcessing)` is thrown.
///
/// - Parameter policy: the rewind policy
/// - Throws rewindErrorUnknownArchorHeight when the rewind points to an invalid height
/// - Throws rewindErrorUnknownAnchorHeight when the rewind points to an invalid height
/// - Throws rewindError for other errors
/// - Note rewind does not trigger notifications as a reorg would. You need to restart the synchronizer afterwards
func rewind(_ policy: RewindPolicy) async throws

View File

@ -986,7 +986,7 @@ class BalanceTests: XCTestCase {
)
guard let sentNote = try? sentNotesRepo.sentNote(byRawTransactionId: transactionId) else {
XCTFail("Could not finde sent note with transaction Id \(transactionId)")
XCTFail("Could not find sent note with transaction Id \(transactionId)")
return
}
@ -1042,7 +1042,7 @@ class BalanceTests: XCTestCase {
}
/**
erify transactions that expire are reflected accurately in balance
Verify transactions that expire are reflected accurately in balance
This test requires the transaction to expire.
How can we mock or cause this? Would createToAddress and faking a network submission through lightwalletService and syncing 10 more blocks work?

View File

@ -25,7 +25,7 @@ class LightWalletServiceTests: XCTestCase {
service = LightWalletGRPCService(endpoint: LightWalletEndpointBuilder.eccTestnet)
}
/// FIXME: check whether this test is stil valid on in memory lwd implementatiojn
/// FIXME: check whether this test is still valid on in memory lwd implementation
// func testFailure() {
//
// let expect = XCTestExpectation(description: self.description)

View File

@ -34,7 +34,7 @@ class CompactBlockStorageTests: XCTestCase {
do {
try await TestDbBuilder.seed(db: compactBlockDao, with: startHeight...finalHeight)
} catch {
XCTFail("seed faild with error: \(error)")
XCTFail("seed failed with error: \(error)")
return
}
@ -65,7 +65,7 @@ class CompactBlockStorageTests: XCTestCase {
let expectedHeight = BlockHeight(123_456)
guard let block = StubBlockCreator.createRandomDataBlock(with: expectedHeight) else {
XCTFail("could not create randem block with height: \(expectedHeight)")
XCTFail("could not create random block with height: \(expectedHeight)")
return
}
do {
@ -92,7 +92,7 @@ class CompactBlockStorageTests: XCTestCase {
let expectedHeight = BlockHeight(123_456)
guard let block = StubBlockCreator.createRandomDataBlock(with: expectedHeight) else {
XCTFail("could not create randem block with height: \(expectedHeight)")
XCTFail("could not create random block with height: \(expectedHeight)")
return
}
try await compactBlockDao.write(blocks: [block])
@ -109,7 +109,7 @@ class CompactBlockStorageTests: XCTestCase {
do {
try await TestDbBuilder.seed(db: compactBlockDao, with: startHeight...finalHeight)
} catch {
XCTFail("seed faild with error: \(error)")
XCTFail("seed failed with error: \(error)")
return
}
let rewindHeight = BlockHeight(finalHeight - 233)

View File

@ -77,7 +77,7 @@ class ZatoshiTests: XCTestCase {
XCTAssertEqual(
result4.amount,
Zatoshi.Constants.maxZatoshi,
"Zatoshi tests: `testAddingZatoshi` the value is expected to be clapmed to upper bound but it's \(result4.amount)"
"Zatoshi tests: `testAddingZatoshi` the value is expected to be clamped to upper bound but it's \(result4.amount)"
)
}
@ -118,7 +118,7 @@ class ZatoshiTests: XCTestCase {
XCTAssertEqual(
result4.amount,
-Zatoshi.Constants.maxZatoshi,
"Zatoshi tests: `testSubtractingZatoshi` the value is expected to be clapmed to lower bound but it's \(result4.amount)"
"Zatoshi tests: `testSubtractingZatoshi` the value is expected to be clamped to lower bound but it's \(result4.amount)"
)
}
@ -130,7 +130,7 @@ class ZatoshiTests: XCTestCase {
// but decimalString is rounding it to maximumFractionDigits set to be 8
// We can't compare it to double value 1.42857143 (or even Decimal(1.42857143))
// so we convert it to string, in that case we are prooving it to be rendered
// so we convert it to string, in that case we are proving it to be rendered
// to the user exactly the way we want
XCTAssertEqual(
number.decimalString(formatter: usNumberFormatter),

View File

@ -152,7 +152,7 @@ class Zip302MemoTests: XCTestCase {
XCTAssertThrowsError(try Memo(string: nullTrailedString)) { error in
guard let thrownError = error as? MemoBytes.Errors else {
XCTFail("Thrown erros is not MemoBytes.Error")
XCTFail("Thrown error is not MemoBytes.Error")
return
}
@ -170,7 +170,7 @@ class Zip302MemoTests: XCTestCase {
XCTAssertThrowsError(try Memo(string: nullTrailedString)) { error in
guard let thrownError = error as? MemoBytes.Errors else {
XCTFail("Thrown erros is not MemoBytes.Error")
XCTFail("Thrown error is not MemoBytes.Error")
return
}

View File

@ -8,7 +8,7 @@ The project is integrated the following CI platforms:
- Builds
## When a PR is opened
## When a PR is opened
- check that linting is successful (to be integrated)
- check that the code builds
@ -17,14 +17,13 @@ The project is integrated the following CI platforms:
## Manual Deployment
Prerequisites:
Prerequisites:
- Write permissions on the repo
- Push permission on CocoaPods Trunk
- Push permission on CocoaPods Trunk
Steps:
- build the project
- run tests
- Create a new tag MAJOR.MIDDLE.MINOR{-betaX}
- update the ZcashLightClientKit.podspec file with the correponding version.
- run `pod lib lint --skip-tests --allow-warnings && pod trunk push --skip-tests --allow-warnings` to create pod version
- update the ZcashLightClientKit.podspec file with the corresponding version.
- run `pod lib lint --skip-tests --allow-warnings && pod trunk push --skip-tests --allow-warnings` to create pod version

View File

@ -502,7 +502,7 @@ block time.</p>
<div class="pointer"></div>
<div class="abstract">
<p>The default maximum amount of time to wait during retry backoff intervals. Failed loops will never wait longer than
this before retyring.</p>
this before retrying.</p>
</div>
<div class="declaration">

View File

@ -554,7 +554,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Capabilites of a signed transaction</p>
<p>Capabilities of a signed transaction</p>
<a href="Protocols/SignedTransactionEntity.html" class="slightly-smaller">See more</a>
</div>

View File

@ -337,7 +337,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>height on which this transaction was mined at. Convention is that -1 is retuned when it has not been mined yet</p>
<p>height on which this transaction was mined at. Convention is that -1 is returned when it has not been mined yet</p>
</div>
<div class="declaration">

View File

@ -318,7 +318,7 @@
</div>
</div>
<p>Capabilites of a signed transaction</p>
<p>Capabilities of a signed transaction</p>
</section>
<section class="section task-group-section">

View File

@ -941,7 +941,7 @@ an option if the transaction has not yet been submitted to the server.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a list of confirmed transactions that preceed the given transaction with a limit count.</p>
<p>Returns a list of confirmed transactions that precede the given transaction with a limit count.</p>
</div>
<div class="declaration">

View File

@ -1394,7 +1394,7 @@ returns false if fails to scan.</p>
</div>
<div>
<h4>Return Value</h4>
<p>true if the operation succeded or false otherwise</p>
<p>true if the operation succeeded or false otherwise</p>
</div>
</section>
</div>
@ -2170,7 +2170,7 @@ returns false if fails to decrypt.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Derives a tranparent address from a public key</p>
<p>Derives a transparent address from a public key</p>
</div>
<div class="declaration">

View File

@ -384,7 +384,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Groups a Sapling Extended Full Viewing Key an a tranparent address extended public key.</p>
<p>Groups a Sapling Extended Full Viewing Key an a transparent address extended public key.</p>
</div>
<div class="declaration">

View File

@ -502,7 +502,7 @@ block time.</p>
<div class="pointer"></div>
<div class="abstract">
<p>The default maximum amount of time to wait during retry backoff intervals. Failed loops will never wait longer than
this before retyring.</p>
this before retrying.</p>
</div>
<div class="declaration">

View File

@ -554,7 +554,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Capabilites of a signed transaction</p>
<p>Capabilities of a signed transaction</p>
<a href="Protocols/SignedTransactionEntity.html" class="slightly-smaller">See more</a>
</div>

View File

@ -337,7 +337,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>height on which this transaction was mined at. Convention is that -1 is retuned when it has not been mined yet</p>
<p>height on which this transaction was mined at. Convention is that -1 is returned when it has not been mined yet</p>
</div>
<div class="declaration">

View File

@ -318,7 +318,7 @@
</div>
</div>
<p>Capabilites of a signed transaction</p>
<p>Capabilities of a signed transaction</p>
</section>
<section class="section task-group-section">

View File

@ -941,7 +941,7 @@ an option if the transaction has not yet been submitted to the server.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a list of confirmed transactions that preceed the given transaction with a limit count.</p>
<p>Returns a list of confirmed transactions that precede the given transaction with a limit count.</p>
</div>
<div class="declaration">

View File

@ -1394,7 +1394,7 @@ returns false if fails to scan.</p>
</div>
<div>
<h4>Return Value</h4>
<p>true if the operation succeded or false otherwise</p>
<p>true if the operation succeeded or false otherwise</p>
</div>
</section>
</div>
@ -2170,7 +2170,7 @@ returns false if fails to decrypt.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Derives a tranparent address from a public key</p>
<p>Derives a transparent address from a public key</p>
</div>
<div class="declaration">

View File

@ -384,7 +384,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Groups a Sapling Extended Full Viewing Key an a tranparent address extended public key.</p>
<p>Groups a Sapling Extended Full Viewing Key an a transparent address extended public key.</p>
</div>
<div class="declaration">

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long