# USUAL

### High-Level Overview

This section provides an overview of the USUAL smart contract. The USUAL contract is designed to manage the USUAL ERC20 Token, implementing functionalities for minting, burning, and transfer operations while incorporating blacklist checks to restrict these operations from sanctioned addresses.

### Contract Summary

USUAL is an ERC-20 compliant token that integrates additional security and access control features to enhance its governance and usability. It inherits functionalities from ERC20PausableUpgradable and ERC20PermitUpgradeable to support permit-based approvals and pausability.

#### Inherited Contracts

* **ERC20PausableUpgradeable**: Extends ERC20 to support pausability
* **ERC20PermitUpgradeable**: Extends ERC20 to support gasless transactions through signed approvals.

#### ERC20PausableUpgradeable

Standard OpenZeppelin Implementation.

#### ERC20PermitUpgradeable

Standard OpenZeppelin Implementation.

### Functions Description

#### Public/External Functions

* **pause()**: Pauses all token transfer operations; callable only by the PAUSING\_CONTRACTS\_ROLE.
* **unpause()**: Resumes all token transfer operations; also callable only by the DEFAULT\_ADMIN\_ROLE.
* **transfer(address to, uint256 amount)**: Transfers tokens to a non-sanctioned address.
* **transferFrom(address sender, address to, uint256 amount)**: Transfers tokens from one non-sanctioned address to another.
* **mint(address to, uint256 amount)**: Mints tokens to a non-sanctioned address if the caller has the USUAL\_MINT role.
* **burn(uint256 amount)** and **burnFrom(address account, uint256 amount)**: Burns tokens from an address, requiring the USUAL\_BURN role.
* **blacklist(address account)** and **unBlacklist(address account)**: Those functions allows the admin to blacklist or remove from blacklist malicious users from using this token. Only callable by the BLACKLIST\_ROLE.

### Functionality Breakdown

#### SC-Flows

<figure><img src="/files/HNvh876j62AFykd30doA" alt=""><figcaption></figcaption></figure>

#### Key Functionalities

* **Minting**: Tokens can be minted to an address, subject to role checks.
* **Burning**: Tokens can be burned from an address, also subject to role checks.
* **Transfers**: Only not sanctioned addresses can send or receive tokens.

### Constants

* **CONTRACT\_REGISTRY\_ACCESS**: This constant is used to define the address of the registry access contract
* **DEFAULT\_ADMIN\_ROLE**: This constant is used to define the default admin role for the contract.
* **PAUSING\_CONTRACTS\_ROLE**: Role required to pause the contract.
* **BLACKLIST\_ROLE**: Role required to blacklist an address.
* **USUAL\_MINT**: Role required to mint new tokens.
* **USUAL\_BURN**: Role required to burn tokens.

### Safeguards Implementation

* **Pausability**: Ensures that token transfers can be halted in case of emergency.
* **Role-Based Access Control**: Restricts sensitive actions to addresses with appropriate roles.
* **Blacklist Enforcement**: Ensures that only non-malicious addresses can participate in the token economy.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://tech.usual.money/smart-contracts/token-contracts/usual.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.