From df56dd77fcfeee5d2a5afca4f153edf8dd34915d Mon Sep 17 00:00:00 2001 From: Andrew7044 <80797345+Andrew7044@users.noreply.github.com> Date: Wed, 14 Feb 2024 18:55:39 -0500 Subject: [PATCH 1/3] Update/Refactor README.md Created a few different updated to the README. Major changes include creating an overview section, addition of a short intro blurb, as well as some rewording of other sections to make them clearer. Formatting was also changed slightly to make sections more easily read/understood. --- README.md | 58 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 7738d3b..ee57554 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,42 @@ -# DN404 🥜 +# DN404: ERC20/ERC721 Co-Joined Implementation [![NPM][npm-shield]][npm-url] [![CI][ci-shield]][ci-url] -DN404 is an implementation of a co-joined ERC20 and ERC721 pair. +Welcome to DN404, an experimental implementation of co-joined ERC20 and ERC721 contracts. +DN404 aims to provide seamless interoperability between ERC20 and ERC721 tokens, ensuring full compliance with their respective specifications while offering optimized functionality. -- Full compliance with the ERC20 and ERC721 specifications. -- Transfers on one side will be reflected on the other side. -- Pretty optimized. +## Overview +DN404 enables transfers between ERC20 and ERC721 tokens, ensuring that actions performed on one side are reflected on the other side. +This project is designed to facilitate easy integration of ERC20 and ERC721 tokens within a single ecosystem, providing developers with a robust foundation for building decentralized applications. ## Installation -To install with [**Foundry**](https://github.com/gakonst/foundry): - +With [**Foundry**](https://github.com/gakonst/foundry): ```sh -forge install vectorized/dn404 +To install DN404 using Foundry, execute the following command: forge install vectorized/dn404 ``` -To install with [**Hardhat**](https://github.com/nomiclabs/hardhat): +With [**Hardhat**](https://github.com/nomiclabs/hardhat): ```sh -npm install dn404 +To install DN404 using Hardhat, execute the following command: npm install dn404 ``` ## Contracts -The Solidity smart contracts are located in the `src` directory. +The DN404 repository contains the following Solidity smart contracts: + +#### DN404: This contract represents the ERC20 functionality within DN404. + +#### DN404Mirror: This contract represents the ERC721 functionality within DN404. + +#### SimpleDN404: A simple example demonstrating DN404 as an ERC20 token. + +#### NFTMintDN404: A simple example demonstrating DN404 as an ERC721 token. + +These contracts are located in the src directory of the repository. Navigation of the branch to access the contracts is shown below. + ```ml src @@ -38,33 +49,32 @@ src ## Contributing -Feel free to make a pull request. +Contributions to DN404 are highly encouraged! +To contribute, please adhere to the guidelines outlined [here](https://github.com/Vectorized/solady/issues/19). +You can contribute by submitting pull requests for new features, enhancements, or bug fixes. -Guidelines same as [Solady's](https://github.com/Vectorized/solady/issues/19). ## Safety -This is **experimental software** and is provided on an "as is" and "as available" basis. - -We **do not give any warranties** and **will not be liable for any loss** incurred through any use of this codebase. - -While DN404 has been heavily tested, there may be parts that exhibit unexpected emergent behavior when used with other code, or break in future Solidity versions. +It's essential to note that DN404 is experimental software provided on an **as is** and **as available** basis. +While the contracts have undergone thorough testing, there may still be unforeseen issues/emergent behavior, especially when used in conjunction with other code or future Solidity versions. -Please always include your own thorough tests when using DN404 to make sure it works correctly with your code. +**Always** conduct comprehensive testing to ensure compatibility with your codebase. ## Upgradability -Most contracts in DN404 are compatible with both upgradeable and non-upgradeable (i.e. regular) contracts. - -Please call any required internal initialization methods accordingly. +Most contracts within DN404 support both upgradeable and non-upgradeable (regular) implementations. +If utilizing upgradeable contracts, ensure to call any required internal initialization methods accordingly.. ## Acknowledgements -This repository is inspired by various sources: - +DN404 draws inspiration from various sources, including: - [Serec](https://twitter.com/SerecThunderson) - [Solady](https://github.com/vectorized/solady) - [ERC721A](https://github.com/chiru-labs/ERC721A) + +These sources have played a significant role in shaping the design and functionality of DN404. + [npm-shield]: https://img.shields.io/npm/v/dn404.svg [npm-url]: https://www.npmjs.com/package/dn404 From bd850946dc9b8c8322b7bc2b2c095a2410b0181c Mon Sep 17 00:00:00 2001 From: Andrew7044 <80797345+Andrew7044@users.noreply.github.com> Date: Wed, 14 Feb 2024 18:57:42 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ee57554..4bf5b66 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ While the contracts have undergone thorough testing, there may still be unforese **Always** conduct comprehensive testing to ensure compatibility with your codebase. +We **do not give any warranties** and **will not be liable for any loss** incurred through any use of this codebase. + ## Upgradability Most contracts within DN404 support both upgradeable and non-upgradeable (regular) implementations. From 88822ac2125843b72ba4374bbdcf5f7237261f03 Mon Sep 17 00:00:00 2001 From: Andrew7044 <80797345+Andrew7044@users.noreply.github.com> Date: Wed, 14 Feb 2024 18:59:38 -0500 Subject: [PATCH 3/3] Update/Refactor README.md Created a few different updated to the README. Major changes include creating an overview section, addition of a short intro blurb, as well as some rewording of other sections to make them clearer. Formatting was also changed slightly to make sections more easily read/understood. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4bf5b66..b85eba0 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ src Contributions to DN404 are highly encouraged! To contribute, please adhere to the guidelines outlined [here](https://github.com/Vectorized/solady/issues/19). -You can contribute by submitting pull requests for new features, enhancements, or bug fixes. +You can contribute by submitting pull requests for new features, enhancements, or bug fixes, or any other areas of improvement that you may find. ## Safety