MOBILE-386 | Added support for ETH Music NFT's

wlara · wlara · commit ba320b9fcb50 · 2025-07-11T11:22:08.000-07:00
diff --git a/newm-server/src/main/kotlin/io/newm/server/Application.kt b/newm-server/src/main/kotlin/io/newm/server/Application.kt
@@ -17,6 +17,7 @@ import io.newm.server.features.collaboration.createCollaborationRoutes
 import io.newm.server.features.distribution.createDistributionRoutes
 import io.newm.server.features.doc.createOpenApiDocumentationRoutes
 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.playlist.createPlaylistRoutes
@@ -77,6 +78,7 @@ fun Application.module() {
         createAuthenticationRoutes()
         createUserRoutes()
         createCardanoRoutes()
+        createEthereumRoutes()
         createSongRoutes()
         createCollaborationRoutes()
         createPlaylistRoutes()
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
@@ -17,6 +17,7 @@ import io.newm.server.features.distribution.distributionKoinModule
 import io.newm.server.features.dripdropz.dripDropzKoinModule
 import io.newm.server.features.earnings.earningsKoinModule
 import io.newm.server.features.email.emailKoinModule
+import io.newm.server.features.ethereum.ethereumKoinModule
 import io.newm.server.features.idenfy.idenfyKoinModule
 import io.newm.server.features.marketplace.marketplaceKoinModule
 import io.newm.server.features.minting.mintingKoinModule
@@ -59,6 +60,7 @@ fun Application.installDependencyInjection() {
             awsKoinModule,
             idenfyKoinModule,
             cardanoKoinModule,
+            ethereumKoinModule,
             daemonsKoinModule,
             distributionKoinModule,
             arweaveKoinModule,
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/cardano/CardanoRoutes.kt b/newm-server/src/main/kotlin/io/newm/server/features/cardano/CardanoRoutes.kt
@@ -154,7 +154,7 @@ fun Routing.createCardanoRoutes() {
             get("nft/songs") {
                 try {
                     respond(
-                        cardanoRepository.getWalletNFTSongs(
+                        cardanoRepository.getWalletNftSongs(
                             userId = myUserId,
                             includeLegacy = parameters["legacy"]?.toBoolean() == true,
                             useDripDropz = parameters["dripDropz"]?.toBoolean() == true
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/cardano/model/CardanoNftSong.kt b/newm-server/src/main/kotlin/io/newm/server/features/cardano/model/CardanoNftSong.kt
@@ -5,7 +5,7 @@ import kotlinx.serialization.Serializable
 import java.util.UUID
 
 @Serializable
-data class NFTSong(
+data class CardanoNftSong(
     @Contextual
     val id: UUID,
     val fingerprint: String,
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/cardano/parser/CardanoNftSongParser.kt b/newm-server/src/main/kotlin/io/newm/server/features/cardano/parser/CardanoNftSongParser.kt
@@ -5,7 +5,7 @@ import io.ktor.utils.io.core.toByteArray
 import io.newm.chain.grpc.LedgerAssetMetadataItem
 import io.newm.chain.grpc.NativeAsset
 import io.newm.chain.util.hexStringToAssetName
-import io.newm.server.features.cardano.model.NFTSong
+import io.newm.server.features.cardano.model.CardanoNftSong
 import io.newm.server.features.nftcdn.repo.NftCdnRepository
 import io.newm.shared.koin.inject
 import io.newm.shared.ktx.toDurationOrNull
@@ -22,7 +22,7 @@ fun List<LedgerAssetMetadataItem>.toNFTSongs(
     asset: NativeAsset,
     isStreamToken: Boolean,
     isNftCdnEnabled: Boolean
-): List<NFTSong> {
+): List<CardanoNftSong> {
     val assetName = asset.name.hexStringToAssetName()
     logger.debug { "Parsing PolicyID: ${asset.policy}, assetName: $assetName" }
 
@@ -100,7 +100,7 @@ fun List<LedgerAssetMetadataItem>.toNFTSongs(
             }
             null
         } else {
-            NFTSong(
+            CardanoNftSong(
                 id = UUID.nameUUIDFromBytes(file.src.toByteArray()),
                 fingerprint = fingerprint,
                 policyId = asset.policy,
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/cardano/repo/CardanoRepository.kt b/newm-server/src/main/kotlin/io/newm/server/features/cardano/repo/CardanoRepository.kt
@@ -16,7 +16,7 @@ import io.newm.chain.grpc.VerifySignDataResponse
 import io.newm.server.features.cardano.model.EncryptionRequest
 import io.newm.server.features.cardano.model.GetWalletSongsResponse
 import io.newm.server.features.cardano.model.Key
-import io.newm.server.features.cardano.model.NFTSong
+import io.newm.server.features.cardano.model.CardanoNftSong
 import io.newm.server.features.song.model.SongFilters
 import io.newm.server.typealiases.UserId
 import kotlinx.coroutines.flow.Flow
@@ -97,11 +97,11 @@ interface CardanoRepository {
         limit: Int
     ): GetWalletSongsResponse
 
-    suspend fun getWalletNFTSongs(
+    suspend fun getWalletNftSongs(
         userId: UserId,
         includeLegacy: Boolean,
         useDripDropz: Boolean
-    ): List<NFTSong>
+    ): List<CardanoNftSong>
 
     suspend fun getWalletImages(userId: UserId): List<String>
 
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/cardano/repo/CardanoRepositoryImpl.kt b/newm-server/src/main/kotlin/io/newm/server/features/cardano/repo/CardanoRepositoryImpl.kt
@@ -57,7 +57,7 @@ import io.newm.server.features.cardano.database.ScriptAddressWhitelistEntity
 import io.newm.server.features.cardano.model.EncryptionRequest
 import io.newm.server.features.cardano.model.GetWalletSongsResponse
 import io.newm.server.features.cardano.model.Key
-import io.newm.server.features.cardano.model.NFTSong
+import io.newm.server.features.cardano.model.CardanoNftSong
 import io.newm.server.features.cardano.model.WalletSong
 import io.newm.server.features.cardano.parser.toNFTSongs
 import io.newm.server.features.cardano.parser.toResourceUrl
@@ -576,13 +576,13 @@ internal class CardanoRepositoryImpl(
         return null
     }
 
-    override suspend fun getWalletNFTSongs(
+    override suspend fun getWalletNftSongs(
         userId: UserId,
         includeLegacy: Boolean,
         useDripDropz: Boolean
-    ): List<NFTSong> {
+    ): List<CardanoNftSong> {
         val assets = if (useDripDropz) getDripDropzAssets(userId) else getWalletAssets(userId)
-        val nftSongs = mutableListOf<NFTSong>()
+        val nftSongs = mutableListOf<CardanoNftSong>()
         val streamTokenPolicyIds = configRepository.getStrings(CONFIG_KEY_MINT_ALL_POLICY_IDS)
         val isNftCdnEnabled = configRepository.getBoolean(CONFIG_KEY_NFTCDN_ENABLED)
         for (asset in assets) {
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumModule.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/EthereumModule.kt
@@ -0,0 +1,10 @@
+package io.newm.server.features.ethereum
+
+import io.newm.server.features.ethereum.repo.EthereumRepository
+import io.newm.server.features.ethereum.repo.EthereumRepositoryImpl
+import org.koin.dsl.module
+
+val ethereumKoinModule =
+    module {
+        single<EthereumRepository> { EthereumRepositoryImpl(get(), get()) }
+    }
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
@@ -0,0 +1,20 @@
+package io.newm.server.features.ethereum
+
+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.ethereum.repo.EthereumRepository
+import io.newm.server.ktx.requiredQueryParam
+import io.newm.shared.koin.inject
+import io.newm.shared.ktx.get
+
+fun Routing.createEthereumRoutes() {
+    val repository: EthereumRepository by inject()
+
+    authenticate(AUTH_JWT) {
+        get("/v1/ethereum/nft/songs") {
+            respond(repository.getNftSongs(request.requiredQueryParam("ownerAddress")))
+        }
+    }
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/EthereumNft.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/EthereumNft.kt
@@ -0,0 +1,68 @@
+package io.newm.server.features.ethereum.model
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class EthereumNft(
+    @SerialName("contract")
+    val contract: Contract,
+    @SerialName("tokenId")
+    val tokenId: String,
+    @SerialName("tokenType")
+    val tokenType: String,
+    @SerialName("name")
+    val name: String?,
+    @SerialName("image")
+    val image: Media?,
+    @SerialName("animation")
+    val animation: Media?,
+    @SerialName("raw")
+    val raw: Raw?,
+    @SerialName("balance")
+    val balance: Long
+) {
+    @Serializable
+    data class Contract(
+        @SerialName("address")
+        val address: String,
+        @SerialName("name")
+        val name: String?
+    )
+
+    @Serializable
+    data class Media(
+        @SerialName("contentType")
+        val contentType: String?,
+        @SerialName("cachedUrl")
+        val cachedUrl: String?,
+        @SerialName("originalUrl")
+        val originalUrl: String?
+    )
+
+    @Serializable
+    data class Raw(
+        @SerialName("metadata")
+        val metadata: Metadata?
+    )
+
+    @Serializable
+    data class Metadata(
+        @SerialName("name")
+        val name: String?,
+        @SerialName("image")
+        val image: String?,
+        @SerialName("animation_url")
+        val animationUrl: String?,
+        @SerialName("attributes")
+        val attributes: List<Attribute>?
+    )
+
+    @Serializable
+    data class Attribute(
+        @SerialName("trait_type")
+        val traitType: String,
+        @SerialName("value")
+        val value: String
+    )
+}
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/EthereumNftSong.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/EthereumNftSong.kt
@@ -0,0 +1,22 @@
+package io.newm.server.features.ethereum.model
+
+import kotlinx.serialization.Contextual
+import kotlinx.serialization.Serializable
+import java.util.UUID
+
+@Serializable
+data class EthereumNftSong(
+    @Contextual
+    val id: UUID,
+    val contractAddress: String,
+    val tokenType: String,
+    val tokenId: String,
+    val amount: Long,
+    val title: String,
+    val imageUrl: String,
+    val audioUrl: String,
+    val duration: Long,
+    val artists: List<String>,
+    val genres: List<String>,
+    val moods: List<String>
+)
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/GetNftsByOwnerResponse.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/model/GetNftsByOwnerResponse.kt
@@ -0,0 +1,9 @@
+package io.newm.server.features.ethereum.model
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class GetNftsByOwnerResponse(
+    @SerialName("ownedNfts") val ownedNfts: List<EthereumNft>
+)
diff --git a/newm-server/src/main/kotlin/io/newm/server/features/ethereum/parser/EthereumNftSongParser.kt b/newm-server/src/main/kotlin/io/newm/server/features/ethereum/parser/EthereumNftSongParser.kt
@@ -0,0 +1,117 @@
+package io.newm.server.features.ethereum.parser
+
+import io.ktor.utils.io.core.toByteArray
+import io.newm.server.features.ethereum.model.EthereumNft
+import io.newm.server.features.ethereum.model.EthereumNftSong
+import io.newm.shared.ktx.containsIgnoreCase
+import java.util.UUID
+
+private val TITLE_TRAIT_TYPES = listOf(
+    "song",
+    "title",
+    "track",
+    "song title",
+    "song name",
+    "track name",
+    "composition",
+    "layer name"
+)
+
+private val ARTIST_TRAIT_TYPES = listOf(
+    "artist",
+    "creator",
+    "collaborator",
+    "performer",
+    "layer artist",
+    "composer"
+)
+
+private val DURATION_TRAIT_TYPES = listOf(
+    "duration",
+    "length",
+    "track length",
+    "runtime",
+    "layer duration"
+)
+
+private val GENRE_TRAIN_TYPES = listOf(
+    "genre",
+    "music genre",
+    "style",
+    "track genre",
+    "layer genre"
+)
+
+private val MOOD_TRAIT_TYPES = listOf(
+    "mood",
+    "vibe",
+    "emotion",
+    "layer mood"
+)
+
+private val AUDIO_URL_REGEX = "\\.(mp3|mp4|wav|flac|aiff|aac)$".toRegex(RegexOption.IGNORE_CASE)
+
+fun EthereumNft.parseSong(): EthereumNftSong? {
+    val audioUrl = (raw?.metadata?.animationUrl ?: animation?.cachedUrl ?: animation?.originalUrl)?.asHttpsUrl()
+    if (audioUrl == null || (!audioUrl.matches(AUDIO_URL_REGEX) && animation?.contentType?.startsWith("audio/") != true)) {
+        // not a music NFT
+        return null
+    }
+
+    return EthereumNftSong(
+        id = UUID.nameUUIDFromBytes(contract.address.toByteArray() + tokenId.toByteArray()),
+        contractAddress = contract.address,
+        tokenType = tokenType,
+        tokenId = tokenId,
+        amount = balance,
+        title = trait(TITLE_TRAIT_TYPES) ?: raw?.metadata?.name ?: contract.name ?: name.orEmpty(),
+        imageUrl = (raw?.metadata?.image ?: image?.cachedUrl ?: image?.originalUrl)?.asHttpsUrl().orEmpty(),
+        audioUrl = audioUrl,
+        duration = trait(DURATION_TRAIT_TYPES)?.asDuration() ?: -1,
+        artists = traits(ARTIST_TRAIT_TYPES),
+        genres = traits(GENRE_TRAIN_TYPES),
+        moods = traits(MOOD_TRAIT_TYPES)
+    )
+}
+
+private fun EthereumNft.trait(types: List<String>): String? =
+    raw
+        ?.metadata
+        ?.attributes
+        ?.firstOrNull { types.containsIgnoreCase(it.traitType) }
+        ?.value
+
+private fun EthereumNft.traits(types: List<String>): List<String> =
+    raw
+        ?.metadata
+        ?.attributes
+        ?.filter { types.containsIgnoreCase(it.traitType) }
+        ?.map { it.value }
+        .orEmpty()
+
+private fun String.asHttpsUrl(): String? =
+    when {
+        startsWith("https://") -> this
+        startsWith("ipfs://") -> "https://ipfs.io/ipfs/${substring(7)}"
+        startsWith("ar://") -> "https://arweave.net/${substring(5)}"
+        else -> null
+    }
+
+private fun String.asDuration(): Long {
+    val parts = split(":")
+    return when (parts.size) {
+        1 -> {
+            // it's just seconds
+            parts[0].toLongOrNull() ?: -1L
+        }
+
+        2 -> {
+            // it's in "mm:ss" format
+            val minutes = parts[0].toLongOrNull()
+            val seconds = parts[1].toLongOrNull()
+            if (minutes != null && seconds != null) minutes * 60 + seconds else -1L
+        }
+
+        else -> -1L
+    }
+}
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
@@ -0,0 +1,9 @@
+package io.newm.server.features.ethereum.repo
+
+import io.newm.server.features.ethereum.model.EthereumNftSong
+
+interface EthereumRepository {
+    // TODO: for now, during the initial/evaluation phase, we pass the owner address directly here,
+    //  later we will migrate to a Wallet connection model similar to Cardano
+    suspend fun getNftSongs(ownerAddress: String): 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
diff --git a/newm-server/src/main/resources/application.conf b/newm-server/src/main/resources/application.conf
diff --git a/newm-server/src/test/kotlin/io/newm/server/features/cardano/parser/CardanoNftSongParserTests.kt b/newm-server/src/test/kotlin/io/newm/server/features/cardano/parser/CardanoNftSongParserTests.kt
diff --git a/newm-server/src/test/kotlin/io/newm/server/features/ethereum/parser/EthereumNftSongParserTests.kt b/newm-server/src/test/kotlin/io/newm/server/features/ethereum/parser/EthereumNftSongParserTests.kt
