Merge pull request #948 from hirosystems/sft-pc-example

Added an SFT PC example to PC guide

Author: ryanwaits

content/docs/stacks/stacks.js/guides/post-conditions.mdx

@@ -16,7 +16,7 @@ In this guide, you will learn how to:
 1. [Construct post-conditions](#constructing-post-conditions).
 2. [Use post-conditions](#using-post-conditions).
 3. [Set the post-condition mode](#setting-the-post-condition-mode).
-4. [Use the legacy methods/enums](#using-the-legacy-methods-enums).
+4. [Usage examples](#usage-examples).
 
 ---
 
@@ -86,123 +86,65 @@ const tx = await makeContractCall({
 
 Essentially, the `postConditionMode` is what tells the Stacks node whether to require (`Deny`) or ignore (`Allow`) the post-conditions when evaluating the transaction.
 
-## Legacy methods/enums
+## Usage examples
 
-Legacy methods and enums can be used interchangeably with the builder methods.
+### Amount uSTX sent
 
-<Callout title="Note">
-If you prefer the legacy methods over the `Pc` builder approach, you can import them from the `@stacks/transactions` package.
-</Callout>
+Construct a post-condition for a certain amount of uSTX to be sent.
 
 ```ts
-import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
+import { Pc } from '@stacks/transactions';
 
-const postCondition = createSTXPostCondition(
-  "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
-  FungibleConditionCode.Equal,
-  1000
-);
+const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
+  .willSendEq(1000)
+  .ustx();
 ```
 
-Some other examples can be found below:
+### Amount FT sent
 
-- [`createSTXPostCondition`](https://stacks.js.org/functions/_stacks_transactions.createSTXPostCondition)
-- [`createFungiblePostCondition`](https://stacks.js.org/functions/_stacks_transactions.createFungiblePostCondition)
-- [`createNonFungiblePostCondition`](https://stacks.js.org/functions/_stacks_transactions.createNonFungiblePostCondition)
-- [`FungibleConditionCode`](https://stacks.js.org/enums/_stacks_transactions.FungibleConditionCode)
-- [`NonFungibleConditionCode`](https://stacks.js.org/enums/_stacks_transactions.NonFungibleConditionCode)
+Construct a post-condition for a certain amount of a specific FT to be sent.
 
-<Callout title="Note">
-Use the `Pc` helpers to construct post-conditions in a clear and concise manner.
-</Callout>
+```ts
+import { Pc } from '@stacks/transactions';
 
----
+const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft')
+  .willSendGte(500)
+  .ft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft', 'token');
+```
 
-## Amount uSTX sent
+### Amount NFT sent / not sent
 
-Construct a post-condition for a certain amount of uSTX to be sent.
+Construct a post-condition for sending / not-sending a specific NFT.
 
-<Tabs id="eq-ustx" items={["Pc","Legacy"]}>
-  <Tab value={"Pc"}>
-    ```ts
-    import { Pc } from '@stacks/transactions';
-
-    const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
-      .willSendEq(1000)
-      .ustx();
-    ```
-  </Tab>
-  <Tab value={"Legacy"}>
-    ```ts
-    import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
-
-    const postCondition = createSTXPostCondition(
-      "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
-      FungibleConditionCode.Equal,
-      1000
-    );
-    ```
-  </Tab>
-</Tabs>
-
-## Amount FT sent
+```ts
+import { Pc } from '@stacks/transactions';
 
-Construct a post-condition for a certain amount of a specific FT to be sent.
+const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
+  .willNotSendAsset()
+  .nft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token', Cl.uint(12));
+```
 
-<Tabs id="gte-ft" items={["Pc","Legacy"]}>
-  <Tab value={"Pc"}>
-    ```ts
-    import { Pc } from '@stacks/transactions';
+### Amount SFT sent / not sent
 
-    const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft')
-      .willSendGte(500)
-      .ft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft', 'token');
-```
-  </Tab>
-  <Tab value={"Legacy"}>
-    ```ts
-    import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
-
-    const postCondition = createSTXPostCondition(
-      "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft",
-      FungibleConditionCode.GreaterEqual,
-      500,
-      "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft::token"
-    );
-    ```
-  </Tab>
-</Tabs>
-
-## Amount NFT sent / not sent
+Construct a post-condition for sending / not-sending a specific SFT (Semi-fungible token).
 
-Construct a post-condition for sending / not-sending a specific NFT.
+```ts
+import { Cl, Pc } from '@stacks/transactions';
 
-<Tabs id="post-condition-examples" items={["Pc","Legacy"]}>
-  <Tab value={"Pc"}>
-    ```ts
-    import { Pc } from '@stacks/transactions';
+const postConditionForNFT = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
+.willSendAsset()
+.nft(
+  "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token::semi-fungible-token-id",
+  Cl.tuple({ "token-id": Cl.uint(1), owner: Cl.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6') })
+);
 
-    const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
-      .willNotSendAsset()
-      .nft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token', Cl.uint(12));
+const postConditionForFT = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
+.willSendEq(500)
+.ft("ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token", "semi-fungible-token");
 ```
-  </Tab>
-  <Tab value={"Legacy"}>
-    ```ts
-    import { createNonFungiblePostCondition, NonFungibleConditionCode } from '@stacks/transactions';
-
-    const postCondition = createNonFungiblePostCondition(
-      "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
-      NonFungibleConditionCode.DoesNotSend,
-      "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token",
-      Cl.uint(12)
-    );
-    ```
-  </Tab>
-</Tabs>
-
-<Callout title="Note" type="warn">
-Post-conditions can only ensure the transfer of assets and cannot guarantee the end-state after a transaction. To learn more, read the [post-conditions](/stacks/stacks.js/concepts/post-conditions) guide.
+
+<Callout title="Note">
+The previous builders (`makeStandardSTXPostCondition`, `makeStandardFungiblePostCondition`, etc) were removed in `v7.0.0`.
 </Callout>
 
 ---
@@ -218,6 +160,6 @@ Post-conditions can only ensure the transfer of assets and cannot guarantee the
   <Card
     href="/stacks/stacks.js/packages/transactions"
     title="API References"
-    description="Dive into the API references for Stacks.js."
+    description="Dive deeper into the API references for the Stacks.js transactions package."
   />
 </Cards>