簡単なEtherのwalletを作る(3)

前節では「simple-ether-wallet」に送金を行う機能を追加しました。walletの画面上で送金を行うとネットワーク上に送金のトランザクションが送信され、それを採掘者が採掘することでアカウントの残高が変化しました。

ブロックチェーンを用いた送金では、あるトランザクションが組み込まれたブロックが採掘されることでそのトランザクションが「1回の承認(confirmation)を得た」と考えます。そしてそのブロックの後ろに続くブロックが採掘されればその数に応じて承認の数が増えて、そのトランザクションの信頼が高まります。Ethereumではおおよそ12回の承認を得ることでほぼ間違いなく信頼ができると言われています。

この節では下図の赤枠のようにwalletが送信したトランザクションの履歴とそれらのトランザクションが何回承認(confirmation)されたかを表示する機能を追加します。

※前節に続きここで説明するアプリケーションのソースコードはGitHub上に公開しています。

Transactionsコレクションを定義

トランザクションの履歴を保管し管理するためにMeteorのCollectionオブジェクトを利用します。MeteorのCollectionオブジェクトはサーバサイドやブラウザのローカルストレージ上にデータを格納し永続的にデータを保持することも可能ですが、ここでは簡単のためにブラウザ上のメモリ上のみに履歴を保存することにします。(そのため、ブラウザのタブを閉じれば履歴はクリアされます。)トランザクション履歴のCollectionオブジェクトとしてTransactionsを定義するコードをclient/lib/init.js内に追加します。

client/lib/init.js

(前略)
//Session変数の初期化
initSessionVars();
//Transactionsコレクションの初期化
Transactions = new Mongo.Collection('transactions', {connection: null});
//オブザーバの起動
observeNode();

アプリが正しく動作していれば、このコードを追加したあと、ブラウザコンソール上で下記のようにコレクション内の全てのドキュメント(レコード)を取り出すコマンドTransactions.find().fetch();を実行してみると[]のように空の配列が返されるはずです。(Transactionsオブジェクトは定義したものの、まだデータは何も入れていないため空の配列が返されます。)

ブラウザコンソール上

> Transactions.find().fetch();
[]

トランザクション情報を登録

Transactionsコレクションが定義されたので、Etherの送金を実行した際にそのトランザクション情報をTransactionsコレクションに登録するようにします。

トランザクションの送信を行うweb3.eth.sendTransaction関数のコールバック関数内でalert("Ether Transfer Succeeded");としていた部分の代わりに次のようなTransactionsコレクションへのドキュメント追加を行う処理を追加し下記のようにします。

client/templates/components/send_ether_component.js

(中略)
//非同期関数「web3.eth.sendTransaction」を呼ぶことでノードにトランザクションを送信
web3.eth.sendTransaction({
from: fundInfo.fAddr,
to: fundInfo.tAddr,
value: fundInfo.amount
}, function(error, txHash){ //戻り値としてトランザクションハッシュ値が返る
console.log("Transaction Hash:", txHash, error);
if(!error) {
//発行したトランザクション情報をTransactionsコレクションに挿入
Transactions.upsert(txHash, {$set: {
amount: Session.get("sendEther.fundInfo").amount,
from: Session.get("sendEther.fundInfo").fAddr,
to: Session.get("sendEther.fundInfo").tAddr,
timestamp: getCurrentUnixTime(),
transactionHash: txHash,
fee: estimatedFeeInWei().toString(10),
}});
} else {
alert("Ether Transfer Failed");
}
});
$('#sendConfirmModal').modal('hide');
}});

また、上記で追加した部分に現在のUNIX時刻を求める新しい関数を利用しているのでその定義を下記のように追記します。

client/lib/modules/time_utils.js

(前略:既存コード)
//現在のUNIX時刻を取得(単位:秒)
getCurrentUnixTime = function(){
var date = new Date() ;
var unixTimeSecond = Math.floor( date.getTime() / 1000 ) ;
return unixTimeSecond;
};

以上の修正を行った上で、アプリ上で送金の操作を行い、ブラウザコンソール上で再度、Transactions.find().fetch();コマンドを実行してみてください。送金を行った情報がドキュメントとして保存されたのが見て取れるはずです。

トランザクション情報を表示

次にTransactionsコレクションの情報を画面上に表示する機能をつけ加えていきます。SendビューにlatestTransactionComponentテンプレートを付け加え、このテンプレート内でTransactionsコレクションを表示する機能を実装していきます。

まずは、下記のようにSendビューのテンプレートにInclusionsタグ{{> latestTransactionComponent}}を追加します。

client/templates/views/send.html

<template name="send">
<div class="row-fluid">
<div class="col-md-8 col-md-offset-2">
{{> accountStatusComponent}}
{{> sendEtherComponent}}
{{> latestTransactionComponent}}
</div>
</div>
</template>

新しく、client/templates/components/以下にlatest_transaction_component.htmllatest_transaction_component.jsのテンプレートとそのヘルパのファイルを下記のように追加します。ここでTransactionsコレクションに何も登録されていない場合は「No Transactions To Show」と表示し、一つ以上トランザクションが登録されていればTransactionsコレクションからfindメソッドを用いて

  • トランザクションの発生日時

  • 送金元アドレス

  • 送金先アドレス

  • 送金額

    を取り出し表示することを行っています。また現時点では承認回数をゼロで固定に表示しています。(後程、リアルタイムに承認回数を表示する機能を実装していきます。)

client/templates/components/latest_transaction_component.html

<template name="latestTransactionComponent">
<div class="panel panel-default">
<div class="panel-heading">
<h4>Latest Transactions (Limit 5)</h4>
</div>
<table class="table table-striped" >
<tbody>
{{#each items}}
{{> transactionItem}}
{{else}}
<tr>
<td> No Transactions To Show</td>
</tr>
{{/each}}
</tbody>
</table>
</div>
</template>
<template name="transactionItem">
<tr>
<td>
<ul>
<li><b>Datetime:</b> {{txDateTime}} </li>
<li><b>From:</b> {{from}}</li>
<li><b>To:</b> {{to}}</li>
</ul>
</td>
<td>
<h4>
<b>{{amountInEther}}</b> ETHER
</h4>
<b>{{confirmationCount}}</b> confirmations
</td>
</tr>
</template>

client/templates/components/latest_transaction_component.js

//latestTransactionComponentテンプレートのヘルパー
Template.latestTransactionComponent.helpers({
//Transactionsコレクションから最大5件のトランザクション情報を取得
//timestamp属性について降順で取り出す。
items: function(){
selector = {};
return Transactions.find(selector, {sort: {timestamp: -1}, limit: 5}).fetch();
}
});
//transactionItemテンプレートのヘルパー
Template.transactionItem.helpers({
//フォーマット化されたトランザクション時刻の取得
txDateTime: function(){
return unix2datetime(this.timestamp);
},
//送金額をEtherの単位で取得
amountInEther: function(){
var amountEth = web3.fromWei(this.amount, "ether");
return parseFloat(amountEth).toFixed(3);
},
//承認回数の取得(現時点では固定でゼロを返す関数)
confirmationCount: function(){
var count = 0;
return count;
}
});

以上のコードを追加した後、画面から送金操作を行うとSendビューの下部に実際に送金した情報がリスト上に表示されるでしょう。

View this Commit On GitHub (Tag:"Step008")

承認状態の監視と表示

最後に、ウォレットで送金したトランザクションの承認状態を監視しそれを表示する機能を付け加えてきましょう。この機能は大まかに以下の方法で実現していきます。

  • Transactionsコレクションの登録状況を常時ウォッチする機能を追加

    • コレクションにトランザクションが新しく追加されたら、そのトランザクションの承認状態の監視を開始。

    • コレクションからトランザクションが削除されたら、そのトランザクションの承認状態の監視を停止。

  • Ehtereumネットワーク上で新しいブロックが採掘されるたびに監視対象のトランザクションの承認状態をチェックする。承認状態の監視は、当該トランザクションが採掘されたブロックの後ろに12個のブロックが追加されるまで行い、その後は監視を停止する。

まずはwalletアプリ起動時にTransactionsコレクションの登録状況の監視を開始するためのメソッドを呼び出すように、client/lib/init.jsの末尾に下記のコードを追加します。

client/lib/init.js

(前略)
observeTransactions();

また、上記で追加したobserveTransactions()メソッドを下記のように実装します。

client/lib/modules/observe_transactions.js

//Transactionsコレクションの状態を監視
observeTransactions = function(){
Transactions.find({}).observe({
//Transactionsコレクションにドキュメントが追加された場合
added: function(newDocument) {
console.log("Added Transaction Document");
checkTransactionConfirmations(newDocument);
},
//Transactionsコレクションからドキュメントが削除された場合
removed: function(document) {
console.log("Removed Transaction Document", document._id);
}
});
};

次に、上記コード内で呼ばれているcheckTransactionConfirmations()メソッドを実装します。処理の内容はソースコード内のコメントを参照してください。

client/lib/modules/check_transaction_confs.js

//承認状態監視停止の閾値
var requiredConfirmations = 12;
//web3.eth.getTransactionと、web3.eth.getTransactionReceipt のAPIメソッドで得られた情報をもとに
//Transactionsコレクションをアップデート
var updateTransaction = function(oldDocument, transaction, receipt){
if(receipt && transaction){
var actualFee = transaction.gasPrice.times(new BigNumber(receipt.gasUsed)).toString(10);
Transactions.update({_id: oldDocument._id},
{$set: {
blockNumber:transaction.blockNumber,
blockHash: transaction.blockHash,
transactionIndex: transaction.transactionIndex,
fee: actualFee
}
});
}else{
console.log("NOT UPDATED");
}
};
//最新ブロックを監視し、トランザクション(tx)の承認状態をアップデートする。
checkTransactionConfirmations = function(tx){
var confCount = 0;
var filter = web3.eth.filter('latest');
//最新ブロックを監視。新しいブロックが採掘されれば、コールバック関数内で指定された処理を行う。
filter.watch(function(e, blockHash){
if(!e) {
console.log("Received New Block");
confCount++;
// Transactionsコレクションから最新状態を取得。
// Transactionsコレクションから削除されていれば監視を停止
tx = Transactions.findOne(tx._id);
if(!tx) {
filter.stopWatching();
return;
}
//web3.eth.getTransactionとweb3.eth.getTransactionReceiptの2つのAPI関数の返り値をもとに、
//最新のトランザクションの状態を取得。
web3.eth.getTransaction(tx.transactionHash, function(e, transaction){
web3.eth.getTransactionReceipt(tx.transactionHash, function(e, receipt){
if(!e) {
//発信したトランザクションを含むブロックが相当の期間採掘されない場合は、
//当該トランザクションがEthereumネットワークに受け入れられなかったとして、
//Walletのトランザクションの歴から削除する。
//ここで「相当の期間」として、requiredConfirmationsに指定された値の2倍としている。
if(!receipt || !transaction){
if(confCount > requiredConfirmations*2){
Transactions.remove(tx._id);
filter.stopWatching();
return;
}else{
return;
}
// 発信したトランザクションを含むブロックが採掘された場合、
// その情報でTransactionsコレクションの情報を更新。
}else if(transaction.blockNumber) {
if(transaction.blockNumber !== tx.blockNumber){
updateTransaction(tx, transaction, receipt);
}
// Transactionsコレクションでのブロックハッシュと、
// 最新のEthereumネットワーク上でのブロックハッシュが異なる場合、
// 当該トランザクションを含むブロックは正規のブロックチェーン内に無いことを示すため、
// Walletのトランザクション履歴から削除する。
web3.eth.getBlock(transaction.blockNumber, function(e, block) {
if(!e) {
if(block.hash !== transaction.blockHash) {
// remove if the parent block is not in the chain anymore.
Transactions.remove(tx._id);
filter.stopWatching();
return;
}
}
});
// 承認回数が指定回数以上になった場合、十分信頼性が高いとして、
// 当該トランザクションの承認状態の監視を停止する。
var confirmations = (EthBlocks.latest.number + 1) - tx.blockNumber;
if(confirmations > requiredConfirmations){
console.log("Confirmed Enough. Stop Watching... TxHash=", tx.transactionHash);
filter.stopWatching();
}
}
}
});
});
}
});
};

また、最後に承認回数を画面に表示するために、transactionItemテンプレートヘルパの承認回数の取得部分をTransactionsコレクションと最新のブロックナンバーの差から表示するように、以下のように修正します。

client/templates/components/latest_transaction_component.js

(前略)
//承認回数の取得
confirmationCount: function(){
var count = 0;
if(this.blockNumber) count = EthBlocks.latest.number - this.blockNumber +1;
if(count > 50) count = "50+";
return count;
}
(後略)

View this Commit On GitHub (Tag:"Step009")