ERC-7654 요청 메서드 타입 (Request Method Types)

Draft · 기타 · 2024-03-13 작성

컨트랙트의 기능을 웹 요청처럼 GET(조회), POST(생성), PUT(수정) 유형으로 나누어, 클라이언트가 서로 다른 컨트랙트를 하나의 일관된 규칙으로 호출하고 응답을 해석할 수 있게 하는 표준입니다.

왜 필요한가

컨트랙트는 저마다 함수가 달라서 클라이언트(컨트랙트를 호출하는 지갑이나 앱 같은 프로그램)가 하나의 공통 표준으로 여러 컨트랙트의 서로 다른 기능을 호출할 방법이 없습니다. 컨트랙트마다 전용 호출 코드를 따로 만들어야 하고 어떤 기능이 데이터를 읽기만 하는지 상태를 바꾸는지도 겉으로 드러나지 않습니다. 이 표준은 컨트랙트의 기능을 읽기(GET), 생성(POST), 수정(PUT) 유형으로 나누어 다시 정의합니다. 이렇게 동작 유형이 분명해지면 각 당사자가 컨트랙트 데이터에 대한 접근과 조작을 종류별로 제한할 수 있고 클라이언트와 컨트랙트 사이의 상호작용이 단순해져 컨트랙트의 기능과 계층 구조를 이해하기 쉬워집니다. 또 각 기능의 요청·응답 데이터 타입이 스스로 구조를 설명하므로, 당사자와 컨트랙트가 통일되고 예측 가능한 방식으로 데이터를 주고받을 수 있습니다.

구현해야 하는 것

심층 설명

네 가지 요청 메서드 타입

표준은 MethodTypes 열거형으로 GET, POST, PUT, OPTIONS 네 가지 타입을 정의합니다. GET은 컨트랙트에 기록 조회를, POST는 새 기록 생성을, PUT은 기록 갱신을 요청하고 OPTIONS는 그 컨트랙트가 지원하는 요청 메서드 타입을 알려 줍니다. 각 컨트랙트의 기능은 GET, POST, PUT 세 타입 안에서 정의해야 하며 이렇게 하면 호출자가 요청에 필요한 정보를 이해하고 처리하기 쉬워집니다. get은 view 함수이고 post와 put은 payable 함수입니다. post와 put의 응답값은 Response 이벤트로도 알립니다.

메서드 정보의 자기 서술

각 요청 메서드는 요청 파라미터 데이터 타입과 응답 파라미터 데이터 타입을 함께 갖습니다. 이 타입들은 constructor에서 설정하고 이후 메서드 이름으로 getMethodReqAndRes를 호출해 얻습니다. 파라미터의 데이터 타입은 Solidity 타입을 열거한 Types.sol 라이브러리의 Types.Type 열거형으로 표현합니다. getMethods로 타입별 메서드 이름 목록을, getMethodInstruction으로 메서드 사용 설명을 얻을 수 있어, 클라이언트가 컨트랙트의 구조를 미리 알지 못해도 필요한 정보를 컨트랙트에서 직접 조회할 수 있습니다.

ABI 인코딩 기반의 요청과 응답

get, post, put은 모두 메서드 이름(string)과 인코딩된 요청 파라미터(bytes)를 받고 인코딩된 응답(bytes)을 돌려주는 공통 형태를 갖습니다. 컨트랙트는 요청을 처리할 때 요청 파라미터 타입과 요청값에 따라 abi.decode로 디코딩하고 응답을 돌려줄 때 응답값과 응답 파라미터 타입에 따라 abi.encode로 인코딩합니다. 클라이언트는 getMethodReqAndRes로 얻은 타입 정보에 맞춰 요청을 인코딩하고 응답을 디코딩하면 되므로, 컨트랙트가 달라도 같은 교환 방식을 쓸 수 있습니다.

DELETE 타입이 없는 이유

이 표준에는 DELETE 동작 타입이 없습니다. 컨트랙트에서 데이터를 삭제하는 것은 비효율적인 연산이기 때문입니다. 대신 개발자가 직접 PUT 요청 메서드를 추가해 데이터를 유효 또는 무효로 표시하고 GET 메서드에서는 유효한 데이터만 돌려주는 방식을 쓸 수 있습니다.

초안 단계의 제안

이 제안은 Draft(초안) 상태입니다. 내용이 아직 바뀔 수 있는 단계이므로, 구현하기 전에 최신 원문을 확인하는 것이 좋습니다.

쓸 때 주의할 점

ERC 원문 · ← ERCs