HRC-4626

Introduce

HRC-4626 is a standard for optimizing and unifying the technical parameters of the income treasury. It provides a standard API for a tokenized yield treasury representing a share of a single underlying HRC-20 token. HRC-4626 also outlines optional extensions to tokenized treasuries using HRC-20, providing basic functionality for depositing, withdrawing tokens, and reading balances.

HRC-4626 The Role of the Earnings Treasury

Lending marketplaces, aggregators, and interest-bearing tokens in nature can help users find the best yield on their crypto tokens by executing different strategies. These strategies are done slightly differently, which can be error-prone or waste development resources.

The HRC-4626 standard for yield treasury reduces integration effort and unlocks avenues to monetize across a wide range of applications by creating a more consistent and robust implementation model that requires no dedicated work from developers.

Functions and functions of HRC-4626:

Method

asset

function asset() public view returns (address)

This function returns the address of the underlying token used for the vault for accounting, depositing, withdrawing.

totalAssets

function totalAssets() public view returns (uint256)

This function returns the total amount of underlying assets held by the vault.

convertToShares

function convertToShares(uint256 assets) public view returns (uint256 shares)

This function returns the amount of shares that would be exchanged by the vault for the amount of assets provided.

convertToAssets

function convertToAssets(uint256 shares) public view returns (uint256 assets)

This function returns the amount of assets that would be exchanged by the vault for the amount of shares provided.

maxDeposit

function maxDeposit(address receiver) public view returns (uint256)

This function returns the amount of assets that would be exchanged by the vault for the amount of shares provided.

previewDeposit

function previewDeposit(uint256 assets) public view returns (uint256)

This function allows users to simulate the effects of their deposit at the current block.

deposit

function deposit(uint256 assets, address receiver) public returns (uint256 shares)

This function deposits assets of underlying tokens into the vault and grants ownership of shares to receiver.

maxMint

function maxMint(address receiver) public view returns (uint256)

This function returns the maximum amount of shares that can be minted in a single mint call by the receiver.

previewMint

function previewMint(uint256 shares) public view returns (uint256)

This function allows users to simulate the effects of their mint at the current block.

mint

function mint(uint256 shares, address receiver) public returns (uint256 assets)

This function mints exactly shares vault shares to receiver by depositing assets of underlying tokens.

maxWithdraw

function maxWithdraw(address owner) public view returns (uint256)

This function returns the maximum amount of underlying assets that can be withdrawn from the owner balance with a single withdraw call.

previewWithdraw

function previewWithdraw(uint256 assets) public view returns (uint256)

This function allows users to simulate the effects of their withdrawal at the current block.

withdraw

function withdraw(uint256 assets, address receiver, address owner) public returns (uint256 shares)

This function burns shares from owner and send exactly assets token from the vault to receiver.

maxRedeem

function maxRedeem(address owner) public view returns (uint256)

This function returns the maximum amount of shares that can be redeem from the owner balance through a redeem call.

previewRedeem

function previewRedeem(uint256 shares) public view returns (uint256)

This function allows users to simulate the effects of their redeemption at the current block.

redeem

function redeem(uint256 shares, address receiver, address owner) public returns (uint256 assets)

This function redeems a specific number of shares from owner and send assets of underlying token from the vault to receiver.

totalSupply

function totalSupply() public view returns (uint256)

Returns the total number of unredeemed vault shares in circulation.

balanceOf

function balanceOf(address owner) public view returns (uint256)

Returns the total amount of vault shares the owner currently has.

Events

Deposit Event

MUST be emitted when tokens are deposited into the vault via the mint and deposit methods

event Deposit(
    address indexed sender,
    address indexed owner,
    uint256 assets,
    uint256 shares
)

Where sender is the user who exchanged assets for shares, and transferred those shares to owner.

Withdraw Event

MUST be emitted when shares are withdrawn from the vault by a depositor in the redeem or withdraw methods.

event Withdraw(
    address indexed sender,
    address indexed receiver,
    address indexed owner,
    uint256 assets,
    uint256 share
)

Where sender is the user who triggered the withdrawal and exchanged shares, owned by owner, for assets. receiver is the user who received the withdrawn assets.