Merge pull request #1495 from WalletConnect/deprecate

Deprecate
WalletConnect · Sep 21, 2024 · e373c53 · e373c53
2 parents 743ff1e + 8395e0c
commit e373c53
Show file tree

Hide file tree

Showing 52 changed files with 391 additions and 42 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -1,10 +1,11 @@
 ![WalletConnect V2](/docs/walletconnect-banner.svg)
 
-# **WalletConnect - Kotlin**
-
-The communications protocol for web3, WalletConnect brings the ecosystem together by enabling hundreds of wallets and apps to securely connect and interact. This repository contains Kotlin implementation of
-WalletConnect v2 protocols for Android applications.
+# **Deprecated - WalletConnect - Kotlin**
+WalletConnect Inc is now Reown. As part of this transition, we are deprecating a number of repositories/packages across our supported platforms, and transitioning to their equivalents published under the Reown organization.
 
+This repository is now considered deprecated and will reach End-of-Life on February 17th 2025. For more details, including migration guides please see: https://docs.reown.com/advanced/walletconnect-deprecations
+
+---
 ####
 
 ## BOM Instructions:

diff --git a/core/android/src/main/kotlin/com/walletconnect/android/CoreClient.kt b/core/android/src/main/kotlin/com/walletconnect/android/CoreClient.kt
@@ -1,7 +1,8 @@
 package com.walletconnect.android
 
+@Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
 object CoreClient : CoreInterface by CoreProtocol.instance {
 
+    @Deprecated("com.walletconnect.android.CoreDelegate has been deprecated. Please use com.reown.android.CoreDelegate instead from - https://github.com/reown-com/reown-kotlin")
     interface CoreDelegate : CoreInterface.Delegate
-
 }
diff --git a/core/android/src/main/kotlin/com/walletconnect/android/CoreInterface.kt b/core/android/src/main/kotlin/com/walletconnect/android/CoreInterface.kt
@@ -10,6 +10,7 @@ import com.walletconnect.android.relay.NetworkClientTimeout
 import com.walletconnect.android.relay.RelayConnectionInterface
 import com.walletconnect.android.verify.client.VerifyInterface
 
+@Deprecated("com.walletconnect.android.CoreInterface has been deprecated. Please use com.reown.android.CoreInterface instead from - https://github.com/reown-com/reown-kotlin")
 interface CoreInterface {
     val Pairing: PairingInterface
     val PairingController: PairingControllerInterface
@@ -20,10 +21,13 @@ interface CoreInterface {
     val Verify: VerifyInterface
     val Explorer: ExplorerInterface
 
+    @Deprecated("com.walletconnect.android.CoreInterface has been deprecated. Please use com.reown.android.CoreInterface instead from - https://github.com/reown-com/reown-kotlin")
     interface Delegate : PairingInterface.Delegate
 
+    @Deprecated("com.walletconnect.android.CoreInterface has been deprecated. Please use com.reown.android.CoreInterface instead from - https://github.com/reown-com/reown-kotlin")
     fun setDelegate(delegate: Delegate)
 
+    @Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
     fun initialize(
         metaData: Core.Model.AppMetaData,
         relayServerUrl: String,
@@ -36,6 +40,7 @@ interface CoreInterface {
         onError: (Core.Model.Error) -> Unit,
     )
 
+    @Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
     fun initialize(
         application: Application,
         projectId: String,

diff --git a/core/android/src/main/kotlin/com/walletconnect/android/CoreProtocol.kt b/core/android/src/main/kotlin/com/walletconnect/android/CoreProtocol.kt
@@ -57,6 +57,7 @@ class CoreProtocol(private val koinApp: KoinApplication = wcKoinApp) : CoreInter
         plantTimber()
     }
 
+    @Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
     override fun setDelegate(delegate: CoreInterface.Delegate) {
         Pairing.setDelegate(delegate)
     }
@@ -65,6 +66,7 @@ class CoreProtocol(private val koinApp: KoinApplication = wcKoinApp) : CoreInter
         val instance = CoreProtocol()
     }
 
+    @Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
     override fun initialize(
         metaData: Core.Model.AppMetaData,
         relayServerUrl: String,
@@ -96,6 +98,7 @@ class CoreProtocol(private val koinApp: KoinApplication = wcKoinApp) : CoreInter
         }
     }
 
+    @Deprecated("com.walletconnect.android.CoreClient has been deprecated. Please use com.reown.android.CoreClient instead from - https://github.com/reown-com/reown-kotlin")
     override fun initialize(
         application: Application,
         projectId: String,

diff --git a/core/android/src/main/kotlin/com/walletconnect/android/relay/RelayClient.kt b/core/android/src/main/kotlin/com/walletconnect/android/relay/RelayClient.kt
@@ -23,6 +23,7 @@ import kotlinx.coroutines.supervisorScope
 import org.koin.core.KoinApplication
 import org.koin.core.qualifier.named
 
+@Deprecated("com.walletconnect.android.relay.RelayClient has been deprecated. Please use com.reown.android.relay.RelayClient instead from - https://github.com/reown-com/reown-kotlin")
 class RelayClient(private val koinApp: KoinApplication = wcKoinApp) : BaseRelayClient(), RelayConnectionInterface {
     private val manualConnection: ManualConnectionLifecycle by lazy { koinApp.koin.get(named(AndroidCommonDITags.MANUAL_CONNECTION_LIFECYCLE)) }
     private val networkState: ConnectivityState by lazy { koinApp.koin.get(named(AndroidCommonDITags.CONNECTIVITY_STATE)) }

diff --git a/core/android/src/main/kotlin/com/walletconnect/android/relay/RelayConnectionInterface.kt b/core/android/src/main/kotlin/com/walletconnect/android/relay/RelayConnectionInterface.kt
@@ -4,6 +4,7 @@ import com.walletconnect.android.Core
 import com.walletconnect.foundation.network.RelayInterface
 import kotlinx.coroutines.flow.StateFlow
 
+@Deprecated("com.walletconnect.android.relay.RelayConnectionInterface has been deprecated. Please use com.reown.android.relay.RelayConnectionInterface instead from - https://github.com/reown-com/reown-kotlin")
 interface RelayConnectionInterface : RelayInterface {
     val wssConnectionState: StateFlow<WSSConnectionState>
     val isNetworkAvailable: StateFlow<Boolean?>

diff --git a/product/walletconnectmodal/ReadMe.md b/product/walletconnectmodal/ReadMe.md
@@ -2,12 +2,6 @@
 
 # Installation
 
-:::caution
-**The WalletConnectModal SDK is currently in Alpha and is not production-ready**.
-
-It's public API and associated documentation may still see significant and breaking changes.
-:::
-
 Kotlin implementation of WalletConnectModal for Android applications.
 
 Android Core ![Maven Central](https://img.shields.io/maven-central/v/com.walletconnect/android-core)

diff --git a/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/Modal.kt b/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/Modal.kt
@@ -7,6 +7,7 @@ import com.walletconnect.android.CoreInterface
 import com.walletconnect.android.cacao.SignatureInterface
 import com.walletconnect.android.internal.common.signing.cacao.Issuer
 
+@Deprecated("com.walletconnect.web3.modal.client.Wallet has been deprecated. Please use com.reown.appkit.client.Modal instead from - https://github.com/reown-com/reown-kotlin")
 object Modal {
 
     sealed interface Listeners {

diff --git a/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/Web3Modal.kt b/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/Web3Modal.kt
@@ -26,6 +26,7 @@ import org.jetbrains.annotations.ApiStatus.Experimental
 import org.koin.core.qualifier.named
 import org.koin.dsl.module
 
+@Deprecated("This package is now considered deprecated and will reach End-of-Life on February 17th 2025. For more details, including migration guides please see: docs.reown.com")
 object Web3Modal {
 
     internal var chains: List<Modal.Model.Chain> = listOf()
@@ -38,6 +39,7 @@ object Web3Modal {
 
     private lateinit var web3ModalEngine: Web3ModalEngine
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.ModalDelegate"))
     interface ModalDelegate {
         fun onSessionApproved(approvedSession: Modal.Model.ApprovedSession)
         fun onSessionRejected(rejectedSession: Modal.Model.RejectedSession)
@@ -64,13 +66,15 @@ object Web3Modal {
         fun onError(error: Modal.Model.Error)
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.ComponentDelegate"))
     interface ComponentDelegate {
         fun onModalExpanded()
 
         fun onModalHidden()
 
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.initialize(init, onSuccess, onError)"))
     fun initialize(
         init: Modal.Params.Init,
         onSuccess: () -> Unit = {},
@@ -91,12 +95,14 @@ object Web3Modal {
         )
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.register(activity)"))
     @Experimental
     fun register(activity: ComponentActivity) {
         checkEngineInitialization()
         web3ModalEngine.registerCoinbaseLauncher(activity)
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.unregister()"))
     @Experimental
     fun unregister() {
         checkEngineInitialization()
@@ -135,18 +141,22 @@ object Web3Modal {
         }
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.setChains(chains)"))
     fun setChains(chains: List<Modal.Model.Chain>) {
         this.chains = chains
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.setAuthRequestParams(authParams)"))
     fun setAuthRequestParams(authParams: Modal.Model.AuthPayloadParams) {
         authPayloadParams = authParams
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.setSessionProperties(properties)"))
     fun setSessionProperties(properties: Map<String, String>) {
         sessionProperties = properties
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.setDelegate(delegate)"))
     @Throws(IllegalStateException::class)
     fun setDelegate(delegate: ModalDelegate) {
         Web3ModalDelegate.connectionState.onEach { connectionState ->
@@ -189,6 +199,7 @@ object Web3Modal {
         ) { onError(it.toModal()) }
     }
 
+    @Deprecated("Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin", replaceWith = ReplaceWith("AppKit.connect(connect, onSuccess, onError)"))
     fun connect(
         connect: Modal.Params.Connect,
         onSuccess: (String) -> Unit,
@@ -201,6 +212,10 @@ object Web3Modal {
         )
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.authenticate(authenticate, walletAppLink, onSuccess, onError)")
+    )
     fun authenticate(
         authenticate: Modal.Params.Authenticate,
         walletAppLink: String? = null,
@@ -213,15 +228,19 @@ object Web3Modal {
             onError = { onError(it.toModal()) })
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.handleDeepLink(url, onError)")
+    )
     fun handleDeepLink(url: String, onError: (Modal.Model.Error) -> Unit) {
         SignClient.dispatchEnvelope(url) {
             onError(it.toModal())
         }
     }
 
     @Deprecated(
-        message = "Modal.Params.Request is deprecated",
-        replaceWith = ReplaceWith("com.walletconnect.web3.modal.client.models.Request")
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.request(request, onSuccess, onError)")
     )
     fun request(
         request: Modal.Params.Request,
@@ -236,6 +255,10 @@ object Web3Modal {
         )
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.request(request, onSuccess, onError)")
+    )
     fun request(
         request: Request,
         onSuccess: (SentRequestResult) -> Unit = {},
@@ -250,6 +273,10 @@ object Web3Modal {
         is SentRequestResult.WalletConnect -> Modal.Model.SentRequest(requestId, sessionTopic, method, params, chainId)
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.request(request, onSuccess, onError)")
+    )
     fun request(
         request: Request,
         onSuccess: () -> Unit,
@@ -259,11 +286,15 @@ object Web3Modal {
         web3ModalEngine.request(request, { onSuccess() }, onError)
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.ping(sessionPing)")
+    )
     fun ping(sessionPing: Modal.Listeners.SessionPing? = null) = web3ModalEngine.ping(sessionPing)
 
     @Deprecated(
-        message = "This has become deprecate in favor of the parameterless disconnect function",
-        level = DeprecationLevel.WARNING
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.disconnect(onSuccess, onError)")
     )
     fun disconnect(
         onSuccess: (Modal.Params.Disconnect) -> Unit = {},
@@ -281,6 +312,10 @@ object Web3Modal {
         )
     }
 
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.disconnect(onSuccess, onError)")
+    )
     fun disconnect(
         onSuccess: () -> Unit,
         onError: (Throwable) -> Unit,
@@ -293,6 +328,10 @@ object Web3Modal {
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getSelectedChain()")
+    )
     fun getSelectedChain() = selectedChain
 //    fun getSelectedChain() = getSelectedChainUseCase()?.toChain()
 
@@ -301,9 +340,8 @@ object Web3Modal {
      * It is advised that this function be called from background operation
      */
     @Deprecated(
-        message = "Getting active session is replaced with getAccount()",
-        replaceWith = ReplaceWith("com.walletconnect.web3.modal.client.Web3Modal.getAccount()"),
-        level = DeprecationLevel.WARNING
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getAccount()")
     )
     internal fun getActiveSessionByTopic(topic: String) = SignClient.getActiveSessionByTopic(topic)?.toModal()
 
@@ -312,9 +350,8 @@ object Web3Modal {
      * It is advised that this function be called from background operation
      */
     @Deprecated(
-        message = "Getting active session is replaced with getAccount()",
-        replaceWith = ReplaceWith("com.walletconnect.web3.modal.client.Web3Modal.getAccount()"),
-        level = DeprecationLevel.WARNING
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getAccount()")
     )
     fun getActiveSession(): Modal.Model.Session? {
         checkEngineInitialization()
@@ -325,6 +362,10 @@ object Web3Modal {
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getAccount()")
+    )
     fun getAccount(): Account? {
         checkEngineInitialization()
         return web3ModalEngine.getAccount()
@@ -334,6 +375,10 @@ object Web3Modal {
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getSession()")
+    )
     fun getSession(): Session? {
         checkEngineInitialization()
         return web3ModalEngine.getSession()
@@ -343,6 +388,10 @@ object Web3Modal {
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
+    @Deprecated(
+        "Web3Modal has been deprecated. Please use AppKit instead from - https://github.com/reown-com/reown-kotlin",
+        replaceWith = ReplaceWith("AppKit.getConnectorType()")
+    )
     fun getConnectorType(): Modal.ConnectorType? {
         checkEngineInitialization()
         return web3ModalEngine.getConnectorType()

diff --git a/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Account.kt b/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Account.kt
@@ -2,6 +2,7 @@ package com.walletconnect.web3.modal.client.models
 
 import com.walletconnect.web3.modal.client.Modal
 
+@Deprecated("com.walletconnect.web3.modal.client.models.Account has been deprecated. Please use com.reown.appkit.client.models.Account instead from - https://github.com/reown-com/reown-kotlin")
 data class Account(
     val address: String,
     val chain: Modal.Model.Chain

diff --git a/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Exceptions.kt b/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Exceptions.kt
@@ -2,5 +2,8 @@ package com.walletconnect.web3.modal.client.models
 
 import com.walletconnect.android.internal.common.exception.WalletConnectException
 
+@Deprecated("com.walletconnect.web3.modal.client.models.Web3ModelClientAlreadyInitializedException has been deprecated. Please use com.reown.appkit.client.models.Web3ModelClientAlreadyInitializedException instead from - https://github.com/reown-com/reown-kotlin")
 class Web3ModelClientAlreadyInitializedException : WalletConnectException("Web3Modal already initialized")
+
+@Deprecated("com.walletconnect.web3.modal.client.models.CoinbaseClientAlreadyInitializedException has been deprecated. Please use com.reown.appkit.client.models.CoinbaseClientAlreadyInitializedException instead from - https://github.com/reown-com/reown-kotlin")
 class CoinbaseClientAlreadyInitializedException : WalletConnectException("Coinbase already initialized")
diff --git a/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Session.kt b/product/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/Session.kt
@@ -3,8 +3,8 @@ package com.walletconnect.web3.modal.client.models
 import com.walletconnect.android.Core
 import com.walletconnect.web3.modal.client.Modal
 
+@Deprecated("com.walletconnect.web3.modal.client.models.Session has been deprecated. Please use com.reown.appkit.client.models.Modal instead from - https://github.com/reown-com/reown-kotlin")
 sealed class Session {
-
     data class WalletConnectSession(
         val pairingTopic: String,
         val topic: String,

diff --git a/...t/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/request/Request.kt b/...t/web3modal/src/main/kotlin/com/walletconnect/web3/modal/client/models/request/Request.kt
@@ -1,5 +1,6 @@
 package com.walletconnect.web3.modal.client.models.request
 
+@Deprecated("com.walletconnect.web3.modal.client.models.request.Request has been deprecated. Please use com.reown.appkit.client.models.request.Request instead from - https://github.com/reown-com/reown-kotlin")
 data class Request(
     val method: String,
     val params: String,

diff --git a/...l/src/main/kotlin/com/walletconnect/web3/modal/client/models/request/SentRequestResult.kt b/...l/src/main/kotlin/com/walletconnect/web3/modal/client/models/request/SentRequestResult.kt
@@ -3,6 +3,7 @@ package com.walletconnect.web3.modal.client.models.request
 import com.walletconnect.sign.client.Sign
 import com.walletconnect.web3.modal.engine.coinbase.CoinbaseResult
 
+@Deprecated("com.walletconnect.web3.modal.client.models.request.SentRequestResult has been deprecated. Please use com.reown.appkit.client.models.request.SentRequestResult instead from - https://github.com/reown-com/reown-kotlin")
 sealed class SentRequestResult {
     abstract val method: String
     abstract val params: String

diff --git a/.../web3modal/src/main/kotlin/com/walletconnect/web3/modal/presets/Web3ModalChainsPresets.kt b/.../web3modal/src/main/kotlin/com/walletconnect/web3/modal/presets/Web3ModalChainsPresets.kt
@@ -3,6 +3,7 @@ package com.walletconnect.web3.modal.presets
 import com.walletconnect.web3.modal.client.Modal
 import com.walletconnect.web3.modal.utils.EthUtils
 
+@Deprecated("com.walletconnect.web3.modal.presets.Web3ModalChainsPresets has been deprecated. Please use  com.reown.appkit.presets.AppKitChainsPresets instead from - https://github.com/reown-com/reown-kotlin")
 object Web3ModalChainsPresets {
     val ethToken = Modal.Model.Token(name = "Ether", symbol = "ETH", decimal = 18)