Skip to content

Latest commit

 

History

History
260 lines (221 loc) · 13.6 KB

README.ko.md

File metadata and controls

260 lines (221 loc) · 13.6 KB
Raw

AMO blockchain을 위한 Tendermint ABCI 앱

This document is available in English also.

개요

현재 AMO 블록체인은 구현상 Tendermint을 기본 합의 구조로 사용한다. Tendermint는 블록체인 노드들 간의 P2P 통신과, validator 노드들 사이의 합의 알고리즘 진행, 클라이언트로부터의 요청을 처리하는 RPC 서버 구동을 담당한다. 그러나, Tendermint만으로 온전한 블록체인으로 동작하지는 않으며 각 블록내 정보, 즉 포함된 거래들을 해석하는 ABCI 앱이 필요하다. ABCI 앱은 거래, 즉 상태 변화와, 블록체인의 상태, validator 제어, 그리고 블록체인의 상태에 대한 클라이언트로부터의 조회 요청을 처리한다. 이 repository는 AMO 블록체인을 위한 Tendermint ABCI 앱을 구현하는 코드(amoabci)와 그외 필요한 스크립트의 조합으로 구성된다.

설치하기

컴파일된 바이너리 설치

다음 명령을 실행해서 컴파일된 바이너리를 설치한다:

wget https://github.com/amolabs/amoabci/releases/download/v<version>/amod-<version>-linux-x86_64.tar.gz
tar -xzf amod-<version>-linux-x86_64.tar.gz
sudo cp ./amod /usr/local/bin/amod

amod의 <version>을 명시해야 한다. 최신 릴리즈를 확인해야 한다.

Docker 이미지를 이용하여 설치

docker 설치

Docker 공식 문서의 Get Docker을 참조하여 컴파일된 바이너리 혹은 소스파일을 이용하여 docker를 설치한다.

amolabs/amod 이미지 가져오기

amolabs의 공식 amod 이미지를 가져오기 위해서, 다음 명령을 실행한다:

sudo docker pull amolabs/amod:<tag>

amod 이미지의 특정 버젼을 가리키는 적절한 tag를 입력한다. 최신 이미지를 가져오기 위해서는 tag는 latest가 되거나 생략될 수 있다. 예를 들어, 1.7.6 버젼의 이미지를 가져오기 위해서는 다음 명령을 실행한다:

sudo docker pull amolabs/amod:1.7.6

소스코드로부터 설치

사전 조건

소스코드로부터 컴파일을 하기 위해서는 다음을 설치해야 한다:

  • git
  • make
    • Debian이나 Ubuntu 리눅스의 경우에는 build-essential 패키지를 설치한다.
    • MacOS의 경우에는 Xcode의 make를 사용허가나 Homebrew를 통해 GNU Make를 설치할 수 있다.
  • golang
    • 경우에 따라서 GOPATH와 GOBIN 환경변수를 수동으로 설정해 줘야 할 수 있다. 이후 더 진행하기 전에 이 변수들을 확인하도록 한다.
  • leveldb
    • Debian이나 Ubuntu 리눅스의 경우에는 libleveldb-dev 패키지를 설치한다.
    • 컴파일하는 서버와 실행하는 서버가 다를 경우 실행하는 서버에는 libleveldb1v5 패키지를 설치한다.
  • rocksdb
    • Debian이나 Ubuntu 리눅스의 경우에는 librocksdb-dev 패키지를 설치한다.
    • 컴파일하는 서버와 실행하는 서버가 다를 경우 실행하는 서버에는 librocksdb5.8 패키지를 설치한다.

amod 설치

다음 명령을 실행해서 amod를 빌드하고 설치한다:

mkdir -p $GOPATH/src/github.com/amolabs
cd $GOPATH/src/github.com/amolabs
git clone https://github.com/amolabs/amoabci
cd amoabci
make install_c

amocli 설치

amocli가 없어도 필요한 데몬들을 실행할 수 있지만, 현재 일어나고 있는 상황을 확인하이 위해 블록체인 노드 데몬들의 상태를 확인해야 할 수 있다. AMO Labs에서는 참조 구현의 일환으로 AMO client(amocli)를 제공하며 이 프로그램을 설치해서 AMO 블록체인 노드들과 통신을 할 수 있다. 더 자세한 사항은 amo-client-go를 참조하도록 한다.

준비하기

AMO 블록체인 노드는 네트워크 응용프로그램이다. 다른 노드들에 연결되지 않으면 별다은 의미 있는 동작을 하지 못한다. 따라서 첫번째로 알아내야 하는 것은 AMO 블록체인 네트워크에 있는 다른 노드들의 주소이다. 네트워크에 있는 여러 노드 중에서 seed 노드라 불리는 노드들 중 하나에 연결하는 것을 권장한다. 만약 적당한 seed 노드가 없다면 peer을 충분히 확보한 노드에 연결한다.

네트워크 정보 (Seed 노드)

chain id node_id node_ip_addr node_p2p_port node_rpc_port
amo-cherryblossom-01 1b575612e9a5c0e1fc629e58e02070934832169a 20.194.0.193 26656 26657
amo-testnet-200706 a944a1fa8259e19a9bac2c2b41d050f04ce50e51 172.105.213.114 26656 26657

NOTE: Mainnet의 chain id는 amo-cherryblossom-01이다. 네트워크 정보는 사전 공지 없이 수정될 수 있다. 해당 노드들 중 어느 한 곳에라도 접속하는데 어려움을 겪는다면, Issues 섹셕에 자유롭게 Issue를 제출할 수 있다.

genesis.json 확보

블록체인은 끊임 없이 변화하는 상태 기계이다. 따라서 블록체인의 초기 상태가 무엇인지 알아내야 한다. AMO 블록체인은 tendermint의 방식을 사용하므로 체인의 초기 상태를 정의하는 genesis.json 파일을 확보해야 한다.

NOTE: 자신만의 체인을 론칭하고 싶다면, 기존에 존재하는 genesis.json 파일을 다운받지 않고 tendermint-like scheme을 따르는 자신만의 genesis.json 파일을 만들 수 있다.

다음 명령을 실행하여 genesis.json 파일을 다운로드한다:

sudo apt install -y curl jq
curl <node_ip_addr>:<node_rpc_port>/genesis | jq '.result.genesis' > genesis.json

데이터 디렉토리 준비

amod는 데이터 디렉토리가 필요하며, 여기에 amod의 설정 파일과 내부 데이터베이스가 저장된다. 해당 디렉토리는 AMO 블록체인의 완전한 스냅샷이 된다. 따라서 디렉토리 구조는 다음과 같은 형태가 되어야만 한다:

(data_root)
└── amo 
    ├── config
    └── data

여기에서 data_root/amo/config 디렉토리에는 특히 node_key.json과 priv_validator_key.json과 같은 민감한 파일들이 저장한다. 이 파일들은 읽기 권한을 조정하여 안전하게 저장해야 한다. 이는 docker 컨테이너로 데몬들을 실행하는 경우에도 해당한다.

필요한 파일들 준비

amod는 정상 동작을 위해 data_root/amo/config에 몇가지 파일들을 필요로 한다:

  • config.toml†: 설정
  • genesis.json†: 블록체인과 앱의 초기 상태
  • node_key.json††: p2p 연결을 위한 노드 키
  • priv_validator_key.json††: 합의 과정을 위한 validator 키

† 이 파일들은 amod를 실행하기 전에 먼저 준비해야 한다.

data_root/amo/config/config.toml 에서 주목해야 할 몇가지 설정 옵션들은 다음과 같다:

  • moniker
  • rpc.laddr
  • rpc.cors_allowed_origins
  • p2p.laddr
  • p2p.external_adderess
  • p2p.seeds
  • p2p.persistent_peers

보다 자세한 정보는 Tendermint 문서를 참조한다.

†† 이 파일들은 미리 준비돼지 않았다면 amod가 스스로 생성할 수 있다. 다만, 특정한 키를 사용하고자 한다면 실행 전에 미리 준비해야 한다. 가능한 방법중 한가지는 amod tendermint init 명령으로 키들을 생성한 후 config.toml과 genesis.json 파일이 있는 설정 디렉토리에 넣어 두는 것이다. 또한, p2p.seeds에 적절한 seed 노드의 <node_id>@<node_ip_addr>:<node_p2p_port>를 작석해야 한다. 예를 들어, 메인넷의 seed 노드에 연결하기 위해서는 p2p.seeds는 1b575612e9a5c0e1fc629e58e02070934832169a@20.194.0.193:26656가 되어야 한다.

스냅샷 설정하기

노드를 실행하기 전에, 블록을 동기화하는 방법에는 두 가지 방법이 있다; genesis 블록부터 동기화 혹은 스냅샷부터 동기화. Genesis 블록부터 동기화하는 것은 많은 물리적 시간을 소모하기에, 특정 블록 높이에서 찍은 블록 스냅샷을 제공한다. 제공되는 스냅샷은 다음과 같다:

Block height DB backend Size (uncompressed) Protocol SW ver. Download
19788000 rocksdb 142GB (268GB) v5 v1.8.3 link(sha256)
19538000 rocksdb 138GB (263GB) v4 v1.7.7, v1.8.3 link(sha256)
11762421 rocksdb 101GB (200GB) v4 v1.7.7 link(sha256)
7698783 rocksdb 70GB (141GB) v4 v1.7.5 link(sha256)
6451392 rocksdb 56GB (116GB) v4 v1.7.5 link(sha256)
2908399 rocksdb 21GB (50GB) v3 v1.6.5 link(sha256)

NOTE: mainnet의 chain id 는 amo-cherryblossom-01 이다.

스냅샷을 다운로드 하고 설정하기 위해서, 다음 명령을 실행한다:

sudo wget http://us-east-1.linodeobjects.com/amo-archive/<preset>_<version>_<db_backend>_<block_height>.tar.bz2
sudo tar -xjf <preset>_<version>_<db_backend>_<block_height>.tar.bz2
sudo rm -rf <data_root>/amo/data/
sudo mv amo-data/amo/data/ <data_root>/amo/

NOTE: 압축된 *.tar.bz2 파일로부터 압축 해제된 파일의 디렉토리 구조가 파일에 따라 다를 수 있다. 압축 해제된 data/ 디렉토리가 <data_root>/amo/ 디렉토리 아래에 잘 위치해 있는지 확인하여야 한다.

예를 들어, chain id 가 amo-cherryblossom-01, version 은 v1.7.5, db backend 가 rocksdb, 블록 높이는 6451392, 데이터 디렉토리가 /mynode 이면, 다음 명령을 실행한다:

sudo wget http://us-east-1.linodeobjects.com/amo-archive/cherryblossom_v1.7.5_rocksdb_6451392.tar.bz2
sudo tar -xjf cherryblossom_v1.7.5_rocksdb_6451392.tar.bz2
sudo rm -rf /mynode/amo/data/
sudo mv data/ /mynode/amo/

사용하기

노드 초기화

amod --home <data_root>/amo tendermint init

참고사항: tendermint 명령어를 실행하기 위해서는 단순히 amod 끝에 tendermint를 붙이면 된다.

노드 실행

amod --home <data_root>/amo run

데몬을 백그라운드 모드로 실행하려면 amod run &와 같이 한다. 여기에서 <data_root>는 앞서 준비한 데이터 디렉토리이다. amod는 유입되는 P2P 연결을 위해 포트 26656을 열고, 유입되는 RPC 연결을 위해 포트 26657을 연다.

Docker로 노드 실행

Docker 이미지 생성

AMO Labs에서 배포하는 amod의 공식 docker 이미지(amolabs/amod)는 Docker hub에서 다운로드할 수 있다. 물론 로컬 docker 이미지를 직접 생성할 수도 있다.

다음과 같이 하여 직접 할 수도 있고 amod의 Makefile을 통해 할 수도 있다. 직접 하는 경우는 다음과 같이 한다:

amod의 docker 이미지를 생성하기 위해서는 다음과 같이 한다:

mkdir -p $GOPATH/src/github.com/amolabs
cd $GOPATH/src/github.com/amolabs
git clone https://github.com/amolabs/amoabci
cd amoabci
make docker

이미지는 amolabs/amod:latest로 태그된다. 이 이미지는 amod를 포함하고 있기 때문에 하나의 이미지(따라서 하나의 컨테이너)만 있으면 된다.

Docker 컨테이너 실행

컨테이너에서 데몬들을 실행하기 위해서는 다음과 같이 한다:

docker run -it --rm -p 26656-26657 -v <data_root>/amo:/amo:Z -d amolabs/amod:latest

위에 사용된 명령행 옵션들은 다음과 같은 의미를 갖는다:

  • -it: 터미널 연결 확보
  • --rm: 데몬들이 중지된 후에 컨테이너 삭제
  • -p 26656-26657: 컨테이너의 포트를 호스트 머신에 연결. 이를 통해 네트워크의 다른 노드들이 이 노드에 정상적으로 연결할 수 있게 된다.
  • -v <data_root>/amo:/amo:Z: amod 데이터 디렉토리 연결 <data_root> 는 절대 경로여야 한다.
  • amolabs/amod:latest: 컨테이너를 생성할 때 이 이미지를 사용

데몬들이 초기화하고 실행되는 동안 로그들이 정상적으로 표시되는지 확인한다.