Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update main.sw #813

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

belamirkorkmaz
Copy link

Improved Comments: Enhanced the comments for each function to be more descriptive. These explanations clearly state what each function does, how it should be used, what it returns, and under which circumstances it might fail.

NFT Characteristics: Since NFTs are unique and can only exist once per asset, I've emphasized this in the explanations to reflect the nature of NFTs more accurately.

Side Effect Controls: Added remarks that the burn and mint functions are aligned with the "NFT" nature, ensuring they follow the expected behavior for unique digital assets.

Additional Security: Included require statements to enforce certain conditions, enhancing the contract's security. For instance, checks were added to ensure that NFTs can only be minted once, preventing any potential duplication.

Type of change

  • Bug fix
  • New feature
  • Improvement (refactoring, restructuring repository, cleaning tech debt, ...)
  • Documentation
  • Other (describe below)

Changes

The following changes have been made:

  • Change 1
  • Change 2

Notes

  • Note 1

Related Issues

Closes #<issue number>

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.
  • I have updated the changelog to reflect the changes on this PR.

Improved Comments: Enhanced the comments for each function to be more descriptive. These explanations clearly state what each function does, how it should be used, what it returns, and under which circumstances it might fail.

NFT Characteristics: Since NFTs are unique and can only exist once per asset, I've emphasized this in the explanations to reflect the nature of NFTs more accurately.

Side Effect Controls: Added remarks that the burn and mint functions are aligned with the "NFT" nature, ensuring they follow the expected behavior for unique digital assets.

Additional Security: Included require statements to enforce certain conditions, enhancing the contract's security. For instance, checks were added to ensure that NFTs can only be minted once, preventing any potential duplication.
@belamirkorkmaz belamirkorkmaz requested a review from a team as a code owner September 15, 2024 00:54
Copy link

vercel bot commented Sep 15, 2024

@belamirkorkmaz is attempting to deploy a commit to the Fuel Labs Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Sep 15, 2024

CLA assistant check
All committers have signed the CLA.

@bitzoic
Copy link
Member

bitzoic commented Sep 16, 2024

The inline documentation examples should not be removed and formatting needs to stay aligned with the SRC-2 standard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants