ERC-838 REVERT 오류 사유 ABI 규격 (ABI specification for REVERT reason string)
Draft · 기타 · 2020-08-20 작성
스마트 컨트랙트가 실패할 때 내보내는 REVERT 사유(reason)에 이름과 인자가 있는 오류를 담는 방법을 ABI(응용 바이너리 인터페이스, Application Binary Interface) 규격에 추가해, 지갑이나 라이브러리가 실패 원인을 읽어낼 수 있게 합니다.
왜 필요한가
이더리움 거래가 실패하면 사용자와 개발자는 무엇이 잘못됐는지 알아야 합니다. REVERT 명령은 실패를 설명하는 메시지를 사유 매개변수에 담을 수 있어 올바른 방향으로 가는 한 걸음이지만 당시 솔리디티(Solidity)에서 검토되던 구현은 문자열 하나를 받는 저수준 인터페이스만 제공했습니다. 즉 오류에 이름을 붙이고 금액 같은 인자를 함께 담아서 이를 다시 클라이언트 쪽에서 해석하는 표준 방법이 없었습니다. 이 사유 매개변수의 오류를 클라이언트로 되돌려 주는 방법을 표준화하면 사용자와 개발자 모두에게 많은 이점이 생깁니다. 컨트랙트 개발 언어는 오류를 선언하고 던지는 문법을 제공할 수 있고 web3 같은 라이브러리는 그 오류를 쉽게 복원해 보여 줄 수 있습니다.
구현해야 하는 것
{ "type": "error", "name": "InsufficientBalance", "arguments": [ { "name": "amount", "type": "uint256" } ] }: JSON ABI에 들어가는 오류 선언의 예입니다. 오류의 이름과 인자 목록을 기술합니다.error InsufficientFunds(uint256 amount);: 고수준 언어에서 오류를 선언하는 문법의 예입니다. uint256 인자 하나를 받는 오류를 정의합니다.function transfer(address _to, uint256 _amount) throws(InsufficientFunds);: 확장안에서 제시한 문법으로, 함수가 어떤 오류를 던질 수 있는지 호출자에게 선언합니다.
심층 설명
JSON ABI의 오류 선언
이 규격을 따르는 컴파일러는 JSON ABI를 만들 때 함수·이벤트와 나란히 오류 선언을 포함해야 합니다(SHOULD). 각 오류 객체는 name(문자열)과 arguments(함수의 inputs 목록과 같은 타입) 키를 반드시 포함해야 하고(MUST), type 값은 반드시 "error"여야 합니다. 예시는 amount라는 uint256 인자 하나를 가진 InsufficientBalance 오류입니다. MUST, SHOULD 같은 키워드는 RFC 2119의 정의를 따릅니다.
셀렉터와 인자 인코딩
오류의 셀렉터(selector)는 시그니처에서 계산하며 공개 함수와 이벤트에서 현재 쓰는 방식과 같습니다(예시의 경우 InsufficientBalance()). 이 셀렉터는 클라이언트가 조회할 수 있도록 사유 문자열에 반드시 포함되어야 합니다(MUST). 오류의 인자는 함수 반환값과 같은 방식으로 RLP 인코딩합니다. 다만 셀렉터와 인자를 담는 정확한 형식은 아직 정해지지 않았습니다. 원문이 언급한 솔리디티 구현은 자유 형식 문자열 앞에 uint256(0)을 붙여서 확장의 여지를 남겨 두고 있습니다.
고수준 언어 문법
솔리디티 같은 고수준 언어는 이를 바탕으로 오류 선언과 던지기 문법을 구현할 수 있습니다. 원문 예시에서는 MyToken 컨트랙트가 error InsufficientFunds(uint256 amount)를 선언하고 transfer 함수 안에서 balances[msg.sender]가 _amount 이하이면 throw InsufficientFunds(_amount)로 오류를 던집니다. 컴파일러는 이렇게 선언된 오류를 라이브러리가 쉽게 복원할 수 있는 방식으로 REVERT의 사유 매개변수에 인코딩합니다.
확장안 1: NatSpec 기본 메시지
오류 선언 위의 NatSpec 주석으로 기본 오류 메시지를 제공할 수 있습니다. 메시지 문자열 안에는 익숙한 NatSpec 문법으로 오류의 인자를 끼워 넣을 수 있습니다. 원문 예시는 /// @notice You don't have enough funds to transfer `amount`. 주석을 InsufficientFunds 선언 위에 붙이는 형태입니다.
확장안 2: 함수의 오류 목록 선언
함수가 어떤 오류를 던질 수 있는지 호출자에게 선언하는 확장도 제시합니다. 이 오류 목록은 해당 함수의 JSON ABI 항목에 errors 키로 포함되어야 합니다. 문법 예시는 function transfer(address _to, uint256 _amount) throws(InsufficientFunds)입니다. 앞으로 비슷한 문법을 지원하려면 오류 오버로딩을 특별히 고려해야 합니다. 이름이 같아도 인자가 다른 오류는 서로 다른 셀렉터를 만들기 때문입니다.
하위 호환성
이 규격을 구현하지 않은 앱과 도구는 사유 문자열이 0으로 시작하지 않을 때 인코딩된 사유 문자열을 무시하면 됩니다. 기존 방식의 자유 형식 문자열과 새 방식의 인코딩된 오류를 접두어로 구분하는 구조입니다.
초안 상태의 제안
이 제안은 초안(Draft) 상태입니다. 아직 내용이 바뀔 수 있고 셀렉터와 인자의 정확한 인코딩 형식도 정해지지 않았습니다. 원문의 Rationale과 Security Considerations 절도 논의가 필요하다고만 적혀 있습니다. 구현하거나 의존하기 전에 최신 상태를 확인해야 합니다.