Truffle

Hong·2022년 12월 4일

🍄 What is Truffle?

Truffle은 블록체인 네트워크에 작성한 contract를 배포해주는 도구라고 생각하면 된다.

물론 remix를 통해서도 배포할 수 있다. 이런 경우 truffle은 필요가 없다.
하지만 배포할 contract가 많은 경우, 한 번에 배포 가능한 truffle이 더 편하다.

💡 Ready(사전작업)

Truffle 프로젝트 생성(truffle이 npm으로 설치되어있다고 가정한다.)
다음 명령어를 통해 Truffle Sample Project를 만들어보자.

$ mkdir sample
$ cd sample
$ truffle init

🗂️ 폴더설명

정상적으로 완료되면 아래와 같이 폴더가 만들어짐

contracts
.sol 파일을 저장하는 곳으로, solidity로 작성한 code파일이 들어간다.

migrations
contracts에서 작성한 sol파일을 js모듈로 export해서 배포할 수 있도록하는 폴더다. 쉽게 말해서 contracts폴더의 파일들을 배포하기 위한 폴더라고 생각하면 된다.

test
작성한 contracts폴더의 파일들을 테스트하기 위한 폴더다.
truffle-config.js
이 파일에서는 배포할 네트워크를 설정한다.

🤖 Truffle Develop (Ethereum Server 실행시키기)

우선, local에서 ethereum blockchain network를 실행시켜야 한다.
Ganache에서 서버를 실행시키는 것과 같은 역할을 한다.

$ truffle develop

위 명령어를 프로젝트 루트 폴더(sample 폴더)에서 실행하면 10개의 Accounts와 Private Keys 가 리스트업 되면서 truffle(develop)> 프롬프트가 나타나게 된다.

🦊 Truffle과 Metamask 연동(optional)

위의 console에서 나오는 http://127.0.0.1:9545/주소를 통해
Metamask와 연결할 수 있다.

혹시 본인 네트워크의 networkID와 chainID를 모르겠다면 truffle console에 아래와 같이 입력해보자

networkID

	await web3.eth.net.getId();

chainID

	await web3.eth.getChainId();

💪 직접 파일을 만들고 내용을 채워보자

contracts/Sample.sol 위치에 다음과 같은 이름으로 파일을 생성

// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.10;

contract SimpleStorage {
  uint val;

  function set(uint x) public {
    val = x;
  }

  function get() public view returns (uint) {
    return val;
  }
}

migrations/1_deploy_sample.js 위치에 다음과 같은 이름으로 파일을 생성

var SimpleStorage = artifacts.require("SimpleStorage");

module.exports = function(deployer) {
  deployer.deploy(SimpleStorage);
};

migrations폴더에 파일 작성시 주의사항

컨트랙트를 호출할 때는 파일명이 아닌 컨트랙트명으로 불러온다.(위에서는 SimpleStorage)
배포파일을 확인하면 파일명 앞에 숫자가 붙어 있다.
migrations 폴더 아래에 포함된 모든 파일을 실행하므로 배포 시 우선순위를 주기 위해 앞에 숫자를 붙여 준다.

📃 Test Contract 작성

test/TestSimpleStorage.sol 위치에 다음과 같은 이름으로 파일을 생성

// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.10;

import "truffle/Assert.sol";
import "truffle/DeployedAddresses.sol";
import "../contracts/Sample.sol";

contract TestSimpleStorage {
    function testSimpleStorage() public {
            SimpleStorage ss = new SimpleStorage();

            uint expected = 4;
            ss.set(expected);
            Assert.equal(ss.get(), expected, "value equal test");

    }
}

이제 컴파일 후 Ethereum Client(Truffle Develop)에 배포하고 테스트까지 해보자.

📦 Smart Contract Compile

truffle(develop)> compile

위 명령어 실행 시 프로젝트 루트 폴더(여기서는 sample이라는 이름)에 /build 폴더가 생성되며 contracts 폴더 아래에 있는 solidity 파일이 json 형태로 변경되어 생성된다.

✈️ Smart Contract Deploy

truffle(develop)> migrate

위 명령어 실행 시 /build 폴더에 생성된 파일(compile된 파일들)을 서버에 배포가 된다.

🧪 Smart Contract Test

truffle(develop)> test

test가 잘 완료되면 passing을 볼 수 있다.

🍫 Ganache 연동

truffle sample 폴더의 truffle-config.js을 간단하게 수정하여 Ganache로컬 네트워크와 연동할 수 있다.
truffle에서 작성한 contract를 Ganache 네트워크에 배포한다고 생각하면 된다.

truffle-config.js의 해당부분을 아래와 같이 수정해준다.

module.exports = {
    networks: {
        development: {
            host: "127.0.0.1",
            port: 7545,
            network_id: "5777,
        },
    },
}