Skip to content

Commit

Permalink
fix(docs/kiosk): update some Kiosk links, add more examples (#4193)
Browse files Browse the repository at this point in the history
* fix(docs/kiosk): update some Kiosk links, add more examples, create marketplace extension doc page
  • Loading branch information
Dkwcs authored Dec 5, 2024
1 parent 4fd9abc commit 5546782
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 2 deletions.
17 changes: 17 additions & 0 deletions docs/content/developer/iota-101/nft/marketplace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
description: A brief introduction to implementing NFT marketplace extension using the Kiosk Apps standard in IOTA's Move language.
---




import Marketplace from '../../../../examples/move/nft_marketplace/README.md';

# Marketplace Extension

The Marketplace Extension for [IOTA Kiosk](../../standards/kiosk.mdx) is a customizable framework that extends the functionality of the IOTA Kiosk by enabling efficient asset trading with integrated royalty management and pricing mechanism.

Kiosk owners can list items for sale by setting prices, and enforce royalties, ensuring creators receive a percentage of each sale. Buyers can securely purchase items, with the extension validating payments and handling royalties automatically. All transactions are governed by robust transfer policies, ensuring security and compliance.

<Marketplace />

5 changes: 5 additions & 0 deletions docs/content/developer/iota-101/nft/rent-nft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ The rental smart contract utilizes th [Kiosk Apps](../../standards/kiosk-apps.md
Both lenders and borrowers must install a Kiosk extension to participate.
Additionally, the creator of the NFT type must create a rental policy and a `ProtectedTP` object to allow the extension to manage rentals while enforcing royalties.

## Move Module Details

The NFT rental functionality is implemented in a single Move module: `nft_rental.move`.
You can find the source code in the [IOTA repository](https://github.com/iotaledger/iota/tree/develop/docs/examples/move/nft_marketplace/sources/rental_extension.move) under the `examples` directory. The code includes comments to help you understand the logic and structure.

### The `nft_rental` Module

The `nft_rental` module provides an API for:
Expand Down
3 changes: 3 additions & 0 deletions docs/content/developer/standards/kiosk-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -259,5 +259,8 @@ txb.moveCall({
## Related links

- [NFT Rental](../iota-101/nft/rent-nft.mdx): An example implementation of the Kiosk Apps standard that enables renting NFTs.
- [NFT Rental Extension](https://github.com/iotaledger/iota/tree/develop/docs/examples/move/nft_marketplace/sources/rental_extension.move): An example implementation of the Kiosk Extension standard that enables renting NFTs.
- [Marketplace](../iota-101/nft/marketplace.mdx): An example implementation of the Kiosk Apps standard that enables marketplace functionality.
- [Marketplace Extension](https://github.com/iotaledger/iota/tree/develop/docs/examples/move/nft_marketplace/sources/marketplace_extension.move): Move module that contains the source code(Kiosk extension) for the marketplace app.

<Quiz questions={questions} />
2 changes: 1 addition & 1 deletion docs/content/sidebars/developer.js
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ const developer = [
{
type: 'category',
label: 'NFT',
items: ['developer/iota-101/nft/create-nft', 'developer/iota-101/nft/rent-nft'],
items: ['developer/iota-101/nft/create-nft', 'developer/iota-101/nft/rent-nft', 'developer/iota-101/nft/marketplace'],
},
{
type: 'category',
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/move/nft_marketplace/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Marketplace Guide
# Marketplace Extension Usage

## Modules

Expand Down

0 comments on commit 5546782

Please sign in to comment.