Merge pull request #229 from sablier-labs/refactor/lockup-prefix

refactor: add Lockup prefix to param snippets
sablier-labs · Dec 24, 2024 · bf490cf · bf490cf
2 parents 05089c2 + 93bea29
commit bf490cf
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 42 deletions.
diff --git a/docs/guides/lockup/examples/create-stream/01-lockup-linear.mdx b/docs/guides/lockup/examples/create-stream/01-lockup-linear.mdx
@@ -7,13 +7,13 @@ title: "Lockup Linear"
 import AdmonitionSimpleCode from "@site/docs/snippets/AdmonitionSimpleCode.mdx";
 import CreateFunctions from "@site/docs/snippets/CreateFunctions.mdx";
 import LockupDeployment from "@site/docs/snippets/LockupDeployment.mdx";
-import ParamAsset from "@site/docs/snippets/ParamAsset.mdx";
-import ParamBroker from "@site/docs/snippets/ParamBroker.mdx";
-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";
+import LockupParamAsset from "@site/docs/snippets/LockupParamAsset.mdx";
+import LockupParamBroker from "@site/docs/snippets/LockupParamBroker.mdx";
+import LockupParamCancelable from "@site/docs/snippets/LockupParamCancelable.mdx";
+import LockupParamRecipient from "@site/docs/snippets/LockupParamRecipient.mdx";
+import LockupParamSender from "@site/docs/snippets/LockupParamSender.mdx";
+import LockupParamTotalAmount from "@site/docs/snippets/LockupParamTotalAmount.mdx";
+import LockupParamTransferable from "@site/docs/snippets/LockupParamTransferable.mdx";
 
 # Create a Lockup Linear stream
 
@@ -106,17 +106,17 @@ LockupLinear.CreateWithDurations memory params;
 
 Let's review each parameter in detail.
 
-<ParamSender />
+<LockupParamSender />
 
-<ParamRecipient />
+<LockupParamRecipient />
 
-<ParamTotalAmount />
+<LockupParamTotalAmount />
 
-<ParamAsset />
+<LockupParamAsset />
 
-<ParamCancelable />
+<LockupParamCancelable />
 
-<ParamTransferable />
+<LockupParamTransferable />
 
 ### Durations
 
@@ -129,7 +129,7 @@ params.durations = LockupLinear.Durations({
 });
 ```
 
-<ParamBroker />
+<LockupParamBroker />
 
 ## Invoke the create function
 

diff --git a/docs/guides/lockup/examples/create-stream/02-lockup-dynamic.mdx b/docs/guides/lockup/examples/create-stream/02-lockup-dynamic.mdx
@@ -7,13 +7,13 @@ title: "Lockup Dynamic"
 import AdmonitionSimpleCode from "@site/docs/snippets/AdmonitionSimpleCode.mdx";
 import CreateFunctions from "@site/docs/snippets/CreateFunctions.mdx";
 import LockupDeployment from "@site/docs/snippets/LockupDeployment.mdx";
-import ParamAsset from "@site/docs/snippets/ParamAsset.mdx";
-import ParamBroker from "@site/docs/snippets/ParamBroker.mdx";
-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";
+import LockupParamAsset from "@site/docs/snippets/LockupParamAsset.mdx";
+import LockupParamBroker from "@site/docs/snippets/LockupParamBroker.mdx";
+import LockupParamCancelable from "@site/docs/snippets/LockupParamCancelable.mdx";
+import LockupParamRecipient from "@site/docs/snippets/LockupParamRecipient.mdx";
+import LockupParamSender from "@site/docs/snippets/LockupParamSender.mdx";
+import LockupParamTotalAmount from "@site/docs/snippets/LockupParamTotalAmount.mdx";
+import LockupParamTransferable from "@site/docs/snippets/LockupParamTransferable.mdx";
 
 # Create a Lockup Dynamic stream
 
@@ -114,17 +114,17 @@ LockupDynamic.CreateWithTimestamps memory params;
 
 Let's review each parameter in detail.
 
-<ParamSender />
+<LockupParamSender />
 
-<ParamRecipient />
+<LockupParamRecipient />
 
-<ParamTotalAmount />
+<LockupParamTotalAmount />
 
-<ParamAsset />
+<LockupParamAsset />
 
-<ParamCancelable />
+<LockupParamCancelable />
 
-<ParamTransferable />
+<LockupParamTransferable />
 
 ### Start time
 
@@ -179,7 +179,7 @@ The `ud2x18` function wraps a basic integer to the `UD2x18` value type, which is
 
 :::
 
-<ParamBroker />
+<LockupParamBroker />
 
 ## Invoke the create function
 

diff --git a/docs/guides/lockup/examples/create-stream/03-lockup-tranched.mdx b/docs/guides/lockup/examples/create-stream/03-lockup-tranched.mdx
@@ -7,13 +7,13 @@ title: "Lockup Tranched"
 import AdmonitionSimpleCode from "@site/docs/snippets/AdmonitionSimpleCode.mdx";
 import CreateFunctions from "@site/docs/snippets/CreateFunctions.mdx";
 import LockupDeployment from "@site/docs/snippets/LockupDeployment.mdx";
-import ParamAsset from "@site/docs/snippets/ParamAsset.mdx";
-import ParamBroker from "@site/docs/snippets/ParamBroker.mdx";
-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";
+import LockupParamAsset from "@site/docs/snippets/LockupParamAsset.mdx";
+import LockupParamBroker from "@site/docs/snippets/LockupParamBroker.mdx";
+import LockupParamCancelable from "@site/docs/snippets/LockupParamCancelable.mdx";
+import LockupParamRecipient from "@site/docs/snippets/LockupParamRecipient.mdx";
+import LockupParamSender from "@site/docs/snippets/LockupParamSender.mdx";
+import LockupParamTotalAmount from "@site/docs/snippets/LockupParamTotalAmount.mdx";
+import LockupParamTransferable from "@site/docs/snippets/LockupParamTransferable.mdx";
 
 # Create a Lockup Tranched stream
 
@@ -113,17 +113,17 @@ LockupTranched.CreateWithDurations memory params;
 
 Let's review each parameter in detail.
 
-<ParamSender />
+<LockupParamSender />
 
-<ParamRecipient />
+<LockupParamRecipient />
 
-<ParamTotalAmount />
+<LockupParamTotalAmount />
 
-<ParamAsset />
+<LockupParamAsset />
 
-<ParamCancelable />
+<LockupParamCancelable />
 
-<ParamTransferable />
+<LockupParamTransferable />
 
 ### Tranches With Duration
 
@@ -153,7 +153,7 @@ params.tranches[1] = (
 In this example, the first tranche (`amount0`) will unlock at the end of the 4 weeks after the stream was created and
 the second tranche (`amount1`) will unlock after further 6 weeks. Thus, the total amount will be unlocked in 10 weeks.
 
-<ParamBroker />
+<LockupParamBroker />
 
 ## Invoke the create function
 

diff --git a/docs/snippets/ParamAsset.mdx → docs/snippets/LockupParamAsset.mdx b/docs/snippets/ParamAsset.mdx → docs/snippets/LockupParamAsset.mdx
diff --git a/docs/snippets/ParamBroker.mdx → docs/snippets/LockupParamBroker.mdx b/docs/snippets/ParamBroker.mdx → docs/snippets/LockupParamBroker.mdx
diff --git a/docs/snippets/ParamCancelable.mdx → docs/snippets/LockupParamCancelable.mdx b/docs/snippets/ParamCancelable.mdx → docs/snippets/LockupParamCancelable.mdx
diff --git a/docs/snippets/ParamRecipient.mdx → docs/snippets/LockupParamRecipient.mdx b/docs/snippets/ParamRecipient.mdx → docs/snippets/LockupParamRecipient.mdx
diff --git a/docs/snippets/ParamSender.mdx → docs/snippets/LockupParamSender.mdx b/docs/snippets/ParamSender.mdx → docs/snippets/LockupParamSender.mdx
diff --git a/docs/snippets/ParamTotalAmount.mdx → docs/snippets/LockupParamTotalAmount.mdx b/docs/snippets/ParamTotalAmount.mdx → docs/snippets/LockupParamTotalAmount.mdx
diff --git a/docs/snippets/ParamTransferable.mdx → docs/snippets/LockupParamTransferable.mdx b/docs/snippets/ParamTransferable.mdx → docs/snippets/LockupParamTransferable.mdx