StakeSquid/dshackle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Handle trace and debug bounds (#570)

Browse Source
This commit is contained in:
KirillPamPam
2024-09-16 17:42:37 +04:00
committed by GitHub
parent f916f0a682
commit f739920ceb
11 changed files with 166 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/main/kotlin/io/emeraldpay/dshackle/rpc/ChainEventMapper.kt
View File

@@ -146,6 +146,7 @@ class ChainEventMapper {
LowerBoundType.BLOCK -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_BLOCK
LowerBoundType.TX -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TX
LowerBoundType.LOGS -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_LOGS
LowerBoundType.TRACE -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TRACE
}
}
}

1
src/main/kotlin/io/emeraldpay/dshackle/rpc/StreamHead.kt
View File

@@ -106,6 +106,7 @@ class StreamHead(
LowerBoundType.BLOCK -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_BLOCK
LowerBoundType.TX -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TX
LowerBoundType.LOGS -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_LOGS
LowerBoundType.TRACE -> BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TRACE
}
}

40
src/main/kotlin/io/emeraldpay/dshackle/upstream/error/EthereumLowerBoundErrorHandler.kt Normal file
View File

@@ -0,0 +1,40 @@
package io.emeraldpay.dshackle.upstream.error
import io.emeraldpay.dshackle.upstream.ChainRequest
import io.emeraldpay.dshackle.upstream.Upstream
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import io.emeraldpay.dshackle.upstream.rpcclient.ListParams
import org.slf4j.LoggerFactory
abstract class EthereumLowerBoundErrorHandler : ErrorHandler {
protected val log = LoggerFactory.getLogger(this::class.java)
override fun handle(upstream: Upstream, request: ChainRequest, errorMessage: String?) {
try {
if (canHandle(request, errorMessage)) {
parseTagParam(request, tagIndex(request.method))?.let {
upstream.updateLowerBound(it, type())
}
}
} catch (e: RuntimeException) {
log.warn("Couldn't update the {} lower bound of {}, reason - {}", type(), upstream.getId(), e.message)
}
}
protected abstract fun tagIndex(method: String): Int
protected abstract fun type(): LowerBoundType
private fun parseTagParam(request: ChainRequest, tagIndex: Int): Long? {
if (tagIndex != -1 && request.params is ListParams) {
val params = request.params.list
if (params.size >= tagIndex) {
val tag = params[tagIndex]
if (tag is String && tag.startsWith("0x")) {
return tag.substring(2).toLong(16)
}
}
}
return null
}
}

36
src/main/kotlin/io/emeraldpay/dshackle/upstream/error/EthereumStateLowerBoundErrorHandler.kt
View File

@@ -1,15 +1,10 @@
package io.emeraldpay.dshackle.upstream.error
import io.emeraldpay.dshackle.upstream.ChainRequest
import io.emeraldpay.dshackle.upstream.Upstream
import io.emeraldpay.dshackle.upstream.ethereum.EthereumLowerBoundStateDetector.Companion.stateErrors
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import io.emeraldpay.dshackle.upstream.rpcclient.ListParams
import org.slf4j.LoggerFactory
object EthereumStateLowerBoundErrorHandler : ErrorHandler {
private val log = LoggerFactory.getLogger(this::class.java)
object EthereumStateLowerBoundErrorHandler : EthereumLowerBoundErrorHandler() {
private val firstTagIndexMethods = setOf(
"eth_call",
"debug_traceCall",
@@ -25,36 +20,11 @@ object EthereumStateLowerBoundErrorHandler : ErrorHandler {
private val applicableMethods = firstTagIndexMethods + secondTagIndexMethods
override fun handle(upstream: Upstream, request: ChainRequest, errorMessage: String?) {
try {
if (canHandle(request, errorMessage)) {
parseTagParam(request, tagIndex(request.method))?.let {
upstream.updateLowerBound(it, LowerBoundType.STATE)
}
}
} catch (e: RuntimeException) {
log.warn("Couldn't update the {} lower bound of {}, reason - {}", LowerBoundType.STATE, upstream.getId(), e.message)
}
}
override fun canHandle(request: ChainRequest, errorMessage: String?): Boolean {
return stateErrors.any { errorMessage?.contains(it) ?: false } && applicableMethods.contains(request.method)
}
private fun parseTagParam(request: ChainRequest, tagIndex: Int): Long? {
if (tagIndex != -1 && request.params is ListParams) {
val params = request.params.list
if (params.size >= tagIndex) {
val tag = params[tagIndex]
if (tag is String && tag.startsWith("0x")) {
return tag.substring(2).toLong(16)
}
}
}
return null
}
private fun tagIndex(method: String): Int {
override fun tagIndex(method: String): Int {
return if (firstTagIndexMethods.contains(method)) {
1
} else if (secondTagIndexMethods.contains(method)) {
@@ -63,4 +33,6 @@ object EthereumStateLowerBoundErrorHandler : ErrorHandler {
-1
}
}
override fun type(): LowerBoundType = LowerBoundType.STATE
}

51
src/main/kotlin/io/emeraldpay/dshackle/upstream/error/EthereumTraceLowerBoundErrorHandler.kt Normal file
View File

@@ -0,0 +1,51 @@
package io.emeraldpay.dshackle.upstream.error
import io.emeraldpay.dshackle.upstream.ChainRequest
import io.emeraldpay.dshackle.upstream.ethereum.EthereumLowerBoundStateDetector.Companion.stateErrors
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
object EthereumTraceLowerBoundErrorHandler : EthereumLowerBoundErrorHandler() {
private val zeroTagIndexMethods = setOf(
"trace_block",
"arbtrace_block",
"debug_traceBlockByNumber",
)
private val firstTagIndexMethods = setOf(
"trace_callMany",
"arbtrace_callMany",
"debug_traceCall",
)
private val secondTagIndexMethods = setOf(
"trace_call",
"arbtrace_call",
)
private val applicableMethods = zeroTagIndexMethods + firstTagIndexMethods + secondTagIndexMethods
private val errors = stateErrors
.plus(
setOf(
"historical state not available",
),
)
private val errorRegexp = Regex("block .* not found")
override fun canHandle(request: ChainRequest, errorMessage: String?): Boolean {
return (errors.any { errorMessage?.contains(it) ?: false } || (errorMessage?.matches(errorRegexp) ?: false)) &&
applicableMethods.contains(request.method)
}
override fun tagIndex(method: String): Int {
return if (firstTagIndexMethods.contains(method)) {
1
} else if (secondTagIndexMethods.contains(method)) {
2
} else if (zeroTagIndexMethods.contains(method)) {
0
} else {
-1
}
}
override fun type(): LowerBoundType = LowerBoundType.TRACE
}

1
src/main/kotlin/io/emeraldpay/dshackle/upstream/error/UpstreamErrorHandler.kt
View File

@@ -16,6 +16,7 @@ interface ErrorHandler {
object UpstreamErrorHandler {
private val errorHandlers = listOf(
EthereumStateLowerBoundErrorHandler,
EthereumTraceLowerBoundErrorHandler,
)
private val errorHandlerExecutor = Executors.newFixedThreadPool(
2 * SchedulersConfig.threadsMultiplier,

12
src/main/kotlin/io/emeraldpay/dshackle/upstream/ethereum/EthereumLowerBoundStateDetector.kt
View File

@@ -69,10 +69,20 @@ class EthereumLowerBoundStateDetector(
throw IllegalStateException("No state data")
}
}
}.flatMap {
Flux.just(it, lowerBoundFromState(it, LowerBoundType.TRACE))
}
}
private fun lowerBoundFromState(stateLowerBoundData: LowerBoundData, newType: LowerBoundType): LowerBoundData {
val currentBound = lowerBounds.getLastBound(newType)
if (currentBound == null || stateLowerBoundData.lowerBound >= currentBound.lowerBound) {
return stateLowerBoundData.copy(type = newType)
}
return LowerBoundData(currentBound.lowerBound, newType)
}
override fun types(): Set<LowerBoundType> {
return setOf(LowerBoundType.STATE)
return setOf(LowerBoundType.STATE, LowerBoundType.TRACE)
}
}

3
src/main/kotlin/io/emeraldpay/dshackle/upstream/lowerbound/LowerBoundData.kt
View File

@@ -20,7 +20,7 @@ data class LowerBoundData(
}
enum class LowerBoundType {
UNKNOWN, STATE, SLOT, BLOCK, TX, LOGS
UNKNOWN, STATE, SLOT, BLOCK, TX, LOGS, TRACE
}
fun BlockchainOuterClass.LowerBoundType.fromProtoType(): LowerBoundType {
@@ -32,5 +32,6 @@ fun BlockchainOuterClass.LowerBoundType.fromProtoType(): LowerBoundType {
BlockchainOuterClass.LowerBoundType.UNRECOGNIZED -> LowerBoundType.UNKNOWN
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TX -> LowerBoundType.TX
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_LOGS -> LowerBoundType.LOGS
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_TRACE -> LowerBoundType.TRACE
}
}

52
src/test/kotlin/io/emeraldpay/dshackle/upstream/error/EthereumTraceLowerBoundErrorHandlerTest.kt Normal file
View File

@@ -0,0 +1,52 @@
package io.emeraldpay.dshackle.upstream.error
import io.emeraldpay.dshackle.upstream.ChainRequest
import io.emeraldpay.dshackle.upstream.Upstream
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import io.emeraldpay.dshackle.upstream.rpcclient.ListParams
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.Arguments
import org.junit.jupiter.params.provider.Arguments.of
import org.junit.jupiter.params.provider.MethodSource
import org.mockito.Mockito.mock
import org.mockito.kotlin.verify
class EthereumTraceLowerBoundErrorHandlerTest {
@ParameterizedTest
@MethodSource("requests")
fun `update lower bound`(request: ChainRequest) {
val upstream = mock<Upstream>()
val handler = EthereumTraceLowerBoundErrorHandler
handler.handle(upstream, request, "missing trie node d5648cc9aef48154159d53800f2f")
verify(upstream).updateLowerBound(213229736, LowerBoundType.TRACE)
}
@Test
fun `update lower bound base on regexp`() {
val upstream = mock<Upstream>()
val handler = EthereumTraceLowerBoundErrorHandler
handler.handle(upstream, ChainRequest("trace_block", ListParams("0xCB5A0A8")), "block #1 not found")
verify(upstream).updateLowerBound(213229736, LowerBoundType.TRACE)
}
companion object {
@JvmStatic
fun requests(): List<Arguments> =
listOf(
of(ChainRequest("trace_block", ListParams("0xCB5A0A8"))),
of(ChainRequest("arbtrace_block", ListParams("0xCB5A0A8"))),
of(ChainRequest("debug_traceBlockByNumber", ListParams("0xCB5A0A8", mapOf("tracer" to "tracer")))),
of(ChainRequest("trace_callMany", ListParams(arrayOf(mapOf("val" to 1)), "0xCB5A0A8"))),
of(ChainRequest("arbtrace_callMany", ListParams(arrayOf(mapOf("val" to 1)), "0xCB5A0A8"))),
of(ChainRequest("debug_traceCall", ListParams(mapOf("val" to 1), "0xCB5A0A8", mapOf("val" to 1)))),
of(ChainRequest("trace_call", ListParams(mapOf("val" to 1), arrayOf(mapOf("val" to 1)), "0xCB5A0A8"))),
of(ChainRequest("arbtrace_call", ListParams(mapOf("val" to 1), arrayOf(mapOf("val" to 1)), "0xCB5A0A8"))),
)
}
}

2
src/test/kotlin/io/emeraldpay/dshackle/upstream/lowerbound/RecursiveLowerBoundServiceTest.kt
View File

@@ -86,6 +86,7 @@ class RecursiveLowerBoundServiceTest {
.expectSubscription()
.expectNoEvent(Duration.ofSeconds(15))
.expectNextMatches { it.lowerBound == 17964844L && it.type == LowerBoundType.STATE }
.expectNextMatches { it.lowerBound == 17964844L && it.type == LowerBoundType.TRACE }
.expectNextMatches { it.lowerBound == 17964844L && it.type == LowerBoundType.BLOCK }
.expectNextMatches { it.lowerBound == 17964844L && it.type == LowerBoundType.TX }
.expectNextMatches { it.lowerBound == 17964844L && it.type == LowerBoundType.LOGS }
@@ -97,6 +98,7 @@ class RecursiveLowerBoundServiceTest {
.hasSameElementsAs(
listOf(
LowerBoundData(17964844L, LowerBoundType.STATE),
LowerBoundData(17964844L, LowerBoundType.TRACE),
LowerBoundData(17964844L, LowerBoundType.BLOCK),
LowerBoundData(17964844L, LowerBoundType.TX),
LowerBoundData(17964844L, LowerBoundType.LOGS),