Hardhat plugin 사용하기 — hardhat-deploy & typechain 이 글은 이전 글의 후속편으로 연재되는글입니다. NomicLabs Hardhat 지난번 글에서 hardhat의 장점 중 하나로 다양한 plugin을 꼽았다. 이번에는 지난번에 소개하지 않았던 plugin 중, 배포를 도와주는 hardhat-deploy를 소개할것이다. 다음 편에는 이 글에 이어서 hardhat의 다른 도구를 소개하고 테스트를 진행 할예정이다. 프로젝트를 시작하기 위한 기본적인 패키지를설치한다. // hardhat 및 typechain을 위한 패키지 yarn add --dev hardhat typescript ts-node typechain @typechain/hardhat @typechain/ethers-v5 // 테스트를 위한 패키지 yarn add --dev @nomiclabs/hardhat-waffle ethereum-waffle chai @nomiclabs/hardhat-ethers ethers 또한 yarn hardhat 입력하여 프로젝트를 시작한다. 이 때, 지난번과 다르게 create an empty hardhat.config.js 을선택한다. Project init https://medium.com/media/db5f7a5fadfcb8d225ed7aef01256573/href 또한 tsconfig 파일도 설정해준다. tsc --init 후, 아래와 같이 tsconfig.json 파일을작성한다. https://medium.com/media/bf86c6c8e117fb2a9011ea158d2b078d/href 설정이 완료됐다! 이제 스마트 컨트랙트를 작성할것이다. ERC20 compile 먼저 간단한 ERC20 토큰을 하나 발행해보자. 토큰 발행을 위해 openzeppelin 을설치한다. yarn add --dev @openzeppelin/contracts contracts 폴더를 만들고 그 안에 SimpleToken.sol 파일을 만든 뒤, 아래와 같이작성한다. https://medium.com/media/5b7edc2b33b9c9588a2f26dfc96c717e/href line 1012: SimpleToken 컨트랙트는 openzeppelin의 ERC20을 상속한다. 토큰 이름과 심볼을 constructor 인자로 받으며, 토큰의 총 발행량은 10¹²개(decimal: 18)이며 발행 대상은 컨트랙트 주소로한다. line 1719: faucet 함수를 실행하면 발행 컨트랙트로부터 함수를 실행한 sender에게로 10000 개의 토큰을전송한다. 컨트랙트 작성이 완료되었으니 컴파일을해보자. yarn hardhat compile Compile done 컴파일이 완료됐다. Contract deploy — Configuration 지난번에는 hardhat 에 기본적으로 내장된 배포 스크립트를 사용했지만, 이번에는 hardhat plugin 중 하나인 hardhat-deploy 를 사용할것이다. hardhat-deploy 는 배포를 편리하게 해줄 뿐 아니라 배포된 컨트랙트의 정보를 자동으로 로컬에 저장하여 배포한 이후에 배포된 컨트랙트와 쉽게 상호작용 할 수 있도록 도와준다. 이 외에도 다양한 기능이 있으니 자세한 내용은 공식문서를 참고하자(링크) 해당 플러그인을 적용하기 위해 패키지를 설치한다. dotenv 는 환경변수를 위해설치한다. yarn add --dev hardhat-deploy dotenv 이후 배포 설정을 위해 hardhat.config 파일을수정한다. https://medium.com/media/b888fecf97bce802fde29d36391b072a/href hardhat-deploy 에서 제공하는 또 하나의 기능은 named account이다. 기존에는 각 networks 설정에 array 로 기록된 private key에 대해 accounts[0], accounts[1] 와 같은 방식으로 사용해야 했으나, hardhat.config의 named account object를 통해 각 계정들에 직접 이름을 부여해서 사용할 수있다. .env 파일 설정은 아래와 같이 진행한다. 각각의 API Key에 대한 구체적인 설명은 이전 게시글에 나타나있다. ETHERSCAN_API_KEY= etherscan api key INFURA_API_KEY= infura api key ADMIN= admin account private key DEPOSITOR= depositor account private key Contract deploy — Script 배포 스크립트가 위치한 폴더로 script 대신 deploy 를 사용할 것이므로, tsconfig.json 파일에서 include 옵션을 script 대신 deploy 로변경해준다. https://medium.com/media/c298786e9d26de593ddbdb838a5aa5b4/href 배포 스크립트를 작성하기 위해 deploy 폴더를 만들고 안에 deploy.ts 을 만든다. 이후 아래와 같이작성한다. https://medium.com/media/92a9b4890fbeae2c90901f5bea8e3656/href line 3: SimpleToken typechain artifact 를 import해준다. line 6: 위에서 설정한 named account 를 불러올 수있다. line 912: deploy 함수는 컨트랙트 이름과 옵션을 인자로 받아서 네트워크에 deploy 한 후, DeployResult 를 반환한다. deploy 함수의 인자로 들어가는 option object에는 from, construct args, log 등이 있으며, 만약 컨트랙트에 external library가 있다면 library linking도 옵션을 이용해서 배포 시점에 쉽게 진행할 수있다. deploy의 실행이 완료되면, live network(ropsten, mainnet)과 ganache의 경우, deployments 폴더에DeployResut 객체가 저장된다. 해당 객체에 저장되는 정보로는 address 와 abi, txHash 를 비롯한 deploy tx와 관련된 것들이 있으며, 아래와 같이 json 형식으로 로컬에저장된다. ( "address": Ŕx5b822aa3F70cB1070E3a116ea37C4aaE81233B20", "abi": [ ... ], "transactionHash":"..." ... ) 만약 웹앱, 또는 디앱을 만드는 경우, abi를 export 할 필요 없이 배포를 한 후 해당 폴더로 접근하여 컨트랙트 객체를 불러올 수있다. line 1518: DeployResult 객체의 abi 와 address 를 이용하여 컨트랙트 객체를 만들 수 있다. 이 때 typechain 을 사용하여 불러온 컨트랙트의 type을 정의해주면 해당 컨트랙트의 method 를 편리하게 사용할 수있다. line 20: getSigner 를 통해 depositor account에 대하여 트랜잭션 서명을 할 수 있는 객체(Signer)를 생성한다. getNamedAccounts 는 단지 public key 만을 반환한다. 그러나 deploy 함수의 경우, 내부에 from option 으로 public key가 들어가게 되면, hardhat.config 의 network setting 에 기록된 private key를 이용해서 해당 account 에 대한 Wallet object 를 생성한다. 또한 ethers.js 를 사용해서도 마찬가지로 getSigner method를 이용하여 signer object를 생성할 수 있다. 이 때 필요한건 wallet 의 private key와 provider에 대한정보이다. line 2223: 컨트랙트 객체의 faucet 함수를 실행한다. 이 때 connect 옵션을 통해 함수를 호출하는 계정을 앞서 namedAccount 에서 를 통해 정의한 depositor 에 대한 Signer 로하였다. line 2932: hardhat-deploy를 이용하면 DeployResult 를 통해 etherscan 에 쉽게 verify 를 할 수 있다. 이는 deploy 함수에서 반환한 DeployResult를 통해 bytecode를 비롯하여 verify에 필요한 정보에 쉽게 접근할 수 있기 때문이다. 또한 hardhat-deploy에는 저장된 DeployResult를 통해 verify를 할 수 있도록 etherscan-vefiry 라는 task를생성한다. task 란 hardhat runtime 에서 실행시킬 수 있는 작업으로써, 컨트랙트 배포, 상호작용, 조회 등 다양한 작업을 자동화할 수 있는 유용한 툴이다. 추후 다음 게시글에서 tasks를 커스텀 하는 방법에 대해 살펴볼것이다. 배포 스크립트 내부에서 해당 task 를 실행함으로써 쉽게 verify가 가능하다. 이 때 HardhatRuntimeEnvironment 객체의 runtime network 속성을 통해 어떤 네트워크에 vefiry 할지 옵션으로 네트워크의 이름을 제공해줄 수있다. Contract deploy — Run 이제 직접 배포를 하기에 앞서, hardhat 테스트 환경에서 배포를해보자. yarn hardhat deploy --network hardhat deploy-local 성공적으로 hardhat local network 에 배포되고 스크립트도 정상 작동하는걸 확인할 수 있다. 만약 오류가 있다면 앞 과정을 다시체크해보자. 이제 테스트 네트워크에 배포하고 스크립트의 함수를 실행하기 위해 각 계정에 테스트 이더를전송한다. 이 글을 작성하는 시점에 ropsten ether faucet이 작동하지 않는다는 제보를 받았다. 만약 ropsten testnet 이더를 구할 수 없다면 kovan, rinkeby 등 다른 테스트 네트워크를 사용하면된다. yarn hardhat deploy --network ropsten 배포가 완료되고 verify 도 완료되었음을 확인할 수있다. 마무리 hardhat-deploy는 이밖에도 library linking, proxy deploy, deploy function tag 등 다양한 기능을 제공한다. 예전에는 flatten 작업을 한 뒤 진행해야 했던 verify 도 이제는 이렇게 손쉽게 자동화 할 수있다. 다음에는 hardhat이 제공하는 강력한 도구인 task 기능을 소개하고 다른 플러그인을 적용시킨 간단한 프로젝트를 소개할예정이다. Hardhat plugin 사용하기 — hardhat-deploy & typechain was originally published in Elysia TechBlog on Medium, where people are continuing the conversation by highlighting and responding to this story.

Hardhat plugin 사용하기 — hardhat-deploy & typechain

댓글 0개