chornyy add web socket implementation

README.md

@@ -21,12 +21,6 @@ This is a Kotlin MultiPlatform library that ...
 - Android API 16+
 - iOS version 11.0+
 
-## Versions
-- kotlin 1.5.20
-  - 0.1.0
-  - 0.2.0
-  - 0.3.0
-
 ## Installation
 root build.gradle  
 ```groovy
@@ -40,7 +34,7 @@ allprojects {
 project build.gradle
 ```groovy
 dependencies {
-    commonMainApi("dev.icerock.moko:web3:0.3.0")
+    commonMainApi("dev.icerock.moko:web3:0.4.0")
 }
 ```
 

gradle/libs.versions.toml

@@ -9,7 +9,8 @@ kbignumVersion = "2.2.0"
 klockVersion = "2.2.2"
 ktorClientVersion = "1.6.1"
 mokoTestVersion = "0.4.0"
-mokoWeb3Version = "0.3.0"
+mokoWeb3Version = "0.4.0"
+multidexVersion = "2.0.1"
 
 [libraries]
 appCompat = { module = "androidx.appcompat:appcompat", version.ref = "androidAppCompatVersion" }
@@ -30,9 +31,11 @@ kotlinSerialization = { module = "org.jetbrains.kotlinx:kotlinx-serialization-js
 ktorClient = { module = "io.ktor:ktor-client-core", version.ref = "ktorClientVersion" }
 ktorClientLogigng = { module = "io.ktor:ktor-client-logging", version.ref = "ktorClientVersion" }
 ktorClientOkHttp = { module = "io.ktor:ktor-client-okhttp", version.ref = "ktorClientVersion" }
+ktorWebsockets = { module = "io.ktor:ktor-client-websockets", version.ref = "ktorClientVersion" }
 ktorClientIos = { module = "io.ktor:ktor-client-ios", version.ref = "ktorClientVersion" }
 klock = { module = "com.soywiz.korlibs.klock:klock", version.ref = "klockVersion" }
 kotlinTestCommon = { module = "org.jetbrains.kotlin:kotlin-test-common", version.ref = "kotlinVersion" }
 kotlinTestAnnotations = { module = "org.jetbrains.kotlin:kotlin-test-annotations-common", version.ref = "kotlinVersion" }
 kotlinTest = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlinVersion" }
-kotlinTestJunit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kotlinVersion" }
+kotlinTestJunit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kotlinVersion" }
+multidex = { module = "androidx.multidex:multidex", version.ref = "multidexVersion" }

sample/android-app/build.gradle.kts

@@ -10,6 +10,7 @@ android {
     defaultConfig {
         applicationId = "dev.icerock.moko.samples.web3"
 
+        multiDexEnabled = true
         versionCode = 1
         versionName = "0.1.0"
     }
@@ -18,6 +19,7 @@ android {
 dependencies {
     implementation(libs.appCompat)
     implementation(libs.material)
+    implementation(libs.multidex)
 
     implementation(projects.sample.mppLibrary)
 }

web3/build.gradle.kts

@@ -9,21 +9,30 @@ plugins {
     id("kotlinx-serialization")
 }
 
+android {
+    testOptions {
+        unitTests.isReturnDefaultValues = true
+    }
+}
+
 dependencies {
     commonMainImplementation(libs.coroutines)
     commonMainImplementation(libs.kbignum)
     commonMainImplementation(libs.kotlinSerialization)
     commonMainImplementation(libs.klock)
     commonMainImplementation(libs.ktorClient)
     commonMainImplementation(libs.ktorClientLogigng)
+    commonMainImplementation(libs.ktorWebsockets)
 
     commonTestImplementation(libs.kotlinTestCommon)
     commonTestImplementation(libs.kotlinTestAnnotations)
-
+
+    androidMainImplementation(libs.ktorClientOkHttp)
     androidTestImplementation(libs.ktorClientOkHttp)
     androidTestImplementation(libs.kotlinTest)
     androidTestImplementation(libs.kotlinTestJunit)
 
+    iosMainImplementation(libs.ktorClientIos)
     iosTestImplementation(libs.ktorClientIos)
 }
 

web3/src/androidMain/kotlin/dev/icerock/moko/web3/websockets/Logger.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.web3.websockets
+
+import android.util.Log
+import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.engine.okhttp.OkHttp
+import java.util.concurrent.TimeUnit
+
+actual fun log(message: String) {
+    Log.d("KCWS", message)
+}
+
+actual fun createHttpClientEngine(): HttpClientEngine {
+    return OkHttp.create {
+        config {
+            retryOnConnectionFailure(true)
+            pingInterval(30, TimeUnit.SECONDS)
+        }
+    }
+}

web3/src/androidTest/kotlin/dev/icerock/moko/web3/Web3SocketTest.kt

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+@file:Suppress("EXPERIMENTAL_API_USAGE")
+
+package dev.icerock.moko.web3
+
+import dev.icerock.moko.web3.websockets.SubscriptionParam
+import dev.icerock.moko.web3.websockets.createHttpClientEngine
+import io.ktor.client.*
+import io.ktor.client.features.logging.*
+import io.ktor.client.features.websocket.*
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.*
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.json.Json
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+
+class Web3SocketTest {
+
+    private lateinit var web3Socket: Web3Socket
+
+    @BeforeTest
+    fun `create socket`() {
+        val httpClient = HttpClient(createHttpClientEngine()) {
+            install(WebSockets) {
+                pingInterval = 30
+            }
+        }
+
+        web3Socket = Web3Socket(
+            httpClient = httpClient,
+            webSocketUrl = "wss://rinkeby.infura.io/ws/v3/59d7fae3226b40e09d84d713e588305b",
+            coroutineScope = GlobalScope
+        )
+    }
+
+    @Test
+    fun `test web socket flow`() {
+        runBlocking {
+            web3Socket.subscribeWebSocketWithFilter(SubscriptionParam.Logs)
+                .onEach(::println)
+                .take(2)
+                .launchIn(scope = this)
+
+            web3Socket.subscribeWebSocketWithFilter(SubscriptionParam.Logs)
+                .onEach(::println)
+                .take(2)
+                .launchIn(scope = this)
+
+            web3Socket.subscribeWebSocketWithFilter(SubscriptionParam.Logs)
+                .onEach(::println)
+                .take(2)
+                .launchIn(scope = this)
+        }
+    }
+}

web3/src/commonMain/kotlin/dev.icerock.moko.web3/LogsWeb3SocketEvent.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.web3
+
+import kotlinx.serialization.Serializable
+
+
+@Serializable
+data class LogsWeb3SocketEvent(
+    val removed: Boolean,
+    val logIndex: String,
+    val transactionIndex: String,
+    val transactionHash: String,
+    val blockHash: String,
+    val blockNumber: String,
+    val address: String,
+    val data: String,
+    val topics: List<String>
+)

web3/src/commonMain/kotlin/dev.icerock.moko.web3/NewHeadsWeb3SocketEvent.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.web3
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class NewHeadsWeb3SocketEvent(
+    val difficulty: String,
+    val extraData: String,
+    val gasLimit: String,
+    val gasUsed: String,
+    val logsBloom: String,
+    val miner: String,
+    val nonce: String,
+    val number: String,
+    val parentHash: String,
+    val receiptsRoot: String,
+    val sha3Uncles: String,
+    val stateRoot: String,
+    val timestamp: String,
+    val transactionsRoot: String,
+    val hash: String
+)

web3/src/commonMain/kotlin/dev.icerock.moko.web3/SyncingWeb3SocketEvent.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2021 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.web3
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class SyncingWeb3SocketEvent(
+    val syncing: Boolean,
+    val status: Status
+) {
+    @Serializable
+    data class Status(
+        val startingBlock: Int,
+        val currentBlock: Int,
+        val highestBlock: Int,
+        val pulledStates: Int,
+        val knownStates: Int
+    )
+}