Skip to content

Commit c05f7fe

Browse files
authored
Update docs: fix minor errors (#106)
* Update sound-creator-v1.mdx * Update sound-edition.mdx * Update edition-max-minter.mdx * Update range-edition-minter.mdx * Update fixed-price-signature-minter.mdx * Update merkle-drop-minter.mdx * Update ownable-roles.mdx
1 parent 7009d9f commit c05f7fe

File tree

7 files changed

+27
-27
lines changed

7 files changed

+27
-27
lines changed

pages/protocol/core/sound-creator-v1.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A factory that allows for a single transaction setup that:
88
2. Authorize one or more minter contracts on SoundEdition.
99
3. Configure one or more minter contracts to mint on SoundEdition.
1010

11-
These three steps are perfomed in the [`createSoundAndMints`](sound-creator-v1#createsoundandmints) function.
11+
These three steps are performed in the [`createSoundAndMints`](sound-creator-v1#createsoundandmints) function.
1212

1313
Inherits:
1414

pages/protocol/core/sound-edition.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Overview:
1010
- Enables the owner, authorized minter contracts or administrators to batch mint NFTs. Authorization is granted by the owner via the [`grantRoles`](#grantRoles) function inherited from [`OwnableRoles`](/protocol/libraries/ownable-roles).
1111
- Token IDs are minted sequentially (e.g. 1, 2, 3...) starting from 1.
1212
- Can optionally implement a `metadataModule` that effectively overrides the default `tokenURI` function.
13-
- Can natively support [range editions](https://sound.mirror.xyz/hmz2pueqBV37MD-mULjvch0vQoc-VKJdsfqXf8jTB30) via a dynamic maximum mintable supply (based on a `editionCutoffTime`),
13+
- Can natively support [range editions](https://sound.mirror.xyz/hmz2pueqBV37MD-mULjvch0vQoc-VKJdsfqXf8jTB30) via a dynamic maximum mintable supply (based on an `editionCutoffTime`),
1414
- Has a pseudorandom `mintRandomness` number optionally set on each [`mint`](#mint) call, which can be used for game mechanics.
1515
- Implements [EIP-2981 Royalty Standard](https://eips.ethereum.org/EIPS/eip-2981).
1616

@@ -119,7 +119,7 @@ This function is called in the [`createSoundAndMints`](sound-creator-v1#createso
119119
function mint(address to, uint256 quantity) external payable returns (uint256)
120120
```
121121

122-
Mints `quantity` tokens to addrress `to`
122+
Mints `quantity` tokens to address `to`
123123

124124
Each token will be assigned a token ID that is consecutively increasing.
125125

@@ -490,7 +490,7 @@ See: https://chiru-labs.github.io/ERC721A/#/tips?id=batch-size
490490

491491
### Initialization flags
492492

493-
Each flag is a bit in the `uint256 _flags` passed to the `initialze` function.
493+
Each flag is a bit in the `uint256 _flags` passed to the `initialize` function.
494494

495495
- `METADATA_IS_FROZEN_FLAG` - If set, the metadata is frozen and cannot be changed.
496496
- `MINT_RANDOMNESS_ENABLED_FLAG` - If set, the `mintRandomness` function is enabled.

pages/protocol/libraries/ownable-roles.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ function grantRoles(address user, uint256 roles) public virtual
7373
```
7474

7575
Allows the owner to grant `user` `roles`.
76-
If the `user` already has a role, then it will be an no-op for the role.
76+
If the `user` already has a role, then it will be a no-op for the role.
7777

7878
**Calling conditions:**
7979

@@ -91,7 +91,7 @@ function revokeRoles(address user, uint256 roles) public virtual
9191
```
9292

9393
Allows the owner to remove `user` `roles`.
94-
If the `user` does not have a role, then it will be an no-op for the role.
94+
If the `user` does not have a role, then it will be a no-op for the role.
9595

9696
**Calling conditions:**
9797

@@ -109,7 +109,7 @@ function renounceRoles(uint256 roles) public virtual
109109
```
110110

111111
Allow the caller to remove their own roles.
112-
If the caller does not have a role, then it will be an no-op for the role.
112+
If the caller does not have a role, then it will be a no-op for the role.
113113

114114
| Params: | |
115115
| ------- | ----------------------------------------- |

pages/protocol/modules/minters/edition-max-minter.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Initializes a range mint instance
6868

6969
**Calling conditions:**
7070

71-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
71+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
7272

7373
| Params: | |
7474
| ----------------------- | -------------------------------------------------------------- |
@@ -113,7 +113,7 @@ Sets the `price` for (`edition`, `mintId`).
113113

114114
**Calling conditions:**
115115

116-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
116+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
117117

118118
| Params: | |
119119
| --------- | ---------------------------------------------------------- |
@@ -135,7 +135,7 @@ Sets the `maxMintablePerAccount` for (`edition`, `mintId`).
135135

136136
**Calling conditions:**
137137

138-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
138+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
139139

140140
| Params: | |
141141
| ----------------------- | -------------------------------------------------------------- |
@@ -199,7 +199,7 @@ event EditionMaxMintCreated(
199199
)
200200
```
201201

202-
Emitted when a edition max is created.
202+
Emitted when an edition max is created.
203203

204204
| Params: | |
205205
| ----------------------- | ------------------------------------------------------------ |

pages/protocol/modules/minters/fixed-price-signature-minter.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Initializes a range edition mint instance.
6161

6262
**Calling conditions:**
6363

64-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
64+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
6565

6666
| Params: | |
6767
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -90,7 +90,7 @@ Sets the max mintable range.
9090

9191
**Calling conditions:**
9292

93-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
93+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
9494

9595
| Params: | |
9696
| ------------------ | ------------------------------------------------------------------- |
@@ -130,7 +130,7 @@ Sets the `price` for (`edition`, `mintId`).
130130

131131
**Calling conditions:**
132132

133-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
133+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
134134

135135
| Params: | |
136136
| --------- | ---------------------------------------------------------- |
@@ -152,7 +152,7 @@ Sets the `maxMintablePerAccount` for (`edition`, `mintId`).
152152

153153
**Calling conditions:**
154154

155-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
155+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
156156

157157
| Params: | |
158158
| ----------------------- | -------------------------------------------------------------- |

pages/protocol/modules/minters/merkle-drop-minter.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Initializes merkle drop mint instance.
6060

6161
**Calling conditions:**
6262

63-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
63+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
6464

6565
| Params: | |
6666
| ------------------------ | ------------------------------------------------------------------ |
@@ -70,7 +70,7 @@ Initializes merkle drop mint instance.
7070
| `startTime` | Start timestamp of sale (in seconds since unix epoch). |
7171
| `endTime` | End timestamp of sale (in seconds since unix epoch). |
7272
| `affiliateFeeBPS` | The affiliate fee in basis points. |
73-
| `maxMintable_` | The maximum number of tokens that can can be minted for this sale. |
73+
| `maxMintable_` | The maximum number of tokens that can be minted for this sale. |
7474
| `maxMintablePerAccount_` | The maximum number of tokens that a single account can mint. |
7575

7676
### mint
@@ -106,7 +106,7 @@ Sets the `price` for (`edition`, `mintId`).
106106

107107
**Calling conditions:**
108108

109-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
109+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
110110

111111
| Params: | |
112112
| --------- | ---------------------------------------------------------- |
@@ -128,7 +128,7 @@ Sets the `maxMintablePerAccount` for (`edition`, `mintId`).
128128

129129
**Calling conditions:**
130130

131-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
131+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
132132

133133
| Params: | |
134134
| ----------------------- | -------------------------------------------------------------- |
@@ -150,7 +150,7 @@ Sets the `maxMintable` for (`edition`, `mintId`).
150150

151151
**Calling conditions:**
152152

153-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
153+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
154154

155155
| Params: | |
156156
| ------------- | ----------------------------------------------------------------- |
@@ -172,7 +172,7 @@ Sets the `merkleRootHash` for (`edition`, `mintId`).
172172

173173
**Calling conditions:**
174174

175-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
175+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
176176

177177
| Params: | |
178178
| ---------------- | -------------------------------------------------------- |

pages/protocol/modules/minters/range-edition-minter.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**[`contracts/modules/RangeEditionMinter.sol`](https://github.com/soundxyz/sound-protocol/blob/master/contracts/modules/RangeEditionMinter.sol)**
44

5-
A minter that enables multiple schedules of fixed-price mints with a maximum mintable supply that drops from a upper bound to a lower bound after a defined cutoff time.
5+
A minter that enables multiple schedules of fixed-price mints with a maximum mintable supply that drops from an upper bound to a lower bound after a defined cutoff time.
66

77
Inherits:
88

@@ -62,7 +62,7 @@ Initializes a range mint instance
6262

6363
**Calling conditions:**
6464

65-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
65+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
6666

6767
| Params: | |
6868
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -92,7 +92,7 @@ Sets the time range.
9292

9393
**Calling conditions:**
9494

95-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
95+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
9696

9797
| Params: | |
9898
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -116,7 +116,7 @@ Sets the max mintable range.
116116

117117
**Calling conditions:**
118118

119-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
119+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
120120

121121
| Params: | |
122122
| ------------------ | ------------------------------------------------------------------- |
@@ -156,7 +156,7 @@ Sets the `price` for (`edition`, `mintId`).
156156

157157
**Calling conditions:**
158158

159-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
159+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
160160

161161
| Params: | |
162162
| --------- | ---------------------------------------------------------- |
@@ -178,7 +178,7 @@ Sets the `maxMintablePerAccount` for (`edition`, `mintId`).
178178

179179
**Calling conditions:**
180180

181-
- The caller must be the owner or an adminstrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
181+
- The caller must be the owner or an administrator (via the [`ADMIN_ROLE`](/protocol/core/sound-edition#admin_role)) of the `edition` contract.
182182

183183
| Params: | |
184184
| ----------------------- | -------------------------------------------------------------- |

0 commit comments

Comments
 (0)