ERC-7509 엔티티 컴포넌트 시스템 (Entity Component System)

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

게임 개발에서 쓰는 설계 방식인 엔티티 컴포넌트 시스템(ECS)을 스마트 컨트랙트로 구현하는 최소 인터페이스입니다. 데이터(컴포넌트)와 로직(시스템)을 분리해 여러 컨트랙트로 된 앱을 자유롭게 조합하고 관리할 수 있게 합니다.

왜 필요한가

스마트 컨트랙트로 게임이나 앱을 만들 때 데이터와 동작이 한 컨트랙트 안에 섞여 있으면 구조를 바꾸기 어렵습니다. 새 기능을 추가하거나 업그레이드할 때 기존 데이터까지 영향을 받고 코드를 다른 곳에서 다시 쓰기도 힘듭니다. 앱이 여러 컨트랙트로 이루어져 있으면 각 컨트랙트의 상태를 한 곳에서 관리할 방법도 마땅치 않습니다. 또 서로 다른 게임이나 앱이 데이터를 주고받으며 연동하려 해도 공통된 틀이 없습니다. 이 제안은 게임 개발에서 코드 재사용성을 높이기 위해 널리 쓰이는 ECS 패턴을 컨트랙트에 맞게 단순화해, 고유 식별자인 엔티티에 데이터 그릇인 컴포넌트를 붙이고 시스템이라는 로직으로 조작하는 공통 인터페이스를 정의합니다.

구현해야 하는 것

심층 설명

월드 중심 구조와 작업 흐름

월드 컨트랙트는 엔티티, 컴포넌트 컨트랙트, 시스템 컨트랙트를 담는 컨테이너입니다. 엔티티와 컴포넌트 컨트랙트 사이의 관계를 만들고 시스템 컨트랙트로 컴포넌트 안의 엔티티 데이터를 동적으로 바꾸는 것이 핵심 원리입니다. 원문이 제시하는 작업 흐름은 IWorld 구현으로 월드 생성, createEntity()로 엔티티 생성, IComponent 구현으로 컴포넌트 생성, registerComponent()로 등록, addComponent()로 엔티티에 부착, 시스템 컨트랙트 생성, registerSystem()으로 등록, 시스템 실행의 8단계입니다. 시스템 컨트랙트는 인터페이스 제한이 없어 어떤 함수든 정의할 수 있습니다.

엔티티의 존재와 상태를 구분하는 이유

엔티티는 createEntity()로 만들며 반드시 고유 Id를 부여해야 합니다(MUST). 상태가 true면 사용 가능, false면 사용 불가이며, false인 엔티티에는 컴포넌트를 추가하거나 제거할 수 없습니다. 원문은 존재하지 않는 엔티티와 상태가 false인 엔티티를 구분합니다. 상태만으로는 엔티티가 실제로 존재하는지 판단할 수 없기 때문입니다. 외부 기여자가 엔티티 기반으로 컴포넌트를 만들 때, 엔티티가 존재하지 않으면 그 컴포넌트는 의미가 없지만 존재하면서 상태만 false라면 상태가 true가 될 때까지 기다렸다가 부착하면 되므로 의미가 있습니다.

컴포넌트 등록과 부착 규칙

컴포넌트는 엔티티에 붙이기 전에 반드시 월드에 등록해야 하고(MUST), 같은 컴포넌트를 거듭 등록할 수 없습니다(MUST NOT). 등록할 때는 컴포넌트의 world()가 돌려주는 주소가 현재 월드 컨트랙트와 같은지 확인하는 것이 권장됩니다(SHOULD). 컴포넌트 상태가 false면 엔티티에 부착할 수 없습니다. addComponent()는 사용 가능한 엔티티와 컴포넌트에만 쓸 수 있고 같은 컴포넌트를 거듭 붙일 수 없으며 removeComponent()는 이전에 붙인 컴포넌트만 뗄 수 있습니다. getEntityComponents()는 컴포넌트 id가 아니라 주소 배열을 바로 돌려주는데, id를 돌려주면 사용자가 id마다 주소를 다시 조회해야 해서 요청이 여러 번 생기기 때문입니다.

IComponent와 타입 정보

컴포넌트 컨트랙트는 world(), types(), set(), 두 가지 get()을 구현합니다. types()는 엔티티 데이터의 타입 배열과 get() 파라미터의 타입 배열을 돌려주며 모든 데이터 타입을 담은 열거형 라이브러리인 Types.sol을 가져다 쓰는 것이 권장됩니다(SHOULD). 단순 바이트 배열 대신 타입 정보를 두는 이유는 컴포넌트를 쓸 때 타입의 정확성을 보장해 잠재적 오류와 불일치를 피하고 외부 개발자가 타입에 맞춰 명확하게 저장하고 조회할 수 있게 하기 위해서입니다. set()은 엔티티와 이를 조작하는 시스템이 모두 사용 가능 상태이고 엔티티에 해당 컴포넌트가 붙어 있을 때 데이터를 저장합니다.

추가 파라미터가 있는 get()의 용도

컴포넌트는 get() 함수를 두 가지로 제공합니다. 하나는 엔티티 id만 받고 다른 하나는 _params라는 추가 파라미터를 더 받아 데이터를 가져올 때 조건으로 씁니다. 원문의 예시로, 엔티티의 레벨에 대응하는 HP를 저장하는 컴포넌트를 정의했다면, 특정 레벨에 맞는 HP를 얻고 싶을 때 엔티티 레벨을 _params로 넘겨 get()을 호출합니다. 추가 파라미터가 필요한지는 구현하는 컴포넌트의 용도에 따라 정하면 됩니다(SHOULD).

외부 개발자의 등록 참여

registerComponent()와 registerSystem()을 외부에 열어 둘지는 앱이나 게임의 개방성에 달려 있습니다. 개발자 참여를 장려한다면 외부에서 등록한 컴포넌트와 시스템의 상태를 처음에는 false로 두고 악성 코드를 제출하지 않았는지 확인한 뒤에 setComponentState()와 setSystemState()로 활성화해야 합니다.

아직 Draft 단계인 제안

이 제안은 Draft 상태입니다. 내용이 바뀔 수 있는 초안 단계이므로 구현 전에 최신 명세를 확인해야 합니다.

쓸 때 주의할 점

ERC 원문 · ← ERCs