ERC-7827 값 버전 관리가 있는 JSON 컨트랙트 (JSON Contract with Value Version Control)

Draft · 기타 · 2024-11-07 작성

스마트 컨트랙트 안에서 JSON 객체를 관리하고 각 키의 값이 바뀐 이력을 버전별로 조회할 수 있게 하는 표준입니다. REST 방식에 익숙한 개발자가 쉽게 쓸 수 있는 읽기 인터페이스를 제공합니다.

왜 필요한가

웹 개발자 대부분은 REST API와 JSON으로 데이터를 주고받는 방식에 익숙합니다. 그런데 이더리움 스마트 컨트랙트는 데이터를 저장하고 읽는 방식이 이와 달라서 새로 들어온 개발자가 구조화된 데이터를 다루려면 컨트랙트마다 다른 저장 구조와 함수를 따로 익혀야 합니다. 공통된 방식이 없으니 컨트랙트에 담긴 데이터를 JSON처럼 통째로 읽어 오는 표준적인 방법도, 어떤 값이 언제 어떻게 바뀌어 왔는지 이력을 확인하는 표준적인 방법도 없습니다. 이 제안은 JSON 데이터 관리와 값 버전 관리를 REST와 비슷한 모양의 공통 인터페이스로 제공해서 웹 배경의 개발자가 이더리움에 더 쉽게 적응하도록 하는 것을 목표로 합니다.

구현해야 하는 것

심층 설명

json(): 전체 상태를 JSON 문자열로 반환

json()은 입력 없이 호출하는 읽기 함수로, JSON 객체 전체의 현재 상태를 하나의 string으로 돌려줍니다. 컨트랙트를 마치 RESTful API처럼 다룰 수 있게 해서 전통 웹 개발 방식에 익숙한 개발자의 접근성을 높이는 것이 설계 의도입니다.

version(key): 키별 버전 이력

version(string key)는 요청한 키가 가졌던 모든 값을 JSON 배열 형태의 문자열로 돌려줍니다. 배열은 시간순으로 정렬되어 가장 이른 버전이 인덱스 0, 가장 최근 버전이 가장 큰 인덱스에 놓입니다. 과거 값은 바꾸지 않고 새 값만 뒤에 덧붙이는 방식이라 이력의 불변성을 유지하면서 갱신을 허용합니다.

write(keys, values, replace): 쓰기 규칙

write(string[] keys, string[] values, bool replace)는 키 배열과 그에 대응하는 값 배열을 받아 JSON 객체에 씁니다. replace가 true면 기존 값을 교체하고 false면 키가 이미 존재할 때 트랜잭션을 되돌립니다(revert). 반환값은 없습니다. 새 키 추가와 기존 키 갱신을 replace 파라미터 하나로 구분합니다.

값은 모두 문자열로 취급

이 표준은 온체인 JSON 인코딩이 본질적으로 가스를 많이 쓴다는 점을 감안해, 값을 문자열(string)로 취급해서 복잡도를 제한하고 인코딩 효율은 클라이언트 라이브러리에 맡깁니다. Solidity 인터페이스 IERC7827은 비규범(non-normative)으로 제시됩니다.

기존 표준과의 관계

이 제안은 새 표준이라 기존 표준과 충돌하지 않습니다. 다만 JSON 객체 처리와 버전 관리를 도입하므로 가스 최적화 관점에서 별도 고려가 필요할 수 있다고 원문은 밝힙니다.

아직 Draft 단계인 제안

이 문서는 2024년 11월 7일에 만들어진 Draft 상태의 제안입니다. 내용이 앞으로 바뀔 수 있고 최종 표준으로 확정된 것이 아니라는 점을 염두에 두어야 합니다.

쓸 때 주의할 점

ERC 원문 · ← ERCs