feat!: add support for dynamic configurables #1555

hal3e · 2024-12-09T16:26:30Z

closes: #1481
closes: #1328 as we can read the configurables directly from the binary

BLOCKED until we have a compiler that supports both abi-errors and dynamic configurables.

Release notes

In this release, we:

Added support for dynamic str configurables.
Added a new configurables reader to contract, script and predicateabigen that can read configurables directly form the binary.
Added struct ConfigurablesReader that can be used to read direct and indirect configurables at runtime and compile time.
Added tests for configurables with loades for contracts, scripts and predicates.
Updated documentation.

Summary

Breaking Changes

Contract Regular and Loader methods code(), contract_id(), code_root, state_root return Result
Executable Regular and Loader methods code(), data_offset_in_code, loader_code return Result
Configurables's update_constants_in returns Result
Predicate's with_configurable returns Result
AbiFormatter's decode_configurables argument configurable_data now accepts a &[u8]

Checklist

All changes are covered by tests (or not applicable)
All changes are documented (or not applicable)
I reviewed the entire PR myself (preferably, on GH UI)
I described all Breaking Changes (or there's none)

e2e/Forc.toml

e2e/tests/configurables.rs

e2e/tests/predicates.rs

packages/fuels-core/src/lib.rs

segfault-magnet

We should probably hold off on merging this until the sway branch catches up with sway master.

I have a feeling it's a bit behind seeing how the configurables offset is 8..16 and not 16..24 seeing as we already support the latter.

Either wait or integrate with the work done in the PR mentioned above so that we detect the compiler version used to generate the sway binary and use 16..24 if it is a modern compiler or 8..16 if it is the older one.

e2e/tests/configurables.rs

packages/fuels-code-gen/src/program_bindings/abigen/configurables.rs

packages/fuels-core/src/lib.rs

segfault-magnet · 2025-02-24T20:20:43Z

packages/fuels-programs/src/contract/regular.rs

@@ -51,10 +51,11 @@ mod code_types {
            }
        }

-        pub(crate) fn code(&self) -> Vec<u8> {
+        pub(crate) fn code(&self) -> Result<Vec<u8>> {


Wdyt about having with_code and with_configurables return a Result, trying to apply the old configurables to the new code or the new configurables to the old code.

If that passes then we can .expect on all the getters and not have Result everywhere.

Nice consequence is that it will fail closer to the thing that made it fail -- ie the code or the configurables that were invalid, not later on when you try and calculate the contract id.

I like the idea.

In the end you chose to not do it @hal3e ?

improve tests with comments Co-authored-by: Ahmed Sagdati <[email protected]>

AurelienFT

I don't understand all the details of each line and interactions but I understood the tests and the main idea and didn't see anything that shocked me. If the tests added pass I think the PR answers the need from an un-educated point of view.

In any cases thank you to not let long time PR die !

AurelienFT · 2025-04-11T15:27:08Z

packages/fuels-programs/src/contract/regular.rs

@@ -51,10 +51,11 @@ mod code_types {
            }
        }

-        pub(crate) fn code(&self) -> Vec<u8> {
+        pub(crate) fn code(&self) -> Result<Vec<u8>> {


In the end you chose to not do it @hal3e ?

AurelienFT · 2025-04-11T15:37:19Z

e2e/tests/configurables.rs

-        new_enum,
+        6,
+        "sway-sway".try_into()?,
+        "forc".try_into()?,


Might be nice to explain why "forc" here. I understood that it's the default configurable in the sway contract but it requires a lot of context for this magic word

It is just a random string we encode and decode. It is hard-coded in the binary and defined in the main.sw file

AurelienFT · 2025-04-11T15:47:24Z

packages/fuels-core/src/utils/offsets.rs

    Ok(base_offset_script(consensus_parameters) + padded_len)
 }
+
+pub fn extract_data_offset(binary: &[u8]) -> Result<usize> {
+    extract_offset_at(binary, 8)


Might not compile due to type of size_of returns but the idea :

Suggested change

extract_offset_at(binary, 8)

extract_offset_at(binary, size_of::<usize>())

AurelienFT · 2025-04-11T15:47:34Z

packages/fuels-core/src/utils/offsets.rs

+}
+
+pub fn extract_offset_at(binary: &[u8], offset: usize) -> Result<usize> {
+    if binary.len() < offset + 8 {


Might not compile due to type of size_of returns but the idea :

Suggested change

if binary.len() < offset + 8 {

if binary.len() < offset + size_of::<usize>() {

AurelienFT · 2025-04-11T16:03:58Z

packages/fuels-core/src/lib.rs

@@ -3,53 +3,297 @@ pub mod traits;
 pub mod types;


All the functions seems to use a lot of offset in a lot of different orders and modifying some buffers that doesn't make sense for a first-time reader. Can you maybe add some documentation at the top of this file for the module and maybe document the functions you created.

EDIT: The documentation on the tests helps a lot to understands the data we are editing here thanks a lot.

hal3e added 4 commits December 9, 2024 12:30

update fuel-abi-types

9879875

update

2ab1409

Work in progress

0f32147

feat!: add support for dynamic configurables

8715d1c

hal3e added the blocked label Dec 9, 2024

hal3e self-assigned this Dec 9, 2024

hal3e added 12 commits December 10, 2024 11:25

update ciyml

82412bc

Merge branch 'master' into hal3e/dynamic-configurables

4675e3f

merge master

542d272

refactor code

54a7842

refactor code

1fb0acb

Work in progress

9f34af8

Merge branch 'master' into hal3e/dynamic-configurables

606d9fe

fix fmt

692edea

Merge branch 'master' into hal3e/dynamic-configurables

3253173

bump fuel-abi-types

e42c91a

Merge branch 'master' into hal3e/dynamic-configurables

94efe89

forc fmt

9d8e166

arboleya mentioned this pull request Jan 16, 2025

Add Support for Dynamic Configurables FuelLabs/fuels-ts#3593

Open

hal3e added 11 commits January 16, 2025 13:15

fix typos

1f3989d

Merge branch 'master' into hal3e/dynamic-configurables

9decbcf

updates

b37ed25

fix todos

2991da7

small improvements

45238c2

merge master

c5da416

Work in progress

1fdb690

Merge branch 'master' into hal3e/dynamic-configurables

b14b1c9

add tests

a0aeffe

var names

186137f

add documentation

11334ca

hal3e and others added 4 commits February 18, 2025 15:47

merge master

77fb33a

PR comments 1st version

685e5dd

refactor

3b64c60

Merge branch 'master' into hal3e/dynamic-configurables

110ae71

MujkicA reviewed Feb 24, 2025

View reviewed changes

segfault-magnet reviewed Feb 24, 2025

View reviewed changes

hal3e and others added 5 commits February 27, 2025 12:10

merge master

dd0bc27

fix fee todos

6d607cd

remove dbg

b6dbd0a

Apply suggestions from code review

fc9fc4e

improve tests with comments Co-authored-by: Ahmed Sagdati <[email protected]>

add fn docstring

40afe0e

hal3e mentioned this pull request Apr 10, 2025

remove Forc.toml and ci.yml patche after dynamic configurables are supported by a new sway release #1610

Open

merge master

da65b6c

hal3e requested a review from a team as a code owner April 11, 2025 11:26

Merge branch 'master' into hal3e/dynamic-configurables

b382e17

AurelienFT requested review from AurelienFT and removed request for digorithm and Salka1988 April 11, 2025 15:06

AurelienFT reviewed Apr 11, 2025

View reviewed changes

hal3e added 9 commits April 14, 2025 13:56

Merge branch 'master' into hal3e/dynamic-configurables

7d1ee87

work in progress

97fd0b8

merge master

70c0be8

Merge branch 'master' into hal3e/dynamic-configurables

040a4d0

Merge branch 'master' into hal3e/dynamic-configurables

398588e

add documentation

13d2317

add docstring

fa7cc9c

pr comments

5ca433d

fix spelling

bf24659

hal3e added the blocked label May 26, 2025

cargo fmt

1e0dc14

	extract_offset_at(binary, 8)
	extract_offset_at(binary, size_of::<usize>())

	if binary.len() < offset + 8 {
	if binary.len() < offset + size_of::<usize>() {

feat!: add support for dynamic configurables #1555

Are you sure you want to change the base?

feat!: add support for dynamic configurables #1555

Uh oh!

Conversation

hal3e commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release notes

Summary

Breaking Changes

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

segfault-magnet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AurelienFT left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hal3e May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hal3e commented Dec 9, 2024 •

edited

Loading

hal3e May 26, 2025 •

edited

Loading