Release v0.24.0

[bitzoic]

Type of change

• Release

[Version 0.24.0]

Added v0.24.0

• #285 Adds the BytecodeRoot and ContractConfigurables types to the Bytecode Library.
• #286 Adds the _metadata() function to the Asset Library.

Changed v0.24.0

• #286 Updates the repository to Sway-Standards v0.6.0 and implements the new SRC-20 and SRC-7 logging specifications.
• #286 _set_metadata(), _set_name() and _set_symbol() now revert if the metadata is an empty string.
• #286 _set_metadata() now reverts if the metadata is empty bytes.
• #286 _mint() and _burn() now revert if the amount argument is zero.
• #289 Bumps Sway-Libs to forc v0.63.3, fuel-core v0.34.0, and fuels v0.66.2.
• #290 Update the Upgradeability library to use a specific storage slot for owner functionality.
• #291 Prepares for the v0.24.0 release.

Breaking v0.24.0

• #285 Removes _with_configurables() functions from Bytecode Library in favor of using an Option.

The following demonstrates the breaking change.

Before:

// Compute bytecode root
let root_no_configurables: BytecodeRoot = compute_bytecode_root(my_bytecode);
let root_with_configurables: BytecodeRoot = compute_bytecode_root_with_configurables(my_bytecode, my_configurables);

// Compute predicate address
let address_no_configurables: Address = compute_predicate_address(my_bytecode);
let address_with_configurables: Address = compute_predicate_address_with_configurables(my_bytecode, my_configurables);

// Verify contract bytecode
verify_contract_bytecode(my_contract_id, my_bytecode); // No configurables
verify_contract_bytecode_with_configurables(my_contract_id, my_bytecode, my_configurables); // With configurables

// Verify predicate address
verify_predicate_address(my_predicate_address, my_bytecode); // No configurables
verify_predicate_address_with_configurables(my_predicate_address, my_bytecode, my_configurables); // With configurables

After:

// Compute bytecode root
let root_no_configurables: BytecodeRoot = compute_bytecode_root(my_bytecode, None);
let root_with_configurables: BytecodeRoot = compute_bytecode_root(my_bytecode, Some(my_configurables));

// Compute predicate address
let address_no_configurables: Address = compute_predicate_address(my_bytecode, None);
let address_with_configurables: Address = compute_predicate_address(my_bytecode, Some(my_configurables));

// Verify contract bytecode
verify_contract_bytecode(my_contract_id, my_bytecode, None); // No configurables
verify_contract_bytecode(my_contract_id, my_bytecode, Some(my_configurables)); // With configurables

// Verify predicate address
verify_predicate_address(my_predicate_address, my_bytecode, None); // No configurables
verify_predicate_address(my_predicate_address, my_bytecode, Some(my_configurables)); // With configurables

• #286 The support functions for Metadata have been removed. They have been moved to sway-standards.

Before:

use sway_libs::asset::metadata::*;

fn foo(my_metadata: Metadata) {
     let res: bool = my_metadata.is_b256(); 
     let res: bool = my_metadata.is_string(); 
     let res: bool = my_metadata.is_bytes(); 
     let res: bool = my_metadata.is_uint();
}

After:

use standards::src7::*;

fn foo(my_metadata: Metadata) {
     let res: bool = my_metadata.is_b256(); 
     let res: bool = my_metadata.is_string(); 
     let res: bool = my_metadata.is_bytes(); 
     let res: bool = my_metadata.is_uint();
}

• #286 The SetMetadata abi set_metadata function definition has changed. The metadata argument is now an Option<Metadata> and the argument order has changed.

Before:

abi SetAssetMetadata {
    #[storage(read, write)]
    fn set_metadata(asset: AssetId, key: String, metadata: Metadata);
}

After:

abi SetAssetMetadata {
    #[storage(read, write)]
    fn set_metadata(asset: AssetId, metadata: Option<Metadata>, key: String);
}

• #286 The _set_name(), _set_symbol(), _mint(), and _set_metdata() functions name, symbol, sub_id, and metadata arguments are now Options.

Before:

fn foo(asset: AssetId, recipient: Identity, amount: u64, key: String, metadata: Metadata) {
    _set_name(storage.name, asset, String::from_ascii_str("Ether"));
    _set_symbol(storage.symbol, asset, String::from_ascii_str("ETH"));
    _mint(storage.total_assets, storage.total_supply, recipient, SubId::zero(), amount);
    _set_metadata(storage.metadata, asset, key, metadata);
}

After:

fn foo(asset: AssetId, recipient: Identity, amount: u64, metadata: Metadata, key: String) {
    _set_name(storage.name, asset, Some(String::from_ascii_str("Ether")));
    _set_symbol(storage.symbol, asset, Some(String::from_ascii_str("ETH")));
    _mint(storage.total_assets, storage.total_supply, recipient, Some(SubId::zero()), amount);
    // Note: Ordering of arguments has changed for `_set_metadata()`
    _set_metadata(storage.metadata, asset, Some(metadata), key);
}

• #290 The _proxy_owner(), only_proxy_owner() and _set_proxy_owner() functions no longer take storage.proxy_owner as a parameter. Instead they directly read and write to the storage slot 0xbb79927b15d9259ea316f2ecb2297d6cc8851888a98278c0a2e03e1a091ea754 which is sha256("storage_SRC14_1").

Before:

fn foo() {
    let stored_proxy_owner = _proxy_owner(storage.proxy_owner);
    only_proxy_owner(storage.proxy_owner);
    _set_proxy_owner(new_proxy_owner, storage.proxy_owner);
}

After:

fn foo() {
    let stored_proxy_owner = _proxy_owner();
    only_proxy_owner();
    _set_proxy_owner(new_proxy_owner);
}

[bitzoic]

Closing for now and will reopen