Commit Graph

50 Commits

Author SHA1 Message Date
Carter Jernigan f4940348fe
Improve readme documentation (#667)
Co-authored-by: Honza <rychnovsky.honza@gmail.com>
2022-08-12 06:57:27 -04:00
Carter Jernigan 96eab807cb [#612] Make dependency locking configurable
This implementation is somewhat special from our other Gradle properties, because it does not get declared in the root gradle.properties.  The reason is that included builds are supposed to have their own properties e.g.

root_project/gradle.properties
root_project/build-conventions/gradle.properties

Instead of declaring the property in different places which might lead to confusion, this leaves the property undeclared, with the Gradle scripts assuming a default value of true.  The only time this is expected to be overridden is due to a workaround for an Android Studio bug.
2022-07-25 15:36:39 -04:00
Francisco Gindre bd2061956b
[#585] Add checkpoints for Orchard Activation Height (#586)
* [#585] Add checkpoints for Orchard Activation Height

Closes #585

these checkpoints will be useful for wallets supporting orchard
that had existing orchard activity from activation height on and
after NU5 SDK support is implemented they need to rescan for orchard
funds.

* Add documentation on special checkpoints

Co-authored-by: Carter Jernigan <git@carterjernigan.com>
2022-06-24 14:27:07 -03:00
Carter Jernigan a5a07becd8
[#548] Configure testing with emulator.wtf 2022-06-21 07:57:04 -04:00
Carter Jernigan 016df9a623 [#271] Namespace checkpoint assets 2022-06-14 13:42:46 -04:00
Carter Jernigan 84442a23a7
[#517] Switch to Adoptium JDK (#519)
Temurin/Adoptium is the default used by Gradle toolchains, and they now have both Java 11 and 17 ARM support for Macs
2022-05-24 08:19:46 -04:00
Carter Jernigan a9245f2d67 [#502] Prepare 1.4.0-beta01 release 2022-05-09 09:57:33 -04:00
Carter Jernigan e78139fa1a [#503] Update checkpoints
- Added instructions to readme for updating checkpoints
 - Added new checkpoints since the last release
 - Re-generated old checkpoints for consistent formatting of the height in quotes.  Although our JSON parser supports both, consistent formatting reduces future bug risks
 - Generated missing checkpoints
 - Removed odd-numbered checkpoints (which were left over as the “latest” checkpoint during previous checkpoint updates)
2022-05-05 12:22:28 -04:00
Carter Jernigan 099986de39 [#373] Add PR and issue templates
This updates our templates to be more consistent with the Secant app repository.

Note that the checklist item for code coverage was removed for now, until we improve the test infrastructure for the SDK.

This also addresses a security reminder, by explicitly stating that one shouldn't run the demo app from a pull request until after reviewing the code changes.
2022-02-03 11:07:43 -05:00
Carter Jernigan eb728fe3d8 [#330] Use KSP for annotation processing
This resolves issues with included builds
2022-01-06 06:59:40 -05:00
Carter Jernigan 0c570a2535 Improve ktlint and JDK compatibility
This eliminates the need to manually set a JDK version when running ktlintFormat.
2021-11-29 14:23:43 -05:00
Carter Jernigan 9fffdce6be
[#323] Set NDK version to 22.1.7171670 2021-11-22 09:20:59 -05:00
Carter Jernigan f7af59da12 [#317] Update NDK to 24.0.7856742 2021-11-18 14:37:36 -05:00
Carter Jernigan f9f8350510
[#313] Gradle 7.3
In addition to updating the version of Gradle, I've added the sha256 to enable verification of the Gradle download.
2021-11-18 14:37:11 -05:00
Carter Jernigan dca91f2558 [#319] Fix ktlint issues 2021-11-18 07:10:30 -05:00
Carter Jernigan 6540e6fd35 [#264] Fix license link in readme 2021-10-04 08:17:55 -04:00
Carter Jernigan b4213f3e48 [#290] Delete `targets` directory during clean 2021-09-30 07:45:36 -04:00
Carter Jernigan 07d02e6cea [#285] Implement gradle build conventions
In addition to using build-conventions to make the build scripts more DRY, the following additional changes are included in this commit:

- Convert build scripts to kts
- Fix a double-build issue with the SDK
- Add configurable options for treating compiler warnings as errors (disabled for now, due to extensive warnings that need to be corrected first)
- Added detekt as an additional static analysis tool
2021-09-25 12:54:42 -04:00
Carter Jernigan 7b28c7ab38 [#255] Fix demo-app paths in readme 2021-08-31 14:53:25 -04:00
Carter Jernigan 8848789b75 Minor updates to the readme
Added instructions for installing Rust with Homebrew, which simplifies setup for many macOS developers.

Add x86_64 target, as the SDK can fail to build out of the box without this option.

Fix instructions for compiling the SDK versus compiling the sample application
2021-08-25 10:07:20 -04:00
Kevin Gorham d7de409726
Add info about publishing. 2021-08-20 00:44:57 -04:00
Kevin Gorham b891163821
Update dependency portion of the readme. 2021-05-11 19:14:56 -04:00
Kevin Gorham b82a296278
Remove Bintray badge from README, add Maven Central. 2021-05-04 17:03:53 -04:00
Kevin Gorham ad1f2438fb
Docs: Update README to draw attention to the demo app. 2021-03-31 09:07:37 -04:00
Eljo Prifti 6e75e0aeb5
fix Readme grammar (#189)
* fix readme grammar

* Update README.md

Co-authored-by: Kevin Gorham <anothergmale@gmail.com>

* Update README.md

Co-authored-by: Kevin Gorham <anothergmale@gmail.com>

Co-authored-by: Kevin Gorham <anothergmale@gmail.com>
2020-12-14 09:15:30 -05:00
Kevin Gorham 34ae0feb8f
Updated primary README. 2020-09-11 06:03:21 -04:00
Kevin Gorham 8180d10d61
Update README to reflect how to use the bintray releases. 2020-06-10 15:47:50 -04:00
Kevin Gorham 79184c3cdd
Merge pull request #133 from zcash/feature/api-updates
Feature/api updates
2020-06-10 06:00:34 -04:00
Kevin Gorham 38fa68a4ec
Update NDK version instructions 2020-06-10 03:43:30 -04:00
Kevin Gorham aa569c99dd
Major refactor: corrected package name.
Now the SDK matches everything else that we have published to bintray and jcenter.
2020-06-10 03:08:19 -04:00
Taylor Hornby 761fd94be0 Replace the threat model with the one on readthedocs 2020-05-27 16:49:20 -06:00
Dimitris Apostolou 44cba56d30
Fix typos and cleanup 2020-03-26 13:00:04 +02:00
Kevin Gorham 785f9d5421
Update main README. 2020-02-27 13:51:00 -05:00
Kevin Gorham 6fa1cda5f6
Merge pull request #94 from defuse/link-to-threat-model
Link to threat model in README
2020-01-16 18:12:45 -05:00
Taylor Hornby 2fe8d0f641 Link to threat model in README 2020-01-16 12:23:41 -07:00
CHMEX 320e87fe07
typo
Great job! 
small typo
2020-01-15 22:48:12 +01:00
Kevin Gorham b32f5973e9
Corrections to the top-level README file. 2020-01-15 08:28:20 -05:00
Bradley Miller 7bde72f11f Update README for first versioned release 2020-01-08 14:10:06 -07:00
Kevin Gorham 1f18042d52
Implement versioning and other cleanup.
- Correct typo and compiler warning in Rust.
'trait objects without an explicity dyn' are deprecated and this is a warning as of Rust 1.37
- update dependencies
- update documentation

docs
2019-09-12 01:31:23 -04:00
Kevin Gorham afa142e1c9 Update docs 2019-03-30 12:22:20 -04:00
Kevin Gorham dec4f0f62e Add docs folder with Synchronizer documentation 2019-03-29 02:31:25 -04:00
Kevin Gorham 72283cee81 Cleanup Synchronizer API, add KDocs and remove dead code 2019-03-29 02:04:25 -04:00
Kevin Gorham af998e132d Promote diagrams from draft to final status 2019-03-27 02:09:25 -04:00
Kevin Gorham 5ea910b7f0 Updated readme to further point to preview branch 2019-03-27 01:32:18 -04:00
Kevin Gorham 4261ae9efc Update README to reference preview branch 2019-03-19 11:51:11 -04:00
Kevin Gorham 2467ab2dfb Update readme to reflect latest behavior 2019-03-13 02:36:35 -04:00
Kevin Gorham cc41d0646b Added diagram for developer Point of View 2019-03-13 02:36:26 -04:00
Kevin Gorham 76bcc52b25 Initial explanation of the structure of the SDK 2019-03-13 02:28:21 -04:00
Kevin Gorham 8598fe5fd7 Add diagram to the README
Renamed data DB in overview diagram. Initially we expected this to only contain UI data but it was easier to have one database for everything that can be derived from a seed, rather than multiple databases segregated by sensitivity.
2019-03-13 02:27:59 -04:00
Kevin Gorham 32af4b9559 initial commit of sample project code
The next step is to clean this up and integrate it with the latest version of the android app
2018-11-20 12:59:08 -05:00