Instadapp/chains
1
0
Fork 0
mirror of https://github.com/Instadapp/chains.git synced 2024-07-29 22:37:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support parent bridges field - closes #349

Browse Source
This commit is contained in:
ligi 2021-09-15 01:23:13 +02:00
parent 59a2e092dd
commit 0b77f10fe4
No known key found for this signature in database
GPG Key ID: 8E81894010ABF23D
9 changed files with 206 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/main/kotlin/org/ethereum/lists/chains/Main.kt
View File

@ -34,7 +34,7 @@ private fun createOutputFiles() {
allChainFiles
.map { Klaxon().parseJsonObject(it.reader()) }
.sortedBy { (it["chainId"] as Number).toLong() }
.sortedBy { (it["chainId"] as Number).toLong() }
.forEach { jsonObject ->
chainJSONArray.add(jsonObject)
@ -215,10 +215,28 @@ fun checkChain(chainFile: File, connectRPC: Boolean) {
throw ParentMustBeObject()
}
if (it.keys != mutableSetOf("chain", "type")) {
if (!it.keys.containsAll(setOf("chain", "type"))) {
throw ParentMustHaveChainAndType()
}
val extraFields = it.keys - setOf("chain", "type", "bridges")
if (extraFields.isNotEmpty()) {
throw ParentHasExtraFields(extraFields)
}
val bridges = it["bridges"]
if (bridges != null && bridges !is List<*>) {
throw ParentBridgeNoArray()
}
(bridges as? JsonArray<*>)?.forEach { bridge ->
if (bridge !is JsonObject) {
throw BridgeNoObject()
}
if (bridge.keys.size != 1 || bridge.keys.first() != "url") {
throw BridgeOnlyURL()
}
}
if (!setOf("L2", "shard").contains(it["type"])) {
throw ParentHasInvalidType(it["type"] as? String)
}

4
src/main/kotlin/org/ethereum/lists/chains/model/Exceptions.kt
View File

@ -19,4 +19,8 @@ class ExplorerStandardMustBeEIP3091: Exception("explorer standard must be EIP309
class ParentHasInvalidType(type: String?): Exception("Parent has invalid type $type - only L2 or shard allowed")
class ParentMustBeObject: Exception("parent must be an object")
class ParentMustHaveChainAndType: Exception("parent must have fields 'chain' and 'type'")
class ParentHasExtraFields(fields: Set<String>): Exception("parent has extra field: $fields")
class ParentBridgeNoArray: Exception("parent bridge must be array")
class BridgeNoObject: Exception("parent bridges must be array consisting of json objects")
class BridgeOnlyURL: Exception("parent bridge only contain an URL")
class ParentChainDoesNotExist(chain: String): Exception("Referenced parent chain ($chain) does not exist")

41
src/test/kotlin/org/ethereum/lists/chains/TheChainChecker.kt
View File

@ -35,6 +35,20 @@ class TheChainChecker {
checkChain(file, false)
}
@Test
fun shouldPassForValidChainWithParentBridge() {
val file = getFile("valid/withparentbridge/eip155-2.json")
checkChain(file, false)
}
@Test(expected = BridgeNoObject::class)
fun shouldFailForParentBridgeElementNoObject() {
val file = getFile("invalid/withparentextrabridgeelementnoobject/eip155-2.json")
checkChain(file, false)
}
@Test(expected = ParentMustBeObject::class)
fun shouldFailForParentNoObject() {
val file = getFile("invalid/withparentnobject/eip155-2.json")
@ -49,6 +63,33 @@ class TheChainChecker {
checkChain(file, false)
}
@Test(expected = ParentHasExtraFields::class)
fun shouldFailForParentWithExtraParentField() {
val file = getFile("invalid/withparentextrafield/eip155-2.json")
checkChain(file, false)
}
@Test(expected = ParentHasExtraFields::class)
fun shouldFailForParentWithExtraField() {
val file = getFile("invalid/withparentextrafield/eip155-2.json")
checkChain(file, false)
}
@Test(expected = BridgeOnlyURL::class)
fun shouldFailForParentWithExtraBridgesField() {
val file = getFile("invalid/withparentextrabridgesfield/eip155-2.json")
checkChain(file, false)
}
@Test(expected = ParentBridgeNoArray::class)
fun shouldFailForParentWithExtraBridgeNoArray() {
val file = getFile("invalid/withparentextrabridgesnoarray/eip155-2.json")
checkChain(file, false)
}
@Test(expected = ParentChainDoesNotExist::class)
fun shouldFailIfParentChainDoesNotExist() {

24
src/test/resources/test_chains/invalid/withparentextrabridgeelementnoobject/eip155-2.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 2,
"networkId": 2,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"parent": {
"chain": "eip155-1",
"type": "L2",
"bridges": ["yolo"]
}
}

24
src/test/resources/test_chains/invalid/withparentextrabridgesfield/eip155-2.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 2,
"networkId": 2,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"parent": {
"chain": "eip155-1",
"type": "L2",
"bridges": [{"yolo":"yoooo"}]
}
}

24
src/test/resources/test_chains/invalid/withparentextrabridgesnoarray/eip155-2.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 2,
"networkId": 2,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"parent": {
"chain": "eip155-1",
"type": "L2",
"bridges": "yolo"
}
}

24
src/test/resources/test_chains/invalid/withparentextrafield/eip155-2.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 2,
"networkId": 2,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"parent": {
"chain": "eip155-1",
"type": "L2",
"yolo": "yooooo"
}
}

19
src/test/resources/test_chains/valid/withparentbridge/eip155-1.json Normal file
View File

@ -0,0 +1,19 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 1,
"networkId": 1,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
}
}

26
src/test/resources/test_chains/valid/withparentbridge/eip155-2.json Normal file
View File

@ -0,0 +1,26 @@
{
"name": "Ethereum Mainnet",
"shortName": "eth",
"chain": "ETH",
"network": "mainnet",
"chainId": 2,
"networkId": 2,
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"infoURL": "https://ethereum.org",
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"parent": {
"chain": "eip155-1",
"type": "L2",
"bridges": [
{"url": "https://bridge.foo.org"}
]
}
}