Skip to content

Optimize tx module for bytecode size and gas usage #7087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 14, 2025
Merged

Optimize tx module for bytecode size and gas usage #7087

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a15aa59
Optimize `tx` module for bytecode size and gas usage
ironcev Apr 14, 2025
e5739d8
Format `tx` with `forc fmt`
ironcev Apr 14, 2025
7d99d5a
Merge branch 'master' into ironcev/optimize-tx-module
ironcev Apr 14, 2025
851fca8
Further optimized `tx_witness_count` and `tx_witness_pointer`
ironcev Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 55 additions & 102 deletions sway-lib-std/src/tx.sw
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ impl PartialEq for Transaction {
}
impl Eq for Transaction {}

const TX_TYPE_SCRIPT: u8 = 0u8;
const TX_TYPE_CREATE: u8 = 1u8;
#[allow(dead_code)]
const TX_TYPE_MINT: u8 = 2u8;
const TX_TYPE_UPGRADE: u8 = 3u8;
const TX_TYPE_UPLOAD: u8 = 4u8;
const TX_TYPE_BLOB: u8 = 5u8;

/// Get the type of the current transaction.
///
/// # Returns
Expand Down Expand Up @@ -120,11 +128,11 @@ impl Eq for Transaction {}
/// ```
pub fn tx_type() -> Transaction {
match __gtf::<u8>(0, GTF_TYPE) {
0u8 => Transaction::Script,
1u8 => Transaction::Create,
3u8 => Transaction::Upgrade,
4u8 => Transaction::Upload,
5u8 => Transaction::Blob,
TX_TYPE_SCRIPT => Transaction::Script,
TX_TYPE_CREATE => Transaction::Create,
TX_TYPE_UPGRADE => Transaction::Upgrade,
TX_TYPE_UPLOAD => Transaction::Upload,
TX_TYPE_BLOB => Transaction::Blob,
_ => revert(0),
}
}
Expand Down Expand Up @@ -276,9 +284,10 @@ pub fn tx_max_fee() -> Option<u64> {
/// }
/// ```
pub fn tx_script_length() -> Option<u64> {
match tx_type() {
Transaction::Script => Some(__gtf::<u64>(0, GTF_SCRIPT_SCRIPT_LENGTH)),
_ => None,
if __gtf::<u8>(0, GTF_TYPE) == TX_TYPE_SCRIPT {
Some(__gtf::<u64>(0, GTF_SCRIPT_SCRIPT_LENGTH))
} else {
None
}
}

Expand All @@ -299,9 +308,10 @@ pub fn tx_script_length() -> Option<u64> {
/// }
/// ```
pub fn tx_script_data_length() -> Option<u64> {
match tx_type() {
Transaction::Script => Some(__gtf::<u64>(0, GTF_SCRIPT_SCRIPT_DATA_LENGTH)),
_ => None,
if __gtf::<u8>(0, GTF_TYPE) == TX_TYPE_SCRIPT {
Some(__gtf::<u64>(0, GTF_SCRIPT_SCRIPT_DATA_LENGTH))
} else {
None
}
}

Expand All @@ -326,12 +336,9 @@ pub fn tx_script_data_length() -> Option<u64> {
/// }
/// ```
pub fn tx_witnesses_count() -> u64 {
match tx_type() {
Transaction::Script => __gtf::<u64>(0, GTF_SCRIPT_WITNESSES_COUNT),
Transaction::Create => __gtf::<u64>(0, GTF_CREATE_WITNESSES_COUNT),
Transaction::Upgrade => __gtf::<u64>(0, GTF_SCRIPT_WITNESSES_COUNT),
Transaction::Upload => __gtf::<u64>(0, GTF_SCRIPT_WITNESSES_COUNT),
Transaction::Blob => __gtf::<u64>(0, GTF_SCRIPT_WITNESSES_COUNT),
match __gtf::<u8>(0, GTF_TYPE) {
TX_TYPE_SCRIPT | TX_TYPE_UPGRADE | TX_TYPE_UPLOAD | TX_TYPE_BLOB => __gtf::<u64>(0, GTF_SCRIPT_WITNESSES_COUNT),
TX_TYPE_CREATE => __gtf::<u64>(0, GTF_CREATE_WITNESSES_COUNT),
_ => revert(0),
}
}
Expand Down Expand Up @@ -361,12 +368,9 @@ fn tx_witness_pointer(index: u64) -> Option<raw_ptr> {
return None
}

match tx_type() {
Transaction::Script => Some(__gtf::<raw_ptr>(index, GTF_SCRIPT_WITNESS_AT_INDEX)),
Transaction::Create => Some(__gtf::<raw_ptr>(index, GTF_CREATE_WITNESS_AT_INDEX)),
Transaction::Upgrade => Some(__gtf::<raw_ptr>(index, GTF_SCRIPT_WITNESS_AT_INDEX)),
Transaction::Upload => Some(__gtf::<raw_ptr>(index, GTF_SCRIPT_WITNESS_AT_INDEX)),
Transaction::Blob => Some(__gtf::<raw_ptr>(index, GTF_SCRIPT_WITNESS_AT_INDEX)),
match __gtf::<u8>(0, GTF_TYPE) {
TX_TYPE_SCRIPT | TX_TYPE_UPGRADE | TX_TYPE_UPLOAD | TX_TYPE_BLOB => Some(__gtf::<raw_ptr>(index, GTF_SCRIPT_WITNESS_AT_INDEX)),
TX_TYPE_CREATE => Some(__gtf::<raw_ptr>(index, GTF_CREATE_WITNESS_AT_INDEX)),
_ => None,
}
}
Expand Down Expand Up @@ -429,13 +433,9 @@ pub fn tx_witness_data<T>(index: u64) -> Option<T> {
return None
}

let length = match tx_witness_data_length(index) {
Some(len) => len,
None => return None,
};

let witness_data_ptr = __gtf::<raw_ptr>(index, GTF_WITNESS_DATA);
if __is_reference_type::<T>() {
let witness_data_ptr = __gtf::<raw_ptr>(index, GTF_WITNESS_DATA);
let length = __gtf::<u64>(index, GTF_WITNESS_DATA_LENGTH);
let new_ptr = alloc_bytes(length);
witness_data_ptr.copy_bytes_to(new_ptr, length);

Expand All @@ -445,59 +445,13 @@ pub fn tx_witness_data<T>(index: u64) -> Option<T> {
} else {
// u8 is the only value type that is less than 8 bytes and should be handled separately
if __size_of::<T>() == 1 {
Some(__gtf::<raw_ptr>(index, GTF_WITNESS_DATA).add::<u8>(7).read::<T>())
Some(witness_data_ptr.add::<u8>(7).read::<T>())
} else {
Some(__gtf::<raw_ptr>(index, GTF_WITNESS_DATA).read::<T>())
Some(witness_data_ptr.read::<T>())
}
}
}

/// Get the transaction script start pointer.
///
/// # Returns
///
/// * [Option<raw_ptr>] - The transaction script start pointer.
///
/// # Examples
///
/// ```sway
/// use std::tx::tx_script_start_pointer;
///
/// fn foo() {
/// let script_start_pointer = tx_script_start_pointer().unwrap();
/// log(script_start_pointer);
/// }
/// ```
fn tx_script_start_pointer() -> Option<raw_ptr> {
match tx_type() {
Transaction::Script => Some(__gtf::<raw_ptr>(0, GTF_SCRIPT_SCRIPT)),
_ => None,
}
}

/// Get the transaction script data start pointer.
///
/// # Returns
///
/// * [Option<raw_ptr>] - The transaction script data start pointer.
///
/// # Examples
///
/// ```sway
/// use std::tx::tx_script_data_start_pointer;
///
/// fn foo() {
/// let script_data_start_pointer = tx_script_data_start_pointer().unwrap();
/// log(script_data_start_pointer);
/// }
/// ```
fn tx_script_data_start_pointer() -> Option<raw_ptr> {
match tx_type() {
Transaction::Script => Some(__gtf::<raw_ptr>(0, GTF_SCRIPT_SCRIPT_DATA)),
_ => None,
}
}

/// Get the script data, typed.
///
/// # Additional Information
Expand All @@ -520,13 +474,12 @@ fn tx_script_data_start_pointer() -> Option<raw_ptr> {
/// }
/// ```
pub fn tx_script_data<T>() -> Option<T> {
let ptr = tx_script_data_start_pointer();
if ptr.is_none() {
return None
if __gtf::<u8>(0, GTF_TYPE) == TX_TYPE_SCRIPT {
// TODO some safety checks on the input data? We are going to assume it is the right type for now.
Some(__gtf::<raw_ptr>(0, GTF_SCRIPT_SCRIPT_DATA).read::<T>())
} else {
None
}

// TODO some safety checks on the input data? We are going to assume it is the right type for now.
Some(ptr.unwrap().read::<T>())
}

/// Get the script bytecode.
Expand All @@ -551,9 +504,10 @@ pub fn tx_script_data<T>() -> Option<T> {
/// }
/// ```
pub fn tx_script_bytecode<T>() -> Option<T> {
match tx_type() {
Transaction::Script => Some(tx_script_start_pointer().unwrap().read::<T>()),
_ => None,
if __gtf::<u8>(0, GTF_TYPE) == TX_TYPE_SCRIPT {
Some(__gtf::<raw_ptr>(0, GTF_SCRIPT_SCRIPT).read::<T>())
} else {
None
}
}

Expand All @@ -574,22 +528,21 @@ pub fn tx_script_bytecode<T>() -> Option<T> {
/// }
/// ```
pub fn tx_script_bytecode_hash() -> Option<b256> {
match tx_type() {
Transaction::Script => {
// Get the script memory details
let mut result_buffer = b256::zero();
let script_length = tx_script_length().unwrap();
let script_ptr = tx_script_start_pointer().unwrap();

// Run the hash opcode for the script in memory
Some(
asm(hash: result_buffer, ptr: script_ptr, len: script_length) {
s256 hash ptr len;
hash: b256
},
)
},
_ => None,
if __gtf::<u8>(0, GTF_TYPE) == TX_TYPE_SCRIPT {
// Get the script memory details
let mut result_buffer = b256::zero();
let script_length = __gtf::<u64>(0, GTF_SCRIPT_SCRIPT_LENGTH);
let script_ptr = __gtf::<raw_ptr>(0, GTF_SCRIPT_SCRIPT);

// Run the hash opcode for the script in memory
Some(
asm(hash: result_buffer, ptr: script_ptr, len: script_length) {
s256 hash ptr len;
hash: b256
},
)
} else {
None
}
}

Expand Down
Loading