Merge pull request #33 from FuelLabs/bitzoic-src5-example

Add SRC-5 Basic examples

examples/Forc.toml

@@ -1,2 +1,7 @@
 [workspace]
-members = ["src_20/single_asset", "src_20/multi_asset"]
+members = [
+  "src_5/initialized_example",
+  "src_5/uninitialized_example",
+  "src_20/single_asset",
+  "src_20/multi_asset",
+]

examples/src_5/initialized_example/Forc.toml

@@ -0,0 +1,8 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "initialized_example.sw"
+license = "Apache-2.0"
+name = "initialized_src5_example"
+
+[dependencies]
+src_5 = { path = "../../../standards/src_5" }

examples/src_5/initialized_example/src/initialized_example.sw

@@ -0,0 +1,47 @@
+contract;
+
+use src_5::{Ownership, SRC_5, State};
+use std::constants::ZERO_B256;
+
+configurable {
+    /// The owner of this contract at deployment.
+    INITIAL_OWNER: Identity = Identity::Address(Address::from(ZERO_B256)),
+}
+
+storage {
+    /// The owner in storage.
+    owner: Ownership = Ownership {
+        state: State::Initialized(INITIAL_OWNER),
+    },
+}
+
+impl SRC_5 for Contract {
+    /// Returns the owner.
+    ///
+    /// # Return Values
+    ///
+    /// * [State] - Represents the state of ownership for this contract.
+    ///
+    /// # Number of Storage Accesses
+    ///
+    /// * Reads: `1`
+    ///
+    /// # Examples
+    ///
+    /// ```sway
+    /// use src_5::SRC_5;
+    ///
+    /// fn foo(contract_id: ContractId) {
+    ///     let ownership_abi = abi(contract_id, SRC_5);
+    ///
+    ///     match ownership_abi.owner() {
+    ///         State::Initialized(owner) => log("The ownership is initalized"),
+    ///         _ => log("This example will never reach this statement"),
+    ///     }
+    /// }
+    /// ```
+    #[storage(read)]
+    fn owner() -> State {
+        storage.owner.read().state
+    }
+}

examples/src_5/uninitialized_example/Forc.toml

@@ -0,0 +1,8 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "uninitialized_example.sw"
+license = "Apache-2.0"
+name = "uninitialized_src5_example"
+
+[dependencies]
+src_5 = { path = "../../../standards/src_5" }

examples/src_5/uninitialized_example/src/uninitialized_example.sw

@@ -0,0 +1,41 @@
+contract;
+
+use src_5::{Ownership, SRC_5, State};
+
+storage {
+    /// The owner in storage.
+    owner: Ownership = Ownership {
+        state: State::Uninitialized,
+    },
+}
+
+impl SRC_5 for Contract {
+    /// Returns the owner.
+    ///
+    /// # Return Values
+    ///
+    /// * [State] - Represents the state of ownership for this contract.
+    ///
+    /// # Number of Storage Accesses
+    ///
+    /// * Reads: `1`
+    ///
+    /// # Examples
+    ///
+    /// ```sway
+    /// use src_5::SRC_5;
+    ///
+    /// fn foo(contract_id: ContractId) {
+    ///     let ownership_abi = abi(contract_id, SRC_5);
+    ///
+    ///     match ownership_abi.owner() {
+    ///         State::Uninitalized => log("The ownership is uninitalized"),
+    ///         _ => log("This example will never reach this statement"),
+    ///     }
+    /// }
+    /// ```
+    #[storage(read)]
+    fn owner() -> State {
+        storage.owner.read().state
+    }
+}