ERC-634 ENS 텍스트 레코드 저장 (Storage of text records in ENS)

Stagnant · 이름·메타데이터 · 2017-05-17 작성

ENS 이름에 이메일, 아바타, SNS 계정, URL 같은 임의의 키-값 텍스트 데이터를 저장하고 조회할 수 있게 하는 리졸버 프로필입니다.

왜 필요한가

ENS 이름은 원래 이더리움 주소나 콘텐츠 해시처럼 기계가 읽는 데이터를 사람이 기억하기 쉬운 이름에 연결하는 용도로 쓰였습니다. 하지만 디버깅, 운영, 안내처럼 사람이 읽어야 하는 부가 정보, 예를 들어 이메일 주소나 아바타 이미지, 소개 글, SNS 계정을 ENS 이름에 붙이고 싶을 때는 표준화된 저장·조회 방법이 없었습니다. 표준이 없으면 서비스마다 각자 다른 방식으로 메타데이터를 저장하게 되고, 지갑이나 앱은 어떤 키로 어떤 값을 조회해야 하는지 미리 알 수 없어 ENS 이름을 범용 프로필처럼 쓰기 어려워집니다. 새 서비스가 등장할 때마다 리졸버 자체를 바꿔야 한다면 확장성도 떨어집니다.

구현해야 하는 것

심층 설명

리졸버 인터페이스와 ERC-165

이 표준은 text(bytes32 node, string key) 함수 하나로 이뤄진 리졸버 인터페이스 IERC634를 정의합니다. node는 ENS 이름의 노드해시이고 key는 조회할 키입니다. 반환값은 임의의 UTF-8 문자열이며, 해당 키가 존재하지 않으면 빈 문자열을 반환해야 합니다. 이 인터페이스의 ERC-165 인터페이스 ID는 0x59d1d43c이며, 리졸버는 이 ID로 text 기능 지원 여부를 알릴 수 있습니다.

글로벌 키

글로벌 키는 소문자, 숫자, 하이픈(-)으로만 구성됩니다. 원문이 정의한 키는 avatar(아바타 이미지 URL), description(이름에 대한 설명), display(대소문자를 포함한 캐노니컬 표시 이름, 대소문자를 접었을 때 ENS 이름과 일치해야 하며 그렇지 않으면 클라이언트가 무시해야 함), email(이메일 주소), keywords(중요도 순으로 나열한 쉼표 구분 키워드 목록), mail(물리적 우편 주소), notice(이름에 대한 공지), location(지역, 예: Toronto, Canada), phone(E.164 형식 전화번호), url(웹사이트 URL)입니다.

서비스 키와 역순 점 표기

서비스 키는 해당 서비스가 소유한 네임스페이스에 대한 역순 점 표기(reverse dot notation)로 구성되며, DNS 이름(.com, .io 등)이나 ENS 이름(.eth)을 쓸 수 있습니다. 서비스 키는 점을 최소 하나 포함해야 합니다. 이 방식 덕분에 새 서비스는 기존 서비스와 충돌할 걱정 없이 자신만의 키를 쓸 수 있고, 새 서비스가 추가될 때마다 이 문서를 갱신할 필요도 없습니다. 원문은 com.github, com.peepeth, com.linkedin, com.twitter, io.keybase, org.telegram을 예시로 권장하며, com.example.users처럼 하위 계층 키도 구성할 수 있다고 설명합니다.

레거시 키

이 표준의 이전 초안에서는 vnd.github(현재 com.github), vnd.peepeth(현재 com.peepeth), vnd.twitter(현재 com.twitter)라는 키를 썼습니다. 원문은 이들의 사용이 널리 퍼지지는 않았을 것이라고 밝히면서도, 최대 호환성을 추구하는 애플리케이션은 새 키 조회가 실패했을 때 폴백으로 이 레거시 키도 조회할 수 있다고 안내합니다.

범용 키-값 구조를 택한 이유

원문은 url, email처럼 사람이 읽는 데이터마다 전용 레코드 타입을 따로 정의하는 대신, DNS의 TXT 레코드를 변형한 모델을 따라 범용적인 키-값 구조를 채택했다고 설명합니다. 이 방식 덕분에 리졸버 인터페이스를 바꾸지 않고도 미래에 키를 확장할 수 있고, 동시에 애플리케이션도 자신만의 커스텀 키를 쓸 수 있습니다.

제안 상태

이 ERC는 현재 Stagnant 상태로, 2017년에 작성된 뒤 더 이상 논의가 진행되지 않고 멈춰 있는 제안입니다. 원문 자체도 Legacy Keys 절에서 이 문서가 여전히 draft 단계였다고 언급하고 있어, 키 목록이나 명세가 앞으로 바뀌거나 더는 갱신되지 않을 수 있습니다.

ERC 원문 · ← ERCs