Skip to content

Commit

Permalink
fix(docs/standards): minor docs refactoring (#3584)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dkwcs authored Oct 25, 2024
1 parent 8c2f491 commit 30fd747
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/content/developer/standards/coin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ We highly recommend you use the [Coin Manager](./coin-manager.mdx) functionality

The Coin standard includes the ability to create regulated coins. To create a regulated coin, you use the `coin::create_regulated_currency` function (which uses the `coin::create_currency` function itself), but which also returns a `DenyCap` capability. The `DenyCap` capability allows the bearer to maintain a list of addresses that aren't allowed to use the token.

:::tip TIP

The [regulated-coin-example](https://github.com/iotaledger/iota/blob/develop/examples/move/coin/sources/regcoin.move) repository provides an example of regulated coin creation.

:::

### DenyList object

The list of addresses that aren't able to use a particular regulated coin is held within a system-created `DenyList` shared object. If you have access to the `DenyCap`, then you can use the `coin::deny_list_add` and `coin::deny_list_remove` functions to add and remove addresses. You can also use the `coin::deny_list_contains` function to check if an address is already on the list.
Expand Down
9 changes: 8 additions & 1 deletion docs/content/developer/standards/kiosk-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ Kiosk has an `id: UID` field like all objects on IOTA, which allows this object

A Kiosk can carry additional dynamic fields and dynamic object fields. The `uid_mut_as_owner` function allows the Kiosk owner to mutably access the `UID` of the Kiosk object and use it to add or remove custom fields.

Its function signature is: `kiosk::uid_mut_as_owner(self: &mut Kiosk, cap: &KioskOwnerCap): &mut UID`
Function signature:

`kiosk::uid_mut_as_owner(self: &mut Kiosk, cap: &KioskOwnerCap): &mut UID`

### The public UID getter

Expand Down Expand Up @@ -253,4 +255,9 @@ txb.moveCall({
});
```


## Related links

- [NFT Rental](../iota-101/nft/rent-nft.mdx): An example implementation of the Kiosk Apps standard that enables renting NFTs.

<Quiz questions={questions} />
2 changes: 1 addition & 1 deletion docs/content/developer/standards/kiosk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ iota client call \

### Create an IOTA Kiosk With Advanced Options

For more advanced use cases, when you want to choose the storage model or perform an action right away, you can use the programmable transaction block (PTB) friendly function kiosk::new.
For more advanced use cases, when you want to choose the storage model or perform an action right away, you can use the programmable transaction block (PTB) friendly function `kiosk::new`.
Kiosk is designed to be shared. If you choose a different storage model, such as owned, your kiosk might not function as intended or not be accessible to other users. You can make sure your Kiosk works by testing it on IOTA Testnet.

### Create an Iota Kiosk With Advanced Options Using Programmable Transaction Blocks
Expand Down

0 comments on commit 30fd747

Please sign in to comment.