Skip to content

Latest commit

 

History

History
349 lines (261 loc) · 14.4 KB

README_KR.md

File metadata and controls

349 lines (261 loc) · 14.4 KB
Raw

loopchain

loopchain 이란?

loopchain은 효율적인 스마트컨트랙트를 기반으로 실시간 거래를 지원할 수 있는 고성능 블록체인입니다.

LoopChain logo

Features

Features

Consensus

loopchain은 BFT(Byzantine Fault Tolerance)를 지원하는 LFT(Loop Fault Tolerance)를 통해 분기가 없는 빠른 합의를 지원를 지원합니다. 또한 LFT를 기반으로 신뢰 관계가 있는 복수의 노드를 하나의 그룹으로 묶어 좀더 빠른 합의를 이뤄낼 수 있으며 이러한 그룹 및 노드에게 투표권 수를 자유롭게 설정할 수 있어 다양한 합의 체계 구축이 가능합니다.

SCORE(Smart Contract On Reliable Environment)

SCORE는 loopchain에서 지원하는 스마트컨트랙트를 지칭하는 것으로서 별도의 VM(Virtual Manchine)없이 노드 운영환경에서 직접적으로 실행되는 고성능 스마트컨트랙트 지원 기능입니다. SCORE는 쉽게 작성할 수 있어 높은 생산성을 가진 스마트컨트랙트이며 블록체인 프로세스와 별도의 프로세스로 동작하면서 다양한 업무를 개발할 수 있도록 지원합니다. 이에 대해서는 SCORE 문서를 참고 바랍니다.

Multi Channel

Multi channel은 하나의 독립적인 블록체인 네트워크내에서 업무별로 채널이라는 가상의 네트워크를 구성하여 채널별로 거래 요청, 합의 및 스마트컨트랙트를 수행할 수 있는 기능입니다. 하나의 노드에 여러 업무별 해당 업무 당사자들과만 연결된 다양한 업무별 채널을 형성하기 때문에 채널별로 무결성 보장 및 합의가 이루어지며 거래 데이터가 실제 거래 당사자들만 보유하게 되어 다양한 규제에 대응할 수 있습니다.

Tiered System

블록체인 네트워크에 참여시 인증과 함께 거래별로 PKI 기반 인증을 통해 거래 내역 검증 및 보안이 이루어집니다. 또한 거래에 참여하지 않지만 필요에따라 거래 내역을 감사할 수 있는 기능을 특정 노드에 부여하는 기능을 지원합니다.

그 외의 내용들은 한국어 백서를 참고 바랍니다.

Components 들

LoopChain components

Peer

새로운 Tx(Transaction)을 만들어서 검증을 요청합니다. 그리고 새로 검증된 block을 모아 Blockchain에 저장하고 그 내용을 읽어볼 수 있게 해줍니다.

Peer (Leader)

일정시간마다 네트워크의 트랜잭션을 모아 블록을 생성하고 다른 Peer들에게 검증을 요청하며, 다수의 Peer가 검증 후 해당 블록을 공인해서 보관하는 모듈입니다.

Radio Station

Peer의 추가/탈퇴/재시작시, 다른 Peer들의 주소를 알림으로써 Peer끼리 통신을 이어가게 해주는 모듈입니다.

loopchain proxy

각 Peer들에 접근을 용이하게 RESTful API를 노출해 주는 모듈입니다.

log collector

각 Peer들이 돌아가는 Log를 수집하는 모듈입니다.

시작하기 (Getting stated)

Local machine 에서 실행하는 방법은 다음과 같습니다.

사전 준비하기 (Prerequisites)

  • Linux (CentOS, Ubuntu), macOS 10.12, Windows 10
  • Python: 3.6 이상
  • Virtualenv : 15.1.0 이상
  • docker :17.x 이상

설치하기

제일 먼저 clone으로 현재 프로젝트를 받으십시오. 그 다음 프로젝트 폴더로 가서 사용환경을 만들어야 합니다. 사용환경을 만들기 위해서는 아래와 같이 합니다.

$ virtualenv -p python3 .  # 가상 작업환경 생성
$ source bin/activate    # 가상 작업환경 진입
$ pip3 install -r requirements.txt  # 필요한 package들을 가상환경에 설치
./generate_code.sh # gRPC가 통신에 필요한 code들을 생성

혹은 손쉽게 이렇게 해도 됩니다.

$ ./setup.sh
$ source bin/activate
$ ./setup.sh
$ ./generate_code.sh

Unit 테스트 실행하기(Running the unit tests)

설치 후, 전체적으로 동작이 되는지를 확인하기 위한 전체 Unit test는 아래와 같이 실행합니다.

$ ./run_test.sh

loopchain 설정 방법

loopchain의 설정값은 기본적으로 파일로 관리합니다.

  • ./loopchain/configure_default.py

    • loopchain의 기본 설정이 기록된 파일입니다.
    • 반드시 존재해야 하는 필수 파일입니다.

  • ./loopchain/configure_user.py

    • loopchain의 사용자 정의 설정이 기록된 파일입니다.
    • 이 파일은 사용자 편의에 따라 추가할 수 있는 파일입니다. 없어도 상관없습니다.
    • configure_default.py 파일 보다 적용되는 우선순위가 높습니다.
    • 적용환경에 따라 변경이 필요한 설정값을 기록합니다.
    • 예를 들어 "IP_LOCAL" 값을 변경 하고자 한다면, configure_user.py 파일에 변경하고자 하는 설정을 추가합니다. : IP_LOCAL = '123.456.789.10'

  • ./loopchain/configure.json

    • 파일 형식은 json으로 하되, 파일 경로는 사용자가 자유롭게 지정할 수 있습니다.
    • 모든 설정 파일(configure_default.py, configure_user.py 등) 중 적용되는 우선순위가 가장 높습니다.
    • peer.py와 radiostation.py를 실행할 때 각각 -o {파일 경로} 혹은 --configure_file_path {파일 경로} 옵션을 뒤에 추가하여 적용할 수 있습니다.

예시

만약에 “PORT_PEER” 경로를 7500으로 변경하고자 한다고 가정하면, loopchain/configure.json 파일에 다음과 같이 설정을 추가합니다.

{
  “PORT_PEER”: 7500
}

이후 Peer를 띄울 때, 둘 중 하나의 명령어로 옵션을 추가하여 실행하면 기존의 설정값이 json의 값으로 변경이 됩니다.

$ ./peer.py -o loopchain/configure.json   # 혹은
$ ./peer.py --configure_file_path loopchain/configure.json

radiostation.py에도 똑같은 방법으로 적용이 가능합니다.

Multichannel

MultiChannel을 이용하기 위해서는 RadioStation이 각 채널의 SCORE 정보와 Peer 정보를 알고 있어야 합니다.

1. Channel 정보를 담고 있는 파일을 만듭니다.

이 파일에는 1. Channel의 이름, 2. 해당 Chennel에서 실행할 SCORE의 이름, 3. 채널에 참여할 Peer들의 목록이 담겨야 합니다 예를 들어 channel_manage_data.json 이라고 만들었다면 아래와 같이 만듭니다.

channel_manage_data.json

{
  "%CHANNEL_NAME1%": { // 1st channel name
    "score_package": "your_score_package", // The name of SCORE to execute in this channel.
    "peers": [
      {
        "peer_target": "%IP%:%PORT%" // The list of eer targets
      },
     ........
    ]
  },
  "%CHANNEL_NAME2%": {  // 2nd channel name
    "score_package": "your_score_package", // The name of SCORE to execute in this channel
    "peers": [
      {
        "peer_target": ""%IP%:%PORT%"   // The list of eer targets
      },
      .......
    ]
  }
}

TIP: peers가 명확하지 않으면 없이 만들어도 됩니다.

예를 들어 kofia_0, kofia_1이라고 channel 이름을 정하고 하나는 score/code1, score/code2를 읽어서 처리하라고 하면 아래와 같이 만들면 됩니다.

{
  "kofia_0": { 
    "score_package": "score/code1", 
    "peers": [
      {
        "peer_target": "111.123.145.123:7100" 
      },
      ......
    ]
  },
  "kofia_1": {  
    "score_package": "score/code2", 
    "peers": [
      {
        "peer_target": "111.123.145.123:7100" 
      },
      ........
    ]
  }
}

2. 위의 파일을 읽어서 Multichannel을 동작하게 RadioStation 설정하고 실행하기.

이제 앞서 만든 channel_manage_data.json 을 RadioStation에서 읽어서 Multichannel을 사용할 수 있게 하려고 합니다

아래와 같이 radiostation용 설정 파일을 만들어 내용을 추가해주십시오.

{
    "CHANNEL_MANAGE_DATA_PATH" : "your channel_manage_data path",
    "ENABLE_CHANNEL_AUTH" : true
}

각 Parameter의 내용은 아래와 같습니다.

  • CHANNEL_MANAGE_DATA_PATH: 앞서 설정한 multichannel 설정 파일의 위치. 파일 이름까지 같이 적어야 합니다.
  • ENABLE_CHANNEL_AUTH :
    • true = multichannel 설정 파일에서 정해진 peer들만 multichannel을 허용합니다.
    • false= 임의로 peer가 추가되어도 multichannel이 동작하게 합니다. 미리 peer목록을 만들어 놓지 않을경우 이용합니다.

예를들어, 여기에서는 임의로 rs_config.json이라고 하면 아래와 같이 적어야 합니다.

rs_config.js

{
   "CHANNEL_MANAGE_DATA_PATH" : "./channel_manage_data.json",
   "ENABLE_CHANNEL_AUTH" : true
 }

이렇게 설정한 설정 파일을 아래 -o option으로 읽게 합니다

$ ./radiostation.py -o rs_config.json

3. Peer 설정하고 실행하기

이제 Peer에게 Multichannel로 동작하게 하기 위해서 1. 여러 channel중에 기본으로 동작할 Chennel이 무엇인지 2. SCORE에서 어떤 Branch를 사용할 지 정해야 합니다. 이 설정이 필요한 이유는 Peer가 여러개의 multichannel을 쓸 수도 있지만 기본적으로 사용하는 channel을 지정해서 오동작을 막기위해서입니다 .

{
    "LOOPCHAIN_DEFAULT_CHANNEL" : "basic channel name",
    "DEFAULT_SCORE_BRANCH": "your working branch name"
}

각 변수들의 뜻은 ,

  • LOOPCHAIN_DEFAULT_CHANNEL : 이 Peer에서 사용하게 될 기본 channel.
  • DEFAULT_SCORE_BRANCH : SCORE의 branch (기본이 master)

예를 들어 아래와 같이 적어주면 됩니다.

peer_config.js

{
    "LOOPCHAIN_DEFAULT_CHANNEL" : "kofia_0",
    "DEFAULT_SCORE_BRANCH": "master"
}

이 파일은 아래와 같이 적어서 peer를 실행합니다.

$ ./peer.py -o peer_config.json

Deployment

실제 LoopChain을 돌리는 방법으로 두가지가 있습니다.

직접 올리기

다음의 순서로 올리게 됩니다.

1. RadioStation 올리기

$  ./radiostation.py  # RadioStation을 띄웁니다.

그러면 이제 아래와 같은 Log를 보실 것입니다. 이 뜻은 현재 Local에서 9002번 Port로 다른 Peer가 접속해오기를 기다린다는 뜻입니다. 이렇게 RadioStation service를 올렸습니다.

..........
'2017-07-20 15:57:09,315 DEBUG RestServerRS run... 9002'
'2017-07-20 15:57:09,373 INFO  * Running on http://0.0.0.0:9002/ (Press CTRL+C to quit)'
'2017-07-20 15:57:11,302 DEBUG Leader Peer Count: (0)'
'2017-07-20 15:57:11,303 ERROR There is no leader in this network.'

2. 여러개의 Peer 올리기

새로운 Terminal을 띄워서 LoopChain folder로 갑니다. 이후 아래와 같이 입력합니다.

$ source bin/activate  # Python 가상 환경을 띄웁니다.
$ ./peer.py            # Peer를 띄웁니다.

하지만 configuration.json 파일에 추가로 설정값을 지정했을 경우에는 아래와 같이 옵션을 추가하여 Peer를 띄워야 합니다.

$ ./peer.py -o loopchain/configure.json

그러면 아래와 같은 Log를 보실 수 있습니다.

...........
'2017-07-20 16:05:13,480 DEBUG peer list update: 1:192.168.18.153:7100 PeerStatus.connected c3c5f2f0-6d19-11e7-875d-14109fdb09f5 (<class 'str'>)'
'2017-07-20 16:05:13,480 DEBUG peer_id: c3c5f2f0-6d19-11e7-875d-14109fdb09f5'
'2017-07-20 16:05:13,480 DEBUG peer_self: <loopchain.baseservice.peer_list.Peer object at 0x106249b00>'
'2017-07-20 16:05:13,481 DEBUG peer_leader: <loopchain.baseservice.peer_list.Peer object at 0x106249b00>'
'2017-07-20 16:05:13,481 DEBUG Set Peer Type Block Generator!'
'2017-07-20 16:05:13,481 INFO LOAD SCORE AND CONNECT TO SCORE SERVICE!'

같은 방식으로 또 다른 Peer를 띄워보실 수 있습니다. 그러나 이번에는 다른 Port를 이용해서 RadioStation과 연결을 해야 합니다.

$ source bin/activate
$ ./peer.py -p 7101

Peer는 RadioStation과 접속할 때, 한 Peer당 7100번 부터 새로운 포트를 받아서 접속합니다. RadioStation은 새로운 Peer가 접속될 때 마다, 기존에 있던 Peer들의 목록을 새로운 Peer에게 전달하고 새로운 Peer가 추가 된 것을 기존 Peer들에게 알려줍니다.

3. 각 Peer 상태 확인하기

각 Peer들과 RadioStation의 상태를 읽어올 수 있게, 각 Peer들에게는 RESTful API로 연결할 수 있습니다.

$ curl http://localhost:9002/api/v1/peer/list  # 현재 Radiostation에 blockchain network를 구성하고 있는 peer들의 목록을 보여줍니다.
$ curl http://localhost:9000/api/v1/status/peer # 현재 Peer0 의 상태를 보여줍니다.
$ curl http://localhost:9100/api/v1/status/peer # 현재 Peer1 의 상태를 보여줍니다.

자세한 RESTful API에 대해서는 Peer RESTful API, Radiostation RESTful API문서를 참고 바랍니다.

4. 새로운 Transaction 만들기

새로운 Transaction을 Peer0에 보내기 위해서는 다음과 같이 RESTful API를 호출합니다.

$ curl -H "Content-Type: application/json" -d '{"data":"hello"}' http://localhost:9000/api/v1/transactions

{"response_code": "0", "tx_hash": "9dc7e5ed17cc5f3258f9b11614b33295e87d80d49b101b7571f444524accee5f", "more_info": ""}

5. 만들어진 Transaction의 height를 확인하기

$ curl http://localhost:9000/api/v1/blocks

{
 "response_code": 0,
 "block_hash": "f7956cb168ac80e5fd569c53c95b55a92254f7a1c372ad06e936cc35357a8ead",
 "block_data_json":
   {
        "prev_block_hash": "af5570f5a1810b7af78caf4bc70a660f0df51e42baf91d4de5b2328de0e83dfc",
        "merkle_tree_root_hash": "1726e6d64a17cb1e0d664f4239f20b7176fc046ae6aa423922fb0ef6eb48512b",
        "time_stamp": "1501132106740684",
        "height": "1",    # Height가 증가.
        "peer_id": "15e6d814-7289-11e7-bb81-14109fdb09f5"
   }
}

Tutorial

SCORE를 포함한 자세한 내용을 담은 Tutorial입니다.

License

이 프로젝트는 Apache 2.0 License를 따릅니다. 자세한 것은 LICENSE를 참고 바랍니다.

Acknowledgments

이 프로젝트는 NIPA 유망 공개SW 기술개발 지원사업지원으로 진행되고 있습니다.