アプリケーション開発ポータルサイト
ServerNote.NET
カテゴリー【JavaScript仮想通貨Node.js
ブラウザのJavaScriptのみでMetaMaskと連携しトランザクションを実行する
POSTED BY
2024-05-31

Ethereumネットワークの標準財布ソフトであるMetaMaskと連携するメモ。
サーバー上のNode.jsを使わずとも、ブラウザのHTML + Javascriptのみでほとんどの操作が可能。

公式のドキュメントは以下。

https://docs.metamask.io/guide/

MetaMaskのインストールはOpenSeaで画像をNFT資産として販売するにはの、
【4、仮想通貨ウオレットプラグインMETAMASKをChrome拡張機能でインストール】など参照してください。

完成されたサンプルはこちら

・MetaMaskのインストール状況を調べ、OKなら接続ボタンでネットワーク・アカウント・ETH残高を取得し表示。
・任意の送金先アドレス・送金額・任意データをフォームで受け取り、MetaMaskを通じて送金トランザクションを発行する。

以下、順番に説明します。最後にHTMlファイル全文を貼り付けています。

1、MetaMaskのインストール有無を確認する

  1. var valid_mm = false;
  2. if (typeof window.ethereum !== 'undefined') {
  3. valid_mm = true;
  4. $("#valid_mm_log").html("MetaMaskが認識できました。");
  5. }
  6. else {
  7. valid_mm = false;
  8. $("#valid_mm_log").html("MetaMaskがインストールされていません。");
  9. }

window.ethereumという型自体が存在するかどうかで判別する。

2、MetaMaskと接続し選択ネットワーク・アカウント・ETH残高を取得する

  1. const wei2eth = 0.000000000000000001;
  2. const eth2wei = 1000000000000000000;
  3.  
  4. var account_mm = "";
  5. var network_id = 0;
  6. var network_name = "";
  7. var balance = 0;
  8.  
  9. async function connect_metamask() {
  10. valid_metamask();
  11.  
  12. if(!valid_mm) {
  13. return;
  14. }
  15.  
  16. $("#connect_mm_log").html("MetaMaskと接続中...");
  17.  
  18. try {
  19. var accounts = await window.ethereum.request({ method: 'eth_requestAccounts' });
  20. if (accounts.length > 0) {
  21.  
  22. //https://chainlist.org/
  23. var network_names = {
  24. 1: "イーサリアムメインネット",
  25. 3: "Ropstenテストネットワーク",
  26. 4: "Rinkebyテストネットワーク",
  27. 42: "Kovanテストネットワーク",
  28. 61: "イーサリアムClassicメインネット",
  29. };
  30.  
  31. var network_id_raw = await window.ethereum.request({ method: 'eth_chainId' });
  32. network_id = parseInt(network_id_raw);
  33. network_name = "不明";
  34.  
  35. if (network_id in network_names) {
  36. network_name = network_names[network_id];
  37. }
  38.  
  39. var msg = "MetaMaskと接続できました。<br>接続しているネットワーク:" + network_name;
  40.  
  41. account_mm = accounts[0];
  42. msg += "<br>アカウントのアドレス:" + account_mm;
  43.  
  44. var amount = await window.ethereum.request({
  45. method: "eth_getBalance",
  46. params: [
  47. account_mm,
  48. "latest",
  49. ],
  50. });
  51. // wei -> ether
  52. balance = parseInt(amount) * wei2eth;
  53.  
  54. msg += "<br>イーサリアム残高:" + balance + "ETH";
  55.  
  56. $("#connect_mm_log").html(msg);
  57.  
  58. }
  59. } catch (err) {
  60. if (err.code === 4001) {
  61. // EIP-1193 userRejectedRequest error
  62. $("#connect_mm_log").html("接続が拒否されました。<br>" + err.message);
  63. } else {
  64. console.error(err);
  65. $("#connect_mm_log").html("接続エラーが発生しました。<br>" + err.message);
  66. }
  67. }
  68. }

window.ethereum.requestでeth_requestAccountsメソッドを呼ぶとMetaMaskへの接続要求がなされ、MetaMaskのポップアップが起動し、このサイトに接続しても良いかどうかの認証ダイアログが出る。「接続しない」にすると、catchで例外errに認証拒否の旨が返るので、エラー出力する。

接続が許可されると、戻り値にアカウントアドレスの文字列配列が返る。選択中のアカウント文字列は、配列の0番目(先頭)で参照する。

接続許可後はMetaMaskの各種APIが呼べるようになる。まずeth_chainIdメソッドで、選択中のネットワークIDを取得して、対応するネットワーク名に置き換える。ネットワークIDと名称の一覧は以下。

https://chainlist.org/

eth_getBalanceメソッドで、アカウントのイーサリアム残高が取得できる。単位はweiで返るので、

  1. const wei2eth = 0.000000000000000001;

を乗じることで、ETH単位に変換できる。

3、選択ネットワークやアカウントの切り替えに反応する

MetaMaskのウィンドウにて、ネットワークやアカウントは随時切り替えられる。それに反応するためのイベントハンドラを設置できる。

  1. window.ethereum.on("accountsChanged", (accountNo) => {
  2. connect_metamask();
  3. });
  4.  
  5. window.ethereum.on("chainChanged", (accountNo) => {
  6. connect_metamask();
  7. });

イベントが来たら、随時connect_metamaskを呼んで、情報を更新してやればよい。

4、任意のアドレスに任意のデータとETHを送金する

  1. async function send_transaction() {
  2.  
  3. trimingForm("to_address_txt");
  4. trimingForm("to_amounts_txt");
  5. trimingForm("to_data_txt");
  6. var to_data_txt = $("#to_data_txt").val();
  7. if (to_data_txt.length > 0) {
  8. to_data_txt = to_data_txt.replace(/\r\n/g, "\n");
  9. to_data_txt = to_data_txt.replace(/\n/g, "");
  10. }
  11. else {
  12. to_data_txt = "";
  13. }
  14.  
  15. if($("#to_address_txt").val().length balance) {
  16. $("#send_amounts_log").html("送金額相当のETHを保持していないようです。");
  17. return;
  18. }
  19.  
  20. if($("#to_address_txt").val() == window.ethereum.selectedAddress) {
  21. $("#send_amounts_log").html("自分自身への送金はできません。");
  22. return;
  23. }
  24.  
  25. $("#send_amounts_log").html("送金トランザクション実行中...");
  26.  
  27. try {
  28.  
  29. var send_wei = parseFloat($("#to_amounts_txt").val()) * eth2wei;
  30. var send_wei_str = "0x" + send_wei.toString(16);
  31. var send_params = {
  32. nonce: '0x00',
  33. gasPrice: '',
  34. gas: '',
  35. to: $("#to_address_txt").val(),
  36. from: window.ethereum.selectedAddress,
  37. value: send_wei_str,
  38. data: to_data_txt,
  39. chainId: '',
  40. };
  41.  
  42. var transaction_id = await window.ethereum.request({
  43. method: 'eth_sendTransaction',
  44. params: [send_params],
  45. });
  46.  
  47. $("#send_amounts_log").html("トランザクション完了:ID " + transaction_id);
  48. }
  49.  
  50. catch (err) {
  51. console.error(err);
  52. $("#send_amounts_log").html("トランザクションエラーが発生しました。<br>" + err.message);
  53. }
  54. }

まずはフォームパラメータフィールドから空白や改行を除く正規化処理をします。

「送金先アカウントアドレス」には人であるEOAだけでなく、コントラクトのアドレスも指定できます。
その場合は「任意データフィールド」に呼ぶコントラクトの関数とパラメータをABIエンコードした16進文字列を指定します。EOAにお金だけ送る場合通常任意データフィールドはカラにします。

connect_metamaskを呼んで、情報を最新にしておきます。

間違ってメインネットで送金してしまうことの無いよう、当サンプルではnetwork_idをチェックし1か61なら実行しないようにしている。

入力された送金額と、現在のアカウントの残高を比較し、少なければ実行しない。

送金先のアカウントアドレスと現在のアカウントアドレスが同じならば実行しない。

ETHとして入力を受けた送金額は、Weiに変換するため、

  1. const eth2wei = 1000000000000000000;

を乗じることでWeiに変換し、0xを付与した16進文字列にするためtoString(16)で変換。送金額はパラメータのvalueフィールドで指定する。

fromに現在選択中のアドレス、toに送金先アドレスを指定してeth_sendTransactionを実行する。gas関係のフィールドはカラにしておけば、MetaMaskのダイアログで確認したとおりの値で埋めてくれる。

MetaMaskの認証ダイアログにて、送金額、発生予想ガス代を確認して、問題なければ「実行」してトランザクション実行。

成功すると、戻り値にトランザクションIDの文字列が返る。このIDをetherscanに貼り付ければ詳細を見ることができる。

送金元から指定分のETHとガス代が引かれ、送金先にETHが加算されているのが確認できるはずである。

なお、NFTなどのスマートコントラクトを送金先に設定し、dataフィールドで呼びたいコントラクト関数の16進文字列を指定すれば、現存するスマートコントラクトのコードですらブラウザ上で実行できる。

HTML+Javascript全文は以下になります。

HTMLmetamask.htmlGitHub Source
  1. <!doctype html>
  2. <html lang="ja">
  3. <head>
  4. <!-- Required meta tags -->
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  7.  
  8. <!-- Bootstrap CSS -->
  9. <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
  10.  
  11. <title>MetaMaskテストページ</title>
  12.  
  13. <style type="text/css">
  14.  
  15. body {
  16. word-break: break-all;
  17. word-wrap: break-word;
  18. margin-bottom: 50px;
  19. }
  20.  
  21. textarea {
  22. line-height: 1.2em;
  23. }
  24.  
  25. </style>
  26.  
  27. <!-- Optional JavaScript -->
  28. <!-- jQuery first, then Popper.js, then Bootstrap JS -->
  29. <script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
  30. <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
  31. <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
  32. </head>
  33.  
  34. <body class="container-fluid m-3">
  35.  
  36. <div class="row mb-2">
  37. <div class="col-12">
  38. <span style="font-size: 2rem;">MetaMaskテストページ</span><span class="mx-2">※REVISION 0.0.0※</span>
  39. </div>
  40. </div>
  41.  
  42. <div class="row mb-3">
  43. <div id="valid_mm_log" class="col-12"></div>
  44. </div>
  45.  
  46. <div class="row mb-3">
  47. <div class="col-12">
  48. <button id="connect_mm_btn" type="button" class="btn-danger p-2 rounded" style="width:250px;">MetaMaskと接続する</button>
  49. </div>
  50. </div>
  51.  
  52. <div class="row mb-3">
  53. <div id="connect_mm_log" class="col-12"></div>
  54. </div>
  55.  
  56. <div class="row mb-3">
  57. <div class="col-12">
  58. 送金先アカウントアドレス(0x~):<br>
  59. <input id="to_address_txt" type="text" style="width:400px;"><br>
  60. 送金額:<input id="to_amounts_txt" type="text" style="width:100px;" value="0.01">ETH<br>
  61. 任意データフィールド(0x~):<br>
  62. <textarea id="to_data_txt" rows="6" style="width: 400px;"></textarea>
  63. </div>
  64. </div>
  65.  
  66. <div class="row mb-3">
  67. <div class="col-12">
  68. <button id="send_amounts_btn" type="button" class="btn-primary p-2 rounded" style="width:250px;">上記内容で送金する</button><b style="color:#ff0000;">※自己責任注意※</b>
  69. </div>
  70. </div>
  71.  
  72. <div class="row mb-3">
  73. <div id="send_amounts_log" class="col-12"></div>
  74. </div>
  75.  
  76. <div class="row mb-3">
  77. <div class="col-12">
  78. ※本サンプル使用によるいかなる損害が発生しても当サイトおよび作成者は一切責任を負いませんのでご注意ください※
  79. </div>
  80. </div>
  81.  
  82. <script>//<![CDATA[
  83.  
  84. const wei2eth = 0.000000000000000001;
  85. const eth2wei = 1000000000000000000;
  86.  
  87. var valid_mm = false;
  88. var account_mm = "";
  89. var network_id = 0;
  90. var network_name = "";
  91. var balance = 0;
  92.  
  93. function escape_html (string) {
  94. if(typeof string !== 'string') {
  95. return string;
  96. }
  97. return string.replace(/[&'`"<>]/g, function(match) {
  98. return {
  99. '&': '&amp;',
  100. "'": '&#x27;',
  101. '`': '&#x60;',
  102. '"': '&quot;',
  103. '<': '&lt;',
  104. '>': '&gt;',
  105. }[match]
  106. });
  107. }
  108.  
  109. function trimingForm(parts) {
  110. if( $('#' + parts).length ) {
  111. var pval = $('#' + parts).val();
  112. if( pval.length > 0 ){
  113. pval = pval.trim();
  114. $('#' + parts).val(pval.trim());
  115. }
  116. }
  117. }
  118.  
  119. function valid_metamask() {
  120. if (typeof window.ethereum !== 'undefined') {
  121. valid_mm = true;
  122. $("#valid_mm_log").html("MetaMaskが認識できました。");
  123. }
  124. else {
  125. valid_mm = false;
  126. $("#valid_mm_log").html("MetaMaskがインストールされていません。");
  127. }
  128. }
  129.  
  130. async function connect_metamask() {
  131. valid_metamask();
  132.  
  133. if(!valid_mm) {
  134. return;
  135. }
  136.  
  137. $("#connect_mm_log").html("MetaMaskと接続中...");
  138.  
  139. try {
  140. var accounts = await window.ethereum.request({ method: 'eth_requestAccounts' });
  141. if (accounts.length > 0) {
  142.  
  143. //https://chainlist.org/
  144. var network_names = {
  145. 1: "イーサリアムメインネット",
  146. 3: "Ropstenテストネットワーク",
  147. 4: "Rinkebyテストネットワーク",
  148. 42: "Kovanテストネットワーク",
  149. 61: "イーサリアムClassicメインネット",
  150. };
  151.  
  152. var network_id_raw = await window.ethereum.request({ method: 'eth_chainId' });
  153. network_id = parseInt(network_id_raw);
  154. network_name = "不明";
  155.  
  156. if (network_id in network_names) {
  157. network_name = network_names[network_id];
  158. }
  159.  
  160. var msg = "MetaMaskと接続できました。<br>接続しているネットワーク:" + network_name;
  161.  
  162. account_mm = accounts[0];
  163. msg += "<br>アカウントのアドレス:" + account_mm;
  164.  
  165. var amount = await window.ethereum.request({
  166. method: "eth_getBalance",
  167. params: [
  168. account_mm,
  169. "latest",
  170. ],
  171. });
  172. // wei -> ether
  173. balance = parseInt(amount) * wei2eth;
  174.  
  175. msg += "<br>イーサリアム残高:" + balance + "ETH";
  176.  
  177. $("#connect_mm_log").html(msg);
  178.  
  179. }
  180. } catch (err) {
  181. if (err.code === 4001) {
  182. // EIP-1193 userRejectedRequest error
  183. $("#connect_mm_log").html("接続が拒否されました。<br>" + err.message);
  184. } else {
  185. console.error(err);
  186. $("#connect_mm_log").html("接続エラーが発生しました。<br>" + err.message);
  187. }
  188. }
  189.  
  190. }
  191.  
  192. $(window).on('pageshow',function(){
  193. valid_metamask();
  194. });
  195.  
  196. $("#connect_mm_btn").on("click", function() {
  197. connect_metamask();
  198. });
  199.  
  200. window.ethereum.on("accountsChanged", (accountNo) => {
  201. connect_metamask();
  202. });
  203.  
  204. window.ethereum.on("chainChanged", (accountNo) => {
  205. connect_metamask();
  206. });
  207.  
  208. $("#send_amounts_btn").on("click", async function() {
  209.  
  210. trimingForm("to_address_txt");
  211. trimingForm("to_amounts_txt");
  212. trimingForm("to_data_txt");
  213. var to_data_txt = $("#to_data_txt").val();
  214. if (to_data_txt.length > 0) {
  215. to_data_txt = to_data_txt.replace(/\r\n/g, "\n");
  216. to_data_txt = to_data_txt.replace(/\n/g, "");
  217. }
  218. else {
  219. to_data_txt = "";
  220. }
  221.  
  222. if($("#to_address_txt").val().length <= 0 ||
  223. $("#to_amounts_txt").val().length <= 0) {
  224. $("#send_amounts_log").html("正しい値を入力してください。");
  225. return;
  226. }
  227.  
  228. connect_metamask();
  229.  
  230. if(network_id == 1 || network_id == 61) {
  231. $("#send_amounts_log").html("本番ネットワークでの送金はできません。");
  232. return;
  233. }
  234.  
  235. if(parseFloat($("#to_amounts_txt").val()) > balance) {
  236. $("#send_amounts_log").html("送金額相当のETHを保持していないようです。");
  237. return;
  238. }
  239.  
  240. if($("#to_address_txt").val() == window.ethereum.selectedAddress) {
  241. $("#send_amounts_log").html("自分自身への送金はできません。");
  242. return;
  243. }
  244.  
  245. $("#send_amounts_log").html("送金トランザクション実行中...");
  246.  
  247. try {
  248.  
  249. var send_wei = parseFloat($("#to_amounts_txt").val()) * eth2wei;
  250. var send_wei_str = "0x" + send_wei.toString(16);
  251. var send_params = {
  252. nonce: '0x00', // ignored by MetaMask
  253. gasPrice: '', // customizable by user during MetaMask confirmation.
  254. gas: '', // customizable by user during MetaMask confirmation.
  255. to: $("#to_address_txt").val(), // Required except during contract publications.
  256. from: window.ethereum.selectedAddress, // must match user's active address.
  257. value: send_wei_str, // Only required to send ether to the recipient from the initiating external account.
  258. data: to_data_txt, // Optional, but used for defining smart contract creation and interaction.
  259. chainId: '', // Used to prevent transaction reuse across blockchains. Auto-filled by MetaMask.
  260. };
  261.  
  262. var transaction_id = await window.ethereum.request({
  263. method: 'eth_sendTransaction',
  264. params: [send_params],
  265. });
  266.  
  267. $("#send_amounts_log").html("トランザクション完了:ID " + transaction_id);
  268. }
  269.  
  270. catch (err) {
  271. console.error(err);
  272. $("#send_amounts_log").html("トランザクションエラーが発生しました。<br>" + err.message);
  273. }
  274.  
  275. });
  276.  
  277. //]]></script>
  278.  
  279.  
  280. </body>
  281. </html>

※本記事は当サイト管理人の個人的な備忘録です。本記事の参照又は付随ソースコード利用後にいかなる損害が発生しても当サイト及び管理人は一切責任を負いません。
※本記事内容の無断転載を禁じます。
【WEBMASTER/管理人】
自営業プログラマーです。お仕事ください!
ご連絡は以下アドレスまでお願いします★

【キーワード検索】