feat: add atk documentation

[roderik]

Summary by Sourcery

Adds documentation for the Asset Tokenization Kit contracts, including Stablecoin, Bond, Fund, Cryptocurrency, and Equity.

Documentation:

• Adds documentation for the Stablecoin contract, detailing its features such as collateral-backed issuance and role-based controls.
• Adds documentation for the Bond contract, explaining its collateralized bond issuance, maturity and redemption features.
• Adds documentation for the Fund contract, covering automated fee management, voting and governance features.
• Adds documentation for the Cryptocurrency contract, describing its minting and supply management capabilities.
• Adds documentation for the Equity contract, detailing its voting and governance mechanisms.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds documentation for several asset tokenization contracts: Stablecoin, Bond, Fund, CryptoCurrency, and Equity. Each contract's documentation includes an introduction, benefits of using digital tokens, contract features, and enterprise applications.

Class diagram for Stablecoin contract

classDiagram
  class Stablecoin {
    -collateral: ERC20
    -supplyManager: Role
    -userManager: Role
    -administrator: Role
    +mint(address to, uint256 amount)
    +pause()
    +unpause()
    +blockUser(address user)
    +unblockUser(address user)
    +supportsInterface(interfaceId: bytes4): bool
  }
  note for Stablecoin "Fully collateralized issuance\nRobust access and role management\nSecurity and regulatory compliance\nCustodial and meta-transaction support\nComprehensive error handling and event logging"

Loading

Class diagram for Bond contract

classDiagram
  class Bond {
    -faceValue: uint256
    -underlyingAsset: ERC20
    -maturityDate: uint256
    -supplyManager: Role
    -userManager: Role
    -adminRole: Role
    +mint(address to, uint256 amount)
    +redeem(uint256 amount)
    +distributeYield()
    +pause()
    +unpause()
    +blockUser(address user)
    +unblockUser(address user)
  }
  note for Bond "Collateralized bond issuance\nMaturity and redemption\nYield distribution\nComprehensive access control\nSecurity and regulatory compliance\nMeta-transaction support\nTransparent yield distribution and auditing"

Loading

Class diagram for Fund contract

classDiagram
  class Fund {
    -managementFee: uint256
    -fundClass: string
    -fundCategory: string
    -supplyManager: Role
    -userManager: Role
    -administrator: Role
    +collectManagementFees()
    +pause()
    +unpause()
    +blockUser(address user)
    +unblockUser(address user)
    +getVotingPower(address account): uint256
  }
  note for Fund "Automated fee management\nVoting and governance\nRole-based access control\nSecurity and compliance\nMeta-transaction support\nCustomizable fund attributes"

Loading

File-Level Changes

Change	Details	Files
Added documentation for the Stablecoin contract.	Introduced a new markdown file detailing the Stablecoin contract. Explained the purpose and benefits of using stablecoins. Described the contract's features, including collateralized issuance, role-based access control, and security measures. Highlighted enterprise use cases such as cross-border settlements and treasury management.	content/docs/building-with-settlemint/kits/asset-tokenization/contracts/stablecoin.mdx
Added documentation for the Bond contract.	Introduced a new markdown file detailing the Bond contract. Explained the purpose and benefits of using digital bonds. Described the contract's features, including collateralized bond issuance, maturity and redemption, and yield distribution. Highlighted enterprise applications such as institutional investments and treasury optimization.	content/docs/building-with-settlemint/kits/asset-tokenization/contracts/bond.mdx
Added documentation for the Fund contract.	Introduced a new markdown file detailing the Fund contract. Explained the purpose and benefits of using digital fund tokens. Described the contract's features, including automated fee management, voting and governance, and role-based access control. Highlighted enterprise applications such as investment fund management and fee automation.	content/docs/building-with-settlemint/kits/asset-tokenization/contracts/fund.mdx
Added documentation for the CryptoCurrency contract.	Introduced a new markdown file detailing the CryptoCurrency contract. Explained the purpose and benefits of using digital tokens. Described the contract's features, including minting and supply management, robust role-based controls, and meta-transaction capability. Highlighted enterprise applications such as institutional asset management and corporate payments.	content/docs/building-with-settlemint/kits/asset-tokenization/contracts/cryptocurrency.mdx
Added documentation for the Equity contract.	Introduced a new markdown file detailing the Equity contract. Explained the purpose and benefits of using digital equity tokens. Described the contract's features, including voting and governance, robust role-based access control, and meta-transaction support. Highlighted enterprise applications such as equity issuance and management and investor voting and governance.	content/docs/building-with-settlemint/kits/asset-tokenization/contracts/equity.mdx

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @roderik - I've reviewed your changes - here's some feedback:

Overall Comments:

• The descriptions are good, but consider adding diagrams or visual aids to enhance understanding.
• It would be helpful to include a 'Getting Started' section in each document to guide new users.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Review instructions: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}