Skip to content

Commit

Permalink
Update README to include Open Edition Minter related changes
Browse files Browse the repository at this point in the history
  • Loading branch information
MightOfOaks committed Jun 11, 2023
1 parent 37507e6 commit 4a27081
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,41 @@ yarn base-minter
yarn mint --token-uri [token-uri]
```

## Open Edition Minter

Open edition minter allows multiple copies of a single NFT to be minted for a given time interval.

### Initialize an open edition minter contract
Specify the collection info and open edition minter configuration in `config.js`, then run:
```sh
yarn open-edition-minter
```
The user is prompted to choose whether the metadata will be stored off-chain or on-chain.
- **off-chain**: the metadata needs to be uploaded to IPFS beforehand and the URI should be specified as _tokenUri_ in `config.js/openEditionMinterConfig`
- **on-chain**: the metadata will be stored on-chain upon collection creation and should be specified as _metadata_ in `config.js/openEditionMinterConfig`
### Mint
#### Mint a token to an address
Specify the minter contract address in `config.js` and run:
```sh
yarn mint --to [address]
```
This mints a token to the given address.
#### Batch mint tokens to an address
Mint `num` tokens to an address.

```sh
yarn mint --to [address] --batch [num]
```
#### Update trading start time
Specify the new `startTradingTime` in `config.js/openEditionMinterConfig` and run:
```sh
yarn open-edition-minter --update-start-trading-time
```
#### Update per address limit
Specify the new `perAddressLimit` in `config.js/openEditionMinterConfig` and run:
```sh
yarn open-edition-minter --update-per-address-limit
```
## Query sg721

You can run queries against an instantiated sg721 contract with:
Expand Down

0 comments on commit 4a27081

Please sign in to comment.