zec
/
zcash-android-wallet-sdk
mirror of https://github.com/zcash/zcash-android-wallet-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[#1309] Update Public APIs doc 

Closes #1309
This commit is contained in:
Honza Rychnovský 2024-01-05 09:32:49 +01:00 committed by GitHub
parent 8c6c2c239e
commit 437a2e08ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Public APIs.md
View File

@ -7,9 +7,9 @@ The SDK has a variety of public APIs that should be kept stable for SDK consumer
1. Navigate to the root of the SDK checkout
1. Run the Gradle task `./gradlew publishToMavenLocal`
1. Modify the wallet app to build against the new SDK
1. Check out the [Zcash Android Wallet](https://github.com/zcash/zcash-android-wallet)
1. Check out the [Zashi Android Wallet](https://github.com/Electric-Coin-Company/zashi-android)
1. Modify settings.gradle to additionally include `mavenLocal()` in the `dependencyResolutionManagement` block
1. Modify [Dependencies.kt](https://github.com/zcash/zcash-android-wallet/blob/master/buildSrc/src/main/java/cash/z/ecc/android/Dependencies.kt) to use the new SDK version defined in the first step
1. Modify the wallet dependency to use the new SDK version defined in the first step
1. Navigate to the root of the wallet app checkout
1. Build the wallet app and unit tests with the task `./gradlew assembleAndroidTest`
1. Verify the build completes successfully
@ -24,8 +24,8 @@ The SDK has a variety of public APIs that should be kept stable for SDK consumer
1. Navigate to the root of the SDK checkout
1. Run the Gradle task `./gradlew publishToMavenLocal`
1. Modify the wallet app to build against the new SDK
1. Check out the [Zcash Android Wallet](https://github.com/zcash/zcash-android-wallet)
1. Check out the [Zashi Android Wallet](https://github.com/Electric-Coin-Company/zashi-android)
1. Modify settings.gradle to additionally include `mavenLocal()` in the `dependencyResolutionManagement` block
1. Modify [Dependencies.kt](https://github.com/zcash/zcash-android-wallet/blob/master/buildSrc/src/main/java/cash/z/ecc/android/Dependencies.kt) to use the new SDK version defined in the first step
1. Modify the wallet dependency to use the new SDK version defined in the first step
1. Install the wallet app using the new SDK
1. Verify that the wallet behaves correctly (it should not act as if it is starting fresh; user data persisted by the old version of the SDK should still be present after SDK upgrade)