Skip to content

Commit

Permalink
feat(docs): Add typescript sdk example snippets in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nonast committed Oct 30, 2024
1 parent a2eca7a commit 4ddc0c4
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ For this example, we use an `AliasOutput` to extract an `Alias` object that owns
</TabItem>
<TabItem value="typescript" label="TypeScript">

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/address-unlock-condition.ts#L44-L50
```
</TabItem>
</Tabs>

Expand All @@ -43,6 +45,9 @@ For this example, we use an `AliasOutput` to extract an `Alias` object that owns

</TabItem>
<TabItem value="typescript" label="TypeScript">
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/address-unlock-condition.ts#L53-L70
```


</TabItem>
</Tabs>
Expand All @@ -57,7 +62,8 @@ For this example, we use an `AliasOutput` to extract an `Alias` object that owns

</TabItem>
<TabItem value="typescript" label="TypeScript">

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/address-unlock-condition.ts#L77-L95
```
</TabItem>
</Tabs>

Expand All @@ -71,6 +77,7 @@ For this example, we use an `AliasOutput` to extract an `Alias` object that owns

</TabItem>
<TabItem value="typescript" label="TypeScript">

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/address-unlock-condition.ts#L97-L166
```
</TabItem>
</Tabs>
12 changes: 8 additions & 4 deletions docs/content/developer/stardust/claiming/alias.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ The first step is to fetch the `AliasOutput` object that needs to be claimed.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/alias-output-claim.ts#L24-L30
```

</TabItem>
</Tabs>
Expand All @@ -50,7 +51,8 @@ Next, check the native tokens that might be held by this output. A [`Bag`](../..
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/alias-output-claim.ts#L31-L60
```

</TabItem>
</Tabs>
Expand All @@ -70,7 +72,8 @@ The main purpose of claiming is to extract the `Alias` object from the `AliasOut

</TabItem>
<TabItem value="typescript" label="TypeScript">

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/alias-output-claim.ts#L62-L110
```
</TabItem>
</Tabs>

Expand Down Expand Up @@ -111,6 +114,7 @@ Once the package is prepared, you can extract and use a Stardust `Alias` in a si

</TabItem>
<TabItem value="typescript" label="TypeScript">

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/alias-migration.ts#L75-L170
```
</TabItem>
</Tabs>
12 changes: 8 additions & 4 deletions docs/content/developer/stardust/claiming/basic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ To begin, you need to determine if your `BasicOutput` can be unlocked. You can a
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/check-basic-output-unlock-conditions.ts#L17-L47
```

</TabItem>
</Tabs>
Expand All @@ -51,7 +52,8 @@ The first step is to fetch the `BasicOutput` object that you intend to claim.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/basic-output-claim.ts#L25-L30
```

</TabItem>
</Tabs>
Expand All @@ -74,7 +76,8 @@ these keys are strings representing the [`OTW`](../../iota-101/move-overview/one
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/basic-output-claim.ts#L38-L61
```

</TabItem>
</Tabs>
Expand All @@ -93,7 +96,8 @@ along with the `Bag` keys to iterate over the extracted native tokens.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/basic-output-claim.ts#L63-L105
```

</TabItem>
</Tabs>
16 changes: 10 additions & 6 deletions docs/content/developer/stardust/claiming/foundry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ The first step is to retrieve the `AliasOutput` object that you intend to claim.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/foundry-output-claim.ts#L33-L38
```

</TabItem>
</Tabs>
Expand All @@ -43,7 +44,8 @@ Next, use the dynamic field function with the "alias" dynamic field key filter t
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/foundry-output-claim.ts#L40-L58
```

</TabItem>
</Tabs>
Expand All @@ -61,7 +63,8 @@ The `Alias` object may own various other objects (for more details, refer to the
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/foundry-output-claim.ts#L60-L86
```

</TabItem>
</Tabs>
Expand All @@ -79,7 +82,8 @@ Since each native token is tied to its own package, a Foundry's native token has
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/foundry-output-claim.ts#L87-L88
```

</TabItem>
</Tabs>
Expand All @@ -97,8 +101,8 @@ Finally, you should create a Programmable Transaction Block (PTB) that claims th
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon

```typescript file=<rootDir>/docs/examples/typescript/src/stardust/foundry-output-claim.ts#L90-L132
```
</TabItem>
</Tabs>

12 changes: 8 additions & 4 deletions docs/content/developer/stardust/claiming/nft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ The first step in claiming your NFT is to retrieve the `NftOutput` object that y
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/nft-output-claim.ts#L24-L35
```

</TabItem>
</Tabs>
Expand All @@ -56,7 +57,8 @@ representing the [`OTW`](../../iota-101/move-overview/one-time-witness.mdx) used
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/nft-output-claim.ts#L37-L64
```

</TabItem>
</Tabs>
Expand All @@ -77,7 +79,8 @@ The primary goal of this process is to extract the `Nft` object from the `NftOut
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/nft-output-claim.ts#L66-L113
```

</TabItem>
</Tabs>
Expand Down Expand Up @@ -117,7 +120,8 @@ This method uses the metadata from the Stardust `Nft` to mint a new NFT.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/nft-migration.ts#L38-L83
```

</TabItem>
</Tabs>
9 changes: 6 additions & 3 deletions docs/content/developer/stardust/claiming/self-sponsor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ Use the IOTA `coin_type` to derive the sponsor and sender addresses.
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/iota-self-sponsor.ts#L19-L24
```

</TabItem>
</Tabs>
Expand All @@ -48,7 +49,8 @@ This process is similar to the one outlined in the [Basic Output](basic.mdx) gui
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/iota-self-sponsor.ts#L41-L71
```

</TabItem>
</Tabs>
Expand All @@ -66,7 +68,8 @@ For this transaction, both the sender address (the object's owner) and the spons
</TabItem>
<TabItem value="typescript" label="TypeScript">

Coming soon
```typescript file=<rootDir>/docs/examples/typescript/src/stardust/iota-self-sponsor.ts#L73-L104
```

</TabItem>
</Tabs>

0 comments on commit 4ddc0c4

Please sign in to comment.