Commit Graph

344 Commits

Author SHA1 Message Date
Jack Grigg 8145248285 Expose APIs for working with transaction proposals
Closes Electric-Coin-Company/zcash-swift-wallet-sdk#1204.
2024-03-06 02:53:33 +00:00
Lukas Korba 9f339d5252 [#1376] Release 2.0.10
- Checkpoints added
- Changelog updated
2024-02-12 19:48:34 +01:00
Lukas Korba 913f677282 [#1374] ZashiError generated code update is missing
- ZcashError generated code updated
2024-02-12 17:55:14 +01:00
Lukas Korba e51f425c54 [#1369] SynchronizerState refactor
- plural of account balances refactor to singular

[#1369] SynchronizerState refactor

- transaprent balance removed from SynchronizerState
- all balances are now handled with AccountBalance

[#1369] SynchronizerState refactor and balances cleanup

- WalletBalance has been removed from the SDK, replaced with AccountBalance
- public APIs for individual balances (getTransparent, getShielded, getShieldedVerfied) have been removed from the SDK, replaced with getAccountBalance
- tests refactored

[#1369] SynchronizerState refactor and balances cleanup

- dark side tests refactored

[#1369] SynchronizerState refactor and balances cleanup (#1372)

- addressed comments

[#1369] SynchronizerState refactor

- ZcashError for spending key does not belong to the wallet
2024-02-12 17:41:26 +01:00
Lukas Korba 99d4821769 [#1368] Handle any lightwalletd error with retry logic
- The retry logic was implemented for blockStream errors only but this PR generalize it for any lightwalletd error
2024-02-12 17:40:28 +01:00
Lukas Korba c7369057f1 [#1153] Allow runtime switch of lightwalletd servers
- new public API switchTo(endpoint:) implemented

[#1153] Allow runtime switch of lightwalletd servers

- API documented
- code cleaned up

[#1153] Allow runtime switch of lightwalletd servers

- mocks generated

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- sever validation added

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- enhanced validation of the server

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- new ZcashError.synchronizerServerSwitch that represents the state when the endpoint fails validation

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- ZcashError definition update

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- addressed comments

[#1153] Allow runtime switch of lightwalletd servers (#1373)

- changelog revert according to proposal
2024-02-12 17:13:08 +01:00
Lukas Korba 10dc5ed861
Merge pull request #1333 from pacu/swiftlint
[#1332] Enable Swiftlint workflow
2024-02-05 12:33:31 +01:00
Lukas Korba 9fab46a2d1 [#1363] Expose PoolBalance Zatoshi values
- new public API with returning AccountBalance

[#1363] Expose PoolBalance Zatoshi values

- accountBalances exposed into the SynchronizationState

[#1363] Expose PoolBalance Zatoshi values

- public vs. internal

[1363] Account balances in the SynchronizerState

- changelog update
- scanAction reports the initial after-scan value immediately instead of after X scans
- SynchronizerState has been refactored, we no longer call 2 rust methods to get shielded verified + total balances
 - tests refactored to reflect this change
- mocks regenerated
- Sourcery version bumped

[#1363] Account balances in the SynchronizerState

- changelog typo fixed

[#1363] Account balances in the SynchronizerState

- internal vs. public
2024-01-31 17:05:13 -08:00
Jack Grigg c8a181d2f0 Merge branch 'main' into feature-2.0.7 2024-01-29 10:02:42 -08:00
Jack Grigg ded20fe7b0 Migrate to in-progress version of FFI backend 0.5.0
Includes:
- Exposed `WalletSummary`.
- Exposed transaction proposals.
- `ScanSummary` returned from `ZcashRustBackend.scanBlocks`.

Closes Electric-Coin-Company/zcash-swift-wallet-sdk#1259.
Closes Electric-Coin-Company/zcash-swift-wallet-sdk#1299.
2024-01-29 09:47:14 -08:00
Lukas Korba e3cbd78712 [#1357] Checkpoints update
- new checkpoints added
2024-01-28 08:43:16 -08:00
Lukas Korba f2a2dfb03c [#1351] Recover from block stream issues
- changelog updated
- block stream errors are now handled as a special case of error, retry logic is triggered but at most 3-times in case of service being truly down
- the failure is not passed to the clients so ideally the false positive errors are reduced as well as the delay in the sync time

[#1351] Recover from block stream issues (#1352)

- typo fixed
2024-01-25 13:35:46 +01:00
Lukas Korba bca6ceb15f [#1346] Troubleshooting synchronization
- changelog update
- the sync time has been reduced by ~33%. The progress reporting frequency has been lowered down 5-times
- this is just first step and a quick improvement before we introduce advanced solution, covered in #1353

[#1346] Troubleshooting synchronization (#1354)

- typo fixed
2024-01-25 13:32:58 +01:00
Lukas Korba 1dde31e41a [#1336] Tweaks for sdk metrics
- the logs are split so it's not a huge string
- the log method is async
- added a new log with balances

[#1336] Tweaks for sdk metrics

- wait a bit so the logs are sorted in time

[#1336] Tweaks for sdk metrics

- wait a bit so the logs are sorted in time

[#1336] Tweaks for sdk metrics

- wait a bit so the logs are sorted in time

[#1336] Tweaks for sdk metrics

- cleanup

[#1336] Tweaks for sdk metrics

- changelog update

[#1336] Tweaks for sdk metrics

- checkpoints updated

[#1336] Tweaks for sdk metrics

- changelog typos fixed

[#1336] Tweaks for sdk metrics

- mocks generated
2023-12-15 09:01:04 +01:00
Francisco Gindre 7272b92765
[#1332] Enable Swiftlint workflow
Closes #1332.

This runs an ubuntu box with a swiftlint process and nothing else.

During implementing this same thing in the ZIP-321 library I found
that the Swift Package Plugin for Swiftlint did work after some
juggling, but it added a lot of build time to the main build job
so it delayed the CI for several minutes while a separate machine
would to the same chore more effectively and also in an isolated
way without mixing lint and build failures
2023-12-12 15:51:15 -03:00
Lukas Korba 3e263f0c35 [#1325] Log metrics
- the logger has been extended to log the level as well
- there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
- this is a base for the exporter on client's side

[#1325] Log metrics

- typos fixed

[#1325] Log metrics

- scan metric logs added

[#1325] Log metrics

- Scan & Enhance logs

[#1325] Log metrics

- checkpoints updated
- every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
- next run clears out the previous data and starts to collect fresh reports for the run

[#1325] Log metrics (#1327)

- changelog update

[#1325] Log metrics (#1327)

- SDKMetrics updated to be mockable
- unit test updated

[#1325] Log metrics (#1327)

- performance tests cleaned out

[#1325] Log metrics (#1327)

- Network tests buildable again
2023-12-12 08:59:52 +01:00
Francisco Gindre 6625ffd711
Create a Dependency that can load checkpoints from bundle
Closes #1315

This PR introduces small changes on each commit.
Things done:

rename Checkpoint+Constants to Checkpoint+helpers

Move `Checkpoint` from Model folder to Checkpoint folder

Remove unused function `ofLatestCheckpoint` from BlockHeight

Create a protocol called `CheckpointSource` that contains the
relevant functionality to get checkpoints from Bundle

Create a set of tests that check that functionality is maintained
when a `CheckpointSource` is used instead of Checkpoint helpers

Implement `BundleCheckpointSource` and add Tests

Code clean up: move `BundleCheckpointURLProvider` to its own file

Code clean up: `Checkpoint+helpers` match file header

Replace use of `Checkpoint.birthday(with:network)` with CheckpointSource

Revert "Remove unused function `ofLatestCheckpoint` from BlockHeight"

addresses PR comment from @daira

This reverts commit d0e154ded7, since it
modifies a public API and it was not the goal of this PR.

Update Sources/ZcashLightClientKit/Checkpoint/BundleCheckpointSource.swift

Use a decent Date Format

Co-authored-by: Daira Emma Hopwood <daira@jacaranda.org>

Improve documentation on BundleCheckpointURLProvider

Co-authored-by: Daira Emma Hopwood <daira@jacaranda.org>

Improve documentation on BundleCheckpointURLProvider

Co-authored-by: Daira Emma Hopwood <daira@jacaranda.org>

use YYYY-mm-dd on file header

author: @daira

Co-authored-by: Daira Emma Hopwood <daira@jacaranda.org>

Add test that verifies that the exact height is returned if available
2023-11-08 15:45:14 -03:00
Lukas Korba fb7eb1978d [#1310] Release 2-0-3
- checkpoints updated

[#1310] Release 2-0-3

- FFI version bumped
- other dependencies bumped as well

[#1310] Release 2-0-3

- checkpoints mentioned in the changelog
2023-10-20 12:46:15 +02:00
Lukas Korba ab23f15fa1 [#1308] Enhancing seems to not process all ranges
- The enhance action is driven by lastEnhancedHeight value. The range is computed from it and every 1000 blocks are enhanced. The value hasn't been reseted with the new suggested ScanRanges so when some higher ranges were processed first, all lower heights were skipped
- fixed and covered with the unit test

[#1308] Enhancing seems to not process all ranges (#1309)

- changelog update
2023-10-20 09:54:17 +02:00
Lukas Korba 5983cd8f91 [#1303] Don't invalidate the timer with the error
- the most simple fix for this issue is to set the number of attempts to the "infinity"
- smarter solution will require a better retry logic in general, covered in #1304
2023-10-12 18:10:07 +02:00
Lukas Korba e763e29dc1 [#1301] foundTransactions don't emit after rewind
- There was a reset missing in the rewind() call. This method is a direct call affecting the state of the compact block processor but the ActionContext has been handled only in the synchronization pipeline. Manual reset was needed to reset the last enhanced height.
- tests added
2023-10-12 15:59:47 +02:00
Lukas Korba 08a16fce61 [#1295] Release ZcashLightClientKit 2.0.1
- checkpoints updated
2023-10-03 07:53:36 +02:00
Lukas Korba 69e38e0667 [#1294] Remove all uses of the incorrect 1000-ZAT fee
- Removed deprecated zip-313 fee of 1000 Zatoshi
- default is now 10k zatoshi, the minimum defined by zip-317

[#1294] Remove all uses of the incorrect 1000-ZAT fee

- changelog update
2023-09-29 20:01:38 +02:00
Lukas Korba 13b994d2a5 [#1288] Extend SyncStatus with stopped state
- InternalSyncStatus as well as SyncStatus were extended with stopped state, this is needed to distinguish between upToDate and stopped via stop() method states as previously stopped state of block processor was mapped to upToDate
2023-09-25 16:33:04 +02:00
Lukas Korba dc4e590f68 [#1281] Database is locked
- Execution of any query in TransactionSQLDAO was not thread safe. Since all queries goes through execute() method, this is now using a lock

[#1281] Database is locked

- global lock used, all rust backend code accessing data DB is under lock
- transactionsqldao is also under same lock

[#1281] Database is locked

- refactor + fbDB locked as well

[#1281] Database is locked

- lock around scalars added

[#1281] Database is locked

- comments addressed
- scalarLocked helper implemented
- connection().run and .transition locked as well

[#1281] Database is locked

- db used so it's not called twice

[#1281] Database is locked

- AccountEntity protected via globalDBLock as well
2023-09-20 19:13:52 +02:00
Kris Nuttycombe a338e1daf5 Apply suggestions from code review.
Co-authored-by: str4d <thestr4d@gmail.com>
2023-09-19 16:24:36 -06:00
Lukas Korba e4bc54e8f2 expiredUnmined fix 2023-09-19 12:09:28 -06:00
Kris Nuttycombe 94a5f599ae Fix incorrect use of transaction index in find-from-transaction query.
This fixes an issue where the transaction index was incorrectly being
used to filter out transactions from the contents of the
`v_transactions` view, and updates the query to account for the fact
that both the block time and the transaction index may be NULL in the
results of this view.
2023-09-19 10:25:18 -06:00
Kris Nuttycombe 2c526dbcd6 Update `zcash-light-client-ffi` to adopt fix for missing transparent history.
Fixes #1271

Co-Authored-By: Jack Grigg <jack@electriccoin.co>
Co-Authored-By: Lukas Korba <lukas.korba@seznam.cz>
2023-09-19 08:26:03 -06:00
Kris Nuttycombe ab7aedeea1
Merge pull request #1274 from LukasKorba/1273-SynchronizerState-not-always-up-to-date
[#1273] SynchronizerState not always up to date
2023-09-18 16:34:35 -06:00
Kris Nuttycombe 36ed739077
Merge pull request #1272 from LukasKorba/1262-Check-pairing-of-deallocations-vs-allocations-in-rustBackend
[#1262] Check pairing of deallocations vs allocations in rustBackend
2023-09-18 16:29:24 -06:00
Lukas Korba 6b8d95906a [#1273] SynchronizerState not always up to date
- latestBlockHeight (chain tip) reported in the SynchronizerState to the clients is now updated every 10mins at most, typically with every sync run (10-30s)
- fully and max scanned heights update fixed
- new mocks provided and tests fixed
2023-09-18 11:01:58 +02:00
Lukas Korba 110007ac66 [#1262] Check pairing of deallocations vs allocations in rustBackend
- rootsPtr deallocated
2023-09-18 08:32:01 +02:00
Kris Nuttycombe 4ef4b1172f Remove the 10-block range limit for during sandblasting.
The improved performance provided by `shardtree` is sufficient to allow
100-block scan ranges throughout the sandblasted range, and limiting to
10 blocks results in significant overhead.

A future release will switch to an adaptive strategy which can
dynamically adjust download and scan range sizes based upon observed
output counts and scanning times to provide consistent throughput.
2023-09-15 20:30:09 -06:00
Francisco Gindre 4f225b5115
[#1267] Avoid Division By Zero in ScanProgress type
Although is not the best way to solve it this addresses the issue
in a single statement and following existing pattern in the code.

The error should be thrown earlier in RustBackend itself if so,
or fallback to some specific value that makes sense to the domain

Closes #1267
2023-09-13 18:47:55 -03:00
Lukas Korba 26fe1f7310 ScanRange initialization changed
- only the matching priorities are allowed, otherwise fatalError
2023-09-13 17:57:24 +02:00
Lukas Korba 50afc8f2e5 Instance totalProgressRange removed
- totalProgressRange was removed from the protocol but not from the actual implementation
2023-09-13 17:42:43 +02:00
Lukas Korba 4e2af5da68 Addressed comments batch 2
- more comments resolved
- totalProgressRange removed from the SDK
- ScanRange now takes into account the given value and properly initializes, + added tests
- tests fixed
2023-09-13 17:33:37 +02:00
Lukas Korba 5600e77a71 Rewind action continues to the processScanRanges
- the diagram png + puml updated
- rewind action continues to the process scan ranges
2023-09-13 16:28:42 +02:00
Lukas Korba 95c9746303 cbp_state_machine updated
- cbp_state_machine.png as well as .puml files updated to reflect the State Machine changes after SBS
- one small cleanup of clearCache, no longer needed to be called twice, only after enhance (missed removal of linear sync)
2023-09-13 15:25:25 +02:00
Lukas Korba 3d2812c77f ProcessSuggestedScanRanges always continues to the download
- the logic deciding if verify range is present and going to the rewind is no longer valid, so removed
- tests updated
2023-09-13 14:58:38 +02:00
Lukas Korba af595e60e6 Cleanup and comment providing context
- adding a context so it's clear why division by 0 is not a concern
- pending transactions removed from the DemoApp's UI, #1260 is a followup
2023-09-13 11:57:21 +02:00
Lukas Korba d5d4664bf5 Rewind when continuity error
- when isContinuityError occurred, the next action  should be rewind, fixed
2023-09-13 09:54:26 +02:00
Lukas Korba 4b45c15a96 Comments addressed
- all comments from the review (round 1) resolved
2023-09-13 09:24:26 +02:00
Lukas Korba fdcb52c088 [#1240] Remove previous progress reporting
- CompactBlockProgress has been update to use syncProgress only
- CompactBlockProgressUpdate removed
- BlockProgress removed
- enhance and fetch progresses removed
- progressPartialUpdate refactored to syncProgress
- tests updated
2023-09-11 09:30:44 +02:00
Lukas Korba 36329fe818 [#1244] Checkpoints update
- mainnet + testnet checkpoints updated
2023-09-08 18:33:44 +02:00
Lukas Korba dc5cbd8dec [#1236] Use of recoverUntil
- SDKSynchronizer's public API prepareWith() now requires a parameter WalletInitMode
- tests fixed
- changelog updated
2023-09-08 15:44:48 +02:00
Lukas Korba 60780f4c83 [#1238] Report sync progress with the new getScanProgress
- getScanProgress used for reporting of the syncing progress

[#1238] Report sync progress with the new getScanProgress

- comment added

[#1238] Report sync progress with the new getScanProgress (#1239)

- TODOs + offline tests fixed
2023-09-08 12:19:54 +02:00
Lukas Korba b8b0f2927b [#1232] Implement createAccount
- create account draft

[#1232] Implement createAccount

- TODO for the recoverUntil parameter

[#1232] Implement createAccount

- force unwrap solved

[#1232] Implement createAccount

- ; removed
2023-09-08 08:18:17 +02:00
Lukas Korba d956e9940b [#1230] Remove linear sync from the SDK
- concept of linear syncing fully removed from the SDK, it's fully replaced with Spend-before-Sync
- BlockDAO - table blocks is no longer used, removed from the SDK and all it's associated getLastBlocks/ScannedHeights as with it
- concept of pending transactions removed from the SDK
- unit tests refactored
2023-09-08 07:40:08 +02:00