【Ethereum開発フレームワーク】truffleの導入・使い方徹底解説

Ethereumのフレームワークtruffleの使い方を徹底紹介していきたいと思います。

 

truffleとは

truffleはEthereum Virtual Marchine(EVM)を使用した、Ethereum開発のための、開発、テストのフレームワークであり、開発ライフを簡単にすることを目標に作られています。

<スポンサードリンク>

なぜtruffleか

truffleを使うことで、Ethereum開発を円滑に進めることができます。
具体的には、下記のような機能が提供されています。

・単体テストフレームワーク
・コマンドでのデプロイ
・ERC190規格を使用した、EthPM&NPMによるパッケージ管理。
・コンソールでのtransactionの発行、デプロイ
・外部スクリプトランナー

※他にもいくつかありますが、主要なものをあげています。

truffleのインストール

下記のコマンドでインストールできます。
※NodeJSが入っている前提で、NodeJSのバージョンは5以上が推奨されています。

% npm install -g truffle

truffleでプロジェクトを作成

次のプロジェクトを作成したいと思います。
今回はテスト用のプロジェクトを作成します。

% mkdir testpj
% cd testpj 
% truffle init
Downloading...
Unpacking...
Setting up...
Unbox successful. Sweet!

Commands:

  Compile:        truffle compile
  Migrate:        truffle migrate
  Test contracts: truffle test

早速ですが、テスト用のプロジェクトを作成してみました。
initというコマンドでtruffle開発のテンプレートを作ってくれます。

具体的には、下記のようなディレクトリとファイルを作ってくれています。

% tree
.
├── contracts
│   └── Migrations.sol
├── migrations
│   └── 1_initial_migration.js
├── test
├── truffle-config.js
└── truffle.js

3 directories, 4 files

上からsolファイルを配置するcontractsディレクトリと、migrationファイルを配置するmigrationsディレクトリとtestファイルを配置するtestディレクトリです。

truffle-config.jsには、諸々の設定、truffle.jsには、デプロイするネットワークの設定などを書いていきます。

<スポンサードリンク>


デプロイ

まず、truffle.jsにデプロイ先の情報を記述します。
今回は、ローカルにデプロイするので、下記のような設定にしますが、クラウド環境等にデプロイする際も、基本は同じです。

module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",
      port: 8545,
      network_id: "*" // Match any network id
    }
  }
};

次にdevelopment環境のコンソールに入ります。
dev環境用のaccountやprivateKeyは用意してくれます。

% truffle development
Truffle Develop started at http://127.0.0.1:9545/

Accounts:
(0) 0x627306090abab3a6e1400e9345bc60c78a8bef57
(1) 0xf17f52151ebef6c7334fad080c5704d77216b732
(2) 0xc5fdf4076b8f3a5357c5e395ab970b5b54098fef
(3) 0x821aea9a577a9b44299b9c15c88cf3087f3b5544
(4) 0x0d1d4e623d10f9fba5db95830f7d3839406c6af2
(5) 0x2932b7a2355d6fecc4b5c0b6bd44cc31df247a2e
(6) 0x2191ef87e392377ec08e7c08eb105ef5448eced5
(7) 0x0f4f2ac550a1b4e2280d04c21cea7ebd822934b5
(8) 0x6330a553fc93768f612722bb8c2ec78ac90b3bbc
(9) 0x5aeda56215b167893e80b4fe645ba6d5bab767de

Private Keys:
(0) c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3
(1) ae6ae8e5ccbfb04590405997ee2d52d2b330726137b875053c36d94e974d162f
(2) 0dbbe8e4ae425a6d2687f1a7e3ba17bc98c673636790f1b8ad91193c05875ef1
(3) c88b703fb08cbea894b6aeff5a544fb92e78a18e19814cd85da83b71f772aa6c
(4) 388c684f0ba1ef5017716adb5d21a053ea8e90277d0868337519f97bede61418
(5) 659cbb0e2411a44db63778987b1e22153c086a95eb6b18bdf89de078917abc63
(6) 82d052c865f5763aad42add438569276c00d3d88a2d062d36b2bae914d58b8c8
(7) aa3680d5d48a8283413f7a108367c7299ca73f553735860a87b08f39395618b7
(8) 0f62d96d6675f32685bbdb8ac13cda7c23436f63efbb9d07700d8669ff12b7c4
(9) 8d5366123cb560bb606379f90a0bfd4769eecc0557f1b362dcae9012b548b1e5

Mnemonic: candy maple cake sugar pudding cream honey rich smooth crumble sweet treat

⚠️  Important ⚠️  : This mnemonic was created for you by Truffle. It is not secure.
Ensure you do not use it on production blockchains, or else you risk losing funds.

コンソールに入った後、migrateコマンドを打つことで、migrationファイルに沿って、dev環境にコントラクトがデプロイされます。

truffle(develop)> migrate --reset
Using network 'develop'.

Running migration: 1_initial_migration.js
  Deploying Migrations...
  ... 0x2794404958d5efa110f78bd43d0469e4e542de0135259b44899d04238452b756
  Migrations: 0x8cdaf0cd259887258bc13a92c0a6da92698644c0
Saving successful migration to network...
  ... 0xd7bc86d31bee32fa3988f1c1eabce403a1b5d570340a3a9cdba53a472ee8c956
Saving artifacts...

テスト

先ほどのコンソール内で、testコマンドを打つと、全テストを流してくれます。ファイルを指定してそのファイルのテストだけ流すこともできます。

truffle(develop)> test
Using network 'develop'.



  0 passing (1ms)

今はテストがないので、0件ですが、test/ 直下にあるファイルのテストを実行できます。

【参考】参考用プロジェクトのunbox

truffleを使ってみるにあたって、なにか参考にされたい方もいると思います。

truffleには、すでに参考になるようなプロジェクトがいくつか用意されており、
「unbox」というコマンドで、ローカルにプロジェクトをダウンロードすることができます。

今回は、「Metacoin」というプロジェクトをunboxしてみようと思います。

% mkdir metacoin
% cd metacoin
% truffle unbox metacoin

Downloading...
Unpacking...
Setting up...
Unbox successful. Sweet!

Commands:

  Compile contracts: truffle compile
  Migrate contracts: truffle migrate
  Test contracts:    truffle test

unboxすることで、ローカルに下記のようなディレクトリがダウンロードされています。

% ls
contracts		test			truffle.js
migrations		truffle-config.js

すでに動くプログラムなので、かなり実装の参考になると思います。
他のサンプルが欲しい方も下記のurlにのっているので、ぜひどうぞ!

https://truffleframework.com/boxes

もちろんmigrateもtestも動きます!

% truffle development
Truffle Develop started at http://127.0.0.1:9545/

Accounts:
(0) 0x627306090abab3a6e1400e9345bc60c78a8bef57
(1) 0xf17f52151ebef6c7334fad080c5704d77216b732
(2) 0xc5fdf4076b8f3a5357c5e395ab970b5b54098fef
(3) 0x821aea9a577a9b44299b9c15c88cf3087f3b5544
(4) 0x0d1d4e623d10f9fba5db95830f7d3839406c6af2
(5) 0x2932b7a2355d6fecc4b5c0b6bd44cc31df247a2e
(6) 0x2191ef87e392377ec08e7c08eb105ef5448eced5
(7) 0x0f4f2ac550a1b4e2280d04c21cea7ebd822934b5
(8) 0x6330a553fc93768f612722bb8c2ec78ac90b3bbc
(9) 0x5aeda56215b167893e80b4fe645ba6d5bab767de

Private Keys:
(0) c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3
(1) ae6ae8e5ccbfb04590405997ee2d52d2b330726137b875053c36d94e974d162f
(2) 0dbbe8e4ae425a6d2687f1a7e3ba17bc98c673636790f1b8ad91193c05875ef1
(3) c88b703fb08cbea894b6aeff5a544fb92e78a18e19814cd85da83b71f772aa6c
(4) 388c684f0ba1ef5017716adb5d21a053ea8e90277d0868337519f97bede61418
(5) 659cbb0e2411a44db63778987b1e22153c086a95eb6b18bdf89de078917abc63
(6) 82d052c865f5763aad42add438569276c00d3d88a2d062d36b2bae914d58b8c8
(7) aa3680d5d48a8283413f7a108367c7299ca73f553735860a87b08f39395618b7
(8) 0f62d96d6675f32685bbdb8ac13cda7c23436f63efbb9d07700d8669ff12b7c4
(9) 8d5366123cb560bb606379f90a0bfd4769eecc0557f1b362dcae9012b548b1e5

Mnemonic: candy maple cake sugar pudding cream honey rich smooth crumble sweet treat

⚠️  Important ⚠️  : This mnemonic was created for you by Truffle. It is not secure.
Ensure you do not use it on production blockchains, or else you risk losing funds.

truffle(develop)> migrate --reset
Compiling ./contracts/ConvertLib.sol...
Compiling ./contracts/MetaCoin.sol...
Compiling ./contracts/Migrations.sol...
Writing artifacts to ./build/contracts

Using network 'develop'.

Running migration: 1_initial_migration.js
  Deploying Migrations...
  ... 0xfdea7d036b462e79fd9a99022a618bff388a036e203777d2b994069c09dc42b7
  Migrations: 0x8cdaf0cd259887258bc13a92c0a6da92698644c0
Saving successful migration to network...
  ... 0xd7bc86d31bee32fa3988f1c1eabce403a1b5d570340a3a9cdba53a472ee8c956
Saving artifacts...
Running migration: 2_deploy_contracts.js
  Deploying ConvertLib...
  ... 0x76c6d1c54913471cf59646735bf15223cc4aaa4093c923b40db408822d0d4dbd
  ConvertLib: 0x345ca3e014aaf5dca488057592ee47305d9b3e10
  Linking ConvertLib to MetaCoin
  Deploying MetaCoin...
  ... 0x9e0ca8aa773223d485f337b858e18f429e6b565caef5aa99659c34444d641c3d
  MetaCoin: 0xf25186b5081ff5ce73482ad761db0eb0d25abfbf
Saving successful migration to network...
  ... 0x059cf1bbc372b9348ce487de910358801bbbd1c89182853439bec0afaee6c7db
Saving artifacts...
truffle(develop)> test
Using network 'develop'.

Compiling ./contracts/ConvertLib.sol...
Compiling ./contracts/MetaCoin.sol...
Compiling ./test/TestMetacoin.sol...
Compiling truffle/Assert.sol...
Compiling truffle/DeployedAddresses.sol...


  TestMetacoin
    ✓ testInitialBalanceUsingDeployedContract (139ms)
    ✓ testInitialBalanceWithNewMetaCoin (304ms)

  Contract: MetaCoin
    ✓ should put 10000 MetaCoin in the first account
    ✓ should call a function that depends on a linked library (45ms)
    ✓ should send coin correctly (271ms)


  5 passing (2s)

 

関連

Ethereum Solidityの最強の開発環境を構築 これだけ!

【solidity】業務ロジックとデータロジックを分断するコントラクト設計

【初心者向け】solidity基礎 modifierの使い方を徹底解説

【初心者向け】Solidity 外部コントラクトの呼び出し方法を徹底解説

Solidity(Remix)とgitを連携させ、Ethereumの開発をする

Ethereum プライベートネットワークでgeth起動時にnodeを自動接続する方法

 

スポンサードリンク



コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA