Adds dynamic relay pool recommendations to the relay list.
This commit is contained in:
Vitor Pamplona
@@ -31,12 +31,14 @@ class RelayUrlFormatter {
|
||||
.removePrefix("ws://")
|
||||
.removeSuffix("/")
|
||||
|
||||
fun isLocalHost(url: String) = url.contains("127.0.0.1") || url.contains("localhost")
|
||||
|
||||
fun isOnion(url: String) = url.endsWith(".onion") || url.endsWith(".onion/")
|
||||
|
||||
fun normalize(url: String): String {
|
||||
val newUrl =
|
||||
if (!url.startsWith("wss://") && !url.startsWith("ws://")) {
|
||||
// TODO: How to identify relays on the local network?
|
||||
val isLocalHost = url.contains("127.0.0.1") || url.contains("localhost")
|
||||
if (url.endsWith(".onion") || url.endsWith(".onion/") || isLocalHost) {
|
||||
if (isOnion(url) || isLocalHost(url)) {
|
||||
"ws://${url.trim()}"
|
||||
} else {
|
||||
"wss://${url.trim()}"
|
||||
@@ -52,6 +54,25 @@ class RelayUrlFormatter {
|
||||
}
|
||||
}
|
||||
|
||||
fun normalizeOrNull(url: String): String? {
|
||||
val newUrl =
|
||||
if (!url.startsWith("wss://") && !url.startsWith("ws://")) {
|
||||
if (isOnion(url) || isLocalHost(url)) {
|
||||
"ws://${url.trim()}"
|
||||
} else {
|
||||
"wss://${url.trim()}"
|
||||
}
|
||||
} else {
|
||||
url.trim()
|
||||
}
|
||||
|
||||
return try {
|
||||
URIReference.parse(newUrl).normalize().toString()
|
||||
} catch (e: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
|
||||
fun getHttpsUrl(dirtyUrl: String): String =
|
||||
if (dirtyUrl.contains("://")) {
|
||||
dirtyUrl.replace("wss://", "https://").replace("ws://", "http://")
|
||||
|
||||
@@ -0,0 +1,164 @@
|
||||
/**
|
||||
* Copyright (c) 2024 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.utils
|
||||
|
||||
import com.vitorpamplona.quartz.encoders.HexKey
|
||||
import com.vitorpamplona.quartz.encoders.RelayUrlFormatter
|
||||
import com.vitorpamplona.quartz.events.AdvertisedRelayListEvent
|
||||
|
||||
class MinimumRelayListProcessor {
|
||||
companion object {
|
||||
fun transpose(
|
||||
userList: Map<HexKey, MutableSet<String>>,
|
||||
ignore: Set<String> = setOf(),
|
||||
): Map<String, MutableSet<HexKey>> {
|
||||
val popularity = mutableMapOf<String, MutableSet<HexKey>>()
|
||||
|
||||
userList.forEach { event ->
|
||||
event.value.forEach { relayUrl ->
|
||||
if (relayUrl !in ignore) {
|
||||
val set = popularity[relayUrl]
|
||||
if (set != null) {
|
||||
set.add(event.key)
|
||||
} else {
|
||||
popularity[relayUrl] = mutableSetOf(event.key)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return popularity
|
||||
}
|
||||
|
||||
/**
|
||||
* filter onion and local host from write relays
|
||||
* for each user pubkey, a list of valid relays.
|
||||
*/
|
||||
fun filterValidRelays(
|
||||
userList: List<AdvertisedRelayListEvent>,
|
||||
hasOnionConnection: Boolean = false,
|
||||
): MutableMap<HexKey, MutableSet<String>> {
|
||||
val validWriteRelayUrls = mutableMapOf<HexKey, MutableSet<String>>()
|
||||
|
||||
userList.forEach { event ->
|
||||
event.writeRelays().forEach { relayUrl ->
|
||||
if (!RelayUrlFormatter.isLocalHost(relayUrl) && (hasOnionConnection || !RelayUrlFormatter.isOnion(relayUrl))) {
|
||||
RelayUrlFormatter.normalizeOrNull(relayUrl)?.let { normRelayUrl ->
|
||||
val set = validWriteRelayUrls[event.pubKey()]
|
||||
if (set != null) {
|
||||
set.add(normRelayUrl)
|
||||
} else {
|
||||
validWriteRelayUrls[event.pubKey()] = mutableSetOf(normRelayUrl)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return validWriteRelayUrls
|
||||
}
|
||||
|
||||
fun reliableRelaySetFor(
|
||||
userList: List<AdvertisedRelayListEvent>,
|
||||
relayUrlsToIgnore: Set<String> = emptySet(),
|
||||
hasOnionConnection: Boolean = false,
|
||||
): Set<RelayRecommendation> =
|
||||
reliableRelaySetFor(
|
||||
filterValidRelays(userList, hasOnionConnection),
|
||||
relayUrlsToIgnore,
|
||||
)
|
||||
|
||||
fun reliableRelaySetFor(
|
||||
usersAndRelays: MutableMap<HexKey, MutableSet<String>>,
|
||||
relayUrlsToIgnore: Set<String> = emptySet(),
|
||||
): Set<RelayRecommendation> {
|
||||
// ignores users that are already being served by the list.
|
||||
val usersToServeInTheFirstRound =
|
||||
usersAndRelays
|
||||
.filter {
|
||||
it.value.none {
|
||||
it in relayUrlsToIgnore
|
||||
}
|
||||
}.toMutableMap()
|
||||
|
||||
// returning this list.
|
||||
val selected = relayUrlsToIgnore.toMutableSet()
|
||||
val returningSet = mutableSetOf<RelayRecommendation>()
|
||||
|
||||
do {
|
||||
// transposes the map so that we get a map of relays with users using them
|
||||
val popularity = transpose(usersToServeInTheFirstRound, selected)
|
||||
|
||||
if (popularity.isEmpty()) {
|
||||
// this happens when there are no relay options left for certain pubkeys
|
||||
break
|
||||
}
|
||||
|
||||
// chooses the most popular relay
|
||||
val mostPopularRelay = popularity.maxBy { it.value.size }
|
||||
selected.add(mostPopularRelay.key)
|
||||
returningSet.add(RelayRecommendation(mostPopularRelay.key, true, mostPopularRelay.value))
|
||||
|
||||
// removes all users that we can now download posts from
|
||||
mostPopularRelay.value.forEach {
|
||||
usersToServeInTheFirstRound.remove(it)
|
||||
}
|
||||
} while (usersToServeInTheFirstRound.isNotEmpty())
|
||||
|
||||
// make a second pass to make sure each user is supported by at least 2 relays.
|
||||
val usersServedByOnlyOneRelay =
|
||||
usersAndRelays.filterTo(mutableMapOf()) { keyPair ->
|
||||
keyPair.value.count {
|
||||
it in selected
|
||||
} < 2
|
||||
}
|
||||
|
||||
do {
|
||||
// transposes the map so that we get a map of relays with users using them
|
||||
val popularity = transpose(usersServedByOnlyOneRelay, selected)
|
||||
|
||||
if (popularity.isEmpty()) {
|
||||
// this happens when there are no relay options left for certain pubkeys
|
||||
break
|
||||
}
|
||||
|
||||
// chooses the most popular relay
|
||||
val mostPopularRelay = popularity.maxBy { it.value.size }
|
||||
|
||||
selected.add(mostPopularRelay.key)
|
||||
returningSet.add(RelayRecommendation(mostPopularRelay.key, false, mostPopularRelay.value))
|
||||
|
||||
// removes all users that we can now download posts from
|
||||
mostPopularRelay.value.forEach {
|
||||
usersServedByOnlyOneRelay.remove(it)
|
||||
}
|
||||
} while (usersServedByOnlyOneRelay.isNotEmpty())
|
||||
|
||||
return returningSet
|
||||
}
|
||||
}
|
||||
|
||||
class RelayRecommendation(
|
||||
val url: String,
|
||||
val requiredToNotMissEvents: Boolean,
|
||||
val users: Set<HexKey>,
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user