[SmartContract] Truffle 로 Solidity 컴파일 및 Ganache 에 배포

 

* 이전 포스팅에 이어지는 내용입니다.

 

SmartContract 를 Solidity 로 작성하고, truffle 로 컴파일하여 결과를 살펴봅시다.

또한, 컴파일한 결과를 가지고 배포까지 진행해보겠습니다.

 

---

Truffle 에서 Solidity 컴파일하기

지난 포스팅에서처럼, truffle 프로젝트를 생성하면 다음의 구조를 갖습니다.

• contracts: solidity 소스파일 (.sol)
• migrations: 배포 script (.js)
• test: 테스트 script (.js or .sol)
• truffe.js: 설정 파일

 

truffle 은 이 구조를 바탕으로 solidity 파일을 컴파일하고, 결과를 보여줍니다.

지금은 어떻게 컴파일 및 배포를 하는지 살펴보는 단계이므로, truffle 의 기본 제공 코드를 이용해 살펴보겠습니다.

 

다음은 truffle 의 Migrations.sol 입니다.

 

// SPDX-License-Identifier: MIT
pragma solidity >=0.4.22 <0.9.0;

contract Migrations {
  address public owner = msg.sender;
  uint public last_completed_migration;

  modifier restricted() {
    require(
      msg.sender == owner,
      "This function is restricted to the contract's owner"
    );
    _;
  }

  function setCompleted(uint completed) public restricted {
    last_completed_migration = completed;
  }
}

 

 

truffle 에서 solidity 를 컴파일하기 위해서는 contracts 폴더에 sol 파일을 작성하고, 터미널에 다음과 같이 입력해줍니다.

$ truffle compile

그럼 다음과 같이 컴파일이 진행되고, 성공적으로 끝나면 build 폴더에 컴파일 결과가 생성됩니다.

solidity 컴파일 결과는 'abi' 와 'bytecode' 로, 해당 내용이 들어있는 것을 확인할 수 있습니다.

* abi: application binary interface (contract 의 명세 역할)

 

 

 

 

배포 script 작성

smart contract 를 배포하기 위해서는 배포 script 를 작성해야 합니다.

deploy (또는 migrate) 를 위해선 배포 스크립트를 migrations 폴더에 작성하면 되는데, 파일명 형식에 정해진 규칙이 있습니다.

 

{숫자}_{이름}.js

 

숫자는 truffle 에서 관리하는 '배포 순서' 입니다.

처음 truffle 프로젝트를 만들면 1_initial_migration.js 라는 파일이 있는데, 이 친구가 1번이고 우리는 2 부터 시작해서 작성하면 됩니다. ex. 2_HelloWorld_migration.js

 

배포 스크립트는 다음과 같은 형식을 따릅니다.

const Migrations = artifacts.require("Migrations");

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

• artifacts.require("CONTRACT_NAME"): contract name (또는 파일명) 을 적어줍니다.
• deployer.deploy(Migrations)
  • 두 번째 parameter 로 해당 contract 의 생성자 인수를 넣어줄 수 있습니다. 즉, contract 의 consrtuctor 에 파라미터가 있었다면, 해당 내용을 채워줍니다.
  • ex. deployer.deploy(Migrations, "Hello");
  • * 이는 'argv' 을 넣어준다고 이해하면 편할 것 같습니다.

 

배포를 위해서는 contract 의 컴파일 결과인 abi 와 bytecode 를 알아야 하는데, truffle 에서는 우리가 직접 저 정보에 접근하지 않고도 손쉽게 배포할 수 있도록 해줍니다.

 

 

 

Ganache test net 에 배포하기

이제 contract 도 작성해서 컴파일했고, 배포 스크립트도 작성했습니다.

 

남은 것은 contract 를 어디에 배포하느냐, 즉 배포 타겟을 정해야 합니다.

'배포 타겟'은 contract 를 어디에 배포하겠냐는 것으로, 로컬 (Ganache, geth 등), 이더리움 테스트넷, 이더리움 메인넷(메인 서버) 등이 있습니다.

• Ganache, geth 를 이용해서 로컬 테스트넷에 배포
• geth 로 메인넷 또는 테스트넷에 배포
• infura 라는 회사가 제공하는 provider 를 통해 메인넷 또는 테스트넷에 배포

 

이는 truffle-config.js 에서 설정해주면 됩니다.

* 이전 truffle 에서는 운영체제에 따라 tuffle.js 또는 truffle-config.js 로 설정 파일이 분리되어 있었는데, 최신 truffle 에서는 truffle-config.js 로 통일되었습니다.

 

truffle-config.js 에서는 디폴트로 다음과 같이 되어있었습니다. (주석으로 작성되어 있습니다)

module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",     // Localhost (default: none)
      port: 8545,            // Standard Ethereum port (default: none)
      network_id: "*",       // Any network (default: none)
    }
};

위의 예시에서처럼 타겟 networks 를 지정해주면 되는데, s 가 붙은 것으로 짐작할 수 있듯이 한번에 여러 network 를 지정하여 다중 배포를 할 수 있습니다.

 

여기서 'network' 의 이름은 마음대로 정해줘도 되지만, 'development' 는 tuffle 이 기본적으로 사용하는 네트워크임을 주의해야 합니다.

또한, network 를 작성할 때는 'host', 'port', 'network_id' 이 세 가지 요소를 반드시 작성해야 합니다.

 

이때 다음과 같이, tuffle command 를 통해 특정 network 를 정해서 테스트를 할 수 있습니다.

$ truffle test --network <NETWORK_NAME>

 

다음은 다중 네트워크 설정에 대한 예시입니다.

 

module.exports = {
  networks: {
    development: { host: "127.0.0.1", port: 8545, network_id: "*", },
    dev-ganache: { host: "127.0.0.1", port: 7545, netword_id: "777", },
    advanced: { host:"192.168.0.x", port: 8777, network_id: 1342, gas: 8500000, gasPrice: 20000000000, },
};

 

 

 

이번 포스팅에서는 Ganache 로 로컬 테스트넷에 배포를 해보도록 하겠습니다.

 

먼저 이전에 설치해둔 Ganache 를 실행해주고, test net 을 만들어줍니다. (저의 경우, QuickStart 로 만들어주었습니다)

 

 

Auto mining 으로 돌아가는 것을 볼 수 있습니다.

그 아래로는 Ganache 가 실행 시 만들어주는 10개의 테스트 계정을 볼 수 있습니다.

 

truffle-config.js 에 다음과 같이 작성해줍니다.

(자신의 Ganache 버전에 맞게 port, network_id 를 변경하시면 됩니다)

 

module.exports = {
    networks: {
        development: {
            host: "127.0.0.1",     // Localhost (default: none)
            port: 7545,            // Standard Ethereum port (default: none)
            network_id: 5777,       // Any network (default: none)
        }
    },
};

 

이제 터미널을 열어서, 다음과 같이 입력해주면 배포 스크립트가 차례로 진행되며 배포된 주소가 나옵니다.

 

$ truffle migrate --network development

• migrate: Run migrations to deply contracts

(혹시, 어떠한 이유로 잘 안된다면, power shell 에서 시도해보세요.)

 

배포는 컴파일 후 실행됩니다.

 

 

contract address 를 이용해서 배포된 contract 를 사용할 수 있습니다.

단, Ganache 는 local test net 이므로, 종료시키면 배포했던 내용이 모두 사라집니다.

 

Ganache 를 보면 한 계정의 이더가 감소한 것을 볼 수 있습니다.

 

 

 

---

이렇게 기본 Solidity 코드를 Truffle 을 이용해서 컴파일하고, Ganache 에 배포하는 것까지 해봤습니다.