Skip to content

GUIDE.md

Junha Yang(양준하) edited this page Jul 8, 2023 · 1 revision

Simperby Onboarding Guide

사전 지식

본 프로젝트는 네 가지에 대한 깊은 사전 지식을 필요로 합니다.

  1. 블록체인 코어 기술: 컨센서스, 탈중앙화, 상태머신복제, 비잔틴 장애 허용, 라이트 클라이언트 등
  2. Git: Simperby 노드는 Git 을 블록체인 상태 스토리지로 사용하기 때문에 단순히 개발하는 용도로 Git 을 쓰는게 아니라 Git 의 내부 동작을 상세히 이해해야 함
  3. DAO: Simperby 는 DAO 프레임워크인 만큼 DAO 원리, 목적, 핵심 기술과 현황에 대한 충분한 이해가 필수적
  4. 네트워크: 블록체인은 기본적으로 Peer-to-Peer 네트워크가 핵심 스택이고, 컨센서스를 진행하기 위해 다양한 패킷을 전달해야하기 때문에 네트워크에 대한 이해가 필수적임

따라서 위 네 가지에 대한 내용을 사전에 충분히 익히는 것이 요구됩니다.

블록체인이랑 관련된 1 이랑 3 은 PDAO 에서 제작한 공개 세미나를 적극 권장합니다. (채널: https://www.youtube.com/@postechdao3785/videos)

Simperby 핵심 프로토콜

Simperby 프로토콜에 대해 다음과 같은 문서를 참고하면 됩니다.

개발 환경 셋업

Simperby 는 Rust 프로그래밍 언어를 사용합니다. 다음을 참조하여 Rust 를 설치하십시오. https://www.rust-lang.org/learn/get-started

  • 개인적으로 선호하는 IDE 가 있지 않으면, Visual Studio Code 와 extension 인 Rust-analyzer 를 추천합니다.
  • Simperby 코드베이스는 Git 으로 관리되고, Simperby 프로토콜 자체도 Git 을 사용하기 때문에 작업하시는 OS 에 Git 이 꼭 설치되어 있어야 합니다. 리눅스의 경우 대부분 기본적으로 설치되어 있으나, 그 외의 경우 각 OS 에 맞게 설치를 하시면 됩니다.

개발 가이드

Simperby 프로젝트에 기여하기 위한 일련의 규칙과 가이드가 있습니다. 꼭 참고해주세요 https://github.com/postech-dao/simperby/blob/main/docs/dev.md