feat: MOBILE-388 - add multi-chain NFT song api

wlara · wlara · commit 2123284f9405 · 2026-01-24T16:50:26.000-08:00
diff --git a/buildSrc/src/main/kotlin/Dependencies.kt b/buildSrc/src/main/kotlin/Dependencies.kt
@@ -69,6 +69,8 @@ object Dependencies {
         const val SERVER_AUTH = "io.ktor:ktor-server-auth:$VERSION"
         const val SERVER_AUTH_JWT = "io.ktor:ktor-server-auth-jwt:$VERSION"
         const val SERVER_HTML_BUILDER = "io.ktor:ktor-server-html-builder:$VERSION"
+        const val SERVER_COMPRESSION = "io.ktor:ktor-server-compression:$VERSION"
+        const val SERVER_COMPRESSION_ZSTD = "io.ktor:ktor-server-compression-zstd:$VERSION"
         const val CLIENT_CORE = "io.ktor:ktor-client-core:$VERSION"
         const val CLIENT_CIO = "io.ktor:ktor-client-cio:$VERSION"
         const val CLIENT_OKHTTP = "io.ktor:ktor-client-okhttp:$VERSION"
diff --git a/buildSrc/src/main/kotlin/Versions.kt b/buildSrc/src/main/kotlin/Versions.kt
@@ -31,7 +31,7 @@ object Versions {
     const val KOTLIN_PLUGIN = "2.3.0"
     const val KTLINT = "1.8.0"
     const val KTLINT_PLUGIN = "12.1.1"
-    const val KTOR = "3.3.3"
+    const val KTOR = "3.4.0"
     const val KTOR_FLYWAY = "3.3.0"
     const val LOGBACK = "1.5.23"
     const val MAVEN_PUBLISH = "0.35.0"
diff --git a/newm-server/build.gradle.kts b/newm-server/build.gradle.kts
@@ -54,6 +54,8 @@ dependencies {
     implementation(Dependencies.Ktor.SERVER_AUTH)
     implementation(Dependencies.Ktor.SERVER_AUTH_JWT)
     implementation(Dependencies.Ktor.SERVER_HTML_BUILDER)
+    implementation(Dependencies.Ktor.SERVER_COMPRESSION)
+    implementation(Dependencies.Ktor.SERVER_COMPRESSION_ZSTD)
     implementation(Dependencies.Ktor.CLIENT_CORE)
     implementation(Dependencies.Ktor.CLIENT_CIO)
     implementation(Dependencies.Ktor.CLIENT_OKHTTP)
diff --git a/newm-server/src/main/kotlin/io/newm/server/Application.kt b/newm-server/src/main/kotlin/io/newm/server/Application.kt
@@ -5,6 +5,7 @@ import io.ktor.server.application.Application
 import io.ktor.server.routing.routing
 import io.newm.server.auth.createAuthenticationRoutes
 import io.newm.server.auth.installAuthentication
+import io.newm.server.compression.installCompression
 import io.newm.server.content.installContentNegotiation
 import io.newm.server.cors.installCORS
 import io.newm.server.curator.installCurator
@@ -20,6 +21,7 @@ import io.newm.server.features.earnings.createEarningsRoutes
 import io.newm.server.features.ethereum.createEthereumRoutes
 import io.newm.server.features.idenfy.createIdenfyRoutes
 import io.newm.server.features.marketplace.createMarketplaceRoutes
+import io.newm.server.features.nftsong.createNftSongRoutes
 import io.newm.server.features.paypal.createPayPalRoutes
 import io.newm.server.features.playlist.createPlaylistRoutes
 import io.newm.server.features.song.createSongRoutes
@@ -65,6 +67,7 @@ fun Application.module() {
     installCORS()
     installForwarder()
     installHealthCheck()
+    installCompression()
 
     routing {
         createStaticContentRoutes()
@@ -84,6 +87,7 @@ fun Application.module() {
         createOpenApiDocumentationRoutes()
         createEarningsRoutes()
         createPayPalRoutes()
+        createNftSongRoutes()
     }
 
     initializeDaemons()
diff --git a/newm-server/src/main/kotlin/io/newm/server/compression/CompressionInstall.kt b/newm-server/src/main/kotlin/io/newm/server/compression/CompressionInstall.kt
@@ -0,0 +1,41 @@
+package io.newm.server.compression
+
+import io.ktor.server.application.Application
+import io.ktor.server.application.install
+import io.ktor.server.plugins.compression.Compression
+import io.ktor.server.plugins.compression.condition
+import io.ktor.server.plugins.compression.deflate
+import io.ktor.server.plugins.compression.gzip
+import io.ktor.server.plugins.compression.minimumSize
+import io.ktor.server.plugins.compression.zstd.zstd
+import io.ktor.server.request.uri
+import io.newm.server.features.nftsong.NFT_SONGS_PATH
+
+private const val COMPRESSIBLE_MIN_SIZE = 1024L
+
+private val COMPRESSIBLE_PATHS = listOf(
+    NFT_SONGS_PATH,
+    // TODO: Add other paths that serve large responses
+)
+
+fun Application.installCompression() {
+    install(Compression) {
+        zstd {
+            priority = 1.0
+            minimumSize(COMPRESSIBLE_MIN_SIZE)
+            condition { request.uri.isCompressible() }
+        }
+        gzip {
+            priority = 0.9
+            minimumSize(COMPRESSIBLE_MIN_SIZE)
+            condition { request.uri.isCompressible() }
+        }
+        deflate {
+            priority = 0.8
+            minimumSize(COMPRESSIBLE_MIN_SIZE)
+            condition { request.uri.isCompressible() }
+        }
+    }
+}
+
+private fun String.isCompressible(): Boolean = COMPRESSIBLE_PATHS.contains(this)
diff --git a/newm-server/src/main/kotlin/io/newm/server/di/DependencyInjectionInstall.kt b/newm-server/src/main/kotlin/io/newm/server/di/DependencyInjectionInstall.kt
@@ -22,6 +22,7 @@ import io.newm.server.features.idenfy.idenfyKoinModule
 import io.newm.server.features.marketplace.marketplaceKoinModule
 import io.newm.server.features.minting.mintingKoinModule
 import io.newm.server.features.nftcdn.nftCdnKoinModule
+import io.newm.server.features.nftsong.nftSongKoinModule
 import io.newm.server.features.paypal.payPalKoinModule
 import io.newm.server.features.playlist.playlistKoinModule
 import io.newm.server.features.referralhero.referralHeroKoinModule
@@ -74,6 +75,7 @@ fun Application.installDependencyInjection() {
             dripDropzKoinModule,
             referralHeroKoinModule,
             payPalKoinModule,
+            nftSongKoinModule,
         )
     }
 }
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumKoinModule.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumKoinModule.kt
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumRoutes.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumRoutes.kt
@@ -5,7 +5,7 @@ import io.ktor.server.response.respond
 import io.ktor.server.routing.Routing
 import io.newm.server.auth.jwt.AUTH_JWT
 import io.newm.server.features.ethereum.repo.EthereumRepository
-import io.newm.server.ktx.requiredQueryParam
+import io.newm.server.ktx.userId
 import io.newm.shared.koin.inject
 import io.newm.shared.ktx.get
 
@@ -14,9 +14,7 @@ fun Routing.createEthereumRoutes() {
 
     authenticate(AUTH_JWT) {
         get("/v1/ethereum/nft/songs") {
-            // TODO: for now, during the initial experimentation phase, we get the owner address directly from
-            //  the client, later we will migrate to a Wallet connection model similar to Cardano
-            respond(repository.getNftSongs(request.requiredQueryParam("ownerAddress")))
+            respond(repository.getWalletNftSongs(userId))
         }
     }
 }
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/repo/EthereumRepository.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/repo/EthereumRepository.kt
@@ -1,7 +1,8 @@
 package io.newm.server.features.ethereum.repo
 
 import io.newm.server.features.ethereum.model.EthereumNftSong
+import io.newm.server.typealiases.UserId
 
 interface EthereumRepository {
-    suspend fun getNftSongs(ownerAddress: String): List<EthereumNftSong>
+    suspend fun getWalletNftSongs(userId: UserId): List<EthereumNftSong>
 }
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/repo/EthereumRepositoryImpl.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/repo/EthereumRepositoryImpl.kt
@@ -12,18 +12,26 @@ import io.newm.server.features.ethereum.model.EthereumNft
 import io.newm.server.features.ethereum.model.EthereumNftSong
 import io.newm.server.features.ethereum.model.GetNftsByOwnerResponse
 import io.newm.server.features.ethereum.parser.parseSong
+import io.newm.server.features.user.database.UserEntity
 import io.newm.server.ktx.checkedBody
 import io.newm.server.ktx.getSecureConfigString
+import io.newm.server.typealiases.UserId
 import io.newm.shared.ktx.getConfigString
+import org.jetbrains.exposed.sql.transactions.transaction
 
 internal class EthereumRepositoryImpl(
     private val client: HttpClient,
     private val environment: ApplicationEnvironment
 ) : EthereumRepository {
     private val logger = KotlinLogging.logger {}
 
-    override suspend fun getNftSongs(ownerAddress: String): List<EthereumNftSong> {
-        logger.debug { "getNftSongs: ownerAddress = $ownerAddress" }
+    override suspend fun getWalletNftSongs(userId: UserId): List<EthereumNftSong> {
+        logger.debug { "getWalletNftSongs: userId = $userId" }
+
+        // Temporary test hook until Ethereum wallet connections are implemented
+        val email = transaction { UserEntity[userId].email }
+        if (!email.endsWith("@newm.io")) return emptyList()
+        val address = "0xbb13c0560c8a8354e6a914f1f2b873cefe0df9f7"
 
         val apiUrl = environment.getConfigString("alchemy.apiUrl")
         val apiKey = environment.getSecureConfigString("alchemy.apiKey")
@@ -34,7 +42,7 @@ internal class EthereumRepositoryImpl(
                     delayMillis { 500L }
                 }
                 accept(ContentType.Application.Json)
-                parameter("owner", ownerAddress)
+                parameter("owner", address)
             }.checkedBody<GetNftsByOwnerResponse>()
             .ownedNfts
             .mapNotNull(EthereumNft::parseSong)
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/NftSongKoinModule.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/NftSongKoinModule.kt
@@ -0,0 +1,10 @@
+package io.newm.server.features.nftsong
+
+import io.newm.server.features.nftsong.repo.NftSongRepository
+import io.newm.server.features.nftsong.repo.NftSongRepositoryImpl
+import org.koin.dsl.module
+
+val nftSongKoinModule =
+    module {
+        single<NftSongRepository> { NftSongRepositoryImpl(get(), get()) }
+    }
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/NftSongRoutes.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/NftSongRoutes.kt
@@ -0,0 +1,22 @@
+package io.newm.server.features.nftsong
+
+import io.ktor.server.auth.authenticate
+import io.ktor.server.response.respond
+import io.ktor.server.routing.Routing
+import io.newm.server.auth.jwt.AUTH_JWT
+import io.newm.server.features.nftsong.repo.NftSongRepository
+import io.newm.server.ktx.userId
+import io.newm.shared.koin.inject
+import io.newm.shared.ktx.get
+
+const val NFT_SONGS_PATH = "/v1/nft/songs"
+
+fun Routing.createNftSongRoutes() {
+    val repository: NftSongRepository by inject()
+
+    authenticate(AUTH_JWT) {
+        get(NFT_SONGS_PATH) {
+            respond(repository.getNftSongs(userId))
+        }
+    }
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftChainMetadata.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftChainMetadata.kt
@@ -0,0 +1,16 @@
+package io.newm.server.features.nftsong.model
+
+sealed interface NftChainMetadata {
+    data class Cardano(
+        val fingerprint: String,
+        val policyId: String,
+        val assetName: String,
+        val isStreamToken: Boolean
+    ) : NftChainMetadata
+
+    data class Ethereum(
+        val contractAddress: String,
+        val tokenType: String,
+        val tokenId: String,
+    ) : NftChainMetadata
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftChainType.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftChainType.kt
@@ -0,0 +1,6 @@
+package io.newm.server.features.nftsong.model
+
+enum class NftChainType {
+    Cardano,
+    Ethereum
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftSong.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/model/NftSong.kt
@@ -0,0 +1,21 @@
+package io.newm.server.features.nftsong.model
+
+import kotlinx.serialization.Contextual
+import kotlinx.serialization.Serializable
+import java.util.UUID
+
+@Serializable
+data class NftSong(
+    @Contextual
+    val id: UUID,
+    val title: String,
+    val imageUrl: String,
+    val audioUrl: String,
+    val duration: Long,
+    val artists: List<String>,
+    val genres: List<String>,
+    val moods: List<String>,
+    val amount: Long,
+    val chainType: NftChainType,
+    val chainMetadata: NftChainMetadata
+)
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/repo/NftSongRepository.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/repo/NftSongRepository.kt
@@ -0,0 +1,8 @@
+package io.newm.server.features.nftsong.repo
+
+import io.newm.server.features.nftsong.model.NftSong
+import io.newm.server.typealiases.UserId
+
+interface NftSongRepository {
+    suspend fun getNftSongs(userId: UserId): List<NftSong>
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/nftsong/repo/NftSongRepositoryImpl.kt b/newm-server/src/main/kotlin/io/newm/server/features/nftsong/repo/NftSongRepositoryImpl.kt
@@ -0,0 +1,68 @@
+package io.newm.server.features.nftsong.repo
+
+import io.newm.server.features.cardano.model.CardanoNftSong
+import io.newm.server.features.cardano.repo.CardanoRepository
+import io.newm.server.features.ethereum.model.EthereumNftSong
+import io.newm.server.features.ethereum.repo.EthereumRepository
+import io.newm.server.features.nftsong.model.NftChainMetadata
+import io.newm.server.features.nftsong.model.NftChainType
+import io.newm.server.features.nftsong.model.NftSong
+import io.newm.server.typealiases.UserId
+
+internal class NftSongRepositoryImpl(
+    private val cardanoRepository: CardanoRepository,
+    private val ethereumRepository: EthereumRepository
+) : NftSongRepository {
+    override suspend fun getNftSongs(userId: UserId): List<NftSong> {
+        val nftSongs = mutableListOf<NftSong>()
+
+        nftSongs += cardanoRepository
+            .getWalletNftSongs(userId, includeLegacy = true, useDripDropz = false)
+            .map { it.toNftSong() }
+
+        nftSongs += ethereumRepository
+            .getWalletNftSongs(userId)
+            .map { it.toNftSong() }
+
+        return nftSongs
+    }
+
+    private fun CardanoNftSong.toNftSong(): NftSong =
+        NftSong(
+            id = id,
+            title = title,
+            imageUrl = imageUrl,
+            audioUrl = audioUrl,
+            duration = duration,
+            artists = artists,
+            genres = genres,
+            moods = moods,
+            amount = amount,
+            chainType = NftChainType.Cardano,
+            chainMetadata = NftChainMetadata.Cardano(
+                fingerprint = fingerprint,
+                policyId = policyId,
+                assetName = assetName,
+                isStreamToken = isStreamToken
+            )
+        )
+
+    private fun EthereumNftSong.toNftSong(): NftSong =
+        NftSong(
+            id = id,
+            title = title,
+            imageUrl = imageUrl,
+            audioUrl = audioUrl,
+            duration = duration,
+            artists = artists,
+            genres = genres,
+            moods = moods,
+            amount = amount,
+            chainType = NftChainType.Ethereum,
+            chainMetadata = NftChainMetadata.Ethereum(
+                contractAddress = contractAddress,
+                tokenType = tokenType,
+                tokenId = tokenId
+            )
+        )
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/user/repo/UserRepositoryImpl.kt b/newm-server/src/main/kotlin/io/newm/server/features/user/repo/UserRepositoryImpl.kt
@@ -44,8 +44,8 @@ import io.newm.shared.ktx.orNull
 import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.launch
 import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
-import java.time.LocalDateTime
 import org.jetbrains.exposed.sql.transactions.transaction
+import java.time.LocalDateTime
 
 internal class UserRepositoryImpl(
     private val googleUserProvider: GoogleUserProvider,
@@ -388,20 +388,18 @@ internal class UserRepositoryImpl(
         logger.debug { "updateReferralStatusIfNeeded: userId = $userId, isConfirmed: $isConfirmed" }
         val email = transaction {
             UserEntity[userId].run {
-                when {
-                    referralStatus == ReferralStatus.Pending && !isConfirmed -> {
+                when (referralStatus) {
+                    ReferralStatus.Pending if !isConfirmed -> {
                         referralStatus = ReferralStatus.Unconfirmed
                         email
                     }
 
-                    referralStatus == ReferralStatus.Unconfirmed && isConfirmed -> {
+                    ReferralStatus.Unconfirmed if isConfirmed -> {
                         referralStatus = ReferralStatus.Confirmed
                         email
                     }
 
-                    else -> {
-                        null
-                    }
+                    else -> null
                 }
             }
         } ?: return

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import io.newm.server.features.idenfy.idenfyKoinModule`
`22`	`22`	`import io.newm.server.features.marketplace.marketplaceKoinModule`
`23`	`23`	`import io.newm.server.features.minting.mintingKoinModule`
`24`	`24`	`import io.newm.server.features.nftcdn.nftCdnKoinModule`
	`25`	`+import io.newm.server.features.nftsong.nftSongKoinModule`
`25`	`26`	`import io.newm.server.features.paypal.payPalKoinModule`
`26`	`27`	`import io.newm.server.features.playlist.playlistKoinModule`
`27`	`28`	`import io.newm.server.features.referralhero.referralHeroKoinModule`
`@@ -74,6 +75,7 @@ fun Application.installDependencyInjection() {`
`74`	`75`	`dripDropzKoinModule,`
`75`	`76`	`referralHeroKoinModule,`
`76`	`77`	`payPalKoinModule,`
	`78`	`+ nftSongKoinModule,`
`77`	`79`	`)`
`78`	`80`	`}`
`79`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import io.ktor.server.response.respond`
`5`	`5`	`import io.ktor.server.routing.Routing`
`6`	`6`	`import io.newm.server.auth.jwt.AUTH_JWT`
`7`	`7`	`import io.newm.server.features.ethereum.repo.EthereumRepository`
`8`		`-import io.newm.server.ktx.requiredQueryParam`
	`8`	`+import io.newm.server.ktx.userId`
`9`	`9`	`import io.newm.shared.koin.inject`
`10`	`10`	`import io.newm.shared.ktx.get`
`11`	`11`
`@@ -14,9 +14,7 @@ fun Routing.createEthereumRoutes() {`
`14`	`14`
`15`	`15`	`authenticate(AUTH_JWT) {`
`16`	`16`	`get("/v1/ethereum/nft/songs") {`
`17`		`- // TODO: for now, during the initial experimentation phase, we get the owner address directly from`
`18`		`- // the client, later we will migrate to a Wallet connection model similar to Cardano`
`19`		`- respond(repository.getNftSongs(request.requiredQueryParam("ownerAddress")))`
	`17`	`+ respond(repository.getWalletNftSongs(userId))`
`20`	`18`	`}`
`21`	`19`	`}`
`22`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`package io.newm.server.features.ethereum.repo`
`2`	`2`
`3`	`3`	`import io.newm.server.features.ethereum.model.EthereumNftSong`
	`4`	`+import io.newm.server.typealiases.UserId`
`4`	`5`
`5`	`6`	`interface EthereumRepository {`
`6`		`- suspend fun getNftSongs(ownerAddress: String): List<EthereumNftSong>`
	`7`	`+ suspend fun getWalletNftSongs(userId: UserId): List<EthereumNftSong>`
`7`	`8`	`}`