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
brew install protobufDebian
apt update
apt install -y cmake pkg-config build-essential git clang libclang-dev protobuf-compilerArch
pacman -Syu --needed --noconfirm cmake gcc pkgconf git clang protobuf-compilerCompiling
We recommend using xtask to build fuel-core:
cargo xtask buildThis 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.shThe script requires pre-installed tools. For more information run:
cat ci_checks.shRunning
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:
--chain <CHAIN_CONFIG>
Specify either an alias to a built-in configuration or filepath to a JSON file [default:
local_testnet]
...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:4000To 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 disabledTroubleshooting
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 --reuseIt 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:66Clear 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 10240Log 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
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.ymlGraphQL 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:
/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\":{\"gas_price\":0,\"gas_limit\":1000000,\"maturity\":0,\"script\":[80,64,0,202,80,68,0,186,51,65,16,0,36,4,0,0],\"script_data\":[],\"inputs\":[
{
\"CoinSigned\": {
\"utxo_id\": {
\"tx_id\": \"c49d65de61cf04588a764b557d25cc6c6b4bc0d7429227e2a21e61c213b3a3e2\",
\"output_index\": 0
},
\"owner\": \"f1e92c42b90934aa6372e30bc568a326f6e66a1a0288595e6e3fbd392a4f3e6e\",
\"amount\": 10599410012256088338,
\"asset_id\": \"2cafad611543e0265d89f1c2b60d9ebf5d56ad7e23d9827d6b522fd4d6e44bc3\",
\"tx_pointer\": {
\"block_height\": 0,
\"tx_index\": 0
},
\"witness_index\": 0,
\"maturity\": 0,
\"predicate_gas_used\": null,
\"predicate\": null,
\"predicate_data\": null
}
}],\"outputs\":[],\"witnesses\":[{
\"data\": [
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
]
}],\"receipts_root\":\"0x6114142d12e0f58cfb8c72c270cd0535944fb1ba763dce83c17e882c482224a2\"}}"
