Skip to content

Commit 90f20dc

Browse files
kumaryash90kumaryash90
committed
update docs
1 parent 4602118 commit 90f20dc

7 files changed

+160
-22
lines changed

‎docs/DropERC20.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ function setMaxTotalSupply(uint256 _maxTotalSupply) external nonpayable
911911

912912

913913

914-
*Lets a contract admin set the global maximum supply of tokens.*
914+
*Set global maximum supply. Must be parsed to 18 decimals when setting, by adding 18 zeros after the desired value.*
915915

916916
#### Parameters
917917

@@ -927,7 +927,7 @@ function setMaxWalletClaimCount(uint256 _count) external nonpayable
927927

928928

929929

930-
*Lets a contract admin set a maximum number of tokens that can be claimed by any wallet.*
930+
*Set a maximum number of tokens that can be claimed by any wallet. Must be parsed to 18 decimals when setting, by adding 18 zeros after the desired value.*
931931

932932
#### Parameters
933933

‎docs/ERC1155DelayedReveal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ Lets an owner or approved operator burn NFTs of the given tokenIds.
9898
function claim(address _receiver, uint256 _tokenId, uint256 _quantity) external payable
9999
```
100100

101-
Lets an address claim multiple lazy minted NFTs at once to a recipient. Contract creators should override this function to create custom logic for claiming, for e.g. price collection, allowlist, max quantity, etc.
101+
Lets an address claim multiple lazy minted NFTs at once to a recipient. This function prevents any reentrant calls, and is not allowed to be overridden. Contract creators should override `verifyClaim` and `transferTokensOnClaim` functions to create custom logic for verification and claiming, for e.g. price collection, allowlist, max quantity, etc.
102102

103-
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
103+
*The logic in `verifyClaim` determines whether the caller is authorized to mint NFTs. The logic in `transferTokensOnClaim` does actual minting of tokens, can also be used to apply other state changes.*
104104

105105
#### Parameters
106106

‎docs/ERC1155LazyMint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ Lets an owner or approved operator burn NFTs of the given tokenIds.
9898
function claim(address _receiver, uint256 _tokenId, uint256 _quantity) external payable
9999
```
100100

101-
Lets an address claim multiple lazy minted NFTs at once to a recipient. Contract creators should override this function to create custom logic for claiming, for e.g. price collection, allowlist, max quantity, etc.
101+
Lets an address claim multiple lazy minted NFTs at once to a recipient. This function prevents any reentrant calls, and is not allowed to be overridden. Contract creators should override `verifyClaim` and `transferTokensOnClaim` functions to create custom logic for verification and claiming, for e.g. price collection, allowlist, max quantity, etc.
102102

103-
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
103+
*The logic in `verifyClaim` determines whether the caller is authorized to mint NFTs. The logic in `transferTokensOnClaim` does actual minting of tokens, can also be used to apply other state changes.*
104104

105105
#### Parameters
106106

‎docs/ERC721DelayedReveal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ Lets an owner or approved operator burn the NFT of the given tokenId.
7171
function claim(address _receiver, uint256 _quantity) external payable
7272
```
7373

74-
Lets an address claim multiple lazy minted NFTs at once to a recipient. Contract creators should override this function to create custom logic for claiming, for e.g. price collection, allowlist, max quantity, etc.
74+
Lets an address claim multiple lazy minted NFTs at once to a recipient. This function prevents any reentrant calls, and is not allowed to be overridden. Contract creators should override `verifyClaim` and `transferTokensOnClaim` functions to create custom logic for verification and claiming, for e.g. price collection, allowlist, max quantity, etc.
7575

76-
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
76+
*The logic in `verifyClaim` determines whether the caller is authorized to mint NFTs. The logic in `transferTokensOnClaim` does actual minting of tokens, can also be used to apply other state changes.*
7777

7878
#### Parameters
7979

‎docs/ERC721LazyMint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ Lets an owner or approved operator burn the NFT of the given tokenId.
7171
function claim(address _receiver, uint256 _quantity) external payable
7272
```
7373

74-
Lets an address claim multiple lazy minted NFTs at once to a recipient. Contract creators should override this function to create custom logic for claiming, for e.g. price collection, allowlist, max quantity, etc.
74+
Lets an address claim multiple lazy minted NFTs at once to a recipient. This function prevents any reentrant calls, and is not allowed to be overridden. Contract creators should override `verifyClaim` and `transferTokensOnClaim` functions to create custom logic for verification and claiming, for e.g. price collection, allowlist, max quantity, etc.
7575

76-
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
76+
*The logic in `verifyClaim` determines whether the caller is authorized to mint NFTs. The logic in `transferTokensOnClaim` does actual minting of tokens, can also be used to apply other state changes.*
7777

7878
#### Parameters
7979

‎docs/ITWRegistry.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# ITWRegistry
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
## Methods
12+
13+
### add
14+
15+
```solidity
16+
function add(address _deployer, address _deployment, uint256 _chainId) external nonpayable
17+
```
18+
19+
Add a deployment for a deployer.
20+
21+
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| _deployer | address | undefined |
28+
| _deployment | address | undefined |
29+
| _chainId | uint256 | undefined |
30+
31+
### count
32+
33+
```solidity
34+
function count(address _deployer) external view returns (uint256 deploymentCount)
35+
```
36+
37+
Get the total number of deployments for a deployer.
38+
39+
40+
41+
#### Parameters
42+
43+
| Name | Type | Description |
44+
|---|---|---|
45+
| _deployer | address | undefined |
46+
47+
#### Returns
48+
49+
| Name | Type | Description |
50+
|---|---|---|
51+
| deploymentCount | uint256 | undefined |
52+
53+
### getAll
54+
55+
```solidity
56+
function getAll(address _deployer) external view returns (struct ITWRegistry.Deployment[] allDeployments)
57+
```
58+
59+
Get all deployments for a deployer.
60+
61+
62+
63+
#### Parameters
64+
65+
| Name | Type | Description |
66+
|---|---|---|
67+
| _deployer | address | undefined |
68+
69+
#### Returns
70+
71+
| Name | Type | Description |
72+
|---|---|---|
73+
| allDeployments | ITWRegistry.Deployment[] | undefined |
74+
75+
### remove
76+
77+
```solidity
78+
function remove(address _deployer, address _deployment, uint256 _chainId) external nonpayable
79+
```
80+
81+
Remove a deployment for a deployer.
82+
83+
84+
85+
#### Parameters
86+
87+
| Name | Type | Description |
88+
|---|---|---|
89+
| _deployer | address | undefined |
90+
| _deployment | address | undefined |
91+
| _chainId | uint256 | undefined |
92+
93+
94+
95+
## Events
96+
97+
### Added
98+
99+
```solidity
100+
event Added(address indexed deployer, address indexed deployment, uint256 indexed chainId)
101+
```
102+
103+
104+
105+
106+
107+
#### Parameters
108+
109+
| Name | Type | Description |
110+
|---|---|---|
111+
| deployer `indexed` | address | undefined |
112+
| deployment `indexed` | address | undefined |
113+
| chainId `indexed` | uint256 | undefined |
114+
115+
### Deleted
116+
117+
```solidity
118+
event Deleted(address indexed deployer, address indexed deployment, uint256 indexed chainId)
119+
```
120+
121+
122+
123+
124+
125+
#### Parameters
126+
127+
| Name | Type | Description |
128+
|---|---|---|
129+
| deployer `indexed` | address | undefined |
130+
| deployment `indexed` | address | undefined |
131+
| chainId `indexed` | uint256 | undefined |
132+
133+
134+

‎docs/TWRegistry.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ function OPERATOR_ROLE() external view returns (bytes32)
4747
### add
4848

4949
```solidity
50-
function add(address _deployer, address _deployment) external nonpayable
50+
function add(address _deployer, address _deployment, uint256 _chainId) external nonpayable
5151
```
5252

53-
53+
Add a deployment for a deployer.
5454

5555

5656

@@ -60,14 +60,15 @@ function add(address _deployer, address _deployment) external nonpayable
6060
|---|---|---|
6161
| _deployer | address | undefined |
6262
| _deployment | address | undefined |
63+
| _chainId | uint256 | undefined |
6364

6465
### count
6566

6667
```solidity
67-
function count(address _deployer) external view returns (uint256)
68+
function count(address _deployer) external view returns (uint256 deploymentCount)
6869
```
6970

70-
71+
Get the total number of deployments for a deployer.
7172

7273

7374

@@ -81,15 +82,15 @@ function count(address _deployer) external view returns (uint256)
8182

8283
| Name | Type | Description |
8384
|---|---|---|
84-
| _0 | uint256 | undefined |
85+
| deploymentCount | uint256 | undefined |
8586

8687
### getAll
8788

8889
```solidity
89-
function getAll(address _deployer) external view returns (address[])
90+
function getAll(address _deployer) external view returns (struct ITWRegistry.Deployment[] allDeployments)
9091
```
9192

92-
93+
Get all deployments for a deployer.
9394

9495

9596

@@ -103,7 +104,7 @@ function getAll(address _deployer) external view returns (address[])
103104

104105
| Name | Type | Description |
105106
|---|---|---|
106-
| _0 | address[] | undefined |
107+
| allDeployments | ITWRegistry.Deployment[] | undefined |
107108

108109
### getRoleAdmin
109110

@@ -259,10 +260,10 @@ function multicall(bytes[] data) external nonpayable returns (bytes[] results)
259260
### remove
260261

261262
```solidity
262-
function remove(address _deployer, address _deployment) external nonpayable
263+
function remove(address _deployer, address _deployment, uint256 _chainId) external nonpayable
263264
```
264265

265-
266+
Remove a deployment for a deployer.
266267

267268

268269

@@ -272,6 +273,7 @@ function remove(address _deployer, address _deployment) external nonpayable
272273
|---|---|---|
273274
| _deployer | address | undefined |
274275
| _deployment | address | undefined |
276+
| _chainId | uint256 | undefined |
275277

276278
### renounceRole
277279

@@ -336,7 +338,7 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)
336338
### Added
337339

338340
```solidity
339-
event Added(address indexed deployer, address indexed deployment)
341+
event Added(address indexed deployer, address indexed deployment, uint256 indexed chainId)
340342
```
341343

342344

@@ -349,11 +351,12 @@ event Added(address indexed deployer, address indexed deployment)
349351
|---|---|---|
350352
| deployer `indexed` | address | undefined |
351353
| deployment `indexed` | address | undefined |
354+
| chainId `indexed` | uint256 | undefined |
352355

353356
### Deleted
354357

355358
```solidity
356-
event Deleted(address indexed deployer, address indexed deployment)
359+
event Deleted(address indexed deployer, address indexed deployment, uint256 indexed chainId)
357360
```
358361

359362

@@ -366,6 +369,7 @@ event Deleted(address indexed deployer, address indexed deployment)
366369
|---|---|---|
367370
| deployer `indexed` | address | undefined |
368371
| deployment `indexed` | address | undefined |
372+
| chainId `indexed` | uint256 | undefined |
369373

370374
### RoleAdminChanged
371375

0 commit comments

Comments
 (0)