Skip to content

Commit

Permalink
Merge branch 'issue-215' of github.com:gRoussac/cep-78-enhanced-nft i…
Browse files Browse the repository at this point in the history
…nto issue-215
  • Loading branch information
gRoussac committed Sep 25, 2023
2 parents 55060ea + 15a3697 commit 30cd9b6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ All notable changes to this project will be documented in this file. The format
### Changed

- Update to README (#248)
- Update ces parser version (#246)
- Update CES parser version (#246)
- Update modalities.md (#245)
- Command fix (#244)
- JS Client: omit dev dependencies when running audit (#241)
- JS Client: Omit dev dependencies when running audit (#241)
- Remove potential revert in init and remove cep47 events dict creation on install (#240)
- Reformatting Documentation (#239)
- Reformatting documentation (#239)

### Added

- ACL package mode. By whitelisting a package in `acl_whitelist`, any further version of a contract will be automaticaly whitelisted for minting.
- ACL package mode - Including a contract package in the `acl_whitelist` will result in automatic whitelisting for any future versions of that contract.

- Package operator mode. By approving a package in `operators`, any further version of a contract will be automaticaly operator for transfer/approve/revoke entrypoints.
- Package operator mode - Approving a package in `operators` allows any future version of that contract to act as an operator for transfer/approve/revoke entrypoints.

## Release 1.4.0

Expand Down
14 changes: 6 additions & 8 deletions docs/modalities.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,21 @@ mode cannot be changed once the contract has been installed. The mode is set by

## AllowMinting

By switching allow_minting to false we pause minting. Reverts with MintingIsPaused error if allow_minting is false. This modality provides two options:
The `AllowMinting` modality dictates the ability for **any** entity to mint or not. If `allow_minting` is set to false, any attempt to mint will revert with a `MintingIsPaused` error. This modality provides two options:

| AllowMinting | bool |
| ------------ | ---- |

## ACLPackageMode

The ACL package mode governs the ability for whitelisting a package instead of a versioned contract. By whitelisting a package, a new contract version will be automaticly whitelisted for minting after its package upgrade. This modality provides two options:
The ACL package mode modality governs the ability for whitelisting a package instead of a versioned contract. By whitelisting a package, a new contract version will be automatically whitelisted for minting after its package upgrade. This modality provides two options:

| ACLPackageMode | bool |
| -------------- | ---- |

This modality is an optional installation parameter and will default to the `false` if not provided. This
mode can be changed on contract upgrade or can be updated via the set variables endpoint.
This modality is an optional installation parameter and will default to `false` if not provided. This mode can be changed on contract upgrade or can be updated via the set variables endpoint.

> Before using this modilty, please understand the security implications of having automatic whitelisting of versioned contracts.
> Before using this modality, please understand the security implications of having automatic whitelisting of versioned contracts.
## PackageOperatorMode

Expand All @@ -147,10 +146,9 @@ The package operator mode governs the ability for approving a package instead of
| PackageOperatorMode | bool |
| ------------------- | ---- |

This modality is an optional installation parameter and will default to the `false` if not provided. This
mode can be changed on contract upgrade or can be updated via the set variables endpoint.
This modality is an optional installation parameter and will default to `false` if not provided. This mode can be changed on contract upgrade or can be updated via the set variables endpoint.

> Before using this modilty, please understand the security implications of having automatic approvals and revocation right of versioned contracts.
> Before using this modality, please understand the security implications of having automatic approvals and revocation rights for versioned contracts.
## NFTMetadataKind

Expand Down

0 comments on commit 30cd9b6

Please sign in to comment.