feat: `AssembleTx` query #2769

netrome · 2025-02-27T08:32:31Z

Added a new assembleTx GraphQL endpoint.
The endpoint can be used to assemble the transaction based on the provided requirements.

The returned transaction contains:

Input coins to cover required_balances
Input coins to cover the fee of the transaction based on the gas price from block_horizon
Change or Destroy outputs for all assets from the inputs
Variable outputs in the case they are required during the execution
Contract inputs and outputs in the case they are required during the execution
Reserved witness slots for signed coins filled with 64 zeroes
Set script gas limit(unless script is empty)
Estimated predicates, if estimate_predicates == true

Returns an error if:

The number of required balances exceeds the maximum number of inputs allowed.
The fee address index is out of bounds.
The same asset has multiple change policies(either the receiver of
the change is different, or one of the policies states about the destruction
of the token while the other does not). The Change output from the transaction
also count as a ChangePolicy.
The number of excluded coin IDs exceeds the maximum number of inputs allowed.
Required assets have multiple entries.
If accounts don't have sufficient amounts to cover the transaction requirements in assets.
If a constructed transaction breaks the rules defined by consensus parameters.

Remaining work do be done:

Client implementation.
Integration tests

Around 30-40% of main logic is done. The functional is quite big and in the future commits I will refactor it to use builder pattern.

crates/fuel-core/src/coins_query.rs

…several issues found in the endpoint.

Removed publishing from e2e tests Started to use `assembleTx` endpoint in more tests Fixed some issues discovered during updating of the tests

… messages

AurelienFT

Tests are getting crunched !!! Good ! Overall the PR is ok to me. Great work !!! I have few questions but will be able to approve soon.

I'm waiting to see if it's ok for SDK integrations

crates/client/assets/schema.sdl

crates/fuel-core/src/schema/tx/assemble_tx.rs

crates/fuel-core/src/schema/tx.rs

crates/fuel-core/src/schema/tx/assemble_tx.rs

… cover free transaction

rymnc · 2025-03-07T12:38:48Z

crates/fuel-core/src/schema/tx.rs

+        )]
+        exclude_input: Option<ExcludeInput>,
+        #[graphql(
+            desc = "Perform the estimation of the predicates before cover fee of the transaction"


Suggested change

desc = "Perform the estimation of the predicates before cover fee of the transaction"

desc = "Perform estimation of the predicates before covering fee of the transaction"

rymnc · 2025-03-07T12:40:57Z

tests/tests/assemble_tx.rs

+    // Given
+    state_config.coins[0].owner = owner;
+    state_config.coins[0].asset_id = base_asset_id;
+    state_config.coins[1].owner = owner;
+    state_config.coins[1].asset_id = non_base_asset_id;
+
+    let mut config = Config::local_node_with_configs(chain_config, state_config);
+    config.utxo_validation = true;
+    config.gas_price_config.min_exec_gas_price = 1000;
+
+    let service = FuelService::new_node(config).await.unwrap();
+    let client = FuelClient::from(service.bound_address);
+    let CoinType::Coin(coin) = client
+        .coins_to_spend(&owner, vec![(non_base_asset_id, 100, None)], None)
+        .await
+        .unwrap()[0][0]
+    else {
+        panic!("Expected a coin");
+    };
+
+    // Given


nit: multiple Given's here

rymnc

nice, i like how its easier to send tx transactions now :)

Added test to cover it

## Version 0.42.0 ### Breaking - [2648](#2648): Add feature-flagged field to block header `fault_proving_header` that contains a commitment to all transaction ids. - [2678](#2678): Removed public accessors for `BlockHeader` fields and replaced with methods instead, moved `tx_id_commitment` to the application header of `BlockHeaderV2`. - [2746](#2746): Breaking changes to the CLI arguments: - To disable `random-walk` just don't specify it. Before it required to use `--random-walk 0`. - Next CLI arguments were renamed: - `relayer-min-duration-s` -> `relayer-min-duration` - `relayer-eth-sync-call-freq-s` -> `relayer-eth-sync-call-freq` - `relayer-eth-sync-log-freq-s` -> `relayer-eth-sync-log-freq` - Default value for the `heartbeat-idle-duration` was changed from `1s` to `100ms`. So information about new block will be propagated faster by default. - All CLI arguments below use time(like `100ms`, `1s`, `1d`, etc.) use as a flag argument instead of number of seconds: - `random-walk` - `connection-idle-timeout` - `info-interval` - `identify-interval` - `request-timeout` - `connection-keep-alive` - `heartbeat-send-duration` - `heartbeat-idle-duration` - `heartbeat-check-interval` - `heartbeat-max-avg-interval` - `heartbeat-max-time-since-last` - `relayer-min-duration` - `relayer-eth-sync-call-freq` - `relayer-eth-sync-log-freq` - [2840](#2840): CLI argument `vm-backtrace` is deprecated and does nothing. It will be removed in a future version of `fuel-core`. The `extra_tx_checks` field was renamed into `forbid_fake_coins` that affects JSON based serialization/deserialization. Renamed `extra_tx_checks_default` field into `forbid_fake_coins_default`. ### Added - [2150](#2150): Upgraded `libp2p` to `0.54.1` and introduced `ConnectionLimiter` to limit pending incoming/outgoing connections. - [2491](#2491): Storage read replays of historical blocks for execution tracing. Only available behind `--historical-execution` flag. - [2619](#2619): Add possibility to submit list of changes to rocksdb. - [2666](#2666): Added two new CLI arguments to control the GraphQL queries consistency: `--graphql-block-height-tolerance` (default: `10`) and `--graphql-block-height-min-timeout` (default: `30s`). If a request requires a specific block height and the node is slightly behind, it will wait instead of failing. - [2682](#2682): Added GraphQL APIs to get contract storage and balances for current and past blocks. - [2719](#2719): Merklized DA compression temporal registry tables. - [2722](#2722): Service definition for state root service. - [2724](#2724): Explicit error type for merkleized storage. - [2726](#2726): Add a new gossip-sub message for transaction preconfirmations - [2731](#2731): Include `TemporalRegistry` trait implementations for v2 tables. - [2733](#2733): Add a pending pool transaction that allow transaction to wait a bit of time if an input is missing instead of direct delete. - [2742](#2742): Added API crate for merkle root service. - [2756](#2756): Add new service for managing pre-confirmations - [2769](#2769): Added a new `assembleTx` GraphQL endpoint. The endpoint can be used to assemble the transaction based on the provided requirements. - The returned transaction contains: - Input coins to cover `required_balances` - Input coins to cover the fee of the transaction based on the gas price from `block_horizon` - `Change` or `Destroy` outputs for all assets from the inputs - `Variable` outputs in the case they are required during the execution - `Contract` inputs and outputs in the case they are required during the execution - Reserved witness slots for signed coins filled with `64` zeroes - Set script gas limit(unless `script` is empty) - Estimated predicates, if `estimate_predicates == true` - Returns an error if: - The number of required balances exceeds the maximum number of inputs allowed. - The fee address index is out of bounds. - The same asset has multiple change policies(either the receiver of the change is different, or one of the policies states about the destruction of the token while the other does not). The `Change` output from the transaction also count as a `ChangePolicy`. - The number of excluded coin IDs exceeds the maximum number of inputs allowed. - Required assets have multiple entries. - If accounts don't have sufficient amounts to cover the transaction requirements in assets. - If a constructed transaction breaks the rules defined by consensus parameters. - [2780](#2780): Add implementations for the pre-confirmation signing task - [2784](#2784): Integrate the pre conf signature task into the main consensus task - [2788](#2788): Scaffold dedicated compression service. - [2799](#2799): Add a transaction waiter to the executor to wait for potential new transactions inside the block production window. Add a channel to send preconfirmation created by executor to the other modules Added a new CLI arguments: - `--production-timeout` to control the block production timeout in the case if block producer stuck. - `--poa-open-period` set the block production mode to `Open`. The `Open` mode starts the production of the next block immediately after the previous block. The block is open until the `period` passed. The period is a duration represented by `100ms`, `1s`, `1m`, etc. The manual block production is disabled if this production mode is used. - [2802](#2802): Add a new cache with outputs extracted from the pool for the duration of the block. - [2824](#2824): Introduce new `Try`-like methods for the `TaskNextAction` - [2840](#2840): Added a new CLI arguments: - `assemble-tx-dry-run-limit` - The max number how many times script can be executed during `assemble_tx` GraphQL request. Default value is `3` times. - `assemble-tx-estimate-predicates-limit` - The max number how many times predicates can be estimated during `assemble_tx` GraphQL request. Default values is `10` times. - [2841](#2841): Following endpoints allow estimation of predicates on submission of the transaction via new `estimatePredicates` argument: - `submit` - `submit_and_await` - `submit_and_await_status` The change is backward compatible with all SDKs. The change is not forward-compatible with Rust SDK in the case of the `estiamte_predicates` flag set. - [2844](#2844): Implement DA compression in `fuel-core-compression-service`. - [2845](#2845): New status to manage the pre confirmation status send in `TxUpdateSender`. - [2855](#2855): Add an expiration interval check for pending pool and refactor extracted_outputs to not rely on block creation/process sequence. - [2856](#2856): Add generic logic for managing the signatures and delegate keys for pre-confirmations signatures - [2862](#2862): Derive `enum_iterator::Sequence` and `strum_macros::{EnumCount, IntoStaticStr}` for MerkleizedColumn. ### Changed - [2388](#2388): Rework the P2P service codecs to avoid unnecessary coupling between components. The refactoring makes it explicit that the Gossipsub and RequestResponse codecs only share encoding/decoding functionalities from the Postcard codec. It also makes handling Gossipsub and RequestResponse messages completely independent of each other. - [2460](#2460): The type of the `max_response_size`for the postcard codec used in `RequestResponse` protocols has been changed from `usize` to `u64`. - [2473](#2473): Graphql requests and responses make use of a new `extensions` object to specify request/response metadata. A request `extensions` object can contain an integer-valued `required_fuel_block_height` field. When specified, the request will return an error unless the node's current fuel block height is at least the value specified in the `required_fuel_block_height` field. All graphql responses now contain an integer-valued `current_fuel_block_height` field in the `extensions` object, which contains the block height of the last block processed by the node. - [2618](#2618): Parallelize block/transaction changes creation in Importer - [2653](#2653): Added cleaner error for wasm-executor upon failed deserialization. - [2656](#2656): Migrate test helper function `create_contract` to `fuel_core_types::test_helpers::create_contract`, and refactor test in proof_system/global_merkle_root crate to use this function. - [2659](#2659): Replace `derivative` crate with `educe` crate. - [2705](#2705): Update the default value for `--max-block-size` and `--max-transmit-size` to 50 MB - [2715](#2715): Each GraphQL response contains `current_consensus_parameters_version` and `current_stf_version` in the `extensions` section. - [2723](#2723): Change the way we are building the changelog to avoids conflicts. - [2725](#2725): New txpool worker to remove lock contention - [2752](#2752): Extended the `TransactionStatus` to support pre-confirmations. - [2761](#2761): Renamed `ConsensusParametersProvider` to `ChainStateInfoProvider` because it is now providing more than just info about consensus parameters. - [2767](#2767): Updated fuel-vm to v0.60.0, see [release notes](https://github.com/FuelLabs/fuel-vm/releases/tag/v0.60.0). - [2781](#2781): Deprecate `dryRun` mutation. Use `dryRun` query instead. - [2791](#2791): Added `TxStatusManager` service which serves as a single source of truth regarding the current statuses of transactions - [2793](#2793): Moved common merkle storage trait implementations to `fuel-core-storage` and made it easier to setup a set of columns that need merkleization. - [2799](#2799): Change the block production to not be trigger after an interval but directly after the creation of last block and let the executor run for the block time window. - [2800](#2800): Implement P2P adapter for preconfirmation broadcasting - [2802](#2802): Change new txs notifier to be notified only on executable transactions - [2811](#2811): When the state rewind window of 7d was triggered, the `is_migration_in_progress` was repeatedly called, resulting in multiple iterations over the empty ModificationsHistoryV1 table. Iteration was slow because compaction didn't have a chance to clean up V1 table. We removed iteration from the migration process. - [2824](#2824): Improve conditions where `Error`s in the `PreConfirmationSignatureTask` stop the service - [2840](#2840): Removed `log_backtrace` logic from the executor. It is not needed anymore with the existence of the local debugger for the transactions. - [2865](#2865): Consider the following transaction statuses as final: `Success`, `Failure`, `SqueezedOut`, `PreConfirmationSqueezedOut`. All other statuses will be considered transient. ### Fixed - [2646](#2646): Improved performance of fetching block height by caching it when the view is created. - [2682](#2682): Fixed the issue with RPC consistency feature for the subscriptions(without the fix first we perform the logic of the query, and only after verify the required height). - [2730](#2730): Fixed RocksDB closing issue that potentially could panic. - [2743](#2743): Allow discovery of the peers when slots for functional connections are consumed. Reserved nodes are not affected by the limitation on connections anymore. - [2746](#2746): Fixed flaky part in the e2e tests and version compatibility tests. Speed up compatibility tests execution time. Decreased the default time between block height propagation throw the network. - [2758](#2758): Made `tx_id_commitment` feature flagged in `fuel-core-client`. - [2832](#2832): - Trigger block production only when all other sub services are started. - Fix relayer syncing issue causing block production to slow down occasionally. - [2840](#2840): Fixed `fuel-core-client` receipt deserialization in the case if the `ContractId` is zero. ### Removed - [2863](#2863): Removed everything related to the state root service, as it has been moved to another repo. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: AurelienFT <[email protected]>

xgreenx added 2 commits February 27, 2025 09:29

Started work on the assemble_tx endpoint.

8a6502c

Around 30-40% of main logic is done. The functional is quite big and in the future commits I will refactor it to use builder pattern.

Implemented remaining logic

a19bcc3

netrome assigned xgreenx and netrome Feb 27, 2025

netrome commented Feb 27, 2025

View reviewed changes

crates/fuel-core/src/coins_query.rs Show resolved Hide resolved

netrome added 4 commits February 27, 2025 10:27

fix: Updated integer types in client

8a5ff0c

feat: Support assembleTx in client

59bc96a

fix: Use HexString instead of passing around Vec<u8>

6d87183

fix: Integer changes in tests

2a42e40

netrome force-pushed the feature/assemble-tx branch from f4a4905 to 2a42e40 Compare February 27, 2025 14:24

netrome and others added 9 commits February 27, 2025 15:28

fix: Typo

1c3561d

fix: Cleanup

04660bd

Re-worked some tests to use new assemble tx API. ALong with it fixed …

2da4546

…several issues found in the endpoint.

Merge branch 'refs/heads/master' into feature/assemble-tx

cdf2970

Updated CHANGELOG

30177d0

Removed publishing from e2e tests Started to use `assembleTx` endpoint in more tests Fixed some issues discovered during updating of the tests

refactor: Tidy up FuelCoreClientExt trait

2bc6258

refactor: Simplify control flow in assemble_transaction impl

7f7df62

refactor: Reorder trait methods

208f60b

refactor: Tidy up AssembleTx::new logic

7fd6d51

netrome force-pushed the feature/assemble-tx branch from e088a07 to 7fd6d51 Compare February 28, 2025 10:18

netrome marked this pull request as ready for review February 28, 2025 13:57

netrome requested review from a team, xgreenx, Dentosal, MitchTurner, acerone85 and rymnc as code owners February 28, 2025 13:58

xgreenx added 2 commits February 28, 2025 11:30

Remove breaking change from API

0b38697

Use GraphQL to produce a block, it awaits off-chain database to index…

f307ba5

… messages

AurelienFT reviewed Mar 3, 2025

View reviewed changes

AurelienFT previously approved these changes Mar 6, 2025

View reviewed changes

netrome and others added 2 commits March 6, 2025 20:12

Merge branch 'master' into feature/assemble-tx

c0f51fe

Add more tests for the change and variable outputs

3c29542

xgreenx dismissed stale reviews from AurelienFT and themself via 3c29542 March 6, 2025 21:18

Handle cases with zero gas price and when we don't need base asset to…

dfd59ca

… cover free transaction

xgreenx previously approved these changes Mar 7, 2025

View reviewed changes

Make audit happy

7a42126

xgreenx dismissed their stale review via 7a42126 March 7, 2025 01:55

Merge branch 'master' into feature/assemble-tx

a5fed62

xgreenx previously approved these changes Mar 7, 2025

View reviewed changes

Merge branch 'master' into feature/assemble-tx

ca42157

rymnc reviewed Mar 7, 2025

View reviewed changes

rymnc previously approved these changes Mar 7, 2025

View reviewed changes

Fixed panic during adding change outputs.

1760da4

Added test to cover it

xgreenx dismissed stale reviews from rymnc and themself via 1760da4 March 9, 2025 02:32

xgreenx and others added 2 commits March 8, 2025 22:10

Make CI happy

13e0607

Merge branch 'master' into feature/assemble-tx

4ce0dc9

AurelienFT approved these changes Mar 11, 2025

View reviewed changes

xgreenx added 2 commits March 11, 2025 12:03

Merge branch 'master' into feature/assemble-tx

876241e

Merge branch 'master' into feature/assemble-tx

14f842a

xgreenx approved these changes Mar 11, 2025

View reviewed changes

xgreenx merged commit 88567d4 into master Mar 11, 2025
34 checks passed

xgreenx deleted the feature/assemble-tx branch March 11, 2025 19:10

xgreenx restored the feature/assemble-tx branch March 11, 2025 19:11

This was referenced Mar 18, 2025

Release v0.42.0 #2877

Merged

test #2878

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `AssembleTx` query #2769

feat: `AssembleTx` query #2769

netrome commented Feb 27, 2025 •

edited by xgreenx

Loading

AurelienFT left a comment

rymnc Mar 7, 2025 •

edited

Loading

rymnc Mar 7, 2025

rymnc left a comment

	desc = "Perform the estimation of the predicates before cover fee of the transaction"
	desc = "Perform estimation of the predicates before covering fee of the transaction"

feat: AssembleTx query #2769

feat: AssembleTx query #2769

Conversation

netrome commented Feb 27, 2025 • edited by xgreenx Loading

AurelienFT left a comment

Choose a reason for hiding this comment

rymnc Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

rymnc Mar 7, 2025

Choose a reason for hiding this comment

rymnc left a comment

Choose a reason for hiding this comment

feat: `AssembleTx` query #2769

feat: `AssembleTx` query #2769

netrome commented Feb 27, 2025 •

edited by xgreenx

Loading

rymnc Mar 7, 2025 •

edited

Loading