fuels-rs README

The project's README from github.com/FuelLabs/fuels-rs. As one markdown file: README.md.

fuels-rs

build crates.io docs discord

Rust SDK for Fuel. It can be used for a variety of things, including but not limited to:

Documentation

See the fuels-rs book

Features

FAQ

What dependencies do I need?

How can I run the SDK tests?

First, build the test projects using forc:

forc build --release --path e2e

Then you can run the SDK tests with:

cargo test

You can also run specific tests. The following example will run all integration tests in types.rs whose names contain in_vector and show their outputs:

cargo test --test types in_vector -- --show-output

How to run WASM tests?

You need to have wasm32 as a target, if you don't already:

 rustup target add wasm32-unknown-unknown

You also need wasm-pack, if you don't already:

cargo install wasm-pack

Navigate to packages/wasm-tests and run wasm-pack test.

What to do if my tests are failing on master

Before doing anything else, try all these commands:

cargo clean
rm Cargo.lock
forc build --release --path e2e
cargo test

Why is the prefix fuels and not fuel?

In order to make the SDK for Fuel feel familiar with those coming from the ethers.js ecosystem, this project opted for an s at the end. The fuels-* family of SDKs is inspired by The Ethers Project.

How can I run the docs locally?

Install mdbook by running:

cargo install mdbook

Next, navigate to the docs folder and run the command below to start a local server and open a new tab in your browser.

mdbook serve --open

You can build the book by running:

mdbook build

fuels-rs (FuelLabs/fuels-rs)

Searching Database…

43K ·GitHub
Fuels-rs
Что это?fuels-rs — официальный SDK на Rust для сети Fuel. Его используют для компиляции, развёртывания и тестирования смарт-контрактов на Sway, запуска локальной ноды Fuel, создания и подписи транзакций, а также генерации Rust-биндингов с проверкой типов для вызовов контрактов.
Это библиотека, которую я добавляю в Rust-проект, или отдельное приложение?Это Rust-крейт (библиотека), который подключается через Cargo.toml. Также в комплекте есть небольшой CLI для типовых операций, например для запуска локальных тестовых кошельков.
Как мне заставить fuels-rs работать на моём компьютере?Добавьте fuels как зависимость крейта в ваш Rust-проект. Чтобы собрать и запустить собственный набор тестов, сначала скомпилируйте тестовые проекты на Sway с помощью forc, а затем запустите тестовый раннер Rust.
Нужно ли что-то кроме инструментов Rust?Да, нужна последняя стабильная версия инструментов Rust, а также бинарники forc и fuel-core из экосистемы Fuel.
Каких частей SDK пока не хватает?Интеграция с кошельками (кроме локальных тестовых кошельков) и запрос и мониторинг событий пока не реализованы.
Почему крейт называется 'fuels', а не 'fuel'?Чтобы было привычно разработчикам из экосистемы ethers.js, проект следует соглашению об именовании 'fuels-', которое используется в семействе SDK Ethers Project.
Могу ли я запустить WASM-тесты SDK?Да. Добавьте target wasm32, установите wasm-pack и выполните 'wasm-pack test' в директории packages/wasm-tests.
Поддерживаются ли локальные тестовые кошельки Fuel из коробки?Да, локальные тестовые кошельки — встроенная возможность SDK, отмеченная как готовая.
Могу ли я запустить сеть Fuel локально с помощью этого SDK?Да, запуск локальных нод Fuel — основная поддерживаемая функция наряду с развёртыванием контрактов и взаимодействием с ними.
What are similar projects?nuvex, TrustMint, linera-protocol, fuels-ts, nuvex-services, Paxeer-X-Network, robinhood-trading-tools, cpp-sdk
Which topics is it in?integration-testing, rust-lang, network, smart-contracts, cryptocurrency, web3, systems-programming, blockchain, wasm, testing, sdk, documentation
Creator
FuelLabs
Size
19.7 MB
Stars
43K
Updated
CommitJun 29Releasev0.77.0Apr 06
Age
4y
Commits · 90 Days