fix cumstom error

pull/1770/head
yann300 3 years ago
parent 960fd05f79
commit d1061b4c96
  1. 47
      apps/remix-ide-e2e/src/tests/transactionExecution.spec.ts
  2. 3
      apps/remix-ide/src/blockchain/blockchain.js
  3. 2
      libs/remix-core-plugin/src/lib/compiler-artefacts.ts
  4. 101
      libs/remix-lib/src/execution/txExecution.ts

@ -178,8 +178,29 @@ module.exports = {
.journalLastChildIncludes('"documentation": "param2"') .journalLastChildIncludes('"documentation": "param2"')
.journalLastChildIncludes('"documentation": "param3"') .journalLastChildIncludes('"documentation": "param3"')
.journalLastChildIncludes('Debug the transaction to get more information.') .journalLastChildIncludes('Debug the transaction to get more information.')
},
'Should Compile and Deploy a contract which define a custom error in a library, the error should be logged in the terminal': function (browser: NightwatchBrowser) {
browser.testContracts('customError.sol', sources[5]['customErrorLib.sol'], ['D'])
.clickLaunchIcon('udapp')
.selectAccount('0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c') // this account will be used for this test suite
.click('#runTabView button[class^="instanceButton"]')
.waitForElementPresent('.instance:nth-of-type(3)')
.click('.instance:nth-of-type(3) > div > button')
.clickFunction('h - transact (not payable)')
.pause(5000)
.journalLastChildIncludes('Error provided by the contract:')
.journalLastChildIncludes('CustomError : error description from library')
.journalLastChildIncludes('Parameters:')
.journalLastChildIncludes('"value": "48"')
.journalLastChildIncludes('"value": "46"')
.journalLastChildIncludes('"value": "error_string_from_library"')
.journalLastChildIncludes('"documentation": "param1 from library"')
.journalLastChildIncludes('"documentation": "param2 from library"')
.journalLastChildIncludes('"documentation": "param3 from library"')
.journalLastChildIncludes('Debug the transaction to get more information.')
.end() .end()
} },
} }
// @TODO test: bytes8[3][] type as input // @TODO test: bytes8[3][] type as input
@ -281,5 +302,29 @@ contract C {
} }
}` }`
} }
},
{
'customErrorLib.sol': {
content: `// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.7;
library lib {
/// error description from library
/// @param a param1 from library
/// @param b param2 from library
/// @param c param3 from library
error CustomError(uint a, uint b, string c);
function set() public {
revert CustomError(48, 46, "error_string_from_library");
}
}
contract D {
function h() public {
lib.set();
}
}`
}
} }
] ]

@ -524,7 +524,8 @@ class Blockchain extends Plugin {
if (execResult) { if (execResult) {
// if it's not the VM, we don't have return value. We only have the transaction, and it does not contain the return value. // if it's not the VM, we don't have return value. We only have the transaction, and it does not contain the return value.
returnValue = execResult ? execResult.returnValue : toBuffer(addHexPrefix(txResult.result) || '0x0000000000000000000000000000000000000000000000000000000000000000') returnValue = execResult ? execResult.returnValue : toBuffer(addHexPrefix(txResult.result) || '0x0000000000000000000000000000000000000000000000000000000000000000')
const vmError = txExecution.checkVMError(execResult, args.data.contractABI, args.data.contract) const compiledContracts = await this.call('compilerArtefacts', 'getAllContractDatas')
const vmError = txExecution.checkVMError(execResult, compiledContracts)
if (vmError.error) { if (vmError.error) {
return cb(vmError.message) return cb(vmError.message)
} }

@ -4,7 +4,7 @@ import { CompilerAbstract } from '@remix-project/remix-solidity'
const profile = { const profile = {
name: 'compilerArtefacts', name: 'compilerArtefacts',
methods: ['get', 'addResolvedContract', 'getCompilerAbstract'], methods: ['get', 'addResolvedContract', 'getCompilerAbstract' , 'getAllContractDatas'],
events: [], events: [],
version: '0.0.1' version: '0.0.1'
} }

@ -57,7 +57,7 @@ export function callFunction (from, to, data, value, gasLimit, funAbi, txRunner,
* @param {Object} execResult - execution result given by the VM * @param {Object} execResult - execution result given by the VM
* @return {Object} - { error: true/false, message: DOMNode } * @return {Object} - { error: true/false, message: DOMNode }
*/ */
export function checkVMError (execResult, abi, contract) { export function checkVMError (execResult, compiledContracts) {
const errorCode = { const errorCode = {
OUT_OF_GAS: 'out of gas', OUT_OF_GAS: 'out of gas',
STACK_UNDERFLOW: 'stack underflow', STACK_UNDERFLOW: 'stack underflow',
@ -91,56 +91,61 @@ export function checkVMError (execResult, abi, contract) {
const returnData = execResult.returnValue const returnData = execResult.returnValue
const returnDataHex = returnData.slice(0, 4).toString('hex') const returnDataHex = returnData.slice(0, 4).toString('hex')
let customError let customError
if (abi) { if (compiledContracts) {
let decodedCustomErrorInputsClean let decodedCustomErrorInputsClean
for (const item of abi) { for (const file of Object.keys(compiledContracts)) {
if (item.type === 'error') { for (const contractName of Object.keys(compiledContracts[file])) {
// ethers doesn't crash anymore if "error" type is specified, but it doesn't extract the errors. see: const contract = compiledContracts[file][contractName]
// https://github.com/ethers-io/ethers.js/commit/bd05aed070ac9e1421a3e2bff2ceea150bedf9b7 for (const item of contract.abi) {
// we need here to fake the type, so the "getSighash" function works properly if (item.type === 'error') {
const fn = getFunctionFragment({ ...item, type: 'function', stateMutability: 'nonpayable' }) // ethers doesn't crash anymore if "error" type is specified, but it doesn't extract the errors. see:
if (!fn) continue // https://github.com/ethers-io/ethers.js/commit/bd05aed070ac9e1421a3e2bff2ceea150bedf9b7
const sign = fn.getSighash(item.name) // we need here to fake the type, so the "getSighash" function works properly
if (!sign) continue const fn = getFunctionFragment({ ...item, type: 'function', stateMutability: 'nonpayable' })
if (returnDataHex === sign.replace('0x', '')) { if (!fn) continue
customError = item.name const sign = fn.getSighash(item.name)
const functionDesc = fn.getFunction(item.name) if (!sign) continue
// decoding error parameters if (returnDataHex === sign.replace('0x', '')) {
const decodedCustomErrorInputs = fn.decodeFunctionData(functionDesc, returnData) customError = item.name
decodedCustomErrorInputsClean = {} const functionDesc = fn.getFunction(item.name)
let devdoc = {} // decoding error parameters
// "contract" reprensents the compilation result containing the NATSPEC documentation const decodedCustomErrorInputs = fn.decodeFunctionData(functionDesc, returnData)
if (contract && fn.functions && Object.keys(fn.functions).length) { decodedCustomErrorInputsClean = {}
const functionSignature = Object.keys(fn.functions)[0] let devdoc = {}
// we check in the 'devdoc' if there's a developer documentation for this error // "contract" reprensents the compilation result containing the NATSPEC documentation
try { if (contract && fn.functions && Object.keys(fn.functions).length) {
devdoc = (contract.object.devdoc.errors && contract.object.devdoc.errors[functionSignature][0]) || {} const functionSignature = Object.keys(fn.functions)[0]
} catch (e) { // we check in the 'devdoc' if there's a developer documentation for this error
console.error(e.message) try {
devdoc = (contract.devdoc.errors && contract.devdoc.errors[functionSignature][0]) || {}
} catch (e) {
console.error(e.message)
}
// we check in the 'userdoc' if there's an user documentation for this error
try {
const userdoc = (contract.userdoc.errors && contract.userdoc.errors[functionSignature][0]) || {}
if (userdoc && (userdoc as any).notice) customError += ' : ' + (userdoc as any).notice // we append the user doc if any
} catch (e) {
console.error(e.message)
}
}
let inputIndex = 0
for (const input of functionDesc.inputs) {
const inputKey = input.name || inputIndex
const v = decodedCustomErrorInputs[inputKey]
decodedCustomErrorInputsClean[inputKey] = {
value: v.toString ? v.toString() : v
}
if (devdoc && (devdoc as any).params) {
decodedCustomErrorInputsClean[input.name].documentation = (devdoc as any).params[inputKey] // we add the developer documentation for this input parameter if any
}
inputIndex++
}
break
} }
// we check in the 'userdoc' if there's an user documentation for this error
try {
const userdoc = (contract.object.userdoc.errors && contract.object.userdoc.errors[functionSignature][0]) || {}
if (userdoc && (userdoc as any).notice) customError += ' : ' + (userdoc as any).notice // we append the user doc if any
} catch (e) {
console.error(e.message)
}
}
let inputIndex = 0
for (const input of functionDesc.inputs) {
const inputKey = input.name || inputIndex
const v = decodedCustomErrorInputs[inputKey]
decodedCustomErrorInputsClean[inputKey] = {
value: v.toString ? v.toString() : v
}
if (devdoc && (devdoc as any).params) {
decodedCustomErrorInputsClean[input.name].documentation = (devdoc as any).params[inputKey] // we add the developer documentation for this input parameter if any
}
inputIndex++
} }
break }
}
} }
} }
if (decodedCustomErrorInputsClean) { if (decodedCustomErrorInputsClean) {

Loading…
Cancel
Save