Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the milestone#3 of native tesseract libraries #1089

Merged
merged 1 commit into from
Jan 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Milestone Delivery :mailbox:

**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**

* **Application Document:** [Tesseract dApps/Wallet integration native mobile libraries](https://github.com/w3f/Grants-Program/blob/master/applications/dapp_wallet_integration_native_mobile_libraries.md)
* **Milestone Number:** 3

**Context**

The grant's goal is to implement [Tesseract](https://github.com/tesseract-one/) native mobile APIs (Swift and Kotlin). This milestone is dedicated to providing **Kotlin** APIs for the **dApp** side.

**Deliverables**

| Number | Deliverable | Link | Notes |
| ------------- | ------------- | ------------- |------------- |
| **0a.** | License | [Apache 2.0](https://github.com/tesseract-one/Tesseract.android/blob/main/LICENSE) | Apache 2.0 |
| **0b.** | Documentation | [Main repo README](https://github.com/tesseract-one/Tesseract.android) | Please, start with the initial README.MD and follow the links. One of the most interesting parts is DAPP.MD |
| **0c.** | Testing and Testing Guide | [gdoc](https://docs.google.com/document/d/1ce8onLBOEBRB_UO4dj9BN7c9aY-c0Xt5QIX3ke2W7sg/edit?usp=sharing) | |
| **0d.** | Docker | | Not required to run the project |
| 0e. | Article | | Will be shared in private by e-mail during the milestone evaluation |
| 1. | Client-side Android library | [java](https://github.com/tesseract-one/Tesseract.android/tree/main/java/client) and [rust](https://github.com/tesseract-one/Tesseract.android/tree/main/rust/library/) | These are the main enty-points. Though, the end-user might want to import some java classes from base and common sibling libraries. |
| 2. | Client-side IPC wrapper for Android | [client-transport-ipc](https://github.com/tesseract-one/Tesseract.android/tree/main/java/client-transport-ipc) | Not a wrapper anymore. Since we have implemented native APIs for transport development as well, IPC transport was fully rewritten in Kotlin. It's very platform specific, so it's a better option. |
| 3. | Client-side of the Test protocol in Kotlin | [with coroutines](https://github.com/tesseract-one/Tesseract.android/blob/main/java/common/src/main/java/one/tesseract/protocol/kotlin/TestService.kt) and [with futures](https://github.com/tesseract-one/Tesseract.android/blob/main/java/common/src/main/java/one/tesseract/protocol/java/TestService.kt) | Depending on the use case, a developer can choose either one. More details here: [Service flavors](https://github.com/tesseract-one/Tesseract.android/blob/main/DAPP.MD#service-flavors). Since the Milestone#1 we moved the interfaces into common code and use them with adapters in both Client and Service implementations. |
| 4. | Client-side of the Substrate protocol in Kotlin | [with coroutines](https://github.com/tesseract-one/Tesseract.android/blob/main/java/common/src/main/java/one/tesseract/protocol/kotlin/SubstrateService.kt) and [with futures](https://github.com/tesseract-one/Tesseract.android/blob/main/java/common/src/main/java/one/tesseract/protocol/java/SubstrateService.kt) | Depending on the use case, a developer can choose either one. More details here: [Service flavors](https://github.com/tesseract-one/Tesseract.android/blob/main/DAPP.MD#service-flavors). Since the Milestone#1 we moved the interfaces into common code and use them with adapters in both Client and Service implementations. |
| 5. | Android demo dApp | [polkachat.kotlin](https://github.com/tesseract-one/polkachat.kotlin) | For the demo, we have forked the [polkachat.rs](https://github.com/tesseract-one/polkachat.rs) (a cross-platform demo dApp in Rust with native UIs) and got rid of all the Rust parts replacing them with new Kotlin equivalents. It can build and run without installing Rust environment at all. |

**Additional Information**

For the sake of keeping the table above small and concise, there are only references to the public APIs. The rest of the libraries in siblings directories (both rust and java), even though are essential, are mostly private and contain code that serve the public APIs to function. There is more details about it in the [testing guide](https://docs.google.com/document/d/1ce8onLBOEBRB_UO4dj9BN7c9aY-c0Xt5QIX3ke2W7sg/edit?usp=sharing).
Loading