Skip to content

Commit d978843

Browse files
ryanwaitsryanwaits
committed
remove legacy examples that have been deprecated in v7
1 parent 8aea049 commit d978843

File tree

1 file changed

+38
-143
lines changed

1 file changed

+38
-143
lines changed

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

+38-143
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In this guide, you will learn how to:
1616
1. [Construct post-conditions](#constructing-post-conditions).
1717
2. [Use post-conditions](#using-post-conditions).
1818
3. [Set the post-condition mode](#setting-the-post-condition-mode).
19-
4. [Use the legacy methods/enums](#using-the-legacy-methods-enums).
19+
4. [Usage examples](#usage-examples).
2020

2121
---
2222

@@ -86,170 +86,65 @@ const tx = await makeContractCall({
8686

8787
Essentially, the `postConditionMode` is what tells the Stacks node whether to require (`Deny`) or ignore (`Allow`) the post-conditions when evaluating the transaction.
8888

89-
## Legacy methods/enums
89+
## Usage examples
9090

91-
Legacy methods and enums can be used interchangeably with the builder methods.
91+
### Amount uSTX sent
9292

93-
<Callout title="Note">
94-
If you prefer the legacy methods over the `Pc` builder approach, you can import them from the `@stacks/transactions` package.
95-
</Callout>
93+
Construct a post-condition for a certain amount of uSTX to be sent.
9694

9795
```ts
98-
import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
96+
import { Pc } from '@stacks/transactions';
9997

100-
const postCondition = createSTXPostCondition(
101-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
102-
FungibleConditionCode.Equal,
103-
1000
104-
);
98+
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
99+
.willSendEq(1000)
100+
.ustx();
105101
```
106102

107-
Some other examples can be found below:
108-
109-
- [`createSTXPostCondition`](https://stacks.js.org/functions/_stacks_transactions.createSTXPostCondition)
110-
- [`createFungiblePostCondition`](https://stacks.js.org/functions/_stacks_transactions.createFungiblePostCondition)
111-
- [`createNonFungiblePostCondition`](https://stacks.js.org/functions/_stacks_transactions.createNonFungiblePostCondition)
112-
- [`FungibleConditionCode`](https://stacks.js.org/enums/_stacks_transactions.FungibleConditionCode)
113-
- [`NonFungibleConditionCode`](https://stacks.js.org/enums/_stacks_transactions.NonFungibleConditionCode)
114-
115-
<Callout title="Note">
116-
Use the `Pc` helpers to construct post-conditions in a clear and concise manner.
117-
</Callout>
118-
119-
---
120-
121-
## Amount uSTX sent
122-
123-
Construct a post-condition for a certain amount of uSTX to be sent.
124-
125-
<Tabs id="eq-ustx" items={["Pc","Legacy"]}>
126-
<Tab value={"Pc"}>
127-
```ts
128-
import { Pc } from '@stacks/transactions';
129-
130-
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
131-
.willSendEq(1000)
132-
.ustx();
133-
```
134-
</Tab>
135-
<Tab value={"Legacy"}>
136-
```ts
137-
import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
138-
139-
const postCondition = createSTXPostCondition(
140-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
141-
FungibleConditionCode.Equal,
142-
1000
143-
);
144-
```
145-
</Tab>
146-
</Tabs>
147-
148-
## Amount FT sent
103+
### Amount FT sent
149104

150105
Construct a post-condition for a certain amount of a specific FT to be sent.
151106

152-
<Tabs id="gte-ft" items={["Pc","Legacy"]}>
153-
<Tab value={"Pc"}>
154-
```ts
155-
import { Pc } from '@stacks/transactions';
107+
```ts
108+
import { Pc } from '@stacks/transactions';
156109

157-
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft')
158-
.willSendGte(500)
159-
.ft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft', 'token');
110+
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft')
111+
.willSendGte(500)
112+
.ft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft', 'token');
160113
```
161-
</Tab>
162-
<Tab value={"Legacy"}>
163-
```ts
164-
import { createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
165-
166-
const postCondition = createSTXPostCondition(
167-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft",
168-
FungibleConditionCode.GreaterEqual,
169-
500,
170-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-ft::token"
171-
);
172-
```
173-
</Tab>
174-
</Tabs>
175-
176-
## Amount NFT sent / not sent
114+
115+
### Amount NFT sent / not sent
177116

178117
Construct a post-condition for sending / not-sending a specific NFT.
179118

180-
<Tabs id="post-condition-examples" items={["Pc","Legacy"]}>
181-
<Tab value={"Pc"}>
182-
```ts
183-
import { Pc } from '@stacks/transactions';
119+
```ts
120+
import { Pc } from '@stacks/transactions';
184121

185-
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
186-
.willNotSendAsset()
187-
.nft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token', Cl.uint(12));
122+
const postCondition = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
123+
.willNotSendAsset()
124+
.nft('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token', Cl.uint(12));
188125
```
189-
</Tab>
190-
<Tab value={"Legacy"}>
191-
```ts
192-
import { createNonFungiblePostCondition, NonFungibleConditionCode } from '@stacks/transactions';
193126

194-
const postCondition = createNonFungiblePostCondition(
195-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
196-
NonFungibleConditionCode.DoesNotSend,
197-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.token-nft::token",
198-
Cl.uint(12)
199-
);
200-
```
201-
</Tab>
202-
</Tabs>
127+
### Amount SFT sent / not sent
203128

204-
## Amount SFT sent / not sent
129+
Construct a post-condition for sending / not-sending a specific SFT (Semi-fungible token).
205130

206-
Construct a post-condition for sending / not-sending a specific SFT (semi-fungible token).
207-
208-
Semi-Fungible-Tokens (SFTs) are an innovative way to bring multiple ownership of a single unique digital item. SFTs are a combination of an NFT portion and an FT portion: where a unique tuple represents the NFT id and the amount units represented as fungible tokens. Therefore, at least two post-conditions are needed to handle the transfer of an SFT.
209-
210-
Check out the SFT starter contract template on the Hiro Platform.
211-
212-
<Tabs id="post-condition-examples" items={["Pc","Legacy"]}>
213-
<Tab value={"Pc"}>
214-
```ts
215-
import { Pc } from '@stacks/transactions';
216-
217-
const postCondition1 = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
218-
.willSendAsset()
219-
.nft(
220-
"ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token::semi-fungible-token-id",
221-
Cl.tuple({ "token-id": Cl.uint(1), owner: Cl.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6') })
222-
);
131+
```ts
132+
import { Cl, Pc } from '@stacks/transactions';
223133

224-
const postCondition2 = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
225-
.willSendEq(500)
226-
.ft("ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token", "semi-fungible-token");
134+
const postConditionForNFT = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
135+
.willSendAsset()
136+
.nft(
137+
"ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token::semi-fungible-token-id",
138+
Cl.tuple({ "token-id": Cl.uint(1), owner: Cl.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6') })
139+
);
227140

141+
const postConditionForFT = Pc.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6')
142+
.willSendEq(500)
143+
.ft("ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token", "semi-fungible-token");
228144
```
229-
</Tab>
230-
<Tab value={"Legacy"}>
231-
```ts
232-
import { createNonFungiblePostCondition, NonFungibleConditionCode, createSTXPostCondition, FungibleConditionCode } from '@stacks/transactions';
233-
234-
const postCondition1 = createNonFungiblePostCondition(
235-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
236-
NonFungibleConditionCode.DoesSend,
237-
"ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token::semi-fungible-token-id",
238-
Cl.tuple({ "token-id": Cl.uint(1), owner: Cl.principal('STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6') })
239-
);
240-
241-
const postCondition = createSTXPostCondition(
242-
"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
243-
FungibleConditionCode.Equal,
244-
500,
245-
"ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.semi-fungible-token::semi-fungible-token"
246-
);
247-
```
248-
</Tab>
249-
</Tabs>
250-
251-
<Callout title="Note" type="warn">
252-
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.
145+
146+
<Callout title="Note">
147+
The previous builders (`makeStandardSTXPostCondition`, `makeStandardFungiblePostCondition`, etc) were removed in `v7.0.0`.
253148
</Callout>
254149

255150
---
@@ -265,6 +160,6 @@ Post-conditions can only ensure the transfer of assets and cannot guarantee the
265160
<Card
266161
href="/stacks/stacks.js/packages/transactions"
267162
title="API References"
268-
description="Dive into the API references for Stacks.js."
163+
description="Dive deeper into the API references for the Stacks.js transactions package."
269164
/>
270165
</Cards>

0 commit comments

Comments
 (0)