Skip to content

Commit

Permalink
Update readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
gRoussac committed Sep 25, 2023
1 parent b6e5b46 commit 55060ea
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/modalities.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The following section discusses the currently implemented modalities and illustr
- [NFTHolderMode](#nftholdermode)
- [WhitelistMode](#whitelistmode)
- [Minting](#minting)
- [AllowMinting](#allowminting)
- [ACLPackageMode](#aclpackagemode)
- [PackageOperatorMode](#packageoperatormode)
- [NFTMetadataKind](#nftmetadatakind)
- [NFTIdentifierMode](#nftidentifiermode)
- [Metadata Mutability](#metadata-mutability)
Expand Down Expand Up @@ -92,7 +95,7 @@ The `WhitelistMode` dictates if the ACL whitelist restricting access to the mint
1. `Unlocked`: The ACL whitelist is unlocked and can be updated via the set variables endpoint.
2. `Locked`: The ACL whitelist is locked and cannot be updated further.

If the `WhitelistMode` is set to `Locked` an ACL whitelist of entity keys must be provided on installation. This whitelist dictates which entities can mint NFTs in the restricted `ACL` minting mode. These entities include `Accounts`, `Contracts` and `Contracts from a package` with [ ACL_PACKAGE_MODE]().
If the `WhitelistMode` is set to `Locked` an ACL whitelist of entity keys must be provided on installation. This whitelist dictates which entities can mint NFTs in the restricted `ACL` minting mode. These entities include `Accounts`, `Contracts` and `Contracts from a package` with [ ACL_PACKAGE_MODE](#aclpackagemode).

This `WhitelistMode` is an optional installation parameter and will be set to unlocked if not passed. However, the whitelist mode itself cannot be changed once the contract has been installed. The mode is passed in as a `u8` value to `whitelist_mode` runtime argument.

Expand All @@ -107,7 +110,7 @@ The minting mode governs the behavior of contract when minting new tokens. The m

1. `Installer`: This mode restricts the ability to mint new NFT tokens only to the installing account of the NFT contract.
2. `Public`: This mode allows any account to mint NFT tokens.
3. `ACL`: This mode allows whitelisted accounts, contracts or contracts from a package with [ACL_PACKAGE_MODE]() to mint NFT tokens.
3. `ACL`: This mode allows whitelisted accounts, contracts or contracts from a package with [ACL_PACKAGE_MODE](#aclpackagemode) to mint NFT tokens.

This modality is an optional installation parameter and will default to the `Installer` mode if not provided. However, this
mode cannot be changed once the contract has been installed. The mode is set by passing a `u8` value to the `minting_mode` runtime argument.
Expand Down

0 comments on commit 55060ea

Please sign in to comment.