Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seunlanlege committed Jul 27, 2024
1 parent fc2d1b4 commit 5db17ed
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
# ERC6160
Implementation of ERC6160

![Unit Tests](https://github.com/polytope-labs/ERC6160/actions/workflows/test.yml/badge.svg)
[![NPM](https://img.shields.io/npm/v/@polytope-labs/erc6160?label=%40polytope-labs%2Ferc6160)](https://www.npmjs.com/package/@polytope-labs/erc6160)

Official Implementation of EIP-6160

This set of interfaces and contracts relates to the [Multi-Chain Native Token Standard.](https://github.com/polytope-labs/EIPs/blob/master/EIPS/eip-6160.md)

The motivation for this standard can be found from our [research publication.](https://research.polytope.technology/multi-chain-native-tokens)

The Core Interfaces specifying the standard specified in the EIP:
* {{IERC6160Ext20.sol}}
* {{IERC6160Ext721.sol}}
* {{IERC6160Ext1155.sol}}
* [IERC6160Ext20.sol](src/interfaces/IERC6160Ext20.sol)
* [IERC6160Ext721.sol](src/interfaces/IERC6160Ext721.sol)
* [IERC6160Ext1155.sol](src/interfaces/IERC6160Ext1155.sol)

Multi-Chain token contracts that chooses to conform to this EIP `MUST` extend their corresponding interface above.
Multi-Chain token contracts that chooses to conform to this EIP `MUST` extend their corresponding interface above.


These example core token contracts implements the interfaces as so:
* {{ERC6160Ext20.sol}}
* {{ERC6160Ext721.sol}}
* {{ERC6160Ext1155.sol}}
* [ERC6160Ext20.sol](src/ERC6160Ext20.sol)
* [ERC6160Ext721.sol](src/ERC6160Ext721.sol)
* [ERC6160Ext1155.sol](src/ERC6160Ext1155.sol)

|Note | This standard is unopinionated, however, aims to set the foundation for creating multi-chain native tokens, also the specifics for authorization and access control are left for developers to implement in token contracts.|
----- | -----
----- | -----

0 comments on commit 5db17ed

Please sign in to comment.