From e9c2e6a81a1dfa4e9c74a2e5809cfc4baa6f500e Mon Sep 17 00:00:00 2001 From: Adam Date: Mon, 12 Feb 2024 13:21:27 -0800 Subject: [PATCH] added into docusaurus --- docs/docs/how-to/auction/create.md | 31 ++++++++++++++++++++++++++++++ docs/sidebars.js | 3 +++ 2 files changed, 34 insertions(+) create mode 100644 docs/docs/how-to/auction/create.md diff --git a/docs/docs/how-to/auction/create.md b/docs/docs/how-to/auction/create.md new file mode 100644 index 0000000000..7c97b0f344 --- /dev/null +++ b/docs/docs/how-to/auction/create.md @@ -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. + + + + 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 + ``` + + + + + 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 + ``` + + diff --git a/docs/sidebars.js b/docs/sidebars.js index 84c931343e..96ac9656d9 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,6 +29,9 @@ const sidebars = { 'how-to/project/create-project', ], }, + { + 'Auction API': ['how-to/auction/create'], + }, { 'DAO Management': [ {