Skip to content

Latest commit

 

History

History
109 lines (61 loc) · 6.45 KB

CHANGELOG.md

File metadata and controls

109 lines (61 loc) · 6.45 KB
Raw

Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog.

[Unreleased]

Changed

  • Update to README (#248)
  • Update CES parser version (#246)
  • Update modalities.md (#245)
  • Command fix (#244)
  • 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)

Added

  • ACL package mode - Including a contract package in the acl_whitelist will result in automatic whitelisting for any future versions of that contract. (#249)

  • 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. (#249)

  • Operator burn mode. This modes adds the possibility for operators to burn NFTs. (#250)

Release 1.4.0

Changed

  • Contracts whitelist migrated to an ACL Whitelist. The ACL whitelist is a list of account and/or contract hashes that specifies which entity can call the mint() entrypoint to mint NFTs.

  • This change results in the contract_whitelist dictionary being deprecated in favor of the new acl_whitelist dictionary.

Added

  • Transfer Filter Hook. The transfer filter modality, if enabled, specifies a contract package hash pointing to a contract that will be called when the transfer method is invoked on the contract.

  • Added the ACL option to the minting_mode modality. This option allows only whitelisted accounts or contracts to mint tokens. More information can be found here.

Release 1.3.0

Changed

  • Modified the json-schema runtime argument to be an optional installation parameter.

Release 1.3.0

Changed

  • Modified the json-schema runtime argument to be an optional installation parameter.

Release 1.2.0

Added

  • Added a new modality named EventsMode that dictates how the installed instance of CEP-78 will handle the recording of events. Refer to the README for further details

  • Added the ability for the contract to specify one or more metadata schemas, with the option to further specify optional metadata schemas. Additional required metadatas are specified by additional_required_metadata, while additional optional metadata schemas can be specified using optional_metadata. Refer to the Installing the Contract section of the README for more information on using these arguments.

  • When upgrading from a contract instance, you may now change the total_token_supply to a number higher than the current number of minted tokens, but lower than your previous total. The number cannot be zero. More information is available in the upgrade tutorials.

  • Added a new entrypoint called revoke that allows token owners to revoke a single approval.

  • Added a new entrypoint is_approval_for_all that allows a caller to check if they are considered an operator for a token owner.

  • For js-client changes, please view the respective change log.

Changed

  • OwnerReverseLookupMode now contains an additional option, TransfersOnly, which begins tracking ownership upon transfer. More information can be found here.

  • Optimized the set_approval_for_all entrypoint implementation to reduce gas costs.

Release 1.1.1

Added

  • Added a new modality named NamedKeyConventionMode that dictates the upgrading and installation process. Refer to the README for further details.

Release 1.1.0

Added

  • Ownership of NFTs issued by a given CEP-78 contract instance are tracked by token id; thus the current owner of any given token by id is available using the owned_by entrypoint. However, some use cases benefit from the ability to ask the reverse question: list all the NFTs from a given contract instance owned by a specific owner.

    • To be able to support this reverse lookup option requires a contract instance to keep track of additional data, which causes higher gas costs for all mints and transfers. The gas cost to ask for any given owner is also unpredictable; as the asker is charged for the appropriate gas cost to read and return a collection that may be empty or may be quite large.

    • The pros and cons of either approach should be considered when installing a new CEP-78 contract. By default, new CEP-78 contract instances will default to the OwnerReverseLookupMode::NoLookup option, which has the lowest operating costs and optimal scaling characteristics. However, the OwnerReverseLookupMode::Complete option can be chosen upon install, which will allow the contract to write the necessary additional data to allow a full lookup by owner.

    • To allow isolation of the additional costs, or tracking individual owners, the reverse lookup mode supports a register entrypoint which is used to register owners prior to minting or receiving a transferred token. In either Assigned or Transferable mode, this register entrypoint can be called by any party on behalf of another party.

    • As a result of this change, the previously used owned_tokens dictionary is now deprecated. Moving forward, token ownership will be tracked using the OwnerReverseLookupMode modality and CEP-78 Page System.

Changed

  • A single instance of CEP-78 is limited to 1,000,000 tokens maximum.

  • The naming convention for the default named key prefix of a given CEP-78 contract instance has been changed to cep78_<collection_name> with spaces and dashes within the collection name converted to underscores.

    • If an account installs more than one contract instance with the same collection name, it can lead to collision. It is recommended that all collection names be distinct or differentiated from each other via a suffix or sequence number as you prefer. Alternately, you may choose to not use the provided installation session logic and solve such a collision as you see fit.

    • If an account attempts to install a second CEP-78 contract with the same name, it will overwrite the access rights and render the first instance unusable.