More than 5 years have passed since last update.

ブロックチェーンNEMアプリ開発時ベストプラクティスのまとめ

Last updated at 2019-07-22Posted at 2018-03-02

NEMでアプリ開発をするときに、だれもが悩む共通話題についてのベストプラクティスをまとめていきたいと思います。

技術関連の情報収集についてこちらにまとめましたのでご参考ください。
NEMについての情報収集の方法

こちらも参考にしてみてください。
NEMTionary
[ARCHIVES] mijin.io forum

#アカウント

検証用のアカウントをさくっとつくる
http://nemtest.s3-website-ap-northeast-1.amazonaws.com/account_generate.html

#トランザクションID

transfer = 0x101; // 257
importanceTransfer = 0x801; // 2049
multisigModification = 0x1001; // 4097
multisigSignature = 0x1002; // 4098
multisigTransaction = 0x1004; // 4100
provisionNamespace = 0x2001; // 8193
mosaicDefinition = 0x4001; // 16385
mosaicSupply = 0x4002; // 16386

#NEM EPOC

NEM_EPOCH = Date.UTC(2015, 2, 29, 0, 6, 25, 0);
transaction id = e793f3d0c5f01b528a027a6f1a13006685ac88be9d9c67aab29c293f9efa6081
http://chain.nem.ninja/#/transfer/e793f3d0c5f01b528a027a6f1a13006685ac88be9d9c67aab29c293f9efa6081
message: good luck!

#手数料

こちらにまとまっています。スモールビジネスなどはあまり知られていないのでぜひ活用しましょう。
NEMの手数料計算

NanoWalletで自動設定される手数料はぎりぎりラインではありません。単純化された関数で少し多めに設定されています。

現行のNEMのモザイク転送時の手数料の計算方法について、APIの仕様書では初期供給量(initial supply) を使って計算するとありますが、実際には現在の供給量を使って計算します。現在の供給量を取るには "/mosaic/supply" という仕様書に書いてない API を使う必要があります。

#メッセージ

メッセージの最大数は1024バイトです。

#ブロック

1ブロックに取り込めるトランザクション数の最大値は120です。
エアドロップなど行う場合はネットワークに迷惑をかけないよう、注意しましょう。

#タイムスタンプ
ネットワーク時間より10秒早いとFAILURE_TIMESTAMP_TOO_FAR_IN_FUTURE エラーが発生してしまいます。
タイムスタンプは /time-sync/network-time から取得した値を1000で割った値を使います。

#決済時

###0CONF承認
Unconfirmedに乗ったタイミングで「支払いの意思あり」として決済完了としてしまうこと。NEM Walletの場合はマルチシグと普通のUnconfirmed状態を見分けるのが難しく、注意が必要です。マルチシグ署名が必要なトランザクションはUnconfirmedのまま署名が行われないと1日後にキャンセルされてしまいます。（キャンセルは分単位で指定可能でNanoWalletの場合1日後と設定されているようです。）

###ブロックに取り込まれないトランザクション
confirmedされたトランザクションについても各ノード間での合意形成に失敗した場合など、ブロックに取り込まれずに取り消しされてしまう可能性があります。外部DBと連携させる場合は不整合が発生しないように数ブロック経過したものを取り込むようにした方が無難です。完全にロックされるのは360ブロックの約6時間後です。

参考：ブロックチェーンの同期

###2ノード確認
複数のノードでconfirmedされていることで決済が完了していることを確認する方法です。

###総金額別必要CONF制御
総金額に応じて、必要とする経過ブロック数の数を変更します。大きな決済ほど必要ブロック数の数を増やしてリスクを回避します。

#マルチシグ

###2-of-2の独自仕様
2つのアカウントで最小署名者数を2に設定したマルチシグの場合、署名者数1で相手方のマルチシグを削除することができます。プレゼントする前提での構成には便利ですが、セキュリティを確保したい場合は2-of-3あるいは2-of-4 以上のマルチシグを構成しましょう。

###マルチシグされたアカウントの秘密鍵
マルチシグされたアカウント（一般的にAliceで説明されることが多いです）の秘密鍵は送金能力がないため外部に流出しても問題ありません。ただし、委任ハーベストのON,OFFをおこなう権限は残ります。

連署人

連署人は最大で32です。アルファベット順で指定します。

その他の注意点

マルチシグアカウントから暗号化メッセージを送ることはできません。また非対応の取引所やサービスに送金した場合、正しく処理されない場合があります。
あるトランザクションのマルチシグ署名中に署名構成を変更すると、そのトランザクションはキャンセルされます。この仕組みを利用して予期しない巨額の送金を確認した場合に即時に署名者情報を変更して送金をキャンセルさせる、といった監視コントラクトを書くことも可能です。

#着金トリガー
###WebSocketでの実装
NEMの場合WebSocketに対応しているので、アカウントの状態が変更になった場合のみトリガーを発火させるようなプログラムを記述することが可能です。ただ、ファイアウォールやルータによりWebSocketのポートが制限される可能性もあるのでそのあたりは注意しておきましょう。会社で利用しているPCなどはポート制限されている可能性が高いです。

nem-sdk


var nem	= require("nem-sdk").default;

var NODES = Array(
"http://alice2.nem.ninja",
"http://alice3.nem.ninja",
"http://alice4.nem.ninja",
"http://alice5.nem.ninja",
"http://alice6.nem.ninja",
"http://alice7.nem.ninja"
);

var node_url;
function getEndpoint(){
	
	return NODES[Math.floor(Math.random() * NODES.length)];
}
node_url = getEndpoint();
var endpoint = nem.model.objects.create("endpoint")(node_url, nem.model.nodes.websocketPort);

// Address to subscribe
var address = "NBZNQL2JDWTGUAW237PXV4SSXSPORY43GUSWGSB7";
var connector = nem.com.websockets.connector.create(endpoint, address);

// Try to establish a connection
connect(connector);

// Connect using connector
function connect(connector){
	return connector.connect().then(function() {

		// Subscribe to confirmed transactions channel
		nem.com.websockets.subscribe.account.transactions.confirmed(connector, function(res) {
			//ここに処理を記述
		});
	});
}

なお、websocketについてのAPIドキュメントは現在こちらだけとのこと。
nis websocket channels and data

###ポーリングでの実装
上記以外にも定期的にノードに対して状態を確認しにいくことをポーリングと言います。都度HTTP接続を行うのでプログラミングの知識が浅い場合は。この場合の方が確実です。理想はWebSocketで接続できない場合はポーリングに切り替えるロジックの実装です。
(後日サンプルコード記載)

#トランザクション
NEM のREST APIで取得できるトランザクションjsonはその種類によって構成が異なります。
モザイクの場合やマルチシグの場合で送金されるXEMの情報が入っている場所が変わってくるので注意が必要です。

###マルチシグの場合
data->transaction->otherTrans->amount:送金額

multisig

{
	"data":[
		{
			"meta":{},
			"transaction":{
				"timeStamp":94734973,
				"signature":"",
				"fee":500000,
				"type":4100,
				"deadline":94738573,
				"version":1744830465,
				"signatures":[
					{
						"timeStamp":94735045,
						"otherHash"{
							"data":"7975b33194054182915b0edca69c6dae8e3e7d03d9100ea101b91d7a21c206d9"
						},
						"otherAccount":"NAGJG3QFWYZ37LMI7IQPSGQNYADGSJZGJRD2DIYA",
						"signature":"",
						"fee":500000,
						"type":4098,
						"deadline":94821445,
						"version":1744830465,
						"signer":"ae6754c70b7e3ba0c51617c8f9efd462d0bf680d45e09c3444e817643d277826"
					}
				],
				"signer":"aa455d831430872feb0c6ae14265209182546c985a321c501be7fdc96ed04757",
				"otherTrans":{
					"timeStamp":94734973,
					"amount":7580000000,
					"fee":50000,
					"recipient":"NXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
					"type":257,
					"deadline":94738573,
					"message":{},
					"version":1744830465,
					"signer":"fbae41931de6a0cc25153781321f3de0806c7ba9a191474bb9a838118c8de4d3"
				}
			}
		}
	]
}

###モザイクの場合
data->transaction->mosaics->quantity:送金額

/account/transfers/all

{
	"data":[
		{
			"meta":{},
			"transaction":{
				"timeStamp":65168770,
				"amount":1000000,
				"signature":"",
				"fee":4000000,
				"recipient":"NXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
				"mosaics":[
					{
						"quantity":8000,
						"mosaicId":{
							"namespaceId":"nem",
							"name":"xem"
						}
					}
				],
				"type":257,
				"deadline":65211970,
				"message":{
					"payload":"",
					"type":1
				},
				"version":1744830466,
				"signer":""
			}
		}
	]
}

シリアライズ

jsonをシリアライズする前に、モザイク名や署名者リストがアルファベット順に並んでいるかチェックしてください。
アルファベット順に並んでいないとannounce時にノード側でエラーとなります。
おそらくノード側の負荷を減らすために、ソートなどはクライアント側でやっておいてねということだと思います。

ハッシュ検索

トランザクションは以下のAPIでハッシュ値より検索できます。
/transaction/get?hash=
ですが、これは公式ドキュメントに記載がありません。ノードによっては再起動でデータから削除できるパラメータもあるそうです。つまり、参照先はフルTXを記録できるノード（アポスティーユ用ノード等）を慎重に選ぶ必要があります。

現在確認できている全TX参照可能なノード一覧
https://github.com/5hyn3/search_nis.transactionHashRetentionTime_-_-1_node/blob/master/result.txt

#ノード接続
数百あるノードの中で、中にはメンテナンスが行き届いていないノードも存在します。そういったノードに接続しないようにする方法を検討します。

pythonの読めるかたはなむやんさんのこちらが参考になるかもしれません。
https://github.com/namuyan/nem-python/blob/master/nem_python/nem_connect.py

###信頼できるノードの調べ方
SNの条件に４ブロックまでの揺れが許容されているため、同期に遅れ始めたノードがギリギリ生き残っている場合があります。
/node/active-peers/max-chain-heightと/chain/heightを比較して
アプリで許容できるブロック差を判断します。
基本差異が1なら許容して連続して続くようならば除外するのが良いかと思います。

###1ノードに対する負荷の目安
スーパーノードの条件に1秒あたり9アクセスというものがあるので、それを目安にするとよいでしょう。（ただし、他からのアクセスもあるので、常に占有はしないように）

###ノード接続に失敗した場合の再接続方法
ノード切断を検知した場合は再接続時に各ノード固有のidパラメータを再利用しないように注意しましょう。また返答に数十秒を要するノードもざらに存在するので、タイムアウトは必ず指定しましょう。

####WebSocketの場合

nem-sdk

var nem	= require("nem-sdk").default;

var NODES = Array("http://alice2.nem.ninja",...);

function getEndpoint(){
		return NODES[Math.floor(Math.random() * NODES.length)];
}
var node_url = getEndpoint();
var endpoint = nem.model.objects.create("endpoint")(node_url, nem.model.nodes.websocketPort);

var address = "NBZNQL2JDWTGUAW237PXV4SSXSPORY43GUSWGSB7";
var connector = nem.com.websockets.connector.create(endpoint, address);

connect(connector);
function connect(connector){
	return connector.connect().then(function() {
	}, function(err) {reconnect();
	});
}

function reconnect() {
	node_url = getEndpoint();
	endpoint = nem.model.objects.create("endpoint")(node_url, nem.model.nodes.websocketPort);
	connector = nem.com.websockets.connector.create(endpoint, address);
	connect(connector);
}