Furnic/docs counter example (FuelLabs#958)

* docs:add counter example to sway book * docs:add counter to examples * style: forc fmt * docs: actually add new page
ahocom55 · Mar 17, 2022 · d357815 · d357815
1 parent da11f37
commit d357815
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 0 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -8,6 +8,7 @@
   - [The Sway Toolchain](./introduction/sway-toolchain.md)
   - [A Forc Project](./introduction/forc_project.md)
 - [Examples](./examples/index.md)
+  - [Counter](./examples/counter.md)
   - [Subcurrency](./examples/subcurrency.md)
   - [FizzBuzz](./examples/fizzbuzz.md)
   - [Wallet Smart Contract](./examples/wallet_smart_contract.md)

diff --git a/docs/src/examples/counter.md b/docs/src/examples/counter.md
@@ -0,0 +1,7 @@
+# Counter
+
+The following is a simple example of a contract which implements a counter. Both the `initialize()` and `increment()` functions return the currently set value.
+
+```sway
+{{#include ../../../examples/counter/src/main.sw}}
+```
diff --git a/docs/src/examples/index.md b/docs/src/examples/index.md
@@ -2,6 +2,7 @@
 
 Some basic example contracts to see how Sway and Forc work.
 
+- [Counter](./counter.md)
 - [Subcurrency](./subcurrency.md)
 - [FizzBuzz](./fizzbuzz.md)
 - [Wallet Smart Contract](./wallet_smart_contract.md)
diff --git a/examples/counter/.gitignore b/examples/counter/.gitignore
@@ -0,0 +1,2 @@
+out
+target
diff --git a/examples/counter/Forc.lock b/examples/counter/Forc.lock
@@ -0,0 +1,21 @@
+[[package]]
+name = 'core'
+source = 'git+http://github.com/FuelLabs/sway-lib-core?reference=master#30274cf817c1848e28f984c2e8703eb25e7a3a44'
+dependencies = []
+
+[[package]]
+name = 'core'
+source = 'git+https://github.com/FuelLabs/sway-lib-core?reference=master#30274cf817c1848e28f984c2e8703eb25e7a3a44'
+dependencies = []
+
+[[package]]
+name = 'counter'
+dependencies = [
+    'core git+http://github.com/FuelLabs/sway-lib-core?reference=master#30274cf817c1848e28f984c2e8703eb25e7a3a44',
+    'std git+http://github.com/FuelLabs/sway-lib-std?reference=master#6a8f5bf588df5d0679fb834f05c900f2e54de426',
+]
+
+[[package]]
+name = 'std'
+source = 'git+http://github.com/FuelLabs/sway-lib-std?reference=master#6a8f5bf588df5d0679fb834f05c900f2e54de426'
+dependencies = ['core git+https://github.com/FuelLabs/sway-lib-core?reference=master#30274cf817c1848e28f984c2e8703eb25e7a3a44']
diff --git a/examples/counter/Forc.toml b/examples/counter/Forc.toml
@@ -0,0 +1,9 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "counter"
+
+[dependencies]
+core = { git = "http://github.com/FuelLabs/sway-lib-core" }
+std = { git = "http://github.com/FuelLabs/sway-lib-std" }
diff --git a/examples/counter/src/main.sw b/examples/counter/src/main.sw
@@ -0,0 +1,22 @@
+contract;
+
+use std::storage::{get, store};
+
+const KEY = 0x0000000000000000000000000000000000000000000000000000000000000000;
+
+abi Incrementor {
+    fn initialize(initial_value: u64) -> u64;
+    fn increment(initial_value: u64) -> u64;
+}
+
+impl Incrementor for Contract {
+    fn initialize(initial_value: u64) -> u64 {
+        store(KEY, initial_value);
+        initial_value
+    }
+    fn increment(increment_by: u64) -> u64 {
+        let new_val = get::<u64>(KEY) + 1;
+        store(KEY, new_val);
+        new_val
+    }
+}