ERC-7729 메타데이터를 가진 ERC-20 토큰 (Token with Metadata)
Draft · 토큰 · 2023-06-24 작성
ERC-20 토큰에 metadata() 함수를 추가해 토큰의 이름·설명·이미지를 담은 JSON 파일의 주소(URI)를 표준화된 방식으로 조회할 수 있게 합니다.
왜 필요한가
이더리움에서 널리 쓰이는 대체 가능 토큰 표준인 ERC-20에는 토큰을 대표하는 이미지나 소개 글 같은 메타데이터(metadata)를 연결하는 표준화된 방법이 없습니다. 원문은 밈코인(memecoin)들이 토큰에 시각적 메타데이터를 연결하는 일의 가치를 보여 주었다고 설명합니다. 토큰마다 메타데이터를 제공하는 방식이 제각각이면 지갑이나 앱이 토큰의 시각 정보를 일관되게 읽어 오기 어렵습니다. 이 제안은 ERC-20 토큰에 메타데이터를 포함하는 방법을 표준으로 정하면 개발자가 더 흥미롭고 상호작용적인 토큰을 만들 수 있고 이를 통해 커뮤니티 참여를 키울 수 있다는 동기에서 출발합니다. 그래서 메타데이터 URI를 돌려주는 함수 하나와, 그 URI가 가리킬 JSON 파일의 형식(스키마)을 함께 정의합니다.
구현해야 하는 것
function metadata() external view returns (string memory);: 토큰에 연결된 메타데이터 URI를 돌려줍니다. 이 URI는 표준이 정한 메타데이터 JSON 스키마를 따르는 JSON 파일을 가리킬 수 있습니다.
심층 설명
필수 구현 범위
표준을 따르는 모든 컨트랙트는 IERC7729 인터페이스와 ERC-20 인터페이스를 반드시(MUST) 구현해야 합니다. 추가되는 함수는 metadata() 하나로, 토큰에 연결된 메타데이터 URI를 문자열로 돌려주는 view 함수입니다. 이 URI는 표준이 정의한 메타데이터 JSON 스키마를 따르는 JSON 파일을 가리킬 수 있습니다(MAY). 참고로 원문 명세의 코드 블록에는 인터페이스 이름이 IERC20Metadata로 적혀 있고 본문 요구사항과 참고 구현에서는 IERC7729라는 이름을 씁니다.
메타데이터 JSON 스키마
URI가 가리키는 JSON은 object 타입이며 속성은 세 가지입니다. name은 이 토큰이 나타내는 자산을 식별하는 문자열, description은 그 자산을 설명하는 문자열, image는 자산을 나타내는 image/* MIME 타입 리소스를 가리키는 URI 문자열입니다. 원문은 이 스키마를 "ERC-7729 Metadata JSON Schema"라고 부릅니다.
설계 근거와 하위 호환성
metadata라는 함수 이름은 기존 표준과 애플리케이션들의 구현 사례를 근거로 선택했습니다. 이 표준은 기존 ERC-20 기능을 새 인터페이스로 확장하는 방식이므로 ERC-20과 하위 호환됩니다. 기존 ERC-20을 다루는 지갑이나 컨트랙트 입장에서는 함수가 하나 추가될 뿐 기존 동작이 바뀌지 않습니다.
참고 구현
원문의 참고 구현은 OpenZeppelin의 ERC20 컨트랙트를 상속하고 _metadata라는 문자열 상태 변수에 ipfs:// 형태의 URI를 저장한 뒤 metadata() 함수에서 그대로 돌려주는 단순한 구조입니다. 메타데이터 본문을 체인에 올리는 것이 아니라 URI만 저장하는 방식입니다.
제안 상태
이 문서는 현재 Draft(초안) 상태입니다. 내용이 앞으로 바뀔 수 있는 단계이므로 구현 전에 최신 원문을 확인하는 것이 좋습니다.
쓸 때 주의할 점
- 악성 URI 위험: 메타데이터 URI가 악성 콘텐츠나 피싱 사이트를 가리키도록 조작될 수 있습니다. 오프체인 인덱서는 사용자를 위해 메타데이터 URI의 보안성과 무결성을 확인하는 검증 절차를 수행해야 합니다.