Move subcurrency example to examples directory

docs/src/examples/subcurrency.md

@@ -1,115 +1,5 @@
 # Subcurrency
 
 ```sway
-contract;
-
-use std::chain::*;
-use std::hash::*;
-use std::storage::*;
-
-////////////////////////////////////////
-// Event declarations
-////////////////////////////////////////
-
-// Events allow clients to react to changes in the contract.
-// Unlike Solidity, events are simply structs.
-// Note: Serialization is not yet implemented, therefore logging
-//  of arbitrary structures will not work without manual
-//  serialization.
-
-/// Emitted when a token is sent.
-struct Sent {
-    from: b256,
-    to: b256,
-    amount: u64,
-}
-
-////////////////////////////////////////
-// ABI method parameter declarations
-////////////////////////////////////////
-
-/// Parameters for `mint` method.
-struct ParamsMint {
-    receiver: b256,
-    amount: u64,
-}
-
-/// Parameters for `send` method.
-struct ParamsSend {
-    sender: b256,
-    receiver: b256,
-    amount: u64,
-}
-
-////////////////////////////////////////
-// ABI declarations
-////////////////////////////////////////
-
-/// ABI definition for a subcurrency.
-abi Token {
-    // Mint new tokens and send to an address.
-    // Can only be called by the contract creator.
-    fn mint(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsMint);
-
-    // Sends an amount of an existing token.
-    // Can be called from any address.
-    fn send(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsSend);
-}
-
-// Note: ABI methods for now must explicitly have as parameters:
-//  gas_ to forward: u64
-//  coins_ to forward: u64,
-//  asset_id_ of coins: b256
-
-////////////////////////////////////////
-// Constants
-////////////////////////////////////////
-
-/// Address of contract creator.
-const MINTER: b256 = 0x9299da6c73e6dc03eeabcce242bb347de3f5f56cd1c70926d76526d7ed199b8b;
-
-////////////////////////////////////////
-// Contract storage
-////////////////////////////////////////
-
-// Contract storage persists across transactions.
-// Note: Contract storage variables are not implemented yet.
-
-const STORAGE_BALANCES: b256 = 0x0000000000000000000000000000000000000000000000000000000000000000;
-
-////////////////////////////////////////
-// ABI definitions
-////////////////////////////////////////
-
-/// Contract implements the `Token` ABI.
-impl Token for Contract {
-    fn mint(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsMint) {
-        // Note: authentication is not yet implemented, for now just trust params
-        // See https://github.com/FuelLabs/sway/issues/195
-        if args.receiver == MINTER {
-            let storage_slot = hash_pair(STORAGE_BALANCES, MINTER, HashMethod::Sha256);
-
-            let mut amount = get::<u64>(storage_slot);
-            amount = amount + args.amount;
-            store(storage_slot, amount);
-        } else {
-            // Revert with error `69`, chosen arbitrarily
-            panic(69);
-        }
-    }
-
-    fn send(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsSend) {
-        let sender_storage_slot = hash_pair(STORAGE_BALANCES, args.sender, HashMethod::Sha256);
-
-        let mut sender_amount = get::<u64>(sender_storage_slot);
-        sender_amount = sender_amount - args.amount;
-        store(sender_storage_slot, sender_amount);
-
-        let receiver_storage_slot = hash_pair(STORAGE_BALANCES, args.receiver, HashMethod::Sha256);
-
-        let mut receiver_amount = get::<u64>(receiver_storage_slot);
-        receiver_amount = receiver_amount + args.amount;
-        store(receiver_storage_slot, receiver_amount);
-    }
-}
+{{#include ../../../examples/subcurrency/src/main.sw:body}}
 ```

examples/subcurrency/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "subcurrency"
+version = "0.0.0"
+authors = ["Fuel Labs <contact@fuel.sh>"]
+edition = "2021"
+license = "Apache-2.0"
+
+[dependencies]
+fuels-abigen-macro = "0.2"
+fuels-core = "0.2"
+fuels-rs = "0.2"
+fuel-gql-client = { version = "0.2", default-features = false }
+fuel-tx = "0.3"
+rand = "0.8"
+tokio = { version = "1.12", features = ["rt", "macros"] }
+
+[[test]]
+name = "integration_tests"
+path = "tests/harness.rs"
+harness = true

examples/subcurrency/Forc.toml

@@ -0,0 +1,9 @@
+[project]
+author = "Fuel Labs <contact@fuel.sh>"
+entry = "main.sw"
+license = "Apache-2.0"
+name = "subcurrency"
+
+[dependencies]
+core = { git = "http://github.com/FuelLabs/sway-lib-core" }
+std = { git = "http://github.com/FuelLabs/sway-lib-std" }

examples/subcurrency/src/main.sw

@@ -0,0 +1,113 @@
+// ANCHOR: body
+contract;
+
+use std::chain::*;
+use std::hash::*;
+use std::storage::*;
+
+////////////////////////////////////////
+// Event declarations
+////////////////////////////////////////
+
+// Events allow clients to react to changes in the contract.
+// Unlike Solidity, events are simply structs.
+// Note: Serialization is not yet implemented, therefore logging
+//  of arbitrary structures will not work without manual
+//  serialization.
+
+/// Emitted when a token is sent.
+struct Sent {
+    from: b256,
+    to: b256,
+    amount: u64,
+}
+
+////////////////////////////////////////
+// ABI method parameter declarations
+////////////////////////////////////////
+
+/// Parameters for `mint` method.
+struct ParamsMint {
+    receiver: b256,
+    amount: u64,
+}
+
+/// Parameters for `send` method.
+struct ParamsSend {
+    sender: b256,
+    receiver: b256,
+    amount: u64,
+}
+
+////////////////////////////////////////
+// ABI declarations
+////////////////////////////////////////
+
+/// ABI definition for a subcurrency.
+abi Token {
+    // Mint new tokens and send to an address.
+    // Can only be called by the contract creator.
+    fn mint(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsMint);
+
+    // Sends an amount of an existing token.
+    // Can be called from any address.
+    fn send(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsSend);
+}
+
+// Note: ABI methods for now must explicitly have as parameters:
+//  gas_ to forward: u64
+//  coins_ to forward: u64
+//  asset_id_ of coins: b256
+
+////////////////////////////////////////
+// Constants
+////////////////////////////////////////
+
+/// Address of contract creator.
+const MINTER: b256 = 0x9299da6c73e6dc03eeabcce242bb347de3f5f56cd1c70926d76526d7ed199b8b;
+
+////////////////////////////////////////
+// Contract storage
+////////////////////////////////////////
+
+// Contract storage persists across transactions.
+// Note: Contract storage variables are not implemented yet.
+
+const STORAGE_BALANCES: b256 = 0x0000000000000000000000000000000000000000000000000000000000000000;
+
+////////////////////////////////////////
+// ABI definitions
+////////////////////////////////////////
+
+/// Contract implements the `Token` ABI.
+impl Token for Contract {
+    fn mint(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsMint) {
+        // Note: authentication is not yet implemented, for now just trust params
+        // See https://github.com/FuelLabs/sway/issues/195
+        if args.receiver == MINTER {
+            let storage_slot = hash_pair(STORAGE_BALANCES, MINTER, HashMethod::Sha256);
+
+            let mut amount = get::<u64>(storage_slot);
+            amount = amount + args.amount;
+            store(storage_slot, amount);
+        } else {
+            // Revert with error `69`, chosen arbitrarily
+            panic(69);
+        }
+    }
+
+    fn send(gas_: u64, coins_: u64, asset_id_: b256, args: ParamsSend) {
+        let sender_storage_slot = hash_pair(STORAGE_BALANCES, args.sender, HashMethod::Sha256);
+
+        let mut sender_amount = get::<u64>(sender_storage_slot);
+        sender_amount = sender_amount - args.amount;
+        store(sender_storage_slot, sender_amount);
+
+        let receiver_storage_slot = hash_pair(STORAGE_BALANCES, args.receiver, HashMethod::Sha256);
+
+        let mut receiver_amount = get::<u64>(receiver_storage_slot);
+        receiver_amount = receiver_amount + args.amount;
+        store(receiver_storage_slot, receiver_amount);
+    }
+}
+// ANCHOR_END: body

examples/subcurrency/tests/harness.rs

@@ -0,0 +1,5 @@
+
+#[tokio::test]
+async fn harness() {
+    assert_eq!(true, true);
+}