Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generate keccak256 mappings from sol errors #1522

Merged
merged 9 commits into from
May 25, 2024
Merged

generate keccak256 mappings from sol errors #1522

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d641ad5
generate keccak256 mappings from sol errors
Intizar-T May 24, 2024
29c672b
Update contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js
Intizar-T May 24, 2024
0abef89
Update contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js
Intizar-T May 24, 2024
4a7b4ee
use for of instead of forEach
Intizar-T May 24, 2024
f1daff9
Use template literals for string operation
Intizar-T May 24, 2024
9b7088d
fix duplicate path declaration error
Intizar-T May 24, 2024
f9759d0
move paths to the top of the script
Intizar-T May 25, 2024
71a6625
implement script to get error from generated hash
Intizar-T May 25, 2024
13136f4
reflect coderabbitai feedback: refactor
Intizar-T May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion contracts/v0.1/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@
"request-vrf": "yarn hardhat run scripts/vrf/integration/request-vrf.ts",
"get-vrf": "yarn hardhat run scripts/vrf/integration/read-vrf.ts",
"request-rr": "yarn hardhat run scripts/request-response/integration/request-data.ts",
"get-rr": "yarn hardhat run scripts/request-response/integration/read-data.ts"
"get-rr": "yarn hardhat run scripts/request-response/integration/read-data.ts",
"sol-error-mappings": "node scripts/sol-error-mappings/error-keccak-mapping.js"
},
"devDependencies": {
"@bisonai/orakl-vrf": "*",
Expand Down
49 changes: 49 additions & 0 deletions contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
const fs = require('node:fs')
const path = require('node:path')
const sha3 = require('js-sha3')

function processFile(filePath) {
const content = fs.readFileSync(filePath, 'utf8')
const lines = content.split('\n')
const mapping = {}

for (const line of lines) {
const trimmedLine = line.trim()
if (trimmedLine.startsWith('error ')) {
const processedLine = trimmedLine
.replace('error ', '')
.replace(
/\(([^)]+)\)/,
(match) =>
`${match
.split(' ')
.filter((_, idx) => idx % 2 === 0)
.join(',')})`
)
.replace(';', '')
const hash = sha3.keccak256(processedLine)
mapping[processedLine] = hash
}
}

return mapping
}

function processDirectory(dirPath) {
const entries = fs.readdirSync(dirPath, { withFileTypes: true })
let mapping = {}

for (const entry of entries) {
const fullPath = path.join(dirPath, entry.name)
if (entry.isDirectory()) {
mapping = { ...mapping, ...processDirectory(fullPath) }
} else if (entry.isFile() && path.extname(entry.name) === '.sol') {
mapping = { ...mapping, ...processFile(fullPath) }
}
}

return mapping
}

const mapping = processDirectory('src')
Intizar-T marked this conversation as resolved.
Show resolved Hide resolved
fs.writeFileSync('scripts/sol-error-mappings/errorMappings.json', JSON.stringify(mapping, null, 2))
71 changes: 71 additions & 0 deletions contracts/v0.1/scripts/sol-error-mappings/errorMappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"TooManyConsumers()": "05a48e0fc42b9cfeed3601aff0cfc0d560d245d28de6c384623d71dc535c2272",
"MustBeRequestedOwner(address)": "d084e975a962ac435d13cd622ad247f5a0482af4cce640e1af8dc9e5e88a9c36",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's probably gonna have different hash if address is replaced with specific value, did you also check the case? would it be still recognizable with this hash value?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a suggestion, but how about making a yarn command taking hash and return decoded custom error using related library?
i found this kind of answer in stackoverflow
https://ethereum.stackexchange.com/a/153295

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

regarding, hash correctness, i found the following piece:

In Solidity, the error signature is generated from its name and the types of its parameters. The parameter names are not included in the signature. This is similar to how function signatures are generated in Solidity.

The signature is then hashed using the Keccak256 algorithm to produce a 4-byte identifier. This identifier is what's used in the bytecode to represent the error.

so as long as the error definitions dont change the encoding/hash won't change. And if the error def changes, we can always generate updated hashes by running this script. Pls let me know if I misunderstood your point.

Copy link
Collaborator

@nick-bisonai nick-bisonai May 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awh I see, think I misunderstood how hashes were generated. thank you for the explanation.
still, it'd be nice to have if we can parse the data together if there's a parameter in the error  😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes that'd be great! I'm currently testing out the library that you suggested, ethers-decode-error, from vrf-consumer script but I keep running into errors when I try to initialize the decoder (it's failing to parse the passed abi) or cannot parse the error if no abi is passed. Maybe we can take a quick look together on Monday :)

"MustBeAccountOwner(address)": "901d952135d9fbff82866f5ab8abcdb4238495fa6f2e413f956656e6569f4dee",
"MustBePaymentSolution(address)": "57695ced935a1fd278569366d16f14a9cb59efb1e3a7239e369fafbf4745c8a3",
"InsufficientBalance()": "f4d678b8ce6b5157126b1484a53523762a93571537a7d5ae97d8014a44715c94",
"InvalidConsumer(address)": "728aeb5f6831d2f2f092f1e141ae8764971c162caea49044ed3a78fe5232582d",
"BurnFeeFailed()": "0e27e65d5fdc901a0726228f89f2ab787c6a59f7cca806b536517699aa1c3de9",
"OperatorFeeFailed()": "b7c1cac73e34902c9c8abee43a3fb8ee3aeb181d4d854c2bb6bba5f2bf286099",
"ProtocolFeeFailed()": "f56213a3d238fd70a27d8220682ab7179f7213c5a97e0195e8c3e26103474d7d",
"OracleAlreadyEnabled()": "9c90768ec46bef7bfbf90cde0bcbadf080f9e05b098f3b4e799d81965fd2e400",
"OracleNotEnabled()": "1c22532f29444f8b045b26ef3311cf25bc6a4ba557f5dfd18d66dd5e05b5401d",
"OffChainReadingOnly()": "8d07577c33e72bbdc050f789f325f74809772dfa9aa1baa567c84149d1603806",
"RequesterNotAuthorized()": "af9a0f5911839e4d4579f16962159b0836dd84da595c5381414fa7445ffe6302",
"PrevRoundNotSupersedable()": "403ea3fa7d59dc3326f7bfa4b2a4d911c220d61ad68cafcac6ecbde8ee2c1bb0",
"RoundNotAcceptingSubmission()": "575c0ddbb1cd0ca17eede1a2e2cdd66b144be386f3f1aa736f49c13d84ae92fd",
"TooManyOracles()": "25d0209c0efd050954bc628679b901fe7e35bdd632e71f070173b6a6e30f7048",
"NoDataPresent()": "bb258700699f4449978821f51700c766295ef133e7bb6177607142c8d88db786",
"NewRequestTooSoon()": "c30a2a1232535b9b0e7074f65c6d557222b26cc3456cb7c4d60ca55214c38e72",
"MinSubmissionGtMaxSubmission()": "fd97bd0fe21f60c1ff361d27f277b231ff2909164349ef648a3e1d7fadb92f2a",
"RestartDelayExceedOracleNum()": "d16b17e2a9d6c5e644833990df9cd32dca3a6d98bbfae18b85c424146b6b5a37",
"MinSubmissionZero()": "5ea0323e3a2de042f2998e13913310e0daab30fbadeec260bc0afab13e3d6965",
"MaxSubmissionGtOracleNum()": "08bc6c01863fb00e1fafb244b24cd46afcbeeab6313836ee09f8e24e2567fc66",
"InvalidProposedAggregator()": "7751b623ca7ec42248b6c4c383057d69d4d1dd5b5f25437058a4d63d49841c00",
"Reentrant()": "ed3ba6a62877a99990a32617b4e001f2c85c7886f010c9b166e8438fd38bcb40",
"NoCorrespondingRequest()": "3688124ad82f221eb78a677092ca0117cccfe21e434a0580aae4708fa81ac9b3",
"NotRequestOwner()": "517907dd6adedc432a6bf3f39b24ae9de6d6b2c28b882262c688c83967d8e73d",
"OracleAlreadyRegistered(address)": "6ff7406ab9964292a7f6959f9445e5acd14929b00e1793fc155e682f7bfb024a",
"NoSuchOracle(address)": "f9a0ffdffcc2341356fb22ccddc9690c8e363ebd79e1335b10f6254fd1a761b7",
"RefundFailure()": "ef7a4b61c46ff73f9899d25704b7b276a655f7a132026f96485e1c55f362e25a",
"InvalidConsumer(uint64,address)": "f0019fe6aece70bd274bf825267212b1ed3198ad77f148bf9fc22ae438a8f1a5",
"IncorrectCommitment()": "d529142c8650841feedc2ecdf8de95e62557caf485696b524803b961fd23badb",
"GasLimitTooBig(uint32,uint32)": "f5d7e01ea5c32f94380825bc1f2bdcf8c3aa85c2719c136d325e11fe7e490679",
"InsufficientPayment(uint256,uint256)": "b99e2ab74a9c2e995ae1a652f5e2850be9926ff7f7c383e9a2f87106a5985716",
"FailedToDeposit()": "a4790ee39e8168587bb57070e7257e57f6ad4498f84af6daaae5a8d9a80ec7ff",
"OnlyOracle()": "80fee105c2072ed9e186f4c861f8af91e75494f49bfc0883cbebb2900e492022",
"ConsumerValid()": "2c34ebbf4c035a75a99ae0583a1c87ed95ed68773bcee27e118bd364c24a0170",
"OnlyVRFCoordinatorCanFulfill(address,address)": "d443d157584d886dc1572efda8ff618310478fef234cf21bd6474dcff9630061",
"InvalidSubmitter(address)": "bff93c5c4e58ecd14ea39b5e97b748def2b298a392498d6a6b987c36adbddfd1",
"InvalidAggregator(address)": "5c8bf34d0efb9c869ef3d02642453dee7ff6788522ea14f1171ebbafe4006f2d",
"PendingRequestExists()": "b42f66e892a890021cc99a072a4941254adf08d9d07497a5763974f07c7c250d",
"InvalidCoordinator()": "61888397e7f6abdb7aa5606af645adcc5be5105ffc1d57ff51bf37371c757dbd",
"InvalidAccount()": "6d187b28dc0ac7ec3747dcca312a7f01229ba51941237588cf813e48090f2a50",
"MustBeAccountOwner()": "60743613d42355a1b7abca5eaf70188edd0a8d0d296764d8322174ea3816893b",
"RatioOutOfBounds()": "4a580a4d9ca7d6bcc6346bb1fc0c966702dca7bc7dbdc75426088ad78c2fa1c7",
"FailedToWithdraw(uint64)": "2aa6965e71a4ababe401114aeaa32fbb68542241412cdba5d07adda7d0ca4be4",
"CoordinatorExists()": "59f4e0cc50f0a25bb90ab2bc2a96e0bbba42c00b7c69072801c99993cbc962f1",
"TooHighFeeRatio()": "ecfd94be746422361a4b6e08111919d03cc4e69503f524e682b4b9ca82d55ca6",
"FailedToWithdrawFromTemporaryAccount(uint64)": "4319610c477765e6fb8ad0b74d559e67cd8d815d34e1d3a8e74236b24df2f384",
"NotEnoughFee()": "688e55ae57be53a93b8e2e12ae566cdd98fe14bce2962b4791d131389e632084",
"InvalidChainID()": "86d846fdeeed7b22f570e447c0a11d55fe5d60ad04021185a696b5e8f4c82ac8",
"InvalidAccId()": "c64f1d96590306c7e5ab187fdf4fbf6bbc75c350609fca0f154d9d98d680572d",
"AccountExisted()": "08b6c186b6fadb3156daae316e1969249df0b936e8ad6038fffc96eda20248b4",
"NotFeePayerOwner()": "ef4c0fcce60bb76e1d03909de72b1439fa82e2a3dc6d39d0e5010c38a2e2d3ed",
"NotChainOwner()": "8e14d678438e2ae0ce60f28aaf69a8198b00eda08ad18ed869cfd86c846f4144",
"ChainExisted()": "ab83f3d420fd41f647e71956d5b4650cca8ad5cdbcd3c4bdbd79926d7f48ecf4",
"DecreaseBalanceFailed()": "21d77dc1d9dd29cafa8bcab7bf62a90b98ed6298942903fe19e6755978d538d3",
"OnlyCoordinatorCanFulfill(address,address)": "1cf993f4855ca2a758bea0e0e264b2cd16369bc2acc356b4ef6323767def33d8",
"UnregisteredOracleFulfillment(address)": "d6c3374809b73865a62040e9d4175a675ce5241e7dd83442b8b143f05384928d",
"InvalidJobId()": "9a358cc50a97a124848276b4066b530e81634389418e22304209dac916351c5a",
"InvalidNumSubmission()": "fa163bb0c495b3525bdc00f733bd249631de579def4e3252546f8b503e1d8723",
"OracleAlreadySubmitted()": "9f17b6ef8f30ce6f653f38decba609f847cc97a6449d90057c0459bf9c69faf3",
"IncompatibleJobId()": "e7b9d74d25161aa458668c8a74ef4e7d4b3b306260ed8f44c342e6ecbb6c47cc",
"InvalidAccRequest()": "b3c2774795da0f5e59df6e814034a6f42e598a2dbd2cfb9ca2033325cfc3c596",
"InvalidKeyHash(bytes32)": "c954459da22ef97b64dd32d2273f28881c8659c5b02396c8e6197ee2ce82f1c7",
"NumWordsTooBig(uint32,uint32)": "47386bec2b588c425db14fbb8b0a29247107dbf09065dfab1c591defa56e13e6",
"NoSuchProvingKey(bytes32)": "77f5b84cb29891be0bb7312b5b6396a8514375e9bdc6eece1026e676bac49dde",
"EvenLengthList()": "0a81fe0db8ac23ede61d8dd687fa3f905c52b59950e09f53876faf9702bdc0b2",
"OnlyOwner(address)": "0a86c02ac610fb23f42673818e2633fb2c60a86b7fe508c07305449f01b527ed",
"AnyError()": "36bed872d00b13403f2e085c920f912c513613c2a9a3132df9f54ed1c465106d"
}
Loading