> For the complete documentation index, see [llms.txt](https://contracts.synapseprotocol.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://contracts.synapseprotocol.com/bridge/synapseerc20.md). # SynapseERC20 ## Methods ### DEFAULT\_ADMIN\_ROLE ```solidity function DEFAULT_ADMIN_ROLE() external view returns (bytes32) ``` #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### DOMAIN\_SEPARATOR ```solidity function DOMAIN_SEPARATOR() external view returns (bytes32) ``` *See {IERC20Permit-DOMAIN\_SEPARATOR}.* #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### MINTER\_ROLE ```solidity function MINTER_ROLE() external view returns (bytes32) ``` #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### allowance ```solidity function allowance(address owner, address spender) external view returns (uint256) ``` *See {IERC20-allowance}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | owner | address | undefined | | spender | address | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### approve ```solidity function approve(address spender, uint256 amount) external nonpayable returns (bool) ``` *See {IERC20-approve}. Requirements: - `spender` cannot be the zero address.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | spender | address | undefined | | amount | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### balanceOf ```solidity function balanceOf(address account) external view returns (uint256) ``` *See {IERC20-balanceOf}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | account | address | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### burn ```solidity function burn(uint256 amount) external nonpayable ``` *Destroys `amount` tokens from the caller. See {ERC20-\_burn}.* #### Parameters | Name | Type | Description | | ------ | ------- | ----------- | | amount | uint256 | undefined | ### burnFrom ```solidity function burnFrom(address account, uint256 amount) external nonpayable ``` *Destroys `amount` tokens from `account`, deducting from the caller's allowance. See {ERC20-\_burn} and {ERC20-allowance}. Requirements: - the caller must have allowance for `accounts`'s tokens of at least `amount`.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | account | address | undefined | | amount | uint256 | undefined | ### decimals ```solidity function decimals() external view returns (uint8) ``` *Returns the number of decimals used to get its user representation. For example, if `decimals` equals `2`, a balance of `505` tokens should be displayed to a user as `5,05` (`505 / 10 ** 2`). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless {\_setupDecimals} is called. NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.* #### Returns | Name | Type | Description | | ---- | ----- | ----------- | | \_0 | uint8 | undefined | ### decreaseAllowance ```solidity function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool) ``` *Atomically decreases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address. - `spender` must have allowance for the caller of at least `subtractedValue`.* #### Parameters | Name | Type | Description | | --------------- | ------- | ----------- | | spender | address | undefined | | subtractedValue | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### getRoleAdmin ```solidity function getRoleAdmin(bytes32 role) external view returns (bytes32) ``` *Returns the admin role that controls `role`. See {grantRole} and {revokeRole}. To change a role's admin, use {\_setRoleAdmin}.* #### Parameters | Name | Type | Description | | ---- | ------- | ----------- | | role | bytes32 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### getRoleMember ```solidity function getRoleMember(bytes32 role, uint256 index) external view returns (address) ``` *Returns one of the accounts that have `role`. `index` must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following post] for more information.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | role | bytes32 | undefined | | index | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | address | undefined | ### getRoleMemberCount ```solidity function getRoleMemberCount(bytes32 role) external view returns (uint256) ``` *Returns the number of accounts that have `role`. Can be used together with {getRoleMember} to enumerate all bearers of a role.* #### Parameters | Name | Type | Description | | ---- | ------- | ----------- | | role | bytes32 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### grantRole ```solidity function grantRole(bytes32 role, address account) external nonpayable ``` *Grants `role` to `account`. If `account` had not been already granted `role`, emits a {RoleGranted} event. Requirements: - the caller must have `role`'s admin role.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### hasRole ```solidity function hasRole(bytes32 role, address account) external view returns (bool) ``` *Returns `true` if `account` has been granted `role`.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### increaseAllowance ```solidity function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool) ``` *Atomically increases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address.* #### Parameters | Name | Type | Description | | ---------- | ------- | ----------- | | spender | address | undefined | | addedValue | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### initialize ```solidity function initialize(string name, string symbol, uint8 decimals, address owner) external nonpayable ``` Initializes this ERC20 contract with the given parameters. #### Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------ | | name | string | Token name | | symbol | string | Token symbol | | decimals | uint8 | Token name | | owner | address | admin address to be initialized with | ### mint ```solidity function mint(address to, uint256 amount) external nonpayable ``` #### Parameters | Name | Type | Description | | ------ | ------- | ----------- | | to | address | undefined | | amount | uint256 | undefined | ### name ```solidity function name() external view returns (string) ``` *Returns the name of the token.* #### Returns | Name | Type | Description | | ---- | ------ | ----------- | | \_0 | string | undefined | ### nonces ```solidity function nonces(address owner) external view returns (uint256) ``` *See {IERC20Permit-nonces}.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | owner | address | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### permit ```solidity function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable ``` *See {IERC20Permit-permit}.* #### Parameters | Name | Type | Description | | -------- | ------- | ----------- | | owner | address | undefined | | spender | address | undefined | | value | uint256 | undefined | | deadline | uint256 | undefined | | v | uint8 | undefined | | r | bytes32 | undefined | | s | bytes32 | undefined | ### renounceRole ```solidity function renounceRole(bytes32 role, address account) external nonpayable ``` *Revokes `role` from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must be `account`.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### revokeRole ```solidity function revokeRole(bytes32 role, address account) external nonpayable ``` *Revokes `role` from `account`. If `account` had been granted `role`, emits a {RoleRevoked} event. Requirements: - the caller must have `role`'s admin role.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### symbol ```solidity function symbol() external view returns (string) ``` *Returns the symbol of the token, usually a shorter version of the name.* #### Returns | Name | Type | Description | | ---- | ------ | ----------- | | \_0 | string | undefined | ### totalSupply ```solidity function totalSupply() external view returns (uint256) ``` *See {IERC20-totalSupply}.* #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### transfer ```solidity function transfer(address recipient, uint256 amount) external nonpayable returns (bool) ``` *See {IERC20-transfer}. Requirements: - `recipient` cannot be the zero address. - the caller must have a balance of at least `amount`.* #### Parameters | Name | Type | Description | | --------- | ------- | ----------- | | recipient | address | undefined | | amount | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### transferFrom ```solidity function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool) ``` *See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - `sender` and `recipient` cannot be the zero address. - `sender` must have a balance of at least `amount`. - the caller must have allowance for `sender`'s tokens of at least `amount`.* #### Parameters | Name | Type | Description | | --------- | ------- | ----------- | | sender | address | undefined | | recipient | address | undefined | | amount | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ## Events ### Approval ```solidity event Approval(address indexed owner, address indexed spender, uint256 value) ``` #### Parameters | Name | Type | Description | | ----------------- | ------- | ----------- | | owner `indexed` | address | undefined | | spender `indexed` | address | undefined | | value | uint256 | undefined | ### RoleAdminChanged ```solidity event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole) ``` #### Parameters | Name | Type | Description | | --------------------------- | ------- | ----------- | | role `indexed` | bytes32 | undefined | | previousAdminRole `indexed` | bytes32 | undefined | | newAdminRole `indexed` | bytes32 | undefined | ### RoleGranted ```solidity event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender) ``` #### Parameters | Name | Type | Description | | ----------------- | ------- | ----------- | | role `indexed` | bytes32 | undefined | | account `indexed` | address | undefined | | sender `indexed` | address | undefined | ### RoleRevoked ```solidity event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender) ``` #### Parameters | Name | Type | Description | | ----------------- | ------- | ----------- | | role `indexed` | bytes32 | undefined | | account `indexed` | address | undefined | | sender `indexed` | address | undefined | ### Transfer ```solidity event Transfer(address indexed from, address indexed to, uint256 value) ``` #### Parameters | Name | Type | Description | | -------------- | ------- | ----------- | | from `indexed` | address | undefined | | to `indexed` | address | undefined | | value | uint256 | undefined |