feat: document "Transferable" flag

refactor: update demot NFT
sablier-labs · Dec 21, 2023 · 8d9de8c · 8d9de8c
1 parent ed052d2
commit 8d9de8c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/docs/contracts/v2/guides/create-stream/01-lockup-linear.mdx b/docs/contracts/v2/guides/create-stream/01-lockup-linear.mdx
@@ -12,6 +12,7 @@ import ParamCancelable from "@site/docs/snippets/ParamCancelable.mdx";
 import ParamRecipient from "@site/docs/snippets/ParamRecipient.mdx";
 import ParamSender from "@site/docs/snippets/ParamSender.mdx";
 import ParamTotalAmount from "@site/docs/snippets/ParamTotalAmount.mdx";
+import ParamTransferable from "@site/docs/snippets/ParamTransferable.mdx";
 
 # Create a Lockup Linear stream
 
@@ -120,6 +121,8 @@ Let's review each parameter in detail.
 
 <ParamCancelable />
 
+<ParamTransferable />
+
 <ParamBroker />
 
 ### Durations

diff --git a/docs/contracts/v2/guides/create-stream/02-lockup-dynamic.mdx b/docs/contracts/v2/guides/create-stream/02-lockup-dynamic.mdx
@@ -12,6 +12,7 @@ import ParamCancelable from "@site/docs/snippets/ParamCancelable.mdx";
 import ParamRecipient from "@site/docs/snippets/ParamRecipient.mdx";
 import ParamSender from "@site/docs/snippets/ParamSender.mdx";
 import ParamTotalAmount from "@site/docs/snippets/ParamTotalAmount.mdx";
+import ParamTransferable from "@site/docs/snippets/ParamTransferable.mdx";
 
 # Create a Lockup Dynamic stream
 
@@ -127,6 +128,8 @@ Let's review each parameter in detail.
 
 <ParamCancelable />
 
+<ParamTransferable />
+
 <ParamBroker />
 
 ### Start time

diff --git a/docs/snippets/ParamTransferable.mdx b/docs/snippets/ParamTransferable.mdx
@@ -0,0 +1,7 @@
+### Transferable
+
+Boolean that indicates whether the stream will be transferable or not.
+
+```solidity
+params.transferable = true;
+```
diff --git a/static/img/nft.svg b/static/img/nft.svg