Skip to content

Commit

Permalink
fix: update instances of "erc20" to use standard "erc-20" (#1263)
Browse files Browse the repository at this point in the history
  • Loading branch information
Olanetsoft authored Dec 5, 2024
1 parent 4f11a46 commit ba87c8e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion public/samples/interchain-token-custom.sol
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

// more suited than OZ ERC20 for proxying because it doesn't require constructor parameters
// more suited than OZ ERC-20 for proxying because it doesn't require constructor parameters
import {ERC20} from "@axelar-network/interchain-token-service/contracts/token-implementations/ERC20.sol";

import {IERC20BurnableMintable} from "@axelar-network/interchain-token-service/interfaces/IERC20BurnableMintable.sol";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You will need:

Deploy the following `SimpleCustomToken` on the Fantom and Polygon testnets.

This code utilizes OpenZeppelin's libraries to create a custom ERC20 token with functionalities for minting, burning, and access control. The token includes a minter role, which enables designated addresses to mint or burn tokens. Additionally, it incorporates ERC20Permit for gasless transactions. The contract starts with a predefined supply of tokens minted to the deployer's address and establishes roles for a default administrator and minter:
This code utilizes OpenZeppelin's libraries to create a custom ERC-20 token with functionalities for minting, burning, and access control. The token includes a minter role, which enables designated addresses to mint or burn tokens. Additionally, it incorporates ERC20Permit for gasless transactions. The contract starts with a predefined supply of tokens minted to the deployer's address and establishes roles for a default administrator and minter:

```solidity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ contract MyInterchainToken is ERC20, ERC20Burnable {
}
```

This token is a simple implementation of an ERC20 token but includes the critical functionality needed to integrate with ITS: the ability to `mint()` and `burn()` tokens. ITS interacts with these functions when bridging tokens between chains.
This token is a simple implementation of an ERC-20 token but includes the critical functionality needed to integrate with ITS: the ability to `mint()` and `burn()` tokens. ITS interacts with these functions when bridging tokens between chains.

You also have the option to inherit from the [InterchainTokenStandard](https://github.com/axelarnetwork/interchain-token-service/blob/main/contracts/interchain-token/InterchainTokenStandard.sol#L12) so that your token has cross-chain functionality built-in, such as the `interchainTransfer()` function.

Expand Down Expand Up @@ -71,7 +71,7 @@ The [`transferMintership()`](https://github.com/axelarnetwork/interchain-token-s

## Send Token using Interchain Transfer Function

An Interchain Token is an ERC20 that is connected to [ITS](https://github.com/axelarnetwork/interchain-token-service/blob/main/contracts/InterchainTokenService.sol) upon deployment comes built-in with the `interchainTransfer()` function, which allows users to bridge their token between any blockchain to which it is deployed. Take a look at the diagram below to see how the `interchainTransfer()` function works.
An Interchain Token is an ERC-20 that is connected to [ITS](https://github.com/axelarnetwork/interchain-token-service/blob/main/contracts/InterchainTokenService.sol) upon deployment comes built-in with the `interchainTransfer()` function, which allows users to bridge their token between any blockchain to which it is deployed. Take a look at the diagram below to see how the `interchainTransfer()` function works.

<Callout type="warning">
This diagram is interactive click on the function names!
Expand Down

0 comments on commit ba87c8e

Please sign in to comment.