2021년 7월 21일수정 hardhat-typechain 대신 @typechain/hardhat 을 사용해야 한다. hardhat 공식 문서에는 아직 반영되지 않았으나, hardhat-typechain을 사용하면 module 을 찾을 수 없다는 없다는 에러가 발생할 수 있다. 따라서 아래 글 내용 중, 패키지 설치 및 import 할 때 hardhat-typechain 대신 @typechain/hardhat을 사용해야한다. 많은 dApp 프로젝트는 Truffle을 사용한다. Elysia에서도 기존의 스마트 컨트랙트 개발을 Truffle로 진행했다. Truffle은 solidity를 비롯한 블록체인 개발에 있어서 테스트 환경 구축, 배포 등 다양한 기능을 제공한다. 엘리시아는 Truffle을 이용해서 개발을 하다, 최근 hardhat을 도입하게 되었다. 그 배경과 도입의 이점, 그리고 직접 hardhat과 각종 플러그인을 사용해보고알아보자. Truffle의 불편함 Truffle에는 아래와 같은 불편함이있다. 첫째, 검증, 즉 Verify 과정이 불편하다. 검증이란, 배포된 컨트랙트의 source code를 etherscan에 업로드하여 컨트랙트와 상호작용 할 수 있도록 하는 과정을 의미한다. 서버를 통하지 않고도 단순하고 직관적으로 컨트랙트를 이용하기 위해서는 etherscan을 이용하는 것이 가장편리하다. uniswap의 wBTC-Eth pair 컨트랙트. uniswap web app을 이용하지 않아도 etherscan에서 직접 uniswap을 사용할 수있다. 컨트랙트를 배포하고 검증 과정을 거치지 않으면 컨트랙트와의 상호작용, 즉 Read, Write Contract 기능이 활성화되지 않는다. Truffle은 검증을 도와주지 않기 때문에 컨트랙트 source code의 업로드를 통해 직접 검증 작업을 거쳐야 한다. 경우에 따라 flatten, 즉 import 한 파일을 하나로 합쳐야 할 때도 있다. truffle-flattener라는 패키지가 있지만, 컨트랙트 하나를 배포할 때마다 이 작업을 해야 하는 것은 상당히번거롭다. 둘째, Typescript에 대한 지원이 빈약하다. 컨트랙트를 테스트 할 때 일반적으로 web3.js, ether.js와 같은 자바스크립트 패키지를 이용한다. bigNumber, uint, keccak256 등 solidity에서 작동하는 변수의 타입과 자바스크립트에서 이를 받아들이는 방식은 약간씩 다르다. 따라서 테스트코드 작성 및 배포 작업에서 typescript를 이용한 정적인 타이핑을 지원하지 않는 것이 불편하게느껴졌다. Truffle에도 좋은 도구와 기능이 많이 있고, 아직 다 사용해보진 않았지만, 구글 검색 결과 hardhat에 대해 좋게 보는 글이 많아서 도입해보았고, 이에 대한 후기를작성한다. hardhat도입 후기 hardhat은 ethereum 개발을 할 때 compile, deploy, test를 모두 진행할 수 있는 개발 프레임워크이다. node에서 동작하며 npm으로 설치할 수 있다. hardhat을 사용해보니 아래와 같은 장점이있었다. 첫째, Verify의 자동화가 가능하다. 간단한 절차만 거치면 이더스캔에 직접 접속하지 않아도 명령어 한 줄로 간단히 verify 작업이 가능하다. hardhat의 verify를 이용해서 스크립트를 작성하면, 연관되어 있는 여러 컨트랙트의 deploy와 verify를 하나의 명령어로 진행 할 수도있다. 둘째, hardhat 플러그인인 Typechain을 이용해서 타입스크립트를 사용할 수 있다. Typechain은 hardhat에서 지원하는 플러그인 중 하나로, 컴파일과 동시에.sol 파일을 타입스크립트로 된 artifact로 만들어준다. https://medium.com/media/f4cd7ce113492dc2772776d929bdb515/href 이렇게 만들어진 아티팩트는 다른 곳에 import 하여 테스트코드에 사용할 수도 있고, dApp 개발 환경에서 컨트랙트 ABI로 접근을 하지 않고도 사용할 수 있도록 도와준다. 컨트랙트 타입을 사용함으로써 코드 작성 및 디버깅을 쉽고 빠르게만들어준다. 셋째, Console.log를 사용할 수 있다. 솔리디티 파일에서 console.log을 사용할 수 있기 때문에 기존 자바스크립트 개발과 비슷한 환경에서 개발할 수 있다. dApp 개발의 진입장벽을 낮추고 개발의 편의성을 올려주기 위한 hardhat팀의 아이디어가 돋보이는기능이다. solidity가 자바스크립트의 문법과 비슷해 보이면서도 다른 점이 많아서 코드 작성 및 테스트를 할 때 헤맬 때가 많았는데, console.log를 사용함으로써 간단하게 디버깅을 할 수 있게되었다. https://medium.com/media/7be9c6f4f65d4d634d5429fff2ebc4c5/href https://hardhat.org/getting-started/#quick-start 넷째, Documentation이 잘 되어있다. Compile, Deploy, test 등 여러 과정에 대해서 나타날 수 있는 오류에 대해 로그가 잘 나타나며, 에러 코드에 대한 공식 문서도 잘 작성되어 있다. Truffle을 이용할 때는 문서에 잘 나와있지 않아 종종 node_module를 들여다보며 에러 코드를 찾기도 했으나, hardhat을 이용한 뒤부터는 공식 문서를 통해 웬만한 문제는 해결이 가능해졌다. 이외에도 openzeppelin 등 여러 다른 팀들도 hardhat에 대한 언급을 자주 하며, 관련된 문서를 잘제공한다. 이 외에도 빠른 테스트 환경, 손쉬운 upgrade proxy 제공, 테스트 커버리지, 테스트 환경에서의 가스 리포터, 리액트 핫 리로더 등 다양한 플러그인을지원한다. hardhat을 설치하고 간단한 코드를 작성하며 hardhat의 기본적인 기능을알아보자. hardhat 설치와시작 NodeJS의 패키지 매니저를 이용하여 hardhat을 설치한다. 엘리시아 프로젝트는 yarn을 사용하기 때문에 yarn을 이용하여 hardhat을설치한다. yarn add --dev hardhat 설치를 완료했으면 hardhat 프로젝트를시작하자. yarn hardhat 아래와 같은화면에서 create a sample project 를 선택한다. 간단한 설정은 편한 대로진행한다. 이렇게 프로젝트가 만들어진다. 이 sample project를 실행하기 위해서는 몇 가지 dependencies가 필요하다고 한다. Typescript를 사용할 예정이므로, 사용하는 패키지의 type들도 설치해주자. 또한 테스트를 위해 mocha도 필요하기 때문에 같이설치한다. yarn add — dev @nomiclabs/hardhat-waffle ethereum-waffle @nomiclabs/hardhat-ethers ethers @types/chai @types/mocha ethereum-waffle, chai, ethers는 모두 컨트랙트 테스트를 도와주는 패키지이다. 추후에살펴보자. 설치를 마친 이후, 프로젝트 디렉토리는 다음과같다. AssetToken 컨트랙트작성하기 이제 openzeppelin을 설치해야한다. yarn add @openzeppelin/contracts 아래 코드처럼 컨트랙트에 import 하는 방식으로 openzeppelin을 사용할 수 있다. contracts 폴더에 assetToken.sol 파일을 만들고 아래와 같이작성하자. https://medium.com/media/6e8847ab07cfbb57fd2bc646ec4618cf/href line4: 오픈제플린의 ERC20을 import 했다. 오픈제플린이 제공하는 ERC20 토큰 표준을 상속받기 위함이다. 해당 파일에 들어가보면 위에서 설명한 것처럼 구현된 ERC20 표준을 확인할 수있다. line711: 일반적인 솔리디티의 constructor와 비슷하지만, line11의 ERC20(name_, symbol_)가 있다. 이는 컨트랙트를 상속했을 때 부모 컨트랙트의 constructor에 넣어줄 인자를 의미한다. 자세한 내용은 공식 문서의 여기를 참조하자. constructor의 각 인자의 뒤에 언더바 _ 가 들어간 이유는, 오픈제플린에서 제공하는 ERC20에 totalSupply(), name(), symbol() 의 동일한 이름이 있기 때문이다. 오픈제플린의 공식 문서에도 이러한 표기법이 설명되어있다. line12: mint는 주조하다 라는 의미이다. 토큰을 새로 발행할 때 실행한다. msg.sender는 컨트랙트를 전송한 주소를 의미한다. 즉 해당 함수는 토큰 컨트랙트를 만든 주소로 발행한 totalSupply 만큼의 토큰을 만들어서 전송하는 의미를가진다. line13: 토큰의 decimal을 세팅하는 함수이다. 설정하지 않으면 디폴트 값은 18로 설정되어 있음을 확인할 수 있다. decimal은 솔리디티에서 소수점 자리를 의미한다. 이더리움은 소수를지원하지 않기 때문에 decimal을 이용하여 소수의 자리수를나타낸다. decimal=0 일 때, transfer(철수, 1)은 철수에게 토큰 1개를 전송하는 것을 의미한다. decimal=2 일 때, transfer(철수, 1)은 토큰을 0.01개를 전송하는 것을의미한다. 일반적인 ERC20 토큰은 decimal=18 이다. decimal 18인 토큰을 철수에게 전송하고 싶다면, transfer(철수, 1000000000000000000)을 입력해야 토큰 1개가 전송된다. 우리가 작성할 토큰은 10000개만 발행할 것이고, 나눌 수 없는 형태로 발행할 것이다. 따라서 decimal에는 0을 입력할것이다. 이렇게 기본적인 토큰 발행은 완료되었다. 컨트랙트를 배포하면 ERC20 표준 토큰이 트랜잭션을 전송한 주소로 10000개 발행된다. 또한 decimal = 0이므로 정수 단위로만 교환할 수 있는 형태로 발행될것이다. Typechain 설치 컨트랙트를 매번 배포하는 방식으로 테스트 하는 것은 번거롭다. 따라서 테스트를 위한 여러 가지 도구가 존재한다. 스마트 컨트랙트 테스트는 일반적인 개발과 비슷한 방식으로 테스트된다. 오히려 더욱 엄밀한 테스트가 요구된다. 스마트 컨트랙트가 배포된 이후에는 일반적인 방법으로 수정이 불가능하기때문이다. 테스트 도구는 자바스크립트에서 일반적으로 사용하는 chai를 이용한다. 앞서 설치한 ethereum-waffle, ethers은 테스트 환경에서 컨트랙트를 배포하고, 임의의 유저 계정, 지갑을 mock 해주며, 여러 가지 테스트를 도와주는 기능을갖는다. ./test의 예제 파일을 확인해보면 일반적으로 chai 를 사용하는 방식과 다르지 않다. 예제 코드는 자바스크립트로 작성되어 있으나, hardhat의 플러그인인 typechain을 이용하면 타입스크립트를 이용해서 컨트랙트 테스트코드를 작성할 때, 여러 도움을준다. 아래는 typechain에 공식 문서에 나타난 typechain의 motivation이다. Interacting with blockchain in Javascript is a pain. Web3 interface is sluggish and when using it with Typescript it gets even worse. Often, you cant be sure what given method call will actually do without looking at ABI file. TypeChain is here to solve these problems (as long as you use Typescript). typechain을 설치하기 위해 여러 모듈을 설치해준 뒤, 타입스크립트까지 같이설치해주자. yarn add --dev @typechain/hardhat typechain ts-generator @typechain/ethers-v5 typescript ts-node 패키지를 설치한 후 플러그인을 적용시키기 위해서는 hardhat.config 파일을 수정해야한다. hardhat.config.js 파일의 확장자를.ts로 변경한 뒤, 아래와 같이작성해준다. https://medium.com/media/d4cb08ab7d1c9aff2cbe38941a2035e8/href 이제 설정은 끝났다. Typechain은 컨트랙트 source code를 받아서 컴파일을 할 때 마다 자동으로 컨트랙트에 대한 타입스크립트로 된 artifact를 만들어준다. 이를 이용하여 타입스크립트의 여러 장점을 취해서 테스트코드를 작성할 수있다. yarn hardhat compile 을 입력하여 컴파일을 해주게되면, 간단한 경고가 나오지만, 이는 오픈제플린과 관련된 내용이며 무시해도 좋다. compile이 완료되었다는 안내와 함께 Typechain artifacts가 생성되었다는 안내도 뜬다. 프로젝트 루트 디렉토리에 솔리디티 파일을 컴파일 한 ABI, bytecode가 저장되는 artifact 폴더가 생성되었고, typechain 폴더도 생성된걸 확인할 수 있다. typechain 폴더에는 위에서 봤던 컨트랙트를 typescript class로 만든 typescript artifact가 생성된다. 안의 프로퍼티에 AssetToken과 AssetToken을 상속받은 ERC20 함수가 있음을 확인할 수있다. 테스트 코드작성 본격적으로 테스트코드 작성을 해보자. test 폴더 안에 AssetToken.test.ts 파일을 생성한 뒤, 아래와 같이 테스트코드를작성한다. https://medium.com/media/136e806551b7fbd3d4e47fcf93955018/href 이 경우, json 파일을 그대로 import 하기 때문에 tsconfig.json 파일에 “resolveJsonModule”: true 옵션을 넣어주어야한다. https://medium.com/media/e5439fffb3f6a8a8862bfca9acf5fa5f/href line45: 컴파일한 artifact를 사용할 수 있도록 임포트한다. line1213: provider란 이더리움 네트워크와 통신할 수 있도록 연결을 매개해 주는 역할이다. getWallets()를 통해 지갑을 얻을 수 있다. 현재 admin 하나만 설정했지만, 최대 10개까지 지갑을 설정할 수 있다. 지갑의 기능을 갖고 있기에 address, private key, mnemonic 등을 속성으로가진다. line1625: 컨트랙트를 deploy한다. 인자로 트랜잭션을 전송할 계정, 컴파일한 ABI, bytecode artifact, constructor의 인자를 넣어준다. 또한 이렇게 line10에서 설정한 변수 assetToken의 타입이 Typechain으로 생성된 AssetToken 컨트랙트임을 명시했기 때문에, 배포된 컨트랙트 인스턴스도 AssetToken 타입을붙여준다. line2837: 일반적인 테스트 코드 작성과 다르지 않다. 첫번째 it 에서는 배포된 컨트랙트가 주어진 데이터를 제대로 입력되었는지 확인하고, 두번째 it 에서는 배포한 계정이 올바르게 토큰을 보유하고 있는지확인한다. yarn hardhat test ./test/AssetToken.test.ts 를 입력하면 아래와 같이 성공했다는 문구를 볼 수있다. 컨트랙트 배포 이제 테스트넷에 배포를 할 차례이다. 배포를 하기 위해서는 2가지 설정이필요하다. provider 및 private key설정 배포 스크립트작성 provider와 private key설정 이더리움 네트워크, 즉 노드와 통신하기 위해서는 provider가 필요하다. 직접 이더리움 노드를 운영할 수도 있지만, 이더리움에 쌓인 데이터를 동기화하고 노드를 운영하는 것은 디스크 용량과 리소스를 너무 많이 잡아먹는 일이다. infura 를 사용하면 직접 노드를 운용할 필요 없이 이더리움 네트워크에 직접 접근할 수 있다. 마치 Cloudfare 같은 느낌이다. 회원가입을 하면 무료로 간단하게 사용할 수 있다. Dashboard에서 Project ID를 받아오자. 이것이 계정의 Infura APIkey이다. infura.io에 접속해서 Project ID를 얻을 수있다. 마찬가지로 트랜잭션을 전송할 계정이 필요하고, 해당 계정에 접근하기 위한 private key가 필요하다. 메타마스크 등 다양한 지갑 어플리케이션을 통해 계정 주소와 private key를 얻을 수있다. 메타마스크에서 address와 private key를 확인할 수있다. 이후 hardhat.config.ts 파일에서 아래와 같이 작성하자. ropsten 테스트 네트워크를 사용해서 작성한 컨트랙틀르 배포할것이다. https://medium.com/media/00c524500944ced090fe42476b46d940/href 각종 비밀 키를 관리하기 위해 dotenv를설치해주고, yarn add --dev dotenv .env 파일을 만들어서 위에서 얻은 2가지를입력해준다. https://medium.com/media/20260d4c77f393bbe7ad210c9d81e60d/href 여기까지 배포 provider 및 private key 설정이완료되었다. 배포 script작성 이제 배포 script를작성한다. https://medium.com/media/12bb04fb716fc6adbd1e30e4a5c29a00/href line612: deploy script에는 AssetToken 이름을 가진 컨트랙트에 대해 bytecode를 생성하는 contractFactory를 이용한다. 여기에 컨트랙트의 constructor에 들어갈 인자를 전달하면 위에서 세팅한 private key에 대한 계정에서 트랜잭션이전송된다. 배포에는 가스가 필요하다! 만약 ropsten ether가 없다면 아래 ropsten faucet에서 얻을 수있다. Ropsten Ethereum Faucet yarn hardhat run — network ropsten scripts/deployScript.ts 를 입력하면 아래처럼 배포가 된다. 배포된 토큰은 ropsten 이더스캔에서 확인이가능하다. Etherscan verify 이더리움 테스트 네트워크에 배포는 완료되었다! 배포된 컨트랙트의 ABI, bytecode를 이용하면 프론트엔드, 혹은 백엔드를 통해 컨트랙트와 상호작용하고, 이를 통해 dAPP을 만들 수 있다. 그러나 이더스캔을 통해서도 컨트랙트에 접근할 수있다. 배포 후 이더스캔을 통해 컨트랙트와 상호작용 하기 위해서는 컨트랙트의 source code를 입력해야 한다. 이 과정을 이더스캔 사이트에서 직접 할 수도 있지만, hardhat-etherscan 플러그인을 이용하면 쉽게 진행할 수있다. 이 과정을 위해서 이더스캔 API 키가 필요하다. http://etherscan.io/ 에서 가입 후, API 키를 발급받을 수 있다. API 키를 받았으면 etherscan 플러그인을설치하자. yarn add — dev @nomiclabs/hardhat-etherscan 이후 hardhat.config.ts에 위 설정을 위해 2가지를추가한다.

hardhat과 typechain을 사용한 컨트랙트 개발

댓글 0개