DEV Community: edo1z

Rust(Rocket)でtracingを使った詳細なエラーログ出力とエラーハンドリングの改善をしてみました

edo1z — Wed, 06 Dec 2023 13:14:12 +0000

RustのWebフレームワークのRocketで作っているWebアプリで、tracingを使った詳細なエラーログ出力とエラーハンドリングの改善をしてみました。

前提

クリーンアーキテクチャっぽい構成を想定しています。controller, use_case, repositoryがあります。repositoryではsqlxでPostgreSQLを使います。

リポジトリ

リポジトリは下記です。
https://github.com/edo1z/rust-rocket-sqlx-sample

tracingを使った詳細なエラーログ出力

エラー発生箇所のファイルパス、行番号、エラー発生までの経緯（どのファイルのどの関数を辿ったのか）などを、出力するために、tracingクレートを利用しました。

ログ出力例

結果的にこのようなログが出力されるようになりました。

2023-12-05T07:43:24.644738Z ERROR user_controller/update{id=12}:user_use_case/update{id=12}:user_repo/update{id=12}: rust_rocket_sqlx_sample::repositories::user_repo: [DbRepoError::SqlxError] no rows returned by a query that expected to return at least one row (src/repositories/user_repo.rs:85)

user_controllerのupdate関数（引数idが12）から、user_use_caseのupdate関数（引数が12）に行き、そこから、user_repoのupdate関数（引数が12）に行って、そこでエラーが発生しているということが分かりまっす。そして、エラー発生箇所は、user_repo.rsの85行目であり、エラーはDbRepoError::SqlxErrorであり、データがなかったことが分かります。分かりやすくなりました！

コードサンプル

repositoryの関数はこんな感じになっております。

#[instrument(name = "user_repo/update", skip_all, fields(id = %id))]
async fn update(
    &self,
    con: &mut PgConnection,
    id: i32,
    name: &String,
) -> Result<User, DbRepoError> {
    query_as!(
        User,
        "UPDATE users SET name = $1 WHERE id = $2 RETURNING *",
        name,
        id
    )
    .fetch_one(&mut *con)
    .await
    .map_err(|e| log_into!(e, DbRepoError))
}

instrument属性

最初の行のinstrument属性は、tracingの機能で、これを書いておくと、エラーログ出力時に、ログ発生の経緯にこの関数のnameや、引数が出力されます。controller, use_case, repositoryに全部書いておくと、全部順番に出力されるので、一目でログ出力時の実行順序が分かります。ただ、ログに引数の値を出力させるというのは、かなり危険な香りがしますので、基本的にはskip_allを設定して、表示させても問題なく、且つ、表示させたいものは、個別にfieldsで設定するという方針にしています。これは、危ないから使わないという選択肢もあるのかもなーとは思いました。どうもデフォルトでOFFには簡単にはできなそうだったのですが、もしデフォルトOFFができると、より安心かなあと思っております。

log_into!マクロ

最後の行の、log_into!マクロは下記になっております。

#[macro_export]
macro_rules! log_into {
    ($error:expr, $target_type:ty) => {{
        let converted_error: $target_type = $error.into();
        tracing::error!("{} ({}:{})", converted_error, file!(), line!());
        converted_error
    }};
}

エラーをtarget_typeの別のエラーに変換して、そのエラーをファイルパスと行番号と共に、tracingのerror!を使ってログ出力するマクロになります。ただの関数ですと、ファイルパス・行番号はこの関数のファイルパス及び行番号になりますので、それもあって、マクロにしております。もしファイルパス・行番号が不要であれば、自動でエラーは変換できるので、このようなマクロを使う必要はありません。

エラーハンドリングの改善

use_caseでrepository等で発生したエラーの詳細を把握し、細かくエラーハンドリングできるようにしつつ、なるべくシンプルにしたいと考えていまして、現状としては、結構いい感じな気がしてます。

ポイント① DbRepoErrorでラップ

DbRepoErrorは下記です。thiserrorクレートという便利ツールを使うことで、記述量が激減しました。fromアトリビュートを設定することで、sqlx::ErrorはDbRepoError::SqlxErrorに自動変換されます。これで、各エラーの詳細を残しつつ、DbRepoErrorとしてuse_caseに渡せるようになりました。

use thiserror::Error;

#[derive(Debug, Error)]
pub enum DbRepoError {
    #[error("[DbRepoError::SerdeError] {0}")]
    SerdeError(#[from] serde_json::Error),
    #[error("[DbRepoError::SqlxError] {0}")]
    SqlxError(#[from] sqlx::Error),

    #[cfg(test)]
    #[error("Dummy error for testing")]
    DummyTestError,
}

ポイント② use_caseで詳細をハンドリングしつつAppErrorに自動変換

AppErrorは現在こちらのようになっております。DbRepoErrorが自動的にAppError::DbErrorに変換されるようになっています。また、RocketのResponderが実装されており、レスポンスにそのままAppErrorが使えるようになっております。そして、レスポンス時のステータスコードも紐づけされています。その他、anyhowを真似したapp_err関数と、app_err!, app_err_bail!, app_err_ensure!マクロを作成しました。

AppErrorのコード（一部）

#[derive(Debug, Error)]
pub enum AppError {
    #[error("Database Error")]
    DbError(#[from] DbRepoError),
    #[error("Bad Request")]
    BadRequest,
    #[error("Unauthorized")]
    Unauthorized,
    #[error("Forbidden")]
    Forbidden,
    #[error("Not Found")]
    NotFound,
    #[error("Internal Server Error")]
    InternalServerError,
    #[error("{message}")]
    CustomError { status_code: u16, message: String },
}

impl AppError {
    pub fn new(status_code: u16, message: &str) -> Self {
        AppError::CustomError {
            status_code,
            message: message.to_string(),
        }
    }

    pub fn status_code(&self) -> u16 {
        match self {
            AppError::DbError(_) => 500,
            AppError::BadRequest => 400,
            AppError::Unauthorized => 401,
            AppError::Forbidden => 403,
            AppError::NotFound => 404,
            AppError::InternalServerError => 500,
            AppError::CustomError { status_code, .. } => *status_code,
        }
    }
}

use_caseのコードサンプル

下記のdeleteは、fromを使って自動変換させています。updateでは、対象データが存在しない場合は、BadRequestエラーを返すようにしています。このように、use_caseで、細かいエラーハンドリングが出来るようになりました。

#[instrument(name = "user_use_case/update", skip_all, fields(id = %id))]
async fn update(
    &self,
    repos: &Repos,
    db_con: &mut DbCon,
    id: i32,
    name: &String,
) -> Result<User, AppError> {
    repos
        .user
        .update(&mut *db_con, id, name)
        .await
        .map_err(|e| {
            if let DbRepoError::SqlxError(sqlx::Error::RowNotFound) = &e {
                AppError::BadRequest
            } else {
                AppError::from(e)
            }
        })
}

#[instrument(name = "user_use_case/delete", skip_all, fields(id = %id))]
async fn delete(&self, repos: &Repos, db_con: &mut DbCon, id: i32) -> Result<(), AppError> {
    repos
        .user
        .delete(&mut *db_con, id)
        .await
        .map_err(|e| AppError::from(e))
}

今後やりたいこと

メトリクスの収集
Datadogで集計・グラフ表示
Datadog経由でSlack通知
レスポンスのjson化（今エラーメッセージがテキスト）

c++23で順列を扱う

edo1z — Wed, 27 Sep 2023 07:23:01 +0000

c++23にする

下記でc++23でコンパイルできる。

g++ -std=c++23 hoge.cpp -o hoge.out

vscodeのコンパイルするタスクも下記でc++23でコンパイルできる。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "c++ build for AtCoder",
      "type": "shell",
      "command": "g++",
      "args": [
        "-g",
        "-O0",
        "-std=c++23", 
        "${file}",
        "-o",
        "${fileDirname}/${fileBasenameNoExtension}.out"
      ],
      "options": {
        "cwd": "${fileDirname}"
      },
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

VSCodeのC/C++拡張機能は、デフォルトでC++17までの機能をサポートしていて、c++20以上を利用する際にエディタでエラーが出る場合がある。.vscode/c_cpp_properties.jsonに下記を設定することで、拡張機能のc++バージョンを変更できるらしい。

{
    "configurations": [
        {
            "name": "Linux",
            "includePath": ["${workspaceFolder}/**"],
            "defines": [],
            "compilerPath": "/usr/bin/g++",
            "cStandard": "c17",
            "cppStandard": "c++23",
            "intelliSenseMode": "gcc-x64",
            "compilerArgs": ["-std=c++23"]
        }
    ],
    "version": 4
}

順列

ranges::next_permutation(hoge)を使うと、引数hogeのvectorに対する、順列のパターンの次を出してくれる。[0,1,2]を入れると、[0,2,1]を返す。[0,2,1]を入れると[1,0,2]を返す。多分。要するに、全パターンを順番に取得する場合は、しっかりと昇順にソートしてから渡す必要がある。iota(hoge.begin(), hoge.end(), 0)は、hogeの最初から最後までを0から始まる連続する数値で埋める関数。

#include <bits/stdc++.h>

using namespace std;

int main()
{
  vector<int> cells(3);
  iota(cells.begin(), cells.end(), 0);
  do
  {
    for (auto &&c : cells)
    {
      cout << c;
    }
    cout << endl;
  } while (ranges::next_permutation(cells).found);
}

上記の実行結果は下記になる。

Building a Clean Architecture with Rust's Rocket and sqlx

edo1z — Mon, 25 Sep 2023 06:33:23 +0000

I tried my best to create a clean architecture with Rust Rocket and sqlx.
I tried my best to create a state that is easy to test and mock, while also separating modules in a nice way.

We've done something similar before at Axum

I used to try to do the same thing with Axum. The repository with the highest number of stars in my history is below.

edo1z / rust-axum-sqlx-sample

Rust Axum+SQLx Sample

rust-axum-sqlx-sample

Install

git clone https://github.com/web3ten0/rust-axum-sqlx-1.git
cd rust-axum-sqlx-1/local
docker-compose up -d
sh scripts/exec_init_db

Migration

参照: https://github.com/launchbadge/sqlx/tree/master/sqlx-cli

cd local/scripts
sh migrate add -r users
sh migrate run
sh migrate revert

Swagger

swagger-uiのURL

http://localhost:8001

View on GitHub

The version of Axum in this repository is already quite old, so I think the whole thing needs to be modified if you try to do it now. Also, use_case is not a Trait, so it may be difficult to create mocks.

However, the code is rather simple (in my opinion), so I think it is good in terms of simplicity.

However, the DB Pool is passed to the repository, so each time a function in the repository is executed, it gets a connection from the Pool. I wonder if this is the difference between this version of Rocket and the current version.

I wonder if getting and destroying a connection every time a function is executed is relatively inefficient compared to continuing to use the same connection for a single request. (I have not measured this, but I asked ChatGPT and they said yes. I think it is basically impossible (and complicated) to do things such as crossing multiple repositories or waiting for a response from an external service before committing.

Repository of the Rocket version we made this time

The repository of this Rocket version is below. Please star it if you like!

edo1z / rust-rocket-sqlx-sample

A clean architecture style Sample using Rust's Rocket, sqlx and PostgreSQL.

rust-rocket-sqlx-sample

A clean architecture style Sample using Rust's Rocket(v0.5), sqlx(v0.6) and PostgreSQL.

How to Use

git clone https://github.com/net3i/rust-rocket-sqlx-sample
cd rust-rocket-sqlx-sample
docker-compose up -d
cp .env.example .env
sh migrate.sh
cargo test -- --test-threads=1
cargo run

Overview of how it works

Use Rocket's rocket_db_pools to retrieve DB Pool connections from Controller arguments. This is passed as an argument to use_case, which passes the connection as an argument to each function in the repository. Only one connection is used per request, and it is returned to the Pool as soon as the request is processed.

Mocking

Since use_case and repository are Trait, mock can be easily created by mockall when testing.

DB Transaction

DB transactions are basically assumed to be used only within each function of repository, but transactions can be generated from DB Pool connections on the use_case side if necessary. However, since the functions in repository do not accept…

View on GitHub

Features

Both use_case and repository are Trait, so it is easier to create mocks.
The repository functions are now passed only references to connections obtained from the DB Pool, which I think is a bit more efficient than the Axum version above. I think it is a little more efficient than the Axum version above.
- A connection is obtained from the Pool for each request, and that connection is used throughout the same request. The connection is returned (discarded) when the request is finished.
Since the connection is passed to each function of repository, it is possible to create a transaction on the use_case side and have it commit after multiple repository functions are executed, if you want to do so.
It is easy to do controller, use_case, and repository (integration test).

Points that annoyed me

Transaction handling
- Transaction and PoolConnection, it was difficult to use mockall.automock while using a repository function that can receive both (I eventually stopped using a function that can receive both).
- As a result of the above, I can no longer use Transaction's Rollback to clear the table state when testing repository. (I now truncate before testing).
Compared to the Axum version, the code around DB connection is a little less simple.
- But it is inefficient to pass a Pool to a function, and it is difficult to use transactions, so I thought it was good.

What I want to do in the future

I would like to introduce SeaORM.
I want to make it easy to use transactions in testing.
Currently, Rocket's sqlx is 0.6, but SeaORM is 0.7. Maybe we will stop using Rocket's db related libraries.

Summary

I thought Axum and Rocket were nice.
I thought it was transaction complicated.
Please star repository if you like!

m1 macのc++でOpenGLを使ってテトリスを作ってみた

edo1z — Sun, 21 Aug 2022 08:09:00 +0000

m1 macの、c++とOpenGLで簡易的なテトリスを作りました。

リポジトリ

https://github.com/web3ten0/cpp-opengl-tetris

実行してみてる動画

動作環境

m1 mac

❯ uname -a
Darwin mac.local 21.6.0 Darwin Kernel Version 21.6.0:
Sat Jun 18 17:05:47 PDT 2022; root:xnu-8020.140.41~1/RELEASE_ARM64_T8101 arm64

❯ brew config
HOMEBREW_VERSION: 3.5.9
CPU: octa-core 64-bit arm_firestorm_icestorm
Clang: 13.1.6 build 1316
macOS: 12.5-arm64
CLT: 13.4.0.0.1.1651278267
Xcode: 13.4.1
Rosetta 2: false

Install〜実行

GLFWをインストール

brwe install glfw
vim ~/.zshrc
# 下記を追加
export CPATH=/opt/homebrew/include
export LIBRARY_PATH=/opt/homebrew/lib

リポジトリをclone

git clone https://github.com/web3ten0/cpp-opengl-tetris.git

binディレクトリ作成、make、実行

cd cpp-opengl-tetris
mkdir bin
make
./bin/main

M1 macのc++でGLFWを使ってみる

edo1z — Sun, 07 Aug 2022 17:13:52 +0000

OpenGLについてまだ全然分かっていませんが、GLFWを使ってアニメーションを表示したいと思っています。とりあえず、M1 macのc++でウインドウを表示しました。

環境

> uname -m
arm64
> brew config
macOS: 12.5-arm64
Rosetta 2: false

GLFWをインストール

> brew install glfw
> brew --prefix glfw
/opt/homebrew/opt/glfw

コンパイル・実行してみるコード

ここのExample code

インストールしただけだとエラーになる

❯ g++ -o main main.cpp -lglfw -framework Cocoa -framework OpenGL -framework IOKit -framework CoreVideo
main.cpp:1:10: fatal error: 'GLFW/glfw3.h' file not found
#include <GLFW/glfw3.h>

CPATH, LIBRARY_PATHを環境変数に追加

> vim ~/.zshrc
# 下記を追加
export CPATH=/opt/homebrew/include
export LIBRARY_PATH=/opt/homebrew/lib

コンパイル・実行成功

コンパイル成功したけど、warningが沢山出る。これはAppleがOpenGLを基本廃止（非推奨）にしているかららしい。

❯ g++ -o main main.cpp -lglfw -framework Cocoa -framework OpenGL -framework IOKit -framework CoreVideo
main.cpp:23:5: warning: 'glClear' is deprecated: first deprecated in macOS 10.14 - OpenGL API deprecated. (Define GL_SILENCE_DEPRECATION to silence these warnings) [-Wdeprecated-declarations]
    glClear(GL_COLOR_BUFFER_BIT);
    ^
/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks/OpenGL.framework/Headers/gl.h:2394:13: note: 'glClear' has been explicitly marked deprecated here
extern void glClear (GLbitfield mask) OPENGL_DEPRECATED(10.0, 10.14);

warningを非表示にしてみる

コードに下記を追加する。
- #define GL_SILENCE_DEPRECATION によって、非表示になる。

#ifdef __APPLE__
#define GL_SILENCE_DEPRECATION
#include <GLFW/glfw3.h>
#endif

Makefileを作る

CPPFLAGS := -I src/includes
FRAMEWORKS := -framework Cocoa -framework OpenGL -framework IOKit -framework CoreVideo
LIBS := -lglfw

BUILD_DIR := ./bin
SRC_DIRS := ./src
SRCS := $(shell find $(SRC_DIRS) -name *.cpp)
OBJS := $(addprefix $(BUILD_DIR)/, $(subst .cpp,.o, $(notdir $(SRCS))))

$(BUILD_DIR)/main: $(OBJS)
    clang++ -o $@ $(LIBS) $(FRAMEWORKS) $^ 
$(BUILD_DIR)/%.o: src/%.cpp
    clang++ -c -o $@ $(CPPFLAGS) $<

do:
    @bin/main
clean:
    rm -rf bin
    mkdir bin

Debugできない

vimspectorで、.vimspector.jsonを下記のように設定してみたけど、エラーになる。
-lglfwがあるとエラーになるっぽい。

{
  "configurations": {
    "CodeLLDB": {
      "adapter": "CodeLLDB",
      "variables": {
        "BUILDME": {
          "shell": "clang++ -o ${workspaceRoot}/bin/debug -g -lglfw -framework Cocoa -framework OpenGL -framework IOKit -framework CoreVideo ${workspaceRoot}/src/main.cpp"
        }
      },
      "configuration": {
        "request": "launch",
        "program": "${workspaceRoot}/bin/debug",
        "stdio": [null, null, null]
      }
    }
  }
}

青いウインドウを表示するコード

#ifdef __APPLE__
#define GL_SILENCE_DEPRECATION
#include <GLFW/glfw3.h>
#endif

#include <iostream>
using namespace std;

static void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods) {
  if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS)
    glfwSetWindowShouldClose(window, GLFW_TRUE);
}

int main(void) {
  GLFWwindow* window;
  if (!glfwInit()) return -1;

  glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
  glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 2);
  glfwWindowHint(GLFW_OPENGL_FORWARD_COMPAT, GL_TRUE);
  glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);

  window = glfwCreateWindow(640, 480, "Hello World", NULL, NULL);
  if (!window) {
    cout << "failed to create window." << endl;
    glfwTerminate();
    return -1;
  }
  cout << "opened window" << endl;
  glfwSetKeyCallback(window, key_callback);
  glfwMakeContextCurrent(window);
  glfwSwapInterval(1);

  const GLubyte* renderer = glGetString(GL_RENDERER);
  const GLubyte* version = glGetString(GL_VERSION);
  std::cout << "Renderer: " << renderer << std::endl;
  std::cout << "OpenGL version supported: " << version << std::endl;

  glClearColor(0.0f, 0.3f, 0.6f, 0.3f);

  while (!glfwWindowShouldClose(window)) {
    glClear(GL_COLOR_BUFFER_BIT);
    glfwSwapBuffers(window);
    glfwPollEvents();
  }

  glfwTerminate();
  cout << "closed window" << endl;
}

リポジトリ

https://github.com/web3ten0/cpp-glfw-1

表示されるウインドウ

NFTを作ってみた

edo1z — Tue, 14 Dec 2021 04:50:59 +0000

SolidityとTypeScriptとHardhatとnft.storageとOpenZeppelinを使って、NFTを作成して、OpenSeaで確認してみました。

ソースコード

https://github.com/web3ten0/hardhat1

.envの作成

.env をこのリポジトリのルートに作成して、下記を入力します。

NFT_STORAGE_API_KEY = *****
METADATA_URI = https://ipfs.io/ipfs/*****/metadata.json
MATIC_TEST_URL=https://rpc-mumbai.maticvigil.com
PRIVATE_KEY_MATIC_TEST=*****
MINT_ADDRESS = 0x*****

画像とmetadata.jsonの作成・アップロード

hoge.jpgを作成して、このリポジトリのルートに置いておきます。
nft.storageにアカウントを作成して、API KEYを、.env の NFT_STORAGE_API_KEY に書きます。
net.storageのgithubにnode.js用のサンプルがありますので、これを参考に、hoge.jpgをIPFSにアップして、metadata.jsonを作成し、URIを取得します。
このリポジトリの scripts/storage.ts は、上記を参考にしたコードです。下記を実行することで、storage.ts が実行されます。

> npx hardhat run scripts/storage.ts

実行後に、https://ipfs.io/ipfs/****/metadata.json というURLが表示されますので、.env の METADATA_URI にそのURLをコピペします。

NFTコントラクトの作成

コントラクトは、ここにあるコードをほぼコピペしました。
ERC721URIStorage だと、mint時にtokenURIを個別に指定できますので、ちょうどよいかなと思いました。
このリポジトリの contracts/NftStorage.sol になります。

networkの設定

今回は、Polygonのテストネット（mumbai）にデプロイしてみました。
hardhat.config.tsでnetworkの設定ができます。Polygonの設定はここが参考になります。
URLとprivate keyが必要なので、.envに書いておきます。
- URLは、下記のように MATIC_TEST_URL に書きます。
- プライベートキーはMetaMaskから取得したりして、下記のように、 PRIVATE_KEY_MATIC_TEST に書きます。
- また、アカウントにはmumbaiのmaticが必要です。ない場合は、ここから貰えます。

MATIC_TEST_URL=https://rpc-mumbai.maticvigil.com
PRIVATE_KEY_MATIC_TEST=*****

コントラクトのデプロイとmint

mint時にNFTを送信するアドレスを、.envのMINT_ADDRESSに書きます。
今回は、test/deploy-nft-and-mint-test.tsでデプロイとmintを一緒に実行してみました。
下記コマンドを実行すると、Polygonのmumbaiにコントラクトがデプロイされて、その後mintされます。

> npx hardhat test --network mumbai

OpenSeaのテストネットでNFTを送信したアカウントでログインすると、NFTが表示されました。

Solidityの数値の明示的な型変換の仕様をRustで試してみた

edo1z — Thu, 09 Dec 2021 06:40:09 +0000

Solidityのドキュメントのここに書いてある内容について、Rustも同じ仕様なのか？などを試してみました。

マイナスのintをuintに変換する

let a:i8 = -3;
println!("a:{}", a as u8);

結果

a:253

Solidityと同じ結果でした。256を足すと答えが出るみたいになってる。

u32をu16に変換する

let b:u32 = 0x12345678;
let c:u16 = b as u16;
println!("b:{}({:#x?}) -> c:{}({:#x?})", b ,b, c, c);

結果

b:305419896(0x12345678) -> c:22136(0x5678)

Solidityと同じ結果でした。

u16をu32に変換する

 let d:u16 = 0x1234;
 let e:u32 = d as u32;
 let f:u32 = 0x00001234;
 println!("u16:{:#x?} u32:{:#x?} u32:{:#x?}", d, e, f);

結果

u16:0x1234 u32:0x1234 u32:0x1234

Solidityと同じ結果ってことかなと思いました。器が大きくなっただけなので、値自体は全く変わっていない、と認識しました。

bytes2からbytes1にする

Solidityのドキュメントのこれです。

int, uintの場合は、容量を減らすと大きい数値がなくなり小さい方が残りますが、byte列の場合は、大きい方が残ると認識しました。

Rustには、bytes2とかbytes1といった型は標準では多分なく、[u8; 2]みたいなu8型の配列やvectorで表すのかなと思います。下記は上記のSolidityの仕様と同じになるように、Rustでやってみたものです。

let g: u32 = 0x04030201;
let h: [u8; 4] = g.to_be_bytes();
let mut i: [u8; 2] = [0; 2];
i.clone_from_slice(&h[..2]);
let k: u16 = u16::from_be_bytes(i);
println!("{}({:#x?}) -> {:?} -> {}({:#x?})", g, g, h, k, k);

結果

67305985(0x4030201) -> [4, 3, 2, 1] -> 1027(0x403)

TruffleでGoerliネットワークにコントラクトをデプロイする

edo1z — Thu, 02 Dec 2021 02:51:28 +0000

TruffleでGethで接続しているGoerliネットワークにコントラクトをデプロイしてみます。

手順概要

GethでGoerliに接続する際に、HTTP APIを有効にする。
- 上記の際に、利用したいweb3コマンドのネームスペースを有効にする。
truffle-config.jsにGoerli用のネットワーク設定を追加する。
truffle migrateを--networkオプションでGoerli用ネットワークを指定して実行することで、デプロイが完了する。

1. GethでGoerliに接続

> geth --goerli --syncmode "light" --http --http.port 3334 --http.api personal,eth,web3,net --allow-insecure-unlock console

上記実行後に、デプロイ時に利用するアカウントのロック解除をしておく。（以下はGethコンソールです）

> personal.unlockAccount(eth.accounts[0],'*******')

2. truffle-config.jsでネットワークの設定

networks: {
  goerli: {
    host: '127.0.0.1',
    port: 3334,
    network_id: 5
  }
}

3.migrateの実行

> truffle migrate --network goerli

Ethereumの超シンプルなコントラクトをgethコンソールからデプロイする

edo1z — Mon, 29 Nov 2021 12:45:26 +0000

下記の超シンプルなコントラクトをコンパイル、デプロイして、アクセスしてみます。Windows10のWSL2のUbuntu20.04でやっています。

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

contract Hoge {
    function get() public pure returns (string memory){
        string memory hoge = "HOGE";
        return hoge;
    }
}

コンパイラは、solcをaptでインストールするか、solc-jsをnpmでインストールするかで、どちらでもコンパイルできました。以下はsolc-jsの場合です。

> solcjs --bin --abi -o bin Hoge.sol

コンパイルすると下記ファイルができます。

❯ tree
.
├── Hoge.sol
└── bin
    ├── Hoge_sol_Hoge.abi
    └── Hoge_sol_Hoge.bin

デプロイするネットワークは、goerliにします。ここでgoerliで使えるETHをもらえます。

> geth --goerli --syncmode "light" --verbosity 0 console

上記を実行するとlightモードでgoerliに接続しつつ、gethコンソールが開きます。以下はgethコンソールでの作業です。利用するアカウントは、ETHを保有しています。アカウントのパスワードは hoge です。

まずは、コンパイルした Hoge_sol_Hoge.binと、Hoge_sol_Hoge.abi の中身をgethコンソールの変数に入れておきます。binの中身の先頭に 0x をつける必要があります。

> bytecode = "0x608060405234801561001057600080fd5b50610182806100206000396000f3fe608060405234801561001057600080fd5b506004361061002b5760003560e01c80636d4ce63c14610030575b600080fd5b61003861004e565b604051610045919061012a565b60405180910390f35b606060006040518060400160405280600481526020017f484f47450000000000000000000000000000000000000000000000000000000081525090508091505090565b600081519050919050565b600082825260208201905092915050565b60005b838110156100cb5780820151818401526020810190506100b0565b838111156100da576000848401525b50505050565b6000601f19601f8301169050919050565b60006100fc82610091565b610106818561009c565b93506101168185602086016100ad565b61011f816100e0565b840191505092915050565b6000602082019050818103600083015261014481846100f1565b90509291505056fea264697066735822122097a132140711a9b641222ac8bc84bb5a671eb1c5c2b26d58c564036536ec0bba64736f6c63430008090033"
> abi = [{"inputs":[],"name":"get","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"pure","type":"function"}]

次に、アカウントのロックを解除して、コントラクトをデプロイします。

> account = eth.accounts[0]
> personal.unlockAccount(account, 'hoge')
> params = {from:account, data:bytecode, gas:500e3}
> tx = eth.sendTransaction(params)

トランザクションが反映されたかどうかは下記で確認できます。未反映の場合nullが返ります。

> web3.eth.getTransactionReceipt(tx)

下記でコントラクトの関数を実行できます。

> addr = web3.eth.getTransactionReceipt(tx).contractAddress
> Hoge = web3.eth.contract(abi).at(addr)
> personal.unlockAccount(account, 'hoge')
> web3.eth.defaultAccount = account
> Hoge.get.call()
"HOGE"