Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jovijovi/ether-minter
An NFT minter microservice inspired by ether-goblin.
https://github.com/jovijovi/ether-minter
blockchain contract erc721 erc721a ethereum microservice minter nft solidity
Last synced: 4 days ago
JSON representation
An NFT minter microservice inspired by ether-goblin.
- Host: GitHub
- URL: https://github.com/jovijovi/ether-minter
- Owner: jovijovi
- License: mit
- Created: 2022-05-25T10:40:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T10:38:12.000Z (about 2 years ago)
- Last Synced: 2023-06-11T03:34:26.469Z (over 1 year ago)
- Topics: blockchain, contract, erc721, erc721a, ethereum, microservice, minter, nft, solidity
- Language: TypeScript
- Homepage:
- Size: 1.05 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ether Minter
[![GitHub Actions](https://github.com/jovijovi/ether-minter/workflows/Test/badge.svg)](https://github.com/jovijovi/ether-minter)
An NFT minter microservice inspired by [ether-goblin](https://github.com/jovijovi/ether-goblin).
## Features
- [Avatar NFT contract](./contracts/Avatar)
- NFT Minter APIs
- Mint NFT by random minter
- Gas price circuit breaker
- Batch mint/transfer/burn NFTs
- Deploy contract by API
- API authorization via 2FA token
- RESTFul APIs for the Ethereum ecosystem
- Microservice run in Docker## Supported Chains
- [Ethereum](https://ethereum.org/)
- [Polygon](https://polygon.technology/)## Development Environment
- typescript `4.8.4`
- node `v18.12.0`
- ts-node `v10.9.1`
- yarn `v1.22.19`## Contract Dependencies
- @openzeppelin/contracts: [`4.7.0`](https://www.npmjs.com/package/@openzeppelin/contracts/v/4.7.0)
- erc721a: [`4.1.0`](https://www.npmjs.com/package/erc721a/v/4.1.0)## Quick Guide
- Install dependency
```shell
yarn
```- Build code
Install all dependencies and compile code.
```shell
make build
```- Build docker image
```shell
make docker
```- Test
```shell
yarn test
```- Run
- Params
- `--config` Config filepath. Example:
```shell
ts-node ./src/main/index.ts --config ./conf/app.config.yaml
```- Run code directly by `ts-node`
```shell
yarn dev-run --config ./conf/app.config.yaml
```- Run compiled code by `node`
```shell
yarn dist-run --config ./conf/app.config.yaml
```- Clean
```shell
make clean
```## Roadmap
- Documents
## License
[MIT](LICENSE)