Skip to content

Commit 49069e4

Browse files
joaquim-vergesjoaquim-verges
committed
docs
1 parent 9f61af5 commit 49069e4

File tree

6 files changed

+220
-0
lines changed

6 files changed

+220
-0
lines changed

‎docs/ERC1155DelayedReveal.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -797,6 +797,25 @@ event TokenURIRevealed(uint256 indexed index, string revealedURI)
797797
| index `indexed` | uint256 | undefined |
798798
| revealedURI | string | undefined |
799799

800+
### TokensClaimed
801+
802+
```solidity
803+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed tokenId, uint256 quantityClaimed)
804+
```
805+
806+
807+
808+
809+
810+
#### Parameters
811+
812+
| Name | Type | Description |
813+
|---|---|---|
814+
| claimer `indexed` | address | undefined |
815+
| receiver `indexed` | address | undefined |
816+
| tokenId `indexed` | uint256 | undefined |
817+
| quantityClaimed | uint256 | undefined |
818+
800819
### TokensLazyMinted
801820

802821
```solidity

‎docs/ERC1155LazyMint.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -667,6 +667,25 @@ event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient,
667667
| royaltyRecipient `indexed` | address | undefined |
668668
| royaltyBps | uint256 | undefined |
669669

670+
### TokensClaimed
671+
672+
```solidity
673+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed tokenId, uint256 quantityClaimed)
674+
```
675+
676+
677+
678+
679+
680+
#### Parameters
681+
682+
| Name | Type | Description |
683+
|---|---|---|
684+
| claimer `indexed` | address | undefined |
685+
| receiver `indexed` | address | undefined |
686+
| tokenId `indexed` | uint256 | undefined |
687+
| quantityClaimed | uint256 | undefined |
688+
670689
### TokensLazyMinted
671690

672691
```solidity

‎docs/ERC721DelayedReveal.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -857,6 +857,25 @@ event TokenURIRevealed(uint256 indexed index, string revealedURI)
857857
| index `indexed` | uint256 | undefined |
858858
| revealedURI | string | undefined |
859859

860+
### TokensClaimed
861+
862+
```solidity
863+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)
864+
```
865+
866+
867+
868+
869+
870+
#### Parameters
871+
872+
| Name | Type | Description |
873+
|---|---|---|
874+
| claimer `indexed` | address | undefined |
875+
| receiver `indexed` | address | undefined |
876+
| startTokenId `indexed` | uint256 | undefined |
877+
| quantityClaimed | uint256 | undefined |
878+
860879
### TokensLazyMinted
861880

862881
```solidity

‎docs/ERC721LazyMint.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -727,6 +727,25 @@ event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient,
727727
| royaltyRecipient `indexed` | address | undefined |
728728
| royaltyBps | uint256 | undefined |
729729

730+
### TokensClaimed
731+
732+
```solidity
733+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)
734+
```
735+
736+
737+
738+
739+
740+
#### Parameters
741+
742+
| Name | Type | Description |
743+
|---|---|---|
744+
| claimer `indexed` | address | undefined |
745+
| receiver `indexed` | address | undefined |
746+
| startTokenId `indexed` | uint256 | undefined |
747+
| quantityClaimed | uint256 | undefined |
748+
730749
### TokensLazyMinted
731750

732751
```solidity

‎docs/IClaimableERC1155.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# IClaimableERC1155
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
## Methods
12+
13+
### claim
14+
15+
```solidity
16+
function claim(address _receiver, uint256 _tokenId, uint256 _quantity) external payable
17+
```
18+
19+
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.
20+
21+
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| _receiver | address | The recipient of the tokens to mint. |
28+
| _tokenId | uint256 | The tokenId of the lazy minted NFT to mint. |
29+
| _quantity | uint256 | The number of tokens to mint. |
30+
31+
### verifyClaim
32+
33+
```solidity
34+
function verifyClaim(address _claimer, uint256 _tokenId, uint256 _quantity) external view
35+
```
36+
37+
Override this function to add logic for claim verification, based on conditions such as allowlist, price, max quantity etc.
38+
39+
*Checks a request to claim NFTs against a custom condition.*
40+
41+
#### Parameters
42+
43+
| Name | Type | Description |
44+
|---|---|---|
45+
| _claimer | address | Caller of the claim function. |
46+
| _tokenId | uint256 | The tokenId of the lazy minted NFT to mint. |
47+
| _quantity | uint256 | The number of NFTs being claimed. |
48+
49+
50+
51+
## Events
52+
53+
### TokensClaimed
54+
55+
```solidity
56+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed tokenId, uint256 quantityClaimed)
57+
```
58+
59+
60+
61+
*Emitted when tokens are claimed*
62+
63+
#### Parameters
64+
65+
| Name | Type | Description |
66+
|---|---|---|
67+
| claimer `indexed` | address | undefined |
68+
| receiver `indexed` | address | undefined |
69+
| tokenId `indexed` | uint256 | undefined |
70+
| quantityClaimed | uint256 | undefined |
71+
72+
73+

‎docs/IClaimableERC721.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# IClaimableERC721
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
## Methods
12+
13+
### claim
14+
15+
```solidity
16+
function claim(address _receiver, uint256 _quantity) external payable
17+
```
18+
19+
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.
20+
21+
*The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.*
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| _receiver | address | The recipient of the NFT to mint. |
28+
| _quantity | uint256 | The number of NFTs to mint. |
29+
30+
### verifyClaim
31+
32+
```solidity
33+
function verifyClaim(address _claimer, uint256 _quantity) external view
34+
```
35+
36+
Override this function to add logic for claim verification, based on conditions such as allowlist, price, max quantity etc.
37+
38+
*Checks a request to claim NFTs against a custom condition.*
39+
40+
#### Parameters
41+
42+
| Name | Type | Description |
43+
|---|---|---|
44+
| _claimer | address | Caller of the claim function. |
45+
| _quantity | uint256 | The number of NFTs being claimed. |
46+
47+
48+
49+
## Events
50+
51+
### TokensClaimed
52+
53+
```solidity
54+
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)
55+
```
56+
57+
58+
59+
*Emitted when tokens are claimed*
60+
61+
#### Parameters
62+
63+
| Name | Type | Description |
64+
|---|---|---|
65+
| claimer `indexed` | address | undefined |
66+
| receiver `indexed` | address | undefined |
67+
| startTokenId `indexed` | uint256 | undefined |
68+
| quantityClaimed | uint256 | undefined |
69+
70+
71+

0 commit comments

Comments
 (0)