Skip to content

Commit

Permalink
added into docusaurus
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam committed Feb 12, 2024
1 parent 70ce641 commit e9c2e6a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/docs/how-to/auction/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Create Auction
tags:
- how-to
- auction
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import DeepLink from '../../_admonitions/_deep_link.md'

Auction APIs allows you to run generic auction without or with an asset. Asset can be NFT.

<Tabs>
<TabItem value="otr" label="OTR">
To create auction, you must call [`AuctionOtrDataset`](../../reference-api/classes/AuctionOtrDataset.md#create) on `dataset(Dataset.AUCTION)`.
[`create`](../../reference-api/classes/AuctionOtrDataset.md#create) takes an object of type [`AuctionCreateTangleRequest`](../../reference-api/interfaces/AuctionCreateTangleRequest.md) as parameter.

```tsx file=../../../../packages/sdk/examples/auction/otr/create.ts#L4-L47
```

<DeepLink/>
</TabItem>
<TabItem value="https" label="HTTPS">
To create auction, you must call [`create`](../../reference-api/classes/AuctionDataset.md#create) on `dataset(Dataset.AUCTION)`.
[`create`](../../reference-api/classes/NftDataset.md#create) takes an object of type [`AuctionCreateRequest`](../../reference-api/interfaces/AuctionCreateRequest.md) as parameter.

```tsx file=../../../../packages/sdk/examples/auction/https/create.ts#L6-L63
```
</TabItem>
</Tabs>
3 changes: 3 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ const sidebars = {
'how-to/project/create-project',
],
},
{
'Auction API': ['how-to/auction/create'],
},
{
'DAO Management': [
{
Expand Down

0 comments on commit e9c2e6a

Please sign in to comment.