Sway Reference: Section 9 Annotations. Document the payable annotation (

FuelLabs#4619)
8siceVobpu · Jun 2, 2023 · 6a9ba1e · 6a9ba1e
1 parent 545d7c4
commit 6a9ba1e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md
@@ -56,6 +56,7 @@
   - [Types](./documentation/language/annotations/type.md)
   - [Attributes](./documentation/language/annotations/attributes/index.md)
     - [Storage](./documentation/language/annotations/attributes/storage.md)
+    - [Payable](./documentation/language/annotations/attributes/payable.md)
     - [Test](./documentation/language/annotations/attributes/test.md)
 - [Traits](./documentation/language/traits/index.md)
 - [Generics](./documentation/language/generics/index.md)

diff --git a/docs/reference/src/code/language/annotations/src/main.sw b/docs/reference/src/code/language/annotations/src/main.sw
@@ -32,3 +32,10 @@ fn example() {
     let baz: bool = true;
     // ANCHOR_END: example
 }
+
+abi MyContract {
+    // ANCHOR: payable
+    #[payable]
+    fn deposit();
+    // ANCHOR_END: payable
+}
diff --git a/docs/reference/src/documentation/language/annotations/attributes/payable.md b/docs/reference/src/documentation/language/annotations/attributes/payable.md
@@ -0,0 +1,11 @@
+# Payable
+
+The payable annotation is used to allow a [contract](../../program-types/contract.md) [function](../../functions/index.md) to accept an asset forwarded via a call.
+
+## Usage
+
+To allow a [contract](../../program-types/contract.md) to accept assets we use the `payable` keyword.
+
+```sway
+{{#include ../../../../code/language/annotations/src/main.sw:payable}}
+```