Release v0.5.2 (#127)

* Hotfix: Update Cargo.toml to v0.5.1 (#115) * Hotfix: Update Cargo.toml to v0.5.1 * Udpate CHANGELOG * fix vault reads * add changelog * move changelog to new empty changelog * add "unreleased" to changelog heads * remove date * add v0.5.1 * SRC-6 example contract does not update managed assets (#122) * Update SRC-6 example with decrementation of managed assets * Update CHANGELOG * Fix link on CHANGELOG.md * Update CHANGELOG to resolve markdown error with duplicate headers * Write to storage * Use new namespace syntax for storage (#120) * chore: fix compiler warnings * remove for examples * Update changelog * Prepare master for v0.5.2 release (#126) * Prepare for v0.5.2 release * Update CHANGELOG * Update CHANGELOG formatting --------- Co-authored-by: SwayStar123 <[email protected]> Co-authored-by: SwayStar123 <[email protected]> Co-authored-by: IGI-111 <[email protected]> Co-authored-by: Sophie <[email protected]> Co-authored-by: K1-R1 <[email protected]>
FuelLabs · Aug 6, 2024 · 270350e · 270350e
1 parent e2d5ac4
commit 270350e
Show file tree

Hide file tree

Showing 11 changed files with 94 additions and 30 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -16,7 +16,7 @@ env:
   CARGO_TERM_COLOR: always
   REGISTRY: ghcr.io
   RUST_VERSION: 1.77.0
-  FORC_VERSION: 0.60.0
+  FORC_VERSION: 0.61.0
   CORE_VERSION: 0.26.0
   PATH_TO_SCRIPTS: .github/scripts
 
@@ -61,7 +61,7 @@ jobs:
           run: forc fmt --path standards --check
 
         - name: Build All Standards
-          run: forc build --path standards
+          run: forc build --error-on-warnings --path standards
 
         - name: Check Sway Formatting Examples
           run: forc fmt --path examples --check

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,30 +5,63 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Version 0.5.1]
+## [Unreleased]
+
+### Added Unreleased
+
+- Something new here 1
+- Something new here 2
+
+### Changed Unreleased
+
+- Something changed here 1
+- Something changed here 2
+
+### Fixed Unreleased
+
+- Some fix here 1
+- Some fix here 2
+
+### Breaking Unreleased
 
-Description of the upcoming release here.
+- Some breaking change here 1
+- Some breaking change here 2
+
+## [Version 0.5.2]
+
+### Changed v0.5.2
+
+- [#126](https://github.com/FuelLabs/sway-standards/pull/126) Prepares for v0.5.2 release.
+
+### Fixed v0.5.2
+
+- [#121](https://github.com/FuelLabs/sway-standards/pull/121) Fixes the `deposit` function in the SRC-6 standard, uses try_read instead of read in order to allow first time deposits to a vault.
+- [#122](https://github.com/FuelLabs/sway-standards/pull/122) Fixes the SRC-6 example contract from a critical bug where the contract can be drained.
+- [#124](https://github.com/FuelLabs/sway-standards/pull/124) Fixes compiler warnings for libraries
+
+## [Version 0.5.1]
 
-### Added
+### Added v0.5.1
 
-- [#107](https://github.com/FuelLabs/sway-standards/pull/107): Adds the `proxy_owner()` function to the SRC-14 standard.
-- [#104](https://github.com/FuelLabs/sway-standards/pull/104): Adds the CHANGELOG.md file to Sway-Standards.
+- [#107](https://github.com/FuelLabs/sway-standards/pull/107) Adds the `proxy_owner()` function to the SRC-14 standard.
+- [#104](https://github.com/FuelLabs/sway-standards/pull/104) Adds the CHANGELOG.md file to Sway-Standards.
 - [#110](https://github.com/FuelLabs/sway-standards/pull/110) Adds the `proxy_target()` function to the SRC-14 standard.
-- [#103](https://github.com/FuelLabs/sway-standards/pull/103): Adds Sway-Standards to the [docs hub](https://docs.fuel.network/docs/sway-standards/).
+- [#103](https://github.com/FuelLabs/sway-standards/pull/103) Adds Sway-Standards to the [docs hub](https://docs.fuel.network/docs/sway-standards/).
 
-### Changed
+### Changed v0.5.1
 
 - [#103](https://github.com/FuelLabs/sway-standards/pull/103) Removes standards in the `./SRC` folder in favor of `./docs`.
 - [#106](https://github.com/FuelLabs/sway-standards/pull/106) Updates links from the Sway Book to Docs Hub.
+- [#120](https://github.com/FuelLabs/sway-standards/pull/120) Updates repository to forc v0.61.0 and uses new namespace in SRC-14 example.
 
-### Fixed
+### Fixed v0.5.1
 
 - [#107](https://github.com/FuelLabs/sway-standards/pull/107) resolves the conflict when SRC-5's `owner()` function is used in both the proxy and target contract in the SRC-14 standard.
 - [#99](https://github.com/FuelLabs/sway-standards/pull/99) Fixes links and typos in the SRC-14 standard.
 - [#112](https://github.com/FuelLabs/sway-standards/pull/112) Fixes inline documentation code in the SRC-3 standard.
 - [#115](https://github.com/FuelLabs/sway-standards/pull/115) Hotfixes the Cargo.toml version to the v0.5.1 release.
 
-#### Breaking
+### Breaking v0.5.1
 
 - [#110](https://github.com/FuelLabs/sway-standards/pull/110) Breaks the `SRC14` abi by adding the `proxy_target()` function. This will need to be added to any SRC14 implementation. The new abi is as follows:
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,4 +1,4 @@
 [package]
 name = "sway-standards"
-version = "0.5.1"
+version = "0.5.2"
 edition = "2021"
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@
     <a href="https://github.com/FuelLabs/sway-standards/actions/workflows/ci.yml" alt="CI">
         <img src="https://github.com/FuelLabs/sway-standards/actions/workflows/ci.yml/badge.svg" />
     </a>
-    <a href="https://crates.io/crates/forc/0.60.0" alt="forc">
-        <img src="https://img.shields.io/badge/forc-v0.60.0-orange" />
+    <a href="https://crates.io/crates/forc/0.61.0" alt="forc">
+        <img src="https://img.shields.io/badge/forc-v0.61.0-orange" />
     </a>
     <a href="./LICENSE" alt="forc">
         <img src="https://img.shields.io/github/license/FuelLabs/sway-standards" />
@@ -65,7 +65,7 @@ If you don't find what you're looking for, feel free to create an issue and prop
 To import a standard the following should be added to the project's `Forc.toml` file under `[dependencies]` with the most recent release:
 
 ```toml
-standards = { git = "https://github.com/FuelLabs/sway-standards", tag = "v0.5.1" }
+standards = { git = "https://github.com/FuelLabs/sway-standards", tag = "v0.5.2" }
 ```
 
 > **NOTE:**
@@ -162,7 +162,7 @@ Example of a minimal SRC-14 implementation with no access control.
 Example of a SRC-14 implementation that also implements [SRC-5](https://docs.fuel.network/docs/sway-standards/src-5-ownership/).
 
 > **Note**
-> All standards currently use `forc v0.60.0`.
+> All standards currently use `forc v0.61.0`.
 
 <!-- TODO:
 ## Contributing

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -7,14 +7,14 @@ Standards in this repository may be in various stages of development. Use of dra
 If you don't find what you're looking for, feel free to create an issue and propose a new standard!
 
 > **Note**
-> All standards currently use `forc v0.60.0`.
+> All standards currently use `forc v0.61.0`.
 
 ## Using a standard
 
 To import a standard the following should be added to the project's `Forc.toml` file under `[dependencies]` with the most recent release:
 
 ```toml
-standards = { git = "https://github.com/FuelLabs/sway-standards", tag = "v0.5.1" }
+standards = { git = "https://github.com/FuelLabs/sway-standards", tag = "v0.5.2" }
 ```
 
 > **NOTE:**

diff --git a/examples/src14-simple-proxy/minimal/src/minimal.sw b/examples/src14-simple-proxy/minimal/src/minimal.sw
@@ -1,10 +1,8 @@
 contract;
 
 use std::execution::run_external;
-use standards::src14::SRC14;
+use standards::src14::{SRC14, SRC14_TARGET_STORAGE};
 
-// use sha256("storage_SRC14") as base to avoid collisions
-#[namespace(SRC14)]
 storage {
     // target is at sha256("storage_SRC14_0")
     target: ContractId = ContractId::zero(),

diff --git a/examples/src14-simple-proxy/owned/src/owned.sw b/examples/src14-simple-proxy/owned/src/owned.sw
@@ -2,17 +2,17 @@ contract;
 
 use std::execution::run_external;
 use standards::src5::{AccessError, State};
-use standards::src14::{SRC14, SRC14Extension};
+use standards::src14::{SRC14, SRC14_TARGET_STORAGE, SRC14Extension};
 
 /// The owner of this contract at deployment.
 const INITIAL_OWNER: Identity = Identity::Address(Address::zero());
 
-// use sha256("storage_SRC14") as base to avoid collisions
-#[namespace(SRC14)]
 storage {
-    // target is at sha256("storage_SRC14_0")
+    proxy {
+        // target is at sha256("storage_SRC14_0")
+        owner: State = State::Initialized(INITIAL_OWNER),
+    },
     target: ContractId = ContractId::zero(),
-    owner: State = State::Initialized(INITIAL_OWNER),
 }
 
 impl SRC14 for Contract {
@@ -31,7 +31,7 @@ impl SRC14 for Contract {
 impl SRC14Extension for Contract {
     #[storage(read)]
     fn proxy_owner() -> State {
-        storage.owner.read()
+        storage::proxy.owner.read()
     }
 }
 
@@ -45,7 +45,7 @@ fn fallback() {
 #[storage(read)]
 fn only_owner() {
     require(
-        storage
+        storage::proxy
             .owner
             .read() == State::Initialized(msg_sender().unwrap()),
         AccessError::NotOwner,

diff --git a/examples/src6-vault/multi_asset_vault/src/main.sw b/examples/src6-vault/multi_asset_vault/src/main.sw
@@ -50,7 +50,14 @@ impl SRC6 for Contract {
 
         _mint(receiver, share_asset, share_asset_vault_sub_id, shares);
 
-        let mut vault_info = storage.vault_info.get(share_asset).read();
+        let mut vault_info = match storage.vault_info.get(share_asset).try_read() {
+            Some(vault_info) => vault_info,
+            None => VaultInfo {
+                managed_assets: 0,
+                vault_sub_id,
+                asset: underlying_asset,
+            },
+        };
         vault_info.managed_assets = vault_info.managed_assets + asset_amount;
         storage.vault_info.insert(share_asset, vault_info);
 
@@ -81,6 +88,10 @@ impl SRC6 for Contract {
         require(msg_asset_id() == share_asset_id, "INVALID_ASSET_ID");
         let assets = preview_withdraw(share_asset_id, shares);
 
+        let mut vault_info = storage.vault_info.get(share_asset_id).read();
+        vault_info.managed_assets = vault_info.managed_assets - shares;
+        storage.vault_info.insert(share_asset_id, vault_info);
+
         _burn(share_asset_id, share_asset_vault_sub_id, shares);
 
         transfer(receiver, underlying_asset, assets);

diff --git a/examples/src6-vault/single_asset_single_sub_vault/src/main.sw b/examples/src6-vault/single_asset_single_sub_vault/src/main.sw
@@ -78,6 +78,10 @@ impl SRC6 for Contract {
         require(msg_asset_id() == share_asset_id, "INVALID_ASSET_ID");
         let assets = preview_withdraw(shares);
 
+        storage
+            .managed_assets
+            .write(storage.managed_assets.read() - shares);
+
         _burn(share_asset_id, shares);
 
         transfer(receiver, underlying_asset, assets);

diff --git a/examples/src6-vault/single_asset_vault/src/main.sw b/examples/src6-vault/single_asset_vault/src/main.sw
@@ -51,7 +51,14 @@ impl SRC6 for Contract {
 
         _mint(receiver, share_asset, share_asset_vault_sub_id, shares);
 
-        let mut vault_info = storage.vault_info.get(share_asset).read();
+        let mut vault_info = match storage.vault_info.get(share_asset).try_read() {
+            Some(vault_info) => vault_info,
+            None => VaultInfo {
+                managed_assets: 0,
+                vault_sub_id,
+                asset: underlying_asset,
+            },
+        };
         vault_info.managed_assets = vault_info.managed_assets + asset_amount;
         storage.vault_info.insert(share_asset, vault_info);
 
@@ -82,6 +89,10 @@ impl SRC6 for Contract {
         require(msg_asset_id() == share_asset_id, "INVALID_ASSET_ID");
         let assets = preview_withdraw(share_asset_id, shares);
 
+        let mut vault_info = storage.vault_info.get(share_asset_id).read();
+        vault_info.managed_assets = vault_info.managed_assets - shares;
+        storage.vault_info.insert(share_asset_id, vault_info);
+
         _burn(share_asset_id, share_asset_vault_sub_id, shares);
 
         transfer(receiver, underlying_asset, assets);

diff --git a/standards/src/src10.sw b/standards/src/src10.sw
@@ -15,18 +15,25 @@ pub enum DepositType {
 /// Enscapsultes metadata sent between the canonical chain and Fuel when a deposit is made.
 struct DepositMessage {
     /// The number of tokens.
+    #[allow(dead_code)]
     pub amount: b256,
     /// The user's address on the canonical chain.
+    #[allow(dead_code)]
     pub from: b256,
     /// The bridging target destination on the Fuel chain.
+    #[allow(dead_code)]
     pub to: Identity,
     /// The bridged token's address on the canonical chain.
+    #[allow(dead_code)]
     pub token_address: b256,
     /// The token's ID on the canonical chain.
+    #[allow(dead_code)]
     pub token_id: b256,
     /// The decimals of the token.
+    #[allow(dead_code)]
     pub decimals: u8,
     /// The type of deposit made.
+    #[allow(dead_code)]
     pub deposit_type: DepositType,
 }