Solidity로 배포하기

소개

이 문서는 Quai Network의 모든 체인에서 Hardhat을 사용하여 Solidity 스마트 계약을 배포하는 방법을 보여줍니다.

필수 조건

Quai에서 단일 체인 스마트 계약을 배포하려면 몇 가지 도구와 종속성이 필요합니다. 사용할 모든 종속성에 대한 개요는 다음과 같습니다:


NodeJS	Javascript 런타임 환경. LTS 버전을 사용하세요.
hardhat-example	Quai Network용 샘플 계약 및 배포 스크립트가 포함된 Hardhat 프로젝트입니다.
Quais.js	Quai Network와 상호 작용하기 위한 JavaScript 라이브러리입니다.
@quai/hardhat-deploy-metadata	계약 메타데이터를 IPFS에 푸시하여 Quaiscan에서 계약을 검증할 수 있게 해주는 Hardhat 플러그인입니다.
@openzeppelin/contracts	샘플 ERC20 및 ERC721 계약에서 사용되는 스마트 계약 라이브러리입니다.

환경 설정

예제 저장소 설치

먼저 hardhat-example 저장소를 복제하고, 이 튜토리얼에서 사용할 Solidity 디렉토리로 이동한 다음, npm을 통해 종속성을 설치합니다.

git clone https://github.com/dominant-strategies/hardhat-example.git
cd hardhat-example/Solidity
npm install

스마트 계약

Solidity/ 디렉토리에는 contracts/ 디렉토리 내에 2개의 샘플 계약이 있습니다: ERC20.sol과 ERC721.sol. 두 계약 모두 Open Zeppelin 라이브러리에서 파생된 구현입니다. 이 튜토리얼에서는 ERC20.sol 샘플 계약을 사용하지만, 자체 계약을 추가하거나 다른 라이브러리의 계약을 사용할 수도 있습니다.

Quai Network EVM은 최대 0.8.20 버전의 Solidity를 지원합니다. 더 새로운 버전의 Solidity를 사용하면 스마트 계약 배포 시 오류가 발생할 수 있습니다.

환경 변수

hardhat-example 저장소 루트에 토큰 세부 정보, 개인 키 및 RPC URL을 안전하게 관리하기 위한 샘플 환경 파일 .env.dist가 포함되어 있습니다.

.env.dist 파일은 템플릿 파일이며 그대로 사용해서는 안 됩니다. .env.dist 파일을 새로운 .env 파일로 복사해야 합니다.이 파일은 hardhat-example 저장소의 루트에 위치하며 Solidity/ 디렉토리의 설정 파일 역할을 합니다.

다음 명령을 사용하여 루트의 .env.dist 파일을 저장소 루트의 새 .env 파일로 복사합니다:

cp ../.env.dist ../.env

.env 파일을 열고 개인 키, RPC URL 및 배포하려는 계약의 토큰 인수를 추가합니다. .env 파일은 다음과 같아야 합니다:

.env

## 샘플 환경 파일 - 필요에 따라 모든 값을 변경하세요

# 배포 주소에 대한 고유 개인 키
CYPRUS1_PK="0x0000000000000000000000000000000000000000000000000000000000000000" # 0x00으로 시작하는 공개 키

# 체인 ID (로컬: 1337, Orchard 테스트넷: 15000, 메인넷: 9)
CHAIN_ID="15000"

# RPC 엔드포인트
RPC_URL="https://orchard.rpc.quai.network"

# ERC20 인수
ERC20_NAME="TestERC20"
ERC20_SYMBOL="TE20"
ERC20_INITIALSUPPLY=1000000

# ERC721 인수
ERC721_NAME="TestERC721"
ERC721_SYMBOL="TE721"
ERC721_BASE_URI="ipfs://METADATA_CID/"
ERC721_MAX_TOKENS=1000

샘플 .env.dist는 Orchard 테스트넷을 대상으로 하므로 실제 QUAI 없이 배포할 수 있습니다. 메인넷에 배포하려면 CHAIN_ID를 9로, RPC_URL을 https://rpc.quai.network로 변경하세요.

RPC 엔드포인트에 대한 자세한 정보는 네트워크 페이지에서 찾을 수 있습니다. hardhat-example 저장소는 Quais SDK를 사용하여 단일 RPC URL만으로 네트워크 연결을 구성합니다. SDK가 네트워크 제공자를 구성하는 방법에 대해 자세히 알아보려면 SDK 제공자 예제 섹션을 방문하세요. 개인 키와 RPC URL을 입력한 후, 이제 hardhat.config.js 내에서 안전하게 사용할 준비가 되었습니다.

Hardhat 구성

Hardhat은 스마트 계약 배포를 구성하는 데 hardhat.config.js 파일을 사용합니다. 설정 파일을 통해 배포 네트워크, 작업, 컴파일러 등을 정의할 수 있습니다. hardhat-example에는 Cyprus-1에서 스마트 계약을 배포하고 검증하기 위한 구성이 포함된 사전 제작된 hardhat.config.js 파일이 포함되어 있습니다.

샘플 hardhat 구성 파일

이 샘플 구성 파일은 hardhat-example 저장소의 일부로 제공됩니다.

hardhat.config.js

/**
 * @type import('hardhat/config').HardhatUserConfig
 */

require('@nomicfoundation/hardhat-toolbox')
require('@quai/quais-upgrades')
require('@quai/hardhat-deploy-metadata')

const dotenv = require('dotenv')
dotenv.config({ path: '../.env' })

module.exports = {
  defaultNetwork: 'cyprus1',
  networks: {
    cyprus1: {
      url: process.env.RPC_URL,
      accounts: [process.env.CYPRUS1_PK],
      chainId: Number(process.env.CHAIN_ID),
    },
  },

  solidity: {
    compilers: [
      {
        version: '0.8.17',
        settings: {
          optimizer: { enabled: true, runs: 1000 },
          metadata: {
            bytecodeHash: 'ipfs',
            useLiteralContent: true,
          },
          evmVersion: 'london',
        },
      },
      {
        version: '0.8.20',
        settings: {
          optimizer: { enabled: true, runs: 1000 },
          metadata: {
            bytecodeHash: 'ipfs',
            useLiteralContent: true,
          },
          evmVersion: 'london',
        },
      },
    ],
  },

  paths: {
    sources: './contracts',
    cache: './cache',
    artifacts: './artifacts',
  },
  mocha: {
    timeout: 20000,
  },
}

Cyprus-1은 현재 Quai Network에서 유일하게 활성화된 영역이므로, 샘플 구성은 단일 cyprus1 네트워크만 정의합니다. 전체 영역 엔드포인트 목록은 네트워크를 참조하세요.

metadata.bytecodeHash: 'ipfs' 및 useLiteralContent: true 컴파일러 설정은 @quai/hardhat-deploy-metadata가 검증 가능한 출력을 생성하는 데 필요합니다. 이를 제거하면 Quaiscan 검증이 작동하지 않습니다.

계약을 배포할 때 hardhat.config.js는 .env 파일에서 개인 키와 RPC URL을 가져옵니다. solidity 객체에서 Solidity 버전과 컴파일러 설정을 지정할 수도 있습니다.

배포 및 상호 작용

Hardhat으로 컴파일

Hardhat을 사용한 스마트 계약 컴파일은 간단하며 CLI에서 npx를 사용하여 수행할 수 있습니다.다음을 사용하여 contracts/ 디렉토리 내의 모든 계약을 컴파일합니다:

npx hardhat compile

다음과 같이 출력되어야 합니다:

Downloading compiler 0.8.20

Compiled 2 Solidity files successfully

배포 스크립트 구성

scripts/ 디렉토리 내에서 ERC20 및 ERC721 계약 모두에 대한 배포 스크립트를 찾을 수 있습니다: deployERC20.js 및 deployERC721.js. 이 튜토리얼에서는 ERC20 계약을 배포할 것입니다.deployERC20.js 스크립트는 hardhat.config.js에서 네트워크 구성을 가져오고 저장소 루트의 .env 파일에서 토큰 인수를 가져와서 계약을 배포하는 데 사용합니다.토큰 인수는 tokenArgs 배열을 통해 사용됩니다:

const tokenArgs = [process.env.ERC20_NAME, process.env.ERC20_SYMBOL, quais.parseUnits(process.env.ERC20_INITIALSUPPLY)]

계약이 배포되기 전에, 스크립트는 @quai/hardhat-deploy-metadata 플러그인을 사용하여 컴파일된 계약의 메타데이터를 IPFS에 푸시하고 생성된 CID를 반환합니다:

const { deployMetadata } = require("hardhat")
// ...
const ipfsHash = await deployMetadata.pushMetadataToIPFS("ERC20")

그런 다음 CID는 ContractFactory의 네 번째 인수로 전달되어 배포된 바이트코드에 임베드됩니다. Quaiscan은 나중에 해당 CID를 읽어 검증을 위해 소스를 가져옵니다 — 이것이 없으면 계약은 배포할 수 있지만 검증할 수 없습니다.

const provider = new quais.JsonRpcProvider(hre.network.config.url, undefined, { usePathing: true })
const wallet = new quais.Wallet(hre.network.config.accounts[0], provider)
const ERC20 = new quais.ContractFactory(ERC20Json.abi, ERC20Json.bytecode, wallet, ipfsHash)

다음 단계에서 계약을 배포하기 위해 토큰 인수와 네트워크 사양을 적절히 수정하는 데 이러한 아이디어를 사용할 것입니다.

deployERC721.js 스크립트는 동일한 구조를 따르지만, 다른 계약 인수와 다른 ABI/바이트코드를 사용합니다. 배포하려는 모든 계약에 대해 이 구성을 복제할 수 있습니다.

계약 배포

배포 스크립트는 배포하려는 네트워크를 지정하는 --network 플래그를 사용합니다. 샘플 구성은 cyprus1만 정의하며, 여기서 이를 사용합니다.

npx hardhat run scripts/deployERC20.js --network cyprus1

다음과 같이 출력되어야 합니다:

File added with CID: QmPCoBa1bCFmRoTD7GuexJqBAy7pqg8J4b8B48q5DgxUEV
Original IPFS hash found in bytecode: QmPCoBa1bCFmRoTD7GuexJqBAy7pqg8J4b8B48q5DgxUEV
Metadata JSON for ERC20 saved to /.../hardhat-example/Solidity/metadata/ERC20_metadata.json
Transaction broadcasted: 0x235fdeb85db5b6cee8da9780e2246907e8342751849f5ce3514847a5dffd916f
Contract deployed to:  0x00735E9B2c731Fd3eCC8129a3653ACb99dF969cC

첫 번째 줄에 출력되는 CID는 Quaiscan에서 계약을 검증하는 데 필요한 IPFS 해시입니다 — 저장해 두세요.축하합니다! 이제 Quai Network에 ERC20 토큰을 배포했습니다!

ERC20.sol 및 ERC721.sol 샘플 계약은 예제 목적으로 각 토큰의 기본 구현입니다. 프로덕션 용도로 배포하기 전에 특정 사용 사례에 맞게 이러한 계약을 수정하는 것이 좋습니다.

계약과 상호 작용

Hardhat 콘솔은 현재 Quai Network의 스마트 계약과의 상호 작용을 지원하지 않습니다.계약과 상호 작용하려면 Quais SDK를 사용하여 간단한 스크립트를 구성할 수 있습니다. 아래 스크립트는 0x00735E9B2c731Fd3eCC8129a3653ACb99dF969cC에 배포한 ERC20 토큰에 대한 Contract 인스턴스를 구성하여 토큰의 이름, 심볼 및 총 공급량을 가져옵니다.

getContractDetails.js

const quais = require('quais')
const ERC20Json = require('../artifacts/contracts/ERC20.sol/ERC20.json')

async function getContractDetails() {
  // 제공자, 지갑 및 계약 팩토리 구성
  const provider = new quais.JsonRpcProvider(hre.network.config.url, undefined, { usePathing: true })
  const wallet = new quais.Wallet(hre.network.config.accounts[0], provider)
  const ERC20 = new quais.Contract("0x00735E9B2c731Fd3eCC8129a3653ACb99dF969cC", ERC20Json.abi, wallet)

  const tokenName = await ERC20.name()
  const tokenSymbol = await ERC20.symbol()
  const tokenDecimals = await ERC20.decimals()
  const tokenTotalSupply = await ERC20.totalSupply()
}

getContractDetails()
  .then(() => process.exit(0))
  .catch((error) => {
    console.error(error)
    process.exit(1)
  })

요약

이제 간단한 Hardhat 프로젝트를 만들고, 자체 스마트 계약을 배포하고 상호 작용하는 데 필요한 모든 도구를 갖추었습니다. 배포 스크립트가 계약의 메타데이터를 IPFS에 푸시했으므로 이제 Quaiscan에서 검증할 수 있습니다 — 다음 단계는 Quaiscan에서 계약 검증을 참조하세요.

클라이언트

마이너

지갑

개발

소개

필수 조건

환경 설정

예제 저장소 설치

스마트 계약

환경 변수

Hardhat 구성

배포 및 상호 작용

요약

​소개

​필수 조건

​환경 설정

​예제 저장소 설치

​스마트 계약

​환경 변수

​Hardhat 구성

​배포 및 상호 작용

​요약

소개

필수 조건

환경 설정

예제 저장소 설치

스마트 계약

환경 변수

Hardhat 구성

배포 및 상호 작용

요약