EIP-2700 자바스크립트 프로바이더 이벤트 알림 표준 (JavaScript Provider Event Emitter)
최종 확정 · 기타 · 원문 상태 Final · 2020-06-05 작성
브라우저 지갑 같은 이더리움 프로바이더(Provider)가 체인 상태 변화를 웹 앱에 알려 줄 때 쓰는 자바스크립트 이벤트 수신 방식(on, removeListener)을 표준으로 정합니다.
왜 필요한가
웹 브라우저나 NodeJS 같은 자바스크립트 실행 환경에서는 지갑 확장 프로그램 같은 플러그인이 실행 환경 안에 객체를 끼워 넣을 수 있습니다. 지갑은 이 방법으로 이더리움 프로바이더 객체를 웹 앱에 노출하고 블록체인 상태 변화가 생기면 앱에 알려 줄 수 있습니다. 그런데 이 객체의 모양이 지갑마다 다르면 앱은 지갑별로 다른 코드를 써야 하고 한 지갑에서 잘 돌던 기능이 다른 지갑에서는 깨질 수 있습니다. 프로바이더와 앱이 최대한 호환되려면 객체가 어떤 모양이어야 하는지 표준이 필요합니다. 이 EIP는 당시 지갑들이 이미 쓰고 있던 이벤트 알림 방식을 표준 문서로 정리해 어떤 지갑과 어떤 앱이 만나도 같은 방식으로 알림을 주고받게 합니다.
무엇이 바뀌나
지금
- 프로바이더마다 알림 방식이 다를 수 있어 앱이 지갑별 구현에 맞춰야 합니다
- 이벤트 구독과 해제가 어떻게 동작해야 하는지 보장된 규칙이 없습니다
EIP-2700 이후
- on과 removeListener 두 메서드로 이벤트 구독과 해제 방식이 통일됩니다
- 등록한 리스너는 해당 이벤트가 일어나면 반드시 호출된다는 보장이 생깁니다
- 앱 개발자는 표준을 따르는 어떤 프로바이더든 같은 코드로 다룰 수 있습니다
누구에게 영향이 있나
- 웹 앱(디앱) 개발자: 지갑마다 다른 알림 코드를 쓰지 않고 표준 인터페이스 하나로 체인 상태 변화를 받을 수 있습니다.
- 지갑·프로바이더 개발자: 앱에 노출하는 객체가 갖춰야 할 최소 모양과 동작 규칙이 명확해집니다.
- 사용자: 어떤 지갑을 쓰든 앱의 이벤트 기반 기능(상태 변화 반영 등)이 일관되게 동작할 토대가 생깁니다.
심층 설명
EthereumProvider 인터페이스
표준이 요구하는 것은 두 메서드뿐입니다. on(eventName: string, listener: (...params: unknown[]) => void): void과 removeListener(eventName: string, listener: (...params: unknown[]) => void): void입니다. 이벤트 이름은 문자열이고 리스너는 임의 개수의 unknown 타입 인자를 받는 콜백 함수입니다. 어떤 이벤트를 들을 수 있는지, 리스너 콜백이 어떤 모양의 인자를 받는지는 이 표준이 정하지 않고 별도 표준에 맡깁니다.
on의 동작 규칙
프로바이더가 아는 eventName으로 on이 호출되면, 프로바이더는 그 이벤트가 일어날 때 전달받은 listener를 반드시 호출해야 합니다(MUST). 같은 listener가 on을 거쳐 같은 이벤트에 여러 번 추가된 경우, 프로바이더는 리스너를 한 번만 호출할지 on 호출 횟수만큼 호출할지 선택할 수 있습니다(MAY). 즉 중복 등록의 처리 방식은 구현마다 다를 수 있으므로, 앱은 같은 리스너를 중복 등록하지 않는 편이 안전합니다.
removeListener의 동작 규칙
이전에 on으로 추가된 것과 같은 eventName과 listener 조합으로 removeListener가 호출되면, 프로바이더는 이벤트당 그 listener를 호출하는 횟수를 1만큼 줄여야 합니다(MUST). 등록이 횟수 단위로 관리된다는 뜻이므로, 여러 번 등록된 리스너를 완전히 떼려면 등록 횟수만큼 해제가 필요할 수 있습니다.
알림 메커니즘만 정의하고 이벤트 목록은 비워 둔 이유
이 표준은 알림을 주고받는 틀만 기술합니다. 유효한 페이로드가 무엇인지, 클라이언트와 프로바이더가 페이로드 내용을 어떻게 발견하고 합의하는지는 정하지 않습니다. 구체적 이벤트 집합은 계속 변해 가는 목록이어서 처음 몇 개를 여기 적어 두는 것이 표준에 가치를 더하지 않는다고 봤습니다. 시간이 지나면 초기 이벤트들이 폐기되거나 쓰이지 않게 될 수 있다는 점도 이유로 들고 있습니다.
이미 쓰이던 관행을 문서화한 소급 표준
원문은 이 EIP를 대체로 소급(retrospective) 표준이라고 설명합니다. 이미 존재하던 명세를 성문화한 것이어서 리스너 인자에 판별 가능한 유니언 객체를 쓰거나 on의 정의를 더 엄격하게 다듬는 식의 개선 여지가 크지 않았다는 뜻입니다. 또한 이 프로바이더 객체를 어디에 어떻게 노출할지는 이후 표준에 맡겨 두었습니다. 상태는 Final로 확정되어 있습니다.
보안 모델: 프로바이더와 클라이언트는 신뢰 관계
원문은 프로바이더와 클라이언트의 관계를 신뢰 관계로 전제합니다. 프로바이더가 클라이언트에 주입될 수 있었다는 것 자체가 사용자가 그 프로바이더를 암묵적으로 신뢰한다는 뜻이거나, 클라이언트가 명시적으로 그 연결을 끌어온 경우라고 봅니다. 따라서 이 표준은 악의적 프로바이더로부터 앱을 보호하는 장치를 별도로 두지 않습니다.