Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0xsequence/erc20-meta-token

General ERC20 to ERC1155 Token Wrapper Contract
https://github.com/0xsequence/erc20-meta-token

erc20 ethereum meta-transaction-functionality

Last synced: 3 months ago
JSON representation

General ERC20 to ERC1155 Token Wrapper Contract

Awesome Lists containing this project

README 

        
General ERC20 to ERC1155 Token Wrapper Contract

===============================================



Allows any ERC-20 token to be wrapped inside of an ERC-1155 contract, and thereby allows

an ERC-20 token to function as an ERC-1155 contract.



## Getting started



### Install



`yarn add @0xsequence/erc20-meta-token` or `npm install @0xsequence/erc20-meta-token`



### Usage from Solidity



```solidity

pragma solidity ^0.8.0;



import '@0xsequence/erc20-meta-token/contracts/interfaces/IERC20Wrapper.sol';



contract ContractA {

  //...

  function f(address payable wrapperAddress, address ERC20tokenAddress, uint256 amount) public {

    IERC20Wrapper(wrapperAddress).deposit(ERC20tokenAddress, msg.sender, amount);

  }

}

```



## How does it work?



When you deposit ERC-20 tokens (e.g. DAI) in the wrapper contract, it will give you back ERC-1155 metaTokens (e.g. MetaDAI) with a 1:1 ratio. These metaToken have native meta-transaction functionalities, which allow you to transfer tokens without doing an on-chain transaction yourself, but by simply signing a message and broadcasting this message to "executors". You can also "approve" addresses to transfer tokens on your behalf with a signed message instead of calling the ERC-20 `approve()` function. 



If you want to transfer some metaTokens, you simply need to call `safeTransferFrom(sender, recipient, ERC20tokenAddress, amount, metaTransactionData)` where token address is the address of the ERC-20 token you want to transfer. Obtaining the balance is similar; `balanceOf(user, ERC20tokenAddress)`.



You can, at anytime, convert back these metaTokens back to their original tokens by calling the `withdraw()` method. 



## Gas Fee Abstraction



When transferring metaTokens, like metaDAI, you can specify in which currency you want the transaction fee to be paid in. By default, ERC20 token transfers require users to pay the fee in ETH, but with metaTokens, users can pay directly in any ERC20 token they wish. Hence, at a high level, users could transfer DAI by paying the transaction fee in DAI as well, never needing to possess ETH. 



## Why use the ERC-1155 Interface?



There are a few reasons why the ERC-1155 standard interface was chosen for this contract. First of all, since byte arrays needs to be passed to the contract, supporting the ERC-20 interface for these metaTokens would not be possible (at least not without adding significant complexity).  Secondly, having a single contract for all ERC-20s is simpler for developers and third parties. Indeed, you don't need to deploy a contract for every ERC-20 token contract users want to augment with meta transaction functionality and third parties don't need to maintain a list of which ERC20 token address maps with which wrapper contract address. 



In addition, it becomes easier to have multiple version of wrapper contracts. Indeed, if 5 versions exists, you only need 5 contracts to support all ERC20s in the five different versions, compared for 5N contracts, where N is the number of ERC-20 contracts. 



# Security Review



erc20-meta-token has been audited by two independant parties and all issues discovered were addressed. 

- [Agustín Aguilar**](https://github.com/0xsequence/erc20-meta-token/blob/master/audits/Security_Audit_Horizon_Games_23-12-19_2.pdf)

- [Consensys Diligence](https://github.com/0xsequence/erc20-meta-token/blob/master/audits/horizon-games-audit-2020-02.pdf)



** Agustín was hired as a full-time employee at Horizon after the audit was completed. Agustín did not take part in the writing of erc20-meta-token contracts.



## Dev env & release



This repository is configured as a yarn workspace, and has multiple pacakge.json files. Specifically,

we have the root ./package.json for the development environment, contract compilation and testing. Contract

source code and distribution files are packaged in "src/package.json".



To release a new version, make sure to bump the version, tag it, and run `yarn release`. The `release` command

will publish the `@0xsequence/erc20-meta-token` package in the "src/" folder, separate from the root package. The advantage

here is that application developers who consume `@0xsequence/erc20-meta-token` aren't required to install any of the devDependencies

in their toolchains as our build and contract packages are separated.



## LICENSE



Copyright (c) 2017-present [Horizon Blockchain Games Inc](https://horizon.io).



Licensed under [Apache-2.0](./LICENSE)