Skip to content

Commit

Permalink
Add documentation comments for Acre contract
Browse files Browse the repository at this point in the history
  • Loading branch information
r-czajkowski committed Dec 5, 2023
1 parent b84ee1b commit 3a312f7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions core/contracts/Acre.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ pragma solidity ^0.8.21;

import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";

/// @title Acre
/// @notice Implementation of the ERR-4626 tokenized vault standard. ERC-4626 is
/// a standard to optimize and unify the technical parameters of
/// yield-bearing vaults. This contract allows the minting and burning
/// of shares, represented as standard ERC20 token, in exchange for tBTC
/// tokens.
/// @dev ERC-4626 standard extends the ERC-20 token.
contract Acre is ERC4626 {
event Staked(bytes32 indexed referral, uint256 assets, uint256 shares);

Expand Down

0 comments on commit 3a312f7

Please sign in to comment.