ERC-7087 Web3 URL 자동 모드 MIME 지정 (MIME type for Web3 URL in Auto Mode)

Draft · 기타 · 2023-05-28 작성

web3:// 주소로 컨트랙트 데이터를 가져올 때, 주소 뒤에 붙이는 쿼리 파라미터로 데이터의 형식(MIME 타입)을 지정하거나 데이터 URL을 풀어서 보여 주게 하는 표준입니다.

왜 필요한가

웹 브라우저는 서버가 보내 주는 형식 정보(Content-Type)를 보고 받은 데이터를 그림으로 보여 줄지, 글로 보여 줄지 정합니다. 이 정보가 없으면 데이터를 잘못 해석해서 엉뚱하게 표시할 수 있습니다. web3:// 프로토콜(ERC-6860)은 스마트 컨트랙트를 웹 주소처럼 접속하게 해 주는데, 여기에는 수동 모드와 자동 모드가 있습니다. 수동 모드 컨트랙트는 처음부터 web3://용으로 만들어져 형식 정보를 직접 알려 주지만 자동 모드는 web3://를 염두에 두지 않고 만든 일반 컨트랙트에도 적용되므로 형식 정보를 알려 줄 방법이 없습니다. 그 결과 컨트랙트가 돌려준 이미지나 JSON이 어떤 형식인지 브라우저가 알 수 없는 공백이 생깁니다. 이 표준은 URL 쪽에서 형식을 알려 주는 쿼리 파라미터를 추가해 이 공백을 메웁니다.

심층 설명

배경: ERC-6860의 두 모드와 공백

web3:// 프로토콜(ERC-6860)에는 수동(manual) 모드와 자동(auto) 모드가 있습니다. 수동 모드는 인터페이스로 그 모드를 명시적으로 요청한 컨트랙트에 쓰이며 ERC-6860에 기술된 방식으로 반환 데이터의 MIME 타입을 알리도록 기대됩니다. 자동 모드는 그 모드를 명시적으로 요청한 컨트랙트와, 아무것도 알리지 않는 나머지 모든 컨트랙트에 쓰입니다. 자동 모드를 명시적으로 요청한 컨트랙트는 MIME 타입을 알릴 것으로 기대할 수 있지만 나머지 컨트랙트에는 그것을 기대할 수 없습니다. 이 표준은 URL 쪽 쿼리 파라미터로 이 공백을 메웁니다.

mime.content: MIME 타입 직접 지정

mime.content=<contentType> 형태로 쓰며 <contentType>은 RFC 6838에 정의된 MIME 타입입니다. <contentType>이 MIME 타입 구조를 따르지 않으면 URL을 가져오지 않고 사용자에게 오류 메시지를 표시합니다. URL 디코딩 후 <contentType>이 응답의 Content-Type 헤더 값으로 설정됩니다. 예를 들어 ?mime.content=image/svg%2Bxml을 붙이면 Content-Type이 image/svg+xml로 설정됩니다.

mime.type: 파일 확장자로 지정

mime.type=<fileType> 형태로 쓰며 <fileType>은 MIME 타입을 알아내는 데 쓰이는 파일 확장자입니다. 확장자를 인식하지 못하면 URL을 가져오지 않고 오류 메시지를 표시합니다. 인식되면 해당 MIME 타입이 Content-Type 헤더 값으로 설정됩니다. 예를 들어 ?mime.type=svg를 붙이면 Content-Type이 image/svg+xml로 설정됩니다. ABNF 문법상 값은 영문자와 숫자 1개 이상으로 구성됩니다.

mime.dataurl: 데이터 URL 디코딩

mime.dataurl은 반환된 바이트를 RFC 2397 데이터 URL로 디코딩하라는 표시입니다. 디코딩 후 풀린 본문이 주 출력으로 반환되고, 데이터 URL 안에 명시된 MIME 타입이 사용됩니다. 데이터를 데이터 URL로 해석할 수 없으면 오류가 반환됩니다. 예를 들어 컨트랙트가 data:application/json,["xx"]를 돌려주면 출력은 ["xx"]가 되고 Content-Type은 application/json으로 설정됩니다.

파라미터 우선순위 규칙

mime 계열 쿼리 파라미터가 여러 개 있으면 마지막 파라미터가 적용됩니다. 아무것도 지정하지 않으면 Content-Type은 ERC-6860이 정한 대로 결정됩니다. returns 쿼리 파라미터가 지정되어 있으면 mime.xxx 파라미터는 무시되고 Content-Type은 ERC-6860이 정합니다. 문법 면에서는 ERC-6860의 attribute 정의(returns, returnTypes)에 mimeCAttr, mimeTAttr, mimeDAttr 세 가지가 추가되는 형태로 확장됩니다.

세 개의 파라미터로 나눈 이유

하나의 쿼리 파라미터 대신 세 개를 쓰는 이유는 혼동을 피하기 위해서입니다. 구현자나 사용자가 링크만 보고도 기대되는 반환 MIME 타입을 쉽게 알 수 있습니다. 또한 자동 모드에서는 쿼리 파라미터가 EVM 메시지(예: calldata)를 구성하는 데 쓰이지 않으므로, 새 쿼리 파라미터를 도입해도 컨트랙트 호출에 영향을 주지 않아 안전합니다.

제안 상태

이 표준은 Draft(초안) 상태입니다. 아직 검토 중이어서 내용이 바뀌거나 진행이 멈출 수 있으므로, 구현하거나 의존하기 전에 최신 상태를 확인하는 것이 좋습니다.

쓸 때 주의할 점

ERC 원문 · ← ERCs