Skip to content

Commit 4ccb9b7

Browse files
authored
add a read me for bumping libxmtp (#201)
1 parent 0134852 commit 4ccb9b7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

library/src/main/java/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# LibXMTP Kotlin
2+
3+
Kotlin code emitted by the `bindings_ffi` crate in [libxmtp](https://github.com/xmtp/libxmtp) including how to get jni libraries
4+
5+
## Process for updating from a [libxmtp](https://github.com/xmtp/libxmtp) Kotlin Binding Release (work in progress!)
6+
7+
1. From repo [libxmtp](https://github.com/xmtp/libxmtp) checkout the branch you would like to make a release from
8+
2. Navigate to the `bindings_ffi` folder
9+
3. Run `./gen_kotlin.sh`
10+
4. Run `./cross_build.sh`
11+
5. Copy the contents of `libxmtp/bindings_ffi/src/uniffi/xmtpv3/xmtpv3.kt` to `xmtp-android/library/src/main/java/xmtpv3.kt`
12+
6. All instances of `value.forEach` should be changed to `value.iterator().forEach` to be compatible with API 23
13+
7. Copy the jniLibs from `libxmtp/bindings_ffi/jniLibs` to `xmtp-android/library/src/main/jniLibs`
14+
15+
You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3.

0 commit comments

Comments
 (0)