Fuel Client

燃料クライアントの実装。

貢献あなたが燃料に貢献することに興味があるなら、私たちを参照してくださCONTRIBUTING.md コーディング標準とレビュープロセスのためのガイドライン。

変更をプッシュしたり、プルリクエストを作成する前に、sourceを実行してくださいci_checks.sh...

建物システム要件 Clangを含むいくつかのシステム要件があります。

MacOS brew更新 brewインストールcmake Debian aptアップデート apt install-y cmake pkg-config build-essential git clang libclang-dev アーチ pacman-Syu--needed--noconfirm cmake gcc pkgconf git clang コンパイル Xtaskを使用してfuel-coreを構築することをお勧めします:

カーゴxtaskビルドこれにより、クライアント用のGraphQLスキーマを再生成するなど、cargo buildとその他のカスタムビルドプロセスが実行されます。

テストザ-ci_checks.sh スクリプトファイルは、テストの実行を含むすべてのCIチェックを実行するために使用できます。

ソースci_checks.sh スクリプトには、事前にインストールされたツールが必要です。より多くの情報の操業のため:

猫ci_checks.sh ランニングこのサービスは、fuel-core runを実行することで起動できます。実行するためのオプションのリストには、ヘルプオプションを使用してアクセスできます:

$ ./target/debug/fuel-core run--help

使用法: フューエルコアラン[オプション]

オプション: --chain<CHAIN_CONFIG> 組み込み構成へのエイリアスまたはjsonファイルへのファイルパスのいずれかを指定します[デフォルト: local_testnet] ... 多くの開発目的では、永続化されない状態を持つことが有用であり、次の例のようにdb-typeオプションをin-memoryに設定することができます。

例を示します。 $ ./target/debug/fuel-core run--db-type in-memory 2023-06-13T12：45：22.860536Z INFO fuel_core::cli::run:230:Block production mode:Instant 2023-06-13T12：38：47.059783Z INFO fuel_core::cli::run:310:Fuel Coreバージョンv0.18.1 2023-06-13T12：38：47.078969Z INFO new{name=fuel-core}:_commit_result{block_id=b1807ca9f2eec7e459b866ecf69b68679fc6b205a9a85c16bd4943d1bfc6fb2a height=0tx_status=[]}:fuel_core_importer::IMPORTER:231:コミットされたブロック 2023-06-13T12：38：47.097777Z INFO new{name=fuel-core}：fuel_core::graphql_api::service:208：GraphQLプロバイダーを127.0.0.1：4000にバインドするローカルノードでブロック生成を無効にするには、--poa-instant=falseを設定します

例を示します。 $ ./target/debug/fuel-core run--poa-instant=false 2023-06-13T12：44：12.857763Z INFO fuel_core::cli::run:232:ブロック生産が無効になっていますトラブルシューティング出版私たちは、すべての木枠の自動公開のためにpublish-cratesアクションを使用しています。

公開に問題がある場合は、actを使用してローカルでトラブルシューティングできます。

act release-s GITHUB_TOKEN=<YOUR_GITHUB_TOKEN>-j publish-crates-check--container-architecture linux/amd64--reuse GitHubへのリクエストを行うには、GitHubTokenが必要です。あなたはこの命令でそれを作成することができます。

古いデータベース次のようなエラーが発生した場合

スレッド'main'は'データベースを開くことができません：DatabaseError（エラー{メッセージ："無効な引数：列ファミリが開かれていません：column-11、column-10、column-9、column-8、column-7、column-6、column-5、column-4、column-3、column-2、column-1、column-0"}）'、fuel-core/src/main.rs:23:66 Rm-rf~/を使用してローカルデータベースをクリアします。燃料/db

ファイル記述子の制限一部のmacOSバージョンでは、デフォルトのファイル記述子の制限が非常に低く、開いているファイルが多すぎるなどのメッセージでIOエラーが発生したり、致命的なランタイムエラーが発生したりする可能性があります。RocksDBがこれらの問題に遭遇した場合、Rustは外部の例外をキャッチできません。開いているファイルの制限を増やすには、次のコマンドを使用します。これは現在のシェルセッションにのみ影響するので、~/に追加することを検討してください。zshrc。

ulimit-n10240 ログレベルこのサービスは環境変数RUST_LOGに依存しています。詳細については、EnvFilter examplesクレートを確認してください。

ヒューマンロギングは、環境変数HUMAN_LOGGING=falseで無効にすることができます

デバッグローカルノードのデバッグビルドの実行の概要については、"デバッグガイド"を参照してください。

ドッカー＆Kubernetes #Dockerイメージを作成するドッカービルド-t燃料コア。 -fデプロイメント/Dockerfile

#Dockerイメージの削除ドッカー画像rm燃料コア

#Kubernetesのボリューム、デプロイ、サービスを作成する kubectl create-f deployment/fuel-core.yml

#Kubernetesのボリューム、展開、サービスの削除 kubectl delete-f deployment/fuel-core.yml GraphQLサービスクライアント機能は、GraphQLクエリを期待するサービスエンドポイントを介して使用できます。

トランザクションエグゼキュータ現在、トランザクションエグゼキュータは即時ブロック生成を実行します。変更はデフォルトでRocksDBに永続化されます。

サービスエンドポイント：/v1/graphql スキーマ（ビルド後に使用可能）：crates/client/assets/schema。sdl サービスは、ここで指定されているように、hexエンコードされたバイナリ形式でトランザクションを受信するsubmitとして定義された

カールの例この例では、次の一連のASMを表すスクリプトを実行します:

ADDI(0x10,RegId::ZERO,0xca), ADDI(0x11,RegId::ZERO,0xba), ログ(0x10,0x11,RegId::ZERO,RegId::ZERO), RET(RegId::ONE), $cargo run--bin fuel-core-client--transaction submit
"{"Script":{"script_gas_limit":1000000,"policies":{"bits":"GasPrice","values":[0,0,0,0]},"maturity":0,"script":[80,64,0,202,80,68,0,186,51,65,16,0,36,4,0,0],"script_data":[],"inputs":[ { 私はこれを試してみました： "utxo_id":{ "tx_id":"c49d65de61cf04588a764b557d25cc6c6b4bc0d7429227e2a21e61c213b3a3e2", 私のコードは次のとおりです。 }, "所有者":"f1e92c42b90934aa6372e30bc568a326f6e66a1a0288595e6e3fbd392a4f3e6e", "量":10599410012256088338, "asset_id":"2cafad611543e0265d89f1c2b60d9ebf5d56ad7e23d9827d6b522fd4d6e44bc3", "tx_pointer":{ ブロックの高さを指定します。, "tx_index":0 }, "witness_index":0, "成熟度":0, "predicate_gas_used":null, "predicate":null, 私はこの問題を解決しました。 } これを行うには、次のコマンドを実行します。 "データ":[ 150,31,98,51,6,239,255,243,45,35,182,26,129,152,46,95,45,211,114,58,51,64,129,194,97,14,181,70,190,37,106,223,170,174,221,230,87,239,67,224,100,137,25,249,193,14,184,195,15,85,156,82,91,78,91,80,126,168,215,170,139,48,19,5 ] これは、次のコマンドを実行して、次のコマンドを実行して実行しています。

Fuel Client

Fuel client implementation.

Contributing

If you are interested in contributing to Fuel, see our CONTRIBUTING.md guidelines for coding standards and review process.

Before pushing any changes or creating pull request please run source ci_checks.sh.

Building

System Requirements

There are several system requirements including clang.

MacOS

brew update
brew install cmake

Debian

apt update
apt install -y cmake pkg-config build-essential git clang libclang-dev

Arch

pacman -Syu --needed --noconfirm cmake gcc pkgconf git clang

Rust setup

You'll need wasm32-unknown-unknown target installed.

rustup target add wasm32-unknown-unknown

Compiling

We recommend using xtask to build fuel-core:

cargo xtask build

This will run cargo build as well as any other custom build processes we have such as re-generating a GraphQL schema for the client.

Testing

The ci_checks.sh script file can be used to run all CI checks, including the running of tests.

source ci_checks.sh

The script requires pre-installed tools. For more information run:

cat ci_checks.sh

Running

The service can be launched by executing fuel-core run. The list of options for running can be accessed via the help option:

$ ./target/debug/fuel-core run --help

USAGE:
    fuel-core run [OPTIONS]

OPTIONS:
        --snapshot <SNAPSHOT>
          Snapshot from which to do (re)genesis. Defaults to local testnet configuration

          [env: SNAPSHOT=]
        ...

For many development purposes it is useful to have a state that won't persist and the db-type option can be set to in-memory as in the following example.

Example

$ ./target/debug/fuel-core run --db-type in-memory
2023-06-13T12:45:22.860536Z  INFO fuel_core::cli::run: 230: Block production mode: Instant
2023-06-13T12:38:47.059783Z  INFO fuel_core::cli::run: 310: Fuel Core version v0.18.1
2023-06-13T12:38:47.078969Z  INFO new{name=fuel-core}:_commit_result{block_id=b1807ca9f2eec7e459b866ecf69b68679fc6b205a9a85c16bd4943d1bfc6fb2a height=0 tx_status=[]}: fuel_core_importer::importer: 231: Committed block
2023-06-13T12:38:47.097777Z  INFO new{name=fuel-core}: fuel_core::graphql_api::service: 208: Binding GraphQL provider to 127.0.0.1:4000

To disable block production on your local node, set --poa-instant=false

Example

$ ./target/debug/fuel-core run --poa-instant=false
2023-06-13T12:44:12.857763Z  INFO fuel_core::cli::run: 232: Block production disabled

Troubleshooting

Publishing

We use publish-crates action for automatic publishing of all crates.

If you have problems with publishing, you can troubleshoot it locally with act.

act release -s GITHUB_TOKEN=<YOUR_GITHUB_TOKEN> -j publish-crates-check --container-architecture linux/amd64 --reuse

It requires GitHubToken to do request to the GitHub. You can create it with this instruction.

Outdated database

If you encounter an error such as

thread 'main' panicked at 'unable to open database: DatabaseError(Error { message: "Invalid argument: Column families not opened: column-11, column-10, column-9, column-8, column-7, column-6, column-5, column-4, column-3, column-2, column-1, column-0" })', fuel-core/src/main.rs:23:66

Clear your local database using: rm -rf ~/.fuel/db

File descriptor limits

On some macOS versions the default file descriptor limit is quite low, which can lead to IO errors with messages like Too many open files or even fatal runtime error: Rust cannot catch foreign exceptions when RocksDB encounters these issues. Use the following command to increase the open file limit. Note that this only affects the current shell session, so consider adding it to ~/.zshrc.

ulimit -n 10240

Log level

The service relies on the environment variable RUST_LOG. For more information, check the EnvFilter examples crate.

Human logging can be disabled with the environment variable HUMAN_LOGGING=false

Debugging

See the guide on debugging for an overview on running a debug build of a local node.

Docker & Kubernetes

# Create Docker Image
docker build -t fuel-core . -f deployment/Dockerfile

# Delete Docker Image
docker image rm fuel-core

# Create Kubernetes Volume, Deployment & Service
kubectl create -f deployment/fuel-core.yml

# Delete Kubernetes Volume, Deployment & Service
kubectl delete -f deployment/fuel-core.yml

GraphQL service

The client functionality is available through a service endpoint that expect GraphQL queries.

Transaction executor

The transaction executor currently performs instant block production. Changes are persisted to RocksDB by default.

Service endpoint: /v1/graphql
Schema (available after building): crates/client/assets/schema.sdl

The service expects a mutation defined as submit that receives a Transaction in hex encoded binary format, as specified here.

cURL example

This example will execute a script that represents the following sequence of ASM:

ADDI(0x10, RegId::ZERO, 0xca),
ADDI(0x11, RegId::ZERO, 0xba),
LOG(0x10, 0x11, RegId::ZERO, RegId::ZERO),
RET(RegId::ONE),

$ cargo run --bin fuel-core-client -- transaction submit \
"{\"Script\":{
    \"body\":{
      \"script_gas_limit\":1000000,
      \"receipts_root\":\"0000000000000000000000000000000000000000000000000000000000000000\",
      \"script\":[80,64,0,202,80,68,0,186,51,65,16,0,36,4,0,0],
      \"script_data\":[]
    },
  \"policies\":{
      \"bits\":\"Maturity | MaxFee\",
      \"values\":[0,0,0,0]},
  \"inputs\":[{
    \"CoinSigned\":{
      \"utxo_id\":{
        \"tx_id\":\"c49d65de61cf04588a764b557d25cc6c6b4bc0d7429227e2a21e61c213b3a3e2\",
        \"output_index\":33298
      },
      \"owner\":\"f1e92c42b90934aa6372e30bc568a326f6e66a1a0288595e6e3fbd392a4f3e6e\",
      \"amount\":4294967295,
      \"asset_id\":\"0000000000000000000000000000000000000000000000000000000000000000\",
      \"tx_pointer\":{
        \"block_height\":0,
        \"tx_index\":0
        },
      \"witness_index\":0,
      \"predicate_gas_used\":null,
      \"predicate\":null,
      \"predicate_data\":null}}],
  \"outputs\":[],
  \"witnesses\":[{
    \"data\":[167,184,58,243,113,131,73,255,233,187,213,245,147,97,92,200,55,162,35,88,241,0,222,151,44,66,30,244,186,138,146,161,73,250,79,15,67,105,225,4,79,142,222,72,74,1,221,173,88,143,201,96,229,4,170,19,75,126,67,159,133,151,149,51]}
  ]}}"

You may meet the error Transaction is not inserted. UTXO does not exist due to the UTXO validation. The UTXO validation can be turned off by adding the --debug flag.

$ ./target/debug/fuel-core run --db-type in-memory --debug

Name		Name	Last commit message	Last commit date
Latest commit History 1,038 Commits
.cargo		.cargo
.github		.github
benches		benches
bin		bin
ci		ci
crates		crates
deployment		deployment
docs		docs
tests		tests
version-compatibility		version-compatibility
xtask		xtask
.gitignore		.gitignore
.prettierrc		.prettierrc
.rustfmt.toml		.rustfmt.toml
.typos.toml		.typos.toml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
Cross.toml		Cross.toml
LICENSE		LICENSE
Makefile.toml		Makefile.toml
README.md		README.md
SECURITY.md		SECURITY.md
ci_checks.sh		ci_checks.sh
clippy.toml		clippy.toml
docker-compose.yml		docker-compose.yml
rust-toolchain.toml		rust-toolchain.toml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Fuel Client

Contributing

Building

System Requirements

MacOS

Debian

Arch

Rust setup

Compiling

Testing

Running

Example

Example

Troubleshooting

Publishing

Outdated database

File descriptor limits

Log level

Debugging

Docker & Kubernetes

GraphQL service

Transaction executor

cURL example

About

Releases

Packages

Languages

License

yofe145/fuel-core

Folders and files

Latest commit

History

Repository files navigation

Fuel Client

Contributing

Building

System Requirements

MacOS

Debian

Arch

Rust setup

Compiling

Testing

Running

Example

Example

Troubleshooting

Publishing

Outdated database

File descriptor limits

Log level

Debugging

Docker & Kubernetes

GraphQL service

Transaction executor

cURL example

About

Resources

License

Security policy

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages