Skip to content

Commit b2adc46

Browse files
cygaarcygaar
committed
Add readme
1 parent a758fcf commit b2adc46

File tree

6 files changed

+147
-17
lines changed

6 files changed

+147
-17
lines changed

‎LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Chiru Labs
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+120-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,124 @@
1-
# Basic Sample Hardhat Project
1+
<!-- PROJECT SHIELDS -->
2+
<!--
3+
*** I'm using markdown "reference style" links for readability.
4+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
5+
*** See the bottom of this document for the declaration of the reference variables
6+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
7+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
8+
-->
9+
[![Contributors][contributors-shield]][contributors-url]
10+
[![Forks][forks-shield]][forks-url]
11+
[![Stargazers][stars-shield]][stars-url]
12+
[![Issues][issues-shield]][issues-url]
13+
[![MIT License][license-shield]][license-url]
214

3-
This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.
415

5-
Try running some of the following tasks:
616

7-
```shell
8-
npx hardhat accounts
9-
npx hardhat compile
10-
npx hardhat clean
11-
npx hardhat test
12-
npx hardhat node
13-
node scripts/sample-script.js
14-
npx hardhat help
17+
18+
<!-- ABOUT THE PROJECT -->
19+
## About The Project
20+
21+
The goal of ERC721A is to provide a fully compliant implementation of IERC721 with significant gas savings for minting multiple NFTs in a single transaction. This project will be updated regularly and will continue to stay up to date with best practices.
22+
23+
### TODO: Add azuki blurb here
24+
25+
For more information on how ERC721A works under the hood, please visit our [blog](https://www.azuki.com/erc721a).
26+
To find other projects that are using ERC721A, please visit [erc721a.org](erc721a.org).
27+
28+
**Chiru Labs is not liable for any outcomes as a result of using ERC721A.**
29+
30+
<br>
31+
32+
33+
<!-- Installation -->
34+
## Installation
35+
36+
```sh
37+
npm install --save-dev erc721a
1538
```
39+
40+
<br>
41+
42+
<!-- USAGE EXAMPLES -->
43+
## Usage
44+
45+
Once installed, you can use the contracts in the library by importing them:
46+
47+
```solidity
48+
pragma solidity ^0.8.0;
49+
50+
import "erc721a/contracts/ERC721A.sol";
51+
52+
contract Azuki is ERC721A {
53+
constructor() ERC721A("Azuki", "AZUKI", 5) {
54+
}
55+
}
56+
```
57+
58+
<br>
59+
60+
<!-- ROADMAP -->
61+
## Roadmap
62+
63+
- [] Add burn function
64+
- [] Move _setOwnersExplicit to an extension
65+
- [] Add more documentation on benefits of using ERC721A
66+
- [] Increase test coverage
67+
- [] Add CI pipeline
68+
69+
70+
See the [open issues](https://github.com/chiru-labs/ERC721A/issues) for a full list of proposed features (and known issues).
71+
72+
73+
<br>
74+
75+
76+
<!-- CONTRIBUTING -->
77+
## Contributing
78+
79+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
80+
81+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
82+
Don't forget to give the project a star! Thanks again!
83+
84+
1. Fork the Project
85+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
86+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
87+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
88+
5. Open a Pull Request
89+
90+
<br>
91+
92+
<!-- LICENSE -->
93+
## License
94+
95+
Distributed under the MIT License. See `LICENSE.txt` for more information.
96+
97+
<br>
98+
99+
<!-- CONTACT -->
100+
## Contact
101+
102+
- 2pm.flow (owner) - [@2pmflow](https://twitter.com/2pmflow)
103+
- location tba (owner) - [@locationtba](https://twitter.com/locationtba)
104+
- cygaar (maintainer) - [@cygaar_dev](https://twitter.com/cygaar_dev)
105+
106+
Project Link: [https://github.com/chiru-labs/ERC721A](https://github.com/chiru-labs/ERC721A)
107+
108+
109+
110+
<!-- MARKDOWN LINKS & IMAGES -->
111+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
112+
[contributors-shield]: https://img.shields.io/github/contributors/chiru-labs/ERC721A.svg?style=for-the-badge
113+
[contributors-url]: https://github.com/chiru-labs/ERC721A/graphs/contributors
114+
[forks-shield]: https://img.shields.io/github/forks/chiru-labs/ERC721A.svg?style=for-the-badge
115+
[forks-url]: https://github.com/chiru-labs/ERC721A/network/members
116+
[stars-shield]: https://img.shields.io/github/stars/chiru-labs/ERC721A.svg?style=for-the-badge
117+
[stars-url]: https://github.com/chiru-labs/ERC721A/stargazers
118+
[issues-shield]: https://img.shields.io/github/issues/chiru-labs/ERC721A.svg?style=for-the-badge
119+
[issues-url]: https://github.com/chiru-labs/ERC721A/issues
120+
[license-shield]: https://img.shields.io/github/license/chiru-labs/ERC721A.svg?style=for-the-badge
121+
[license-url]: https://github.com/chiru-labs/ERC721A/blob/master/LICENSE.txt
122+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
123+
[linkedin-url]: https://linkedin.com/in/linkedin_username
124+
[product-screenshot]: images/screenshot.png

‎contracts/ERC721A.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// SPDX-License-Identifier: MIT
2-
// Creators: locationtba.eth, 2pmflow.eth
2+
// Creator: Chiru Labs
33

44
pragma solidity ^0.8.0;
55

‎contracts/mocks/ERC721AMock.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// SPDX-License-Identifier: MIT
2-
// Creators: locationtba.eth, 2pmflow.eth, cygaar.eth
2+
// Creators: Chiru Labs
33

44
pragma solidity ^0.8.0;
55

‎contracts/mocks/ERC721ReceiverMock.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// SPDX-License-Identifier: MIT
2-
// Creators: locationtba.eth, 2pmflow.eth, cygaar.eth
2+
// Creators: Chiru Labs
33

44
pragma solidity ^0.8.0;
55

‎package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "chirulabs-solidity",
2+
"name": "erc721a",
33
"version": "0.0.1",
4-
"description": "Chiru Labs' smart contract library for Solidity",
4+
"description": "ERC721A contract for Solidity",
55
"files": [
66
"/contracts/**/*.sol",
77
"/build/contracts/*.json",
@@ -35,7 +35,7 @@
3535
"type": "git",
3636
"url": "git+https://github.com/chiru-labs/ERC721A.git"
3737
},
38-
"author": "",
38+
"author": "chiru-labs",
3939
"license": "ISC",
4040
"bugs": {
4141
"url": "https://github.com/chiru-labs/ERC721A/issues"

0 commit comments

Comments
 (0)