DragonX/dragonx-android-wallet-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
fekt
2022-06-30 01:53:12 -04:00
commit 0131016214
703 changed files with 33394 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/-sdk-synchronizer/-sync-state/-cache-only/-init-.md Normal file
View File

@@ -0,0 +1,14 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [CacheOnly](index.md) / [<init>](./-init-.md)
# <init>
`CacheOnly(startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = Int.MAX_VALUE)`
State for when compact blocks have been downloaded but not scanned. This state is typically achieved when the
app was previously started but killed before the first scan took place. In this case, we do not need to
download compact blocks that we already have.
### Parameters
`startingBlockHeight` - the last block that has been downloaded into the cache. We do not need to download
any blocks before this height because we already have them.

26
docs/-sdk-synchronizer/-sync-state/-cache-only/README.md Normal file
View File

@@ -0,0 +1,26 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [CacheOnly](./index.md)
# CacheOnly
`class CacheOnly : `[`SdkSynchronizer.SyncState`](../index.md)
State for when compact blocks have been downloaded but not scanned. This state is typically achieved when the
app was previously started but killed before the first scan took place. In this case, we do not need to
download compact blocks that we already have.
### Parameters
`startingBlockHeight` - the last block that has been downloaded into the cache. We do not need to download
any blocks before this height because we already have them.
### Constructors
| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `CacheOnly(startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = Int.MAX_VALUE)`<br>State for when compact blocks have been downloaded but not scanned. This state is typically achieved when the app was previously started but killed before the first scan took place. In this case, we do not need to download compact blocks that we already have. |
### Properties
| Name | Summary |
|---|---|
| [startingBlockHeight](starting-block-height.md) | `val startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>the last block that has been downloaded into the cache. We do not need to download any blocks before this height because we already have them. |

9
docs/-sdk-synchronizer/-sync-state/-cache-only/starting-block-height.md Normal file
View File

@@ -0,0 +1,9 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [CacheOnly](index.md) / [startingBlockHeight](./starting-block-height.md)
# startingBlockHeight
`val startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the last block that has been downloaded into the cache. We do not need to download
any blocks before this height because we already have them.

8
docs/-sdk-synchronizer/-sync-state/-first-run.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../../index.md) / [cash.z.ecc.android.sdk.data](../../index.md) / [SdkSynchronizer](../index.md) / [SyncState](index.md) / [FirstRun](./-first-run.md)
# FirstRun
`object FirstRun : `[`SdkSynchronizer.SyncState`](index.md)
State for the first run of the Synchronizer, when the database has not been initialized.

12
docs/-sdk-synchronizer/-sync-state/-ready-to-process/-init-.md Normal file
View File

@@ -0,0 +1,12 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [ReadyToProcess](index.md) / [&lt;init&gt;](./-init-.md)
# &lt;init&gt;
`ReadyToProcess(startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = Int.MAX_VALUE)`
The final state of the Synchronizer, when all initialization is complete and the starting block is known.
### Parameters
`startingBlockHeight` - the height that will be fed to the downloader. In most cases, it will represent
either the wallet birthday or the last block that was processed in the previous session.

24
docs/-sdk-synchronizer/-sync-state/-ready-to-process/README.md Normal file
View File

@@ -0,0 +1,24 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [ReadyToProcess](./index.md)
# ReadyToProcess
`class ReadyToProcess : `[`SdkSynchronizer.SyncState`](../index.md)
The final state of the Synchronizer, when all initialization is complete and the starting block is known.
### Parameters
`startingBlockHeight` - the height that will be fed to the downloader. In most cases, it will represent
either the wallet birthday or the last block that was processed in the previous session.
### Constructors
| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `ReadyToProcess(startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = Int.MAX_VALUE)`<br>The final state of the Synchronizer, when all initialization is complete and the starting block is known. |
### Properties
| Name | Summary |
|---|---|
| [startingBlockHeight](starting-block-height.md) | `val startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>the height that will be fed to the downloader. In most cases, it will represent either the wallet birthday or the last block that was processed in the previous session. |

9
docs/-sdk-synchronizer/-sync-state/-ready-to-process/starting-block-height.md Normal file
View File

@@ -0,0 +1,9 @@
[zcash-android-wallet-sdk](../../../../index.md) / [cash.z.ecc.android.sdk.data](../../../index.md) / [SdkSynchronizer](../../index.md) / [SyncState](../index.md) / [ReadyToProcess](index.md) / [startingBlockHeight](./starting-block-height.md)
# startingBlockHeight
`val startingBlockHeight: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the height that will be fed to the downloader. In most cases, it will represent
either the wallet birthday or the last block that was processed in the previous session.

23
docs/-sdk-synchronizer/-sync-state/README.md Normal file
View File

@@ -0,0 +1,23 @@
[zcash-android-wallet-sdk](../../../index.md) / [cash.z.ecc.android.sdk.data](../../index.md) / [SdkSynchronizer](../index.md) / [SyncState](./index.md)
# SyncState
`sealed class SyncState`
Represents the initial state of the Synchronizer.
### Types
| Name | Summary |
|---|---|
| [CacheOnly](-cache-only/index.md) | `class CacheOnly : `[`SdkSynchronizer.SyncState`](./index.md)<br>State for when compact blocks have been downloaded but not scanned. This state is typically achieved when the app was previously started but killed before the first scan took place. In this case, we do not need to download compact blocks that we already have. |
| [FirstRun](-first-run.md) | `object FirstRun : `[`SdkSynchronizer.SyncState`](./index.md)<br>State for the first run of the Synchronizer, when the database has not been initialized. |
| [ReadyToProcess](-ready-to-process/index.md) | `class ReadyToProcess : `[`SdkSynchronizer.SyncState`](./index.md)<br>The final state of the Synchronizer, when all initialization is complete and the starting block is known. |
### Inheritors
| Name | Summary |
|---|---|
| [CacheOnly](-cache-only/index.md) | `class CacheOnly : `[`SdkSynchronizer.SyncState`](./index.md)<br>State for when compact blocks have been downloaded but not scanned. This state is typically achieved when the app was previously started but killed before the first scan took place. In this case, we do not need to download compact blocks that we already have. |
| [FirstRun](-first-run.md) | `object FirstRun : `[`SdkSynchronizer.SyncState`](./index.md)<br>State for the first run of the Synchronizer, when the database has not been initialized. |
| [ReadyToProcess](-ready-to-process/index.md) | `class ReadyToProcess : `[`SdkSynchronizer.SyncState`](./index.md)<br>The final state of the Synchronizer, when all initialization is complete and the starting block is known. |