Fix links in Upgradeability Library docs #304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
K1-R1
previously approved these changes
Oct 23, 2024
|
Requires #305 to be merged first |
SwayStar123
approved these changes
Oct 29, 2024
K1-R1
approved these changes
Oct 29, 2024
bitzoic
added a commit
that referenced
this pull request
Dec 16, 2024
commit 44066b12344979514426c14ae8088c1690fc34d6 Author: Cameron Carstens <[email protected]> Date: Sat Dec 14 08:51:45 2024 +0000 Prepare master for version v0.24.1 (#314) ## Type of change <!--Delete points that do not apply--> - Release ## Changes The following changes have been made: - Updates all instances and mentions of v0.24.0 to v0.24.1 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 24d01a6bccf6ada68317dcd90df92424c36223a7 Author: SwayStar123 <[email protected]> Date: Thu Dec 12 18:00:17 2024 +0530 Fix readme link (#311) ## Type of change - Bug fix ## Changes Old link lead to queue, corrected the link ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. Co-authored-by: Cameron Carstens <[email protected]> commit 0cec568c6cf6ffd2dfcbafc4dd7ae012f6ab8b01 Author: Cameron Carstens <[email protected]> Date: Tue Dec 10 23:09:39 2024 +0000 Reentrancy Tests with Proxy (#310) ## Type of change <!--Delete points that do not apply--> - New feature ## Changes The following changes have been made: - Adds tests to ensure that the reentrancy guard works with a proxy contract - Refactors the reentrancy guard test contracts to use storage ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 8e40e68032aaa1fb9afdda70f2ca8ee5e5e8c4e4 Author: Call Delegation <[email protected]> Date: Tue Dec 10 11:10:25 2024 -0500 docs: Link checker (#313) ## Type of change Link checker so that broken links are caught before it reaches the docs hub ## Related Issues [<!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number-->](https://github.com/FuelLabs/docs-hub/pull/533) ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. commit 7c4c4643176450d9214a83c803fd5be6e79f54e5 Author: Cameron Carstens <[email protected]> Date: Fri Nov 29 11:41:01 2024 +0100 Add fallback tests to reentrancy guard library (#309) ## Type of change <!--Delete points that do not apply--> - New feature ## Changes The following changes have been made: - Adds tests to the reentrancy guard library using the `fallback` function, ensuring the reentrancy guard still works ## Notes - This Pr compliments #307 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: K1-R1 <[email protected]> commit f901f5097690b060ae2d6df469f893112d579150 Author: Cameron Carstens <[email protected]> Date: Wed Nov 27 01:56:14 2024 +0700 Remove comments on cross-contract reentrancy venerability (#308) ## Type of change <!--Delete points that do not apply--> - Documentation ## Changes The following changes have been made: - Removed cautionary note on cross-contract vulnerability in inline docs - Removed comment on cross-contract vulnerability in documentation - Added note stating cross-contract reentrancy not possible but to still exercise caution ## Notes - Cross-contract reentrancy occurs when a contract like a vault issues and manages assets for token contract. However, as Fuel uses native assets, no contract call must be made to update balances. Therefore it is not possible to perform a cross-contract reentrancy attack. - A cautionary note on relying on other contracts for state has been added as this can introduce dependency attacks. ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #307 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 03f8ff9939471f0a5b6659e1b91c14e4bf39a9b7 Author: Cameron Carstens <[email protected]> Date: Fri Nov 1 10:06:43 2024 +0700 Fix links in Upgradeability Library docs (#304) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Changes The following changes have been made: - Fixes links to the SRC-14 documentation ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #303 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: K1-R1 <[email protected]> commit 5e3977190a72912104e8aec16d64de5479cea0db Author: Cameron Carstens <[email protected]> Date: Wed Oct 30 12:11:01 2024 +0700 Update SRC-7 naming (#306) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) - Documentation ## Changes The following changes have been made: - Updates the SRC-7 naming to "Onchain Asset Metadata Standard" - Adds comments on the SRC-7 intent for stateful metadata ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: K1-R1 <[email protected]> commit 2aed0cae3de22fe0fd56c6ac7d42502b14170c28 Author: Call Delegation <[email protected]> Date: Tue Oct 29 04:24:52 2024 -0400 docs: Fix ignition docs (#300) ## Type of change <!--Delete points that do not apply--> - Bug fix - New feature - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) - Documentation - Other (describe below) ## Changes The following changes have been made: - Change 1 - Change 2 ## Notes - Note 1 ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #\<issue number\> ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. Co-authored-by: K1-R1 <[email protected]> Co-authored-by: Cameron Carstens <[email protected]> commit 9927e985a56466fdfbf89a248aca4388e89e004f Author: mcisb <[email protected]> Date: Mon Oct 28 13:48:50 2024 +0300 chore: fix md typos (#302) Co-authored-by: K1-R1 <[email protected]> commit 05f8644817b20406d068913184c708ab12c60299 Author: Cameron Carstens <[email protected]> Date: Fri Oct 25 09:21:44 2024 +0545 Update to forc v0.66.2, fuel-core v0.40. and fuels-rs v0.66.9 (#305) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - Updates to forc v0.66.2 - Updates to fuel-core v0.40.0 - Updates to fuels-rs v0.66.9 ## Notes - This PR fixes CI on the repository and must be merged first ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 50107770ff892d0d997c33dd469b6913b3d49fec Author: Cameron Carstens <[email protected]> Date: Mon Sep 23 18:41:02 2024 +0545 Fix README headers (#298) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Changes The following changes have been made: - Makes the Upgradability libraries header an h4 over and h2 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit d77ab39d050f051b189620b8d6474aea7d271fbf Author: Call Delegation <[email protected]> Date: Thu Sep 5 09:27:22 2024 -0400 Fixe docs anchor for basic SRC-7 example (#297) ## Type of change <!--Delete points that do not apply--> - Bug fix - Documentation ## Changes The following changes have been made: - Fixes docs anchor for basic SRC-7 example ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: bitzoic <[email protected]> commit b03cc281241b36945da0fa3bd816862219334c25 Author: Cameron Carstens <[email protected]> Date: Fri Aug 30 21:52:16 2024 +0800 Revert breaking changes to asset library (#294) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - Removes the breaking changes from the asset library made in https://github.com/FuelLabs/sway-libs/pull/286 - Leaves improvements made in https://github.com/FuelLabs/sway-libs/pull/286 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 93cfa355e74d7a4088372b9b930e653d784cbb86 Author: Cameron Carstens <[email protected]> Date: Fri Aug 30 21:43:51 2024 +0800 Revert remove _with_configurables functions from Bytecode Library and use Option instead (#293) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - Removes the breaking changes from https://github.com/FuelLabs/sway-libs/pull/285 - Leaves the `BytecodeRoot` and `Contractconfigurables` types ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. commit 74ab16895b79e3f82185613008b3d6ad59702dc3 Author: Cameron Carstens <[email protected]> Date: Fri Aug 30 20:23:25 2024 +0800 Prepare for v0.24.0 release (#291) ## Type of change <!--Delete points that do not apply--> - Release ## Changes The following changes have been made: - Prepares master for the v0.24.0 release ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit d67f94cdb91ffa2df2ff4c599c7c4cd3bd567331 Author: K1-R1 <[email protected]> Date: Fri Aug 30 09:23:18 2024 +0100 Upgradeability: use specific storage slot for owner functionality (#290) ## Type of change - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - The upgradeability lib has been updated to use a specific storage slot for the proxy owner - The upgradeability example has been updated to use a specific storage slot for the proxy owner - The upgradeability test contract has been updated to use a specific storage slot for the proxy owner ## Notes 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")`. ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #287 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: bitzoic <[email protected]> commit fda3ebc733a2707270e8fd66005155afb3f90cab Author: K1-R1 <[email protected]> Date: Fri Aug 30 09:08:30 2024 +0100 Update to forc 0.63.3 and fuel-rs 0.66.2 (#289) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - Update to forc 0.63.3 and fuel-core 0.34.0 - Update to fuel-rs 0.66.2 ## Notes - Bytecode tests are currently failing ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #288 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: bitzoic <[email protected]> commit e60e82e5e3002fe6606c1021550c50fb7083f100 Author: Cameron Carstens <[email protected]> Date: Fri Aug 30 10:56:45 2024 +0800 Update to Sway-Standards v0.6.0 (#286) ## Type of change <!--Delete points that do not apply--> - Breaking - New feature - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Breaking The following breaking changes have been made: 1. The support functions for `Metadata` have been removed. They have been moved to sway-standards. Before: ```sway 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: ```sway 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(); } ``` 2. The `SetMetadata` and `_set_metadata` function definitions have changed. The `metadata` argument is now an `Option<Metadata>` and the argument order has changed. Before: ```sway impl SetAssetMetadata for Contract { #[storage(read, write)] fn set_metadata(asset: AssetId, key: String, metadata: Metadata) { _set_metadata(storage.metadata, asset, key, metadata); } } ``` After: ```sway impl SetAssetMetadata for Contract { #[storage(read, write)] fn set_metadata(asset: AssetId, metadata: Option<Metadata>, key: String) { _set_metadata(storage.metadata, asset, metadata, key); } } ``` 3. The `_set_name()` function's `name` argument is now an `Option<String>` Before: ```sway fn foo(asset: AssetId) { _set_name(storage.name, asset, String::from_ascii_str("Ether")); } ``` After: ```sway fn foo(asset: AssetId) { _set_name(storage.name, asset, Some(String::from_ascii_str("Ether"))); } ``` 3. The `_set_symbol()` function's `name` argument is now an `Option<String>` Before: ```sway fn foo(asset: AssetId) { _set_symbol(storage.name, asset, String::from_ascii_str("ETH")); } ``` After: ```sway fn foo(asset: AssetId) { _set_symbol(storage.name, asset, Some(String::from_ascii_str("ETH"))); } ``` 4. The `_mint()` function's `sub_id` argument is now an `Option<SubId>` Before: ```sway fn foo(recipient: Identity, amount: u64) { let asset_id = _mint(storage.total_assets, storage.total_supply, recipient, SubId::zero(), amount); } ``` After: ```sway fn foo(recipient: Identity, amount: u64) { let asset_id = _mint(storage.total_assets, storage.total_supply, recipient, Some(SubId::zero()), amount); } ``` ## Changes The following changes have been made: - Updated all `Forc.toml` files to use sway-standards `v0.6.0` - Updated docs to mention logging - Removed `Metadata` convenience functions - The `_metadata()` function has been added - The `_set_metadata()` function's `metadata` argument is now an `Option<Metadata>` and the argument order has changed - The `SetMetadata` abi's `set_metadata()` `metadata` argument is now an `Option<Metadata>` and the argument order has changed - `_set_metadata()` now reverts if the metadata is an empty string - `_set_metadata()` now reverts if the metadata are empty bytes - The `_set_name()` function's `name` argument is now an `Option<String>` - `_set_name()` now reverts if the `name` argument is an empty string - The `_set_symbol()` function's `name` argument is now an `Option<String>` - `_set_symbol()` now reverts if the `symbol` argument is an empty string - The `_mint()` function's `sub_id` argument is now an `Option<SubId>` - `_mint()` now reverts if the `amount` argument is zero - `_burn()` now reverts if the `amount` argument is zero - Test edge cases for `_mint()` have been added - Test edge cases for `_burn()` have been added - Test edge cases for `_set_name()` have been added - Test edge cases for `_set_symbol()` have been added - Test edge cases for `_set_decimals()` have been added ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit afb9fcdae8492449a28fa215f876ea3c4e63ade3 Author: Cameron Carstens <[email protected]> Date: Wed Aug 28 09:59:00 2024 +0800 Remove `_with_configurables` functions from Bytecode Library and use `Option` instead (#285) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) - Breaking ## Breaking The following demonstrates the breaking change: Before: ```sway fn foo(my_bytecode: Vec<u8>, my_configurables: ContractConfigurables, my_contract_id: ContractId, my_predicate_address: Address) { // 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: ```sway fn foo(my_bytecode: Vec<u8>, my_configurables: ContractConfigurables, my_contract_id: ContractId, my_predicate_address: Address) { // 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 } ``` ## Changes The following changes have been made: - `compute_bytecode_root_with_configurables()` has been removed in place of `compute_bytecode_root()` with an `Option` argument for configurables - `compute_predicate_address_with_configurables()` has been removed in place of `compute_predicate_address()` with an `Option` argument for configurables - `verify_contract_bytecode_with_configurables()` has been removed in place of `verify_contract_bytecode()` with an `Option` argument for configurables - `verify_predicate_address_with_configurables()` has been removed in place of `verify_predicate_address()` with an `Option` argument for configurables - The `BytecodeRoot` type has been added - The `ContractConfigurables` type has been added ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #219 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 847c0d332749e260e387f10ae8cdb6d27d06156a Author: withbest <[email protected]> Date: Fri Aug 16 05:07:31 2024 +0900 chore: fix some comments (#271) ## Type of change - Documentation ## Changes - fix some comments ## Notes - Note 1 ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #\<issue number\> ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. Signed-off-by: withbest <[email protected]> Co-authored-by: Cameron Carstens <[email protected]> commit 50be622109e3c584efc29edac5390c96f1ccc43a Author: Cameron Carstens <[email protected]> Date: Tue Aug 6 23:22:52 2024 +0700 Bump to sway-standards v0.5.2, forc v0.62.0, fuel-core v0.31.0 and v0.23.1 release (#281) ## Type of change <!--Delete points that do not apply--> - Improvement - Release ## Changes The following changes have been made: - Bumps repo to forc v0.62.0 - Bumps repo to fuel-core v0.31.0 - Bumps repo to sway-standard v0.5.2 - Prepares for v0.23.1 release ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. - [ ] I have updated the changelog to reflect the changes on this PR. commit e205b05cba60ad5f8ce7c95d94c767bbdc4327dd Author: Cameron Carstens <[email protected]> Date: Thu Aug 1 18:32:44 2024 +0530 Prepare for v0.23.0 release (#276) ## Type of change <!--Delete points that do not apply--> - Release ## Changes The following changes have been made: - Updates all instances of `v0.22.0` to `v0.23.0` ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit dbd5e36f2dc9e5a208b49b3e01e91f745b979068 Author: Cameron Carstens <[email protected]> Date: Thu Aug 1 18:28:05 2024 +0530 Handle case when bytecode is empty (#275) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Changes The following changes have been made: - `_compute_bytecode_root()` now reverts when the `bytecode` argument is an empty slice. Previously the function would enter an infinite loop. ## Notes - This was reported as part of the attackathon ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 3a8a5dc417d7f9dd5db555dcc68f5c75c0275737 Author: SwayStar123 <[email protected]> Date: Thu Aug 1 18:21:55 2024 +0530 Fix buffer overflow in swap_configurables (#274) ## Type of change - Bug fix ## Changes The following changes have been made: - Changes the swap_configurables function to assert that the offset and length of the configurable bytes are less than the bytecode length, in order to avoid a buffer overflow ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: Cameron Carstens <[email protected]> commit 0b64cbfe3655dbc8f1b217856a20710595353d0f Author: K1-R1 <[email protected]> Date: Thu Aug 1 13:32:12 2024 +0100 Deprecate Fixed Point library (#278) commit ddfe6844df878986ed2083b3393d8fbd4fe254cd Author: Cameron Carstens <[email protected]> Date: Thu Aug 1 11:04:42 2024 +0530 Fix `neg_from()` in favor of `neg_try_from()` for Signed Integers (#273) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Breaking The `neg_from` implementation for all signed integers has been removed. The `neg_try_from()` implementation has been added in its place. The following demonstrates the breaking change. While this example code uses the I8 type, the same logic may be applied to the I16, I32, I64, I128, and I256 types. Before: ```sway let my_negative_i8: I8 = I8::neg_from(1u8); ``` After: ```sway let my_negative_i8: I8 = I8::neg_try_from(1u8).unwrap(); ``` ## Changes The following changes have been made: - Removes `neg_from()` in favor of `neg_try_from()` for `I8` - Removes `neg_from()` in favor of `neg_try_from()` for `I16` - Removes `neg_from()` in favor of `neg_try_from()` for `I32` - Removes `neg_from()` in favor of `neg_try_from()` for `I64` - Removes `neg_from()` in favor of `neg_try_from()` for `I128` - Removes `neg_from()` in favor of `neg_try_from()` for `I256` ## Notes - This is a breaking change - Previously the `neg_from()` implementation would break on values greater than the indent for each signed integer ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 7fdf8ec351bd6a76c7eef8585e44d043044d9c7b Author: Cameron Carstens <[email protected]> Date: Wed Jul 31 17:55:16 2024 +0530 Fix `From` implementation for Signed Integers (#272) ## Type of change <!--Delete points that do not apply--> - Bug fix - New feature - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Breaking The `From` implementation for all signed integers to their respective unsigned integer has been removed. The `TryFrom` implementation has been added in its place. The following demonstrates the breaking change. While this example code uses the I8 type, the same logic may be applied to the I16, I32, I64, I128, and I256 types. Before: ```sway let my_i8: I8 = I8::from(1u8); ``` After: ```sway let my_i8: I8 = I8::try_from(1u8).unwrap(); ``` ## Changes The following changes have been made: - Removes the `From` implementation for `u8` into `I8` - Removes the `From` implementation for `u16` into `I16` - Removes the `From` implementation for `u32` into `I32` - Removes the `From` implementation for `u64` into `I64` - Removes the `From` implementation for `U128` into `I128` - Removes the `From` implementation for `u256` into `I256` - Adds the `TryFrom` implementation for `u8` into `I8` - Adds the `TryFrom` implementation for `u16` into `I16` - Adds the `TryFrom` implementation for `u32` into `I32` - Adds the `TryFrom` implementation for `u64` into `I64` - Adds the `TryFrom` implementation for `U128` into `I128` - Adds the `TryFrom` implementation for `u256` into `I256` - Adds the `TryFrom` implementation for `I8` into `u8` - Adds the `TryFrom` implementation for `I16` into `u16` - Adds the `TryFrom` implementation for `I32` into `u32` - Adds the `TryFrom` implementation for `I64` into `u64` - Adds the `TryFrom` implementation for `I128` into `U128` - Adds the `TryFrom` implementation for `I256` into `u256` ## Notes - Reported in the Fuel Attackathon - This is a breaking change - Previously the `From` implementations would revert if the input was greater than the indent. ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit c34c84b48afe14651e86e919be28b2c24d6450cc Author: Cameron Carstens <[email protected]> Date: Wed Jul 31 11:33:57 2024 +0530 Fix Signed Integers Subtraction (#268) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Changes The following changes have been made: The following changes have been made: - Fixed when subtracting a negative from a positive number for `I8`, `I16`, `I32`, `I64`, `I128`, and `I256`. - Fixed when subtracting two negative numbers for `I8`, `I16`, `I32`, `I64`, `I128`, and `I256`. ## Notes - Reported in the Fuel Attackathon ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit db11dc2c58351567f8b81b750a0a01084373fc75 Author: Cameron Carstens <[email protected]> Date: Mon Jul 29 11:52:40 2024 +0530 Add `OrdEq` impl to Signed Integers (#270) ## Type of change <!--Delete points that do not apply--> - New feature ## Changes The following changes have been made: - `I8`, `I16`, `I32`, `I64`, `I128`, and `I256` now support `OrdEq`. Closes #\<issue number\> ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 51876797c76b8d1777b1c179e5f5725ae1b2cbb3 Author: Cameron Carstens <[email protected]> Date: Fri Jul 26 09:55:21 2024 +0530 Hash StorageKey slot for Admin library (#269) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Changes The following changes have been made: - Adds the string "admin" and hashes with the bits of an Identity when creating the storage slot to storage an admin. ## Notes - Reported in the Fuel Attackathon ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: SwayStar123 <[email protected]> commit 624b664d1792bbb0955c6c66b051bc6dc722327b Author: Cameron Carstens <[email protected]> Date: Thu Jul 25 13:18:32 2024 +0530 Signed Integers `TwosComplement` fix to `WrappingNeg` (#263) ## Type of change <!--Delete points that do not apply--> - Bug fix ## Changes The following changes have been made: - The `TwosComplement` trait was not correctly implemented. To stay in line with Rust's practices, the `WrappingNeg` trait now replaces it with the original desired functionality of the `TwosComplement` trait. - Bits for `I128` and `I256` are now correct - The indent for `I128` and `I256` are now correct ## Notes - This PR changes the folder names in the tests from `iX_twos_complement_test` to `iX_wrapping_neg_test`. ## Breaking Changes The following demonstrates the breaking change. While this example code uses the `I8` type, the same logic may be applied to the `I16`, `I32`, `I64`, `I128`, and `I256` types. Before: ```sway let my_i8 = i8::zero(); let twos_complement = my_i8.twos_complement(); ``` After: ```sway let my_i8 = i8::zero(); let wrapping_neg = my_i8.wrapping_neg(); ``` ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: K1-R1 <[email protected]> commit 76cf2cc59ca43d376083095ac577e65d17bcdfc6 Author: Cameron Carstens <[email protected]> Date: Wed Jul 24 19:22:01 2024 +0530 Adds the `SetMetadataEvent` (#265) ## Type of change <!--Delete points that do not apply--> - New feature ## Changes The following changes have been made: - Adds a `SetMetadataEvent` struct - Emits `SetMetadataEvent` when `_set_metadata()` is called - Enables the metadata tests now that the SDK supports wrapped heap types. ## Notes - This was requested by an external member. ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #264 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 8d97fb37fef51ad11ee844eb160cab878fb30c4c Author: SwayStar123 <[email protected]> Date: Wed Jul 24 18:40:39 2024 +0530 Fix ordering functions for IFP (#262) ## Type of change - Bug fix ## Changes The IFP gt and lt functions were incorrectly implemented, this pr fixes the implementation and adds tests to ensure functionality ## Notes - Bug was discovered here https://bugs.immunefi.com/dashboard/submission/32276 ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit 2a869c583d2ab9fbe8de17a3301d928b224062c7 Author: K1-R1 <[email protected]> Date: Mon Jul 8 13:59:02 2024 +0100 Upgradability library (#259) ## Type of change <!--Delete points that do not apply--> - New feature - Documentation ## Changes The following changes have been made: - Added a new upgradability library - Added test for the new lib - Added docs for the new lib ## Notes - The upgradability library provides methods to implement the required and optional functionality from [SRC-14](https://docs.fuel.network/docs/sway-standards/src-14-simple-upgradeable-proxies/) as well as additional functionality for ownership of the proxy contract. Whilst SRC-14 standardizes the target storage slot: ```sway /// The standard storage slot to store proxy target address. /// /// Value is `sha256("storage_SRC14_0")`. pub const SRC14_TARGET_STORAGE: b256 = 0x7bb458adc1d118713319a5baa00a2d049dd64d2916477d2688d76970c898cd55; ``` It doesn't standardize a storage slot for proxy owner. Consequently the functions that read and write to the storage slot for proxy owner require a storage key parameter: ```sway #[storage(read)] pub fn proxy_owner(proxy_owner_storage_key: StorageKey<State>) -> State { proxy_owner_storage_key.read() } ``` - The upgradability depends on the master branch of sway-standards; as the current release does not have the up-to-date SRC-14 ABIs. TODOs are included, and once this PR is merged, an issue to resolve this will be made. ## Related Issues <!--Delete everything after the "#" symbol and replace it with a number. No spaces between hash and number--> Closes #260 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. commit d299d2d41f7fd3676b1332f6f5997a76b927ee01 Author: Cameron Carstens <[email protected]> Date: Wed Jun 19 12:00:21 2024 +0800 Update instructions on how to run tests (#258) ## Type of change <!--Delete points that do not apply--> - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) ## Ch…
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Changes
The following changes have been made:
Related Issues
Closes #303
Checklist
Breaking*orNew Featurelabels where relevant.