EIP-2696 자바스크립트 request RPC 전송 (JavaScript `request` method RPC transport)
최종 확정 · 기타 · 원문 상태 Final · 2020-06-04 작성
자바스크립트 환경에서 앱이 이더리움 프로바이더 객체의 request 메서드 하나로 요청을 보내고 프로미스로 결과를 받는 표준 전송 방식을 정합니다.
왜 필요한가
자바스크립트 실행 환경(NodeJS, 일렉트론, 브라우저 등)에서는 실행 환경이나 플러그인이 앱에 객체를 주입할 수 있습니다. 지갑 같은 도구는 이 방식으로 이더리움 프로바이더(Ethereum Provider) 객체를 앱에 노출해서 앱이 이더리움 같은 블록체인과 서명 도구에 간접적으로 접근하게 합니다. 그런데 이 객체의 모양이 표준으로 정해져 있지 않으면 프로바이더마다 다른 방식을 쓰게 되고 앱은 프로바이더별로 코드를 따로 짜야 합니다. 이 EIP는 프로바이더와 클라이언트가 최대한 호환되도록 그 객체의 모양을 표준으로 정합니다. request 메서드 하나로 요청을 보내고 프로미스(Promise)로 결과나 에러를 받는 방식이 핵심입니다. 다만 어떤 요청 내용(페이로드)이 유효한지, 이 객체를 어디에 어떻게 노출할지는 이 표준이 다루지 않고 다른 표준에 맡깁니다.
무엇이 바뀌나
지금
- 프로바이더가 앱에 노출하는 객체의 모양에 공통 표준이 없습니다
- 앱과 블록체인 사이 통신은 주로 JSON-RPC로 하지만 자바스크립트 안에서 그것을 호출하는 방식이 제각각일 수 있습니다
- 요청이 실패했을 때 에러의 형태와 의미가 통일되어 있지 않습니다
EIP-2696 이후
- 모든 프로바이더가 request 메서드 하나를 가진 EthereumProvider 객체를 구현합니다
- 요청 인자(method, params)를 JSON 문자열이 아니라 자바스크립트 객체로 그대로 전달합니다
- 실패 시 에러는 message, code, data를 가진 ProviderRpcError 공통 규격을 따릅니다
누구에게 영향이 있나
- 앱(디앱) 개발자: 어떤 프로바이더가 주입되어도 같은 request 호출 방식으로 요청을 보낼 수 있어 프로바이더별 분기 코드가 줄어듭니다.
- 지갑·프로바이더 구현자: request 메서드와 ProviderRpcError 에러 규격을 반드시 구현해야 하며 기존 JSON-RPC 관행과 맞춰져 있어 이전이 쉽습니다.
- 라이브러리 개발자: web3 계열 라이브러리가 공통 인터페이스 하나를 기준으로 프로바이더를 다룰 수 있습니다.
- 사용자: 직접 체감하는 변화는 없지만 지갑과 앱 사이 연동이 표준화되어 호환성 문제가 줄어듭니다.
심층 설명
EthereumProvider 인터페이스
프로바이더는 노출된 EthereumProvider 객체에 request 메서드를 반드시(MUST) 구현해야 합니다. request는 인자 하나로 호출할 수 있어야 하며 그 인자는 RequestArguments 타입입니다. RequestArguments는 필수 필드 method(string)와 선택 필드 params(readonly unknown[] 또는 object)로 구성됩니다. 반환 타입은 Promise<unknown>입니다. 이 표준은 RFC-2119의 MUST, SHOULD 등 키워드 해석을 따릅니다.
JSON-RPC 요청과의 대응 규칙
프로바이더가 다른 표준에서 정의된 JSON-RPC 요청을 지원한다면, 그 JSON-RPC 메서드에 대한 request 호출을 반드시 받아야 합니다. 이때 RequestArguments.method는 JSON-RPC의 method 문자열과, RequestArguments.params는 JSON-RPC의 params 객체와 일치해야 합니다. params는 JSON 문자열이 아니라 지정된 JSON-RPC 타입에 맞는 자바스크립트 객체로 인코딩해야 합니다. 예를 들어 JSON-RPC 페이로드가 { "jsonrpc": "2.0", "id": 1, "method": "do_work", "params": [ 5, "hello" ] }라면, 앱은 method와 params만 담은 객체 하나로 request를 호출합니다. jsonrpc 버전이나 id 같은 전송용 필드는 앱이 다루지 않습니다.
결과 반환 형식
프로바이더가 어떤 JSON-RPC 요청을 지원한다면, 그 요청에 대해 정의된 result와 일치하는 객체를 반드시 반환해야 합니다. 즉 JSON-RPC 응답 전체({ "jsonrpc": "2.0", "id": 1, "result": ... })가 아니라 result에 해당하는 값만 돌려줍니다. 원문 예시에서 응답 페이로드의 result가 { "color": "red", "value": 5 }라면, request의 응답은 { color: 'red', value: 5 } 객체입니다.
ProviderRpcError와 에러 코드
요청을 어떤 이유로든 처리할 수 없으면 프로바이더는 프로미스를 에러로 끝내야 하며 그 에러는 가능한 한 ProviderRpcError 형태여야 합니다. ProviderRpcError는 Error를 확장하며 message(string), code(number), 선택적 data(unknown)를 가집니다. 표준이 정의한 코드는 4001 User Rejected Request(사용자가 요청을 거절함), 4100 Unauthorized(요청한 메서드나 계정이 사용자에게 승인되지 않음), 4200 Unsupported Method(프로바이더가 지원하지 않는 메서드), 4900 Disconnected(모든 체인과 연결이 끊김), 4901 Chain Disconnected(요청한 체인과 연결되지 않음)입니다. 이 표나 JSON-RPC 명세, 해당 요청 표준에 정의된 code를 쓸 때는 에러 사유가 그 코드의 확립된 의미와 일치해야 하고 message도 정해진 message와 일치해야 합니다. data 필드에는 에러 이해나 문제 해결에 도움이 되는 어떤 데이터든 담을 수 있습니다(MAY).
이 표준이 다루지 않는 것
이 표준은 전송 방식만 기술합니다. 어떤 페이로드가 유효한지, 클라이언트와 프로바이더가 페이로드 내용을 어떻게 발견하고 합의하는지는 명시하지 않습니다. 또 이 이더리움 객체를 어디에 어떻게 노출할지도 이후 표준에 맡깁니다. 따라서 실제 사용 가능한 메서드 목록이나 객체 주입 위치는 별도 표준이 정합니다.
설계 근거와 보안 가정, 현재 상태
원문은 이 방식이 앱과 블록체인 사이 통신 수단으로 최선은 아닐 수 있지만 커뮤니티의 확립된 관행과 가깝게 맞춰져 있어 기존 시스템에서 이전하기가 비교적 쉽다고 설명합니다. 현재 대부분의 통신이 JSON-RPC로 이루어지므로, 기존 시스템과 빠르게 통합할 수 있도록 JSON-RPC 표준에 맞췄습니다. 보안 측면에서 프로바이더와 클라이언트의 관계는 신뢰 관계로 가정합니다. 사용자가 프로바이더를 암묵적으로 신뢰하기 때문에 프로바이더가 클라이언트에 주입될 수 있었거나, 클라이언트가 명시적으로 연결을 가져온 것으로 봅니다. 이 EIP의 상태는 Final로, 확정된 표준입니다.