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.
Building
System Requirements
There are several system requirements including llvm, clang and postgres.
MacOS
brew update
brew install openssl cmake llvm libpq postgresqlDebian
apt update
apt install -y cmake pkg-config libssl-dev git gcc build-essential git clang libclang-dev llvm libpq-devArch
pacman -Syu --needed --noconfirm cmake gcc openssl-1.0 pkgconf git clang llvm11 llvm11-libs postgresql-libs
export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0";
export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"Building
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.
Running
The service can listen to an arbitrary socket, as specified in the help command:
$ ./target/release/fuel-core --help
fuel-core 0.1.0
USAGE:
fuel-core [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--ip <ip> [default: 127.0.0.1]
--port <port> [default: 4000]
--db-path <file path> [default: None]
Example
$ ./target/release/fuel-core --ip 127.0.0.1 --port 4000
Jul 12 23:28:47.238 INFO fuel_core: Binding GraphQL provider to 127.0.0.1:4000
Troubleshooting
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
Log level
The service relies on the environment variable RUST_LOG. For more information, check the EnvFilter examples crate.
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:
/graphql - Schema (available after building):
fuel-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, REG_ZERO, 0xca),
ADDI(0x11, REG_ZERO, 0xba),
LOG(0x10, 0x11, REG_ZERO, REG_ZERO),
RET(REG_ONE),
$ cargo run --bin fuel-gql-cli -- 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\":[],\"outputs\":[{\"Coin\":{\"to\":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], \"amount\": 10, \"color\": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}}],\"witnesses\":[],\"receipts_root\":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}}"
