Skip to content

Commit

Permalink
Check gas price multiply conditions (#496)
Browse files Browse the repository at this point in the history 
* multiply conditions

* update doc
  • Loading branch information
@tonatoz
tonatoz authored Jun 3, 2024
1 parent 724e9be commit 753b7d8
Show file tree
Hide file tree
Showing 6 changed files with 87 additions and 33 deletions.
3 changes: 2 additions & 1 deletion docs/reference-configuration.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,8 @@ If it's enabled configuration parameter for chain `call-limit-contract` is requi
| `validate-gas-price`
| boolean
| `true`
| Enable/Disable the gas price validation. If it's enabled, the Dshackle will check the gas price of the upstream and will not use it if it's too high.
| Enable/Disable the gas price validation. If it's enabled, the Dshackle will check the gas price of the upstream and compare it with the gas price conditions in chain.yaml
Check conditions can contain multiple values presented as a list of pair operator and value. The operator can be `eq`, `ne`, `gt`, `ge`, `lt`, `le`. Value is a Long number.

| `call-limit-size`
| number
Expand Down
39 changes: 24 additions & 15 deletions foundation/src/main/kotlin/org/drpc/chainsconfig/ChainsConfig.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,30 @@ data class ChainsConfig(private val chains: List<ChainConfig>) : Iterable<Chains
fun default(): ChainsConfig = ChainsConfig(emptyList())
}

class GasPriceCondition(private val condition: String) {
class GasPriceCondition(rawConditions: List<String>) {
private val conditions: List<Pair<String, Long>> = rawConditions.map {
val parts = it.split(" ")
if (parts.size != 2 || listOf("ne", "eq", "gt", "lt", "ge", "le").none { op -> op == parts[0] }) {
throw IllegalArgumentException("Invalid condition: $it")
}
Pair(parts[0], parts[1].toLong())
}

fun check(value: Long): Boolean {
val (op, valueStr) = condition.split(" ")
return when (op) {
"ne" -> value != valueStr.toLong()
"eq" -> value == valueStr.toLong()
"gt" -> value > valueStr.toLong()
"lt" -> value < valueStr.toLong()
"ge" -> value >= valueStr.toLong()
"le" -> value <= valueStr.toLong()
else -> throw IllegalArgumentException("Unsupported condition: $condition")
return conditions.all { (op, limit) ->
when (op) {
"ne" -> value != limit
"eq" -> value == limit
"gt" -> value > limit
"lt" -> value < limit
"ge" -> value >= limit
"le" -> value <= limit
else -> false
}
}
}

fun rules() = condition
fun rules() = conditions.joinToString { (op, limit) -> "$op $limit" }
}

data class ChainConfig(
Expand All @@ -49,7 +58,7 @@ data class ChainsConfig(private val chains: List<ChainConfig>) : Iterable<Chains
val id: String,
val blockchain: String,
val type: String,
val gasPriceCondition: GasPriceCondition? = null,
val gasPriceCondition: GasPriceCondition,
) {
companion object {
@JvmStatic
Expand All @@ -70,12 +79,12 @@ data class ChainsConfig(private val chains: List<ChainConfig>) : Iterable<Chains
"undefined",
"undefined",
"unknown",
null,
GasPriceCondition(emptyList()),
)

@JvmStatic
fun defaultWithGasPriceCondition(gasPriceCondition: String) = defaultWithContract(null).copy(
gasPriceCondition = GasPriceCondition(gasPriceCondition),
fun defaultWithGasPriceCondition(gasPriceConditions: List<String>) = defaultWithContract(null).copy(
gasPriceCondition = GasPriceCondition(gasPriceConditions),
)
}
}
Expand Down
51 changes: 43 additions & 8 deletions foundation/src/main/kotlin/org/drpc/chainsconfig/ChainsConfigReader.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,47 @@ class ChainsConfigReader(
MappingNode(
chain.tag,
listOf(
NodeTuple(ScalarNode(Tag.STR, "settings", null, null, DumperOptions.ScalarStyle.LITERAL), chainSettings),
NodeTuple(
ScalarNode(Tag.STR, "blockchain", null, null, DumperOptions.ScalarStyle.LITERAL),
ScalarNode(Tag.STR, blockchain, null, null, DumperOptions.ScalarStyle.LITERAL),
ScalarNode(
Tag.STR,
"settings",
null,
null,
DumperOptions.ScalarStyle.LITERAL,
),
chainSettings,
),
NodeTuple(
ScalarNode(Tag.STR, "type", null, null, DumperOptions.ScalarStyle.LITERAL),
ScalarNode(Tag.STR, type, null, null, DumperOptions.ScalarStyle.LITERAL),
ScalarNode(
Tag.STR,
"blockchain",
null,
null,
DumperOptions.ScalarStyle.LITERAL,
),
ScalarNode(
Tag.STR,
blockchain,
null,
null,
DumperOptions.ScalarStyle.LITERAL,
),
),
NodeTuple(
ScalarNode(
Tag.STR,
"type",
null,
null,
DumperOptions.ScalarStyle.LITERAL,
),
ScalarNode(
Tag.STR,
type,
null,
null,
DumperOptions.ScalarStyle.LITERAL,
),
),
),
chain.flowStyle,
Expand All @@ -62,7 +95,8 @@ class ChainsConfigReader(
private fun parseChain(blockchain: String, node: MappingNode): ChainsConfig.ChainConfig {
val id = getValueAsString(node, "id")
?: throw IllegalArgumentException("undefined id for $blockchain")
val settings = getMapping(node, "settings") ?: throw IllegalArgumentException("undefined settings for $blockchain")
val settings =
getMapping(node, "settings") ?: throw IllegalArgumentException("undefined settings for $blockchain")
val lags = getMapping(settings, "lags")?.let { lagConfig ->
Pair(
getValueAsInt(lagConfig, "syncing")
Expand All @@ -86,7 +120,7 @@ class ChainsConfigReader(
?: throw IllegalArgumentException("undefined shortnames for $blockchain")
val type = getValueAsString(node, "type")
?: throw IllegalArgumentException("undefined type for $blockchain")
val gasPriceCondition = getValueAsString(node, "gas-price-condition")
val gasPriceConditions = getListOfString(node, "gas-price-condition") ?: emptyList()
return ChainsConfig.ChainConfig(
expectedBlockTime = expectedBlockTime,
syncingLagSize = lags.first,
Expand All @@ -101,7 +135,7 @@ class ChainsConfigReader(
id = id,
blockchain = blockchain,
type = type,
gasPriceCondition = gasPriceCondition?.let { ChainsConfig.GasPriceCondition(gasPriceCondition) },
gasPriceCondition = ChainsConfig.GasPriceCondition(gasPriceConditions),
)
}

Expand All @@ -118,6 +152,7 @@ class ChainsConfigReader(
val merged = mergeMappingNode(defChain.second, curChain.second)
parseChain(defChain.first, merged!!)
}

else -> ChainsConfig.ChainConfig.default()
}
}
Expand Down
7 changes: 5 additions & 2 deletions foundation/src/main/resources/chains.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,9 @@ chain-settings:
grpcId: 1006
chain-id: 0x38
short-names: [bsc, binance, bnb-smart-chain]
gas-price-condition: ne 3000000000
gas-price-condition:
- ne 3000000000
- ne 5000000000
- id: Testnet
priority: 1
code: BSC_TESTNET
Expand Down Expand Up @@ -610,7 +612,8 @@ chain-settings:
short-names: [kava]
chain-id: 0x8ae
grpcId: 1025
gas-price-condition: eq 1000000000
gas-price-condition:
- eq 1000000000
- id: Testnet
priority: 10
code: KAVA_TESTNET
Expand Down
6 changes: 3 additions & 3 deletions src/main/kotlin/io/emeraldpay/dshackle/upstream/ethereum/EthereumUpstreamValidator.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,18 +197,18 @@ open class EthereumUpstreamValidator @JvmOverloads constructor(
}

private fun validateGasPrice(): Mono<ValidateUpstreamSettingsResult> {
if (!options.validateGasPrice || config.gasPriceCondition == null) {
if (!options.validateGasPrice) {
return Mono.just(ValidateUpstreamSettingsResult.UPSTREAM_VALID)
}
return upstream.getIngressReader()
.read(ChainRequest("eth_gasPrice", ListParams()))
.flatMap(ChainResponse::requireStringResult)
.map { result ->
val actualGasPrice = result.substring(2).toLong(16)
if (!config.gasPriceCondition!!.check(actualGasPrice)) {
if (!config.gasPriceCondition.check(actualGasPrice)) {
log.warn(
"Node ${upstream.getId()} has gasPrice $actualGasPrice, " +
"but it is not equal to the required ${config.gasPriceCondition!!.rules()}",
"but it is not equal to the required ${config.gasPriceCondition.rules()}",
)
ValidateUpstreamSettingsResult.UPSTREAM_FATAL_SETTINGS_ERROR
} else {
Expand Down
14 changes: 10 additions & 4 deletions ...test/groovy/io/emeraldpay/dshackle/upstream/ethereum/EthereumUpstreamValidatorSpec.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ class EthereumUpstreamValidatorSpec extends Specification {
it.validateChain = false
it.validateCallLimit = false
}.buildOptions()
def conf = ChainConfig.defaultWithGasPriceCondition("ne 3000000000")
def conf = ChainConfig.defaultWithGasPriceCondition(["ne 3000000000", "ne 5000000000"])
def up = Mock(Upstream) {
3 * getIngressReader() >>
Mock(Reader) {
Expand All @@ -374,7 +374,7 @@ class EthereumUpstreamValidatorSpec extends Specification {
it.validateChain = false
it.validateCallLimit = false
}.buildOptions()
def conf = ChainConfig.defaultWithGasPriceCondition("eq 1000000000")
def conf = ChainConfig.defaultWithGasPriceCondition(["eq 1000000000"])
def up = Mock(Upstream) {
3 * getIngressReader() >>
Mock(Reader) {
Expand All @@ -395,6 +395,7 @@ class EthereumUpstreamValidatorSpec extends Specification {
setup:
def options = ChainOptions.PartialOptions.getDefaults().tap {
it.validateCallLimit = false
it.validateGasPrice = false
}.buildOptions()
def up = Mock(Upstream) {
4 * getIngressReader() >> Mock(Reader) {
Expand All @@ -417,6 +418,7 @@ class EthereumUpstreamValidatorSpec extends Specification {
setup:
def options = ChainOptions.PartialOptions.getDefaults().tap {
it.validateCallLimit = false
it.validateGasPrice = false
}.buildOptions()
def up = Mock(Upstream) {
4 * getIngressReader() >> Mock(Reader) {
Expand All @@ -437,7 +439,9 @@ class EthereumUpstreamValidatorSpec extends Specification {

def "Upstream is valid if all setting are valid"() {
setup:
def options = ChainOptions.PartialOptions.getDefaults().buildOptions()
def options = ChainOptions.PartialOptions.getDefaults().tap{
it.validateGasPrice = false
}.buildOptions()
def up = Mock(Upstream) {
5 * getIngressReader() >> Mock(Reader) {
1 * read(new ChainRequest("eth_chainId", new ListParams())) >> Mono.just(new ChainResponse('"0x1"'.getBytes(), null))
Expand All @@ -461,7 +465,9 @@ class EthereumUpstreamValidatorSpec extends Specification {

def "Upstream is not valid if there are errors"() {
setup:
def options = ChainOptions.PartialOptions.getDefaults().buildOptions()
def options = ChainOptions.PartialOptions.getDefaults().tap {
it.validateGasPrice = false
}.buildOptions()
def up = Mock(Upstream) {
5 * getIngressReader() >> Mock(Reader) {
1 * read(new ChainRequest("eth_chainId", new ListParams())) >> Mono.just(new ChainResponse(null, new ChainCallError(1, "Too long")))
Expand Down

0 comments on commit 753b7d8

Please sign in to comment.