Skip to content

Commit 55f36b0

Browse files
kumaryash90kumaryash90
committed
update docs
1 parent b1b46c1 commit 55f36b0

File tree

4 files changed

+4
-266
lines changed

4 files changed

+4
-266
lines changed

‎docs/ERC1155Drop.md

+1-67
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66

7-
BASE: ERC1155Base EXTENSION: SignatureMintERC1155, DropSinglePhase1155 The `ERC1155Drop` contract uses the `ERC1155Base` contract, along with the `SignatureMintERC1155` and `DropSinglePhase1155` extension. The 'signature minting' mechanism in the `SignatureMintERC1155` extension is a way for a contract admin to authorize an external party's request to mint tokens on the admin's contract. At a high level, this means you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party. The `drop` mechanism in the `DropSinglePhase1155` extension is a distribution mechanism for lazy minted tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint lazy minted tokens. The `ERC721Drop` contract lets you lazy mint tokens, and distribute those lazy minted tokens via signature minting, or via the drop mechanism.
7+
BASE: ERC1155Base EXTENSION: DropSinglePhase1155 The `ERC1155Base` smart contract implements the ERC1155 NFT standard. It includes the following additions to standard ERC1155 logic: - Contract metadata for royalty support on platforms such as OpenSea that use off-chain information to distribute roaylties. - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2981 compliance for royalty support on NFT marketplaces. The `drop` mechanism in the `DropSinglePhase1155` extension is a distribution mechanism for lazy minted tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint lazy minted tokens. The `ERC721Drop` contract lets you lazy mint tokens, and distribute those lazy minted tokens via the drop mechanism.
88

99

1010

@@ -365,29 +365,6 @@ Lets an authorized address lazy mint a given amount of NFTs.
365365
|---|---|---|
366366
| batchId | uint256 | A unique integer identifier for the batch of NFTs lazy minted together. |
367367

368-
### mintWithSignature
369-
370-
```solidity
371-
function mintWithSignature(ISignatureMintERC1155.MintRequest _req, bytes _signature) external payable returns (address signer)
372-
```
373-
374-
375-
376-
377-
378-
#### Parameters
379-
380-
| Name | Type | Description |
381-
|---|---|---|
382-
| _req | ISignatureMintERC1155.MintRequest | undefined |
383-
| _signature | bytes | undefined |
384-
385-
#### Returns
386-
387-
| Name | Type | Description |
388-
|---|---|---|
389-
| signer | address | undefined |
390-
391368
### multicall
392369

393370
```solidity
@@ -766,30 +743,6 @@ Returns the metadata URI for an NFT.
766743
|---|---|---|
767744
| _0 | string | undefined |
768745

769-
### verify
770-
771-
```solidity
772-
function verify(ISignatureMintERC1155.MintRequest _req, bytes _signature) external view returns (bool success, address signer)
773-
```
774-
775-
776-
777-
778-
779-
#### Parameters
780-
781-
| Name | Type | Description |
782-
|---|---|---|
783-
| _req | ISignatureMintERC1155.MintRequest | undefined |
784-
| _signature | bytes | undefined |
785-
786-
#### Returns
787-
788-
| Name | Type | Description |
789-
|---|---|---|
790-
| success | bool | undefined |
791-
| signer | address | undefined |
792-
793746
### verifyClaim
794747

795748
```solidity
@@ -1017,25 +970,6 @@ event TokensLazyMinted(uint256 indexed startTokenId, uint256 endTokenId, string
1017970
| baseURI | string | undefined |
1018971
| encryptedBaseURI | bytes | undefined |
1019972

1020-
### TokensMintedWithSignature
1021-
1022-
```solidity
1023-
event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, uint256 indexed tokenIdMinted, ISignatureMintERC1155.MintRequest mintRequest)
1024-
```
1025-
1026-
1027-
1028-
1029-
1030-
#### Parameters
1031-
1032-
| Name | Type | Description |
1033-
|---|---|---|
1034-
| signer `indexed` | address | undefined |
1035-
| mintedTo `indexed` | address | undefined |
1036-
| tokenIdMinted `indexed` | uint256 | undefined |
1037-
| mintRequest | ISignatureMintERC1155.MintRequest | undefined |
1038-
1039973
### TransferBatch
1040974

1041975
```solidity

‎docs/ERC20Drop.md

+1-66
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66

7-
BASE: ERC20 EXTENSION: SignatureMintERC20, DropSinglePhase The `ERC20Drop` contract uses the `ERC20Base` contract, along with the `SignatureMintERC20` and `DropSinglePhase` extensions. The 'signature minting' mechanism in the `SignatureMintERC20` extension is a way for a contract admin to authorize an external party's request to mint tokens on the admin's contract. At a high level, this means you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism for tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint tokens.
7+
BASE: ERC20 EXTENSION: DropSinglePhase The `ERC20Drop` smart contract implements the ERC20 standard. It includes the following additions to standard ERC20 logic: - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2612 compliance: See {ERC20-permit} method, which can be used to change an account's ERC20 allowance by presenting a message signed by the account. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism for tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint tokens.
88

99

1010

@@ -259,29 +259,6 @@ function increaseAllowance(address spender, uint256 addedValue) external nonpaya
259259
|---|---|---|
260260
| _0 | bool | undefined |
261261

262-
### mintWithSignature
263-
264-
```solidity
265-
function mintWithSignature(ISignatureMintERC20.MintRequest _req, bytes _signature) external payable returns (address signer)
266-
```
267-
268-
269-
270-
271-
272-
#### Parameters
273-
274-
| Name | Type | Description |
275-
|---|---|---|
276-
| _req | ISignatureMintERC20.MintRequest | undefined |
277-
| _signature | bytes | undefined |
278-
279-
#### Returns
280-
281-
| Name | Type | Description |
282-
|---|---|---|
283-
| signer | address | undefined |
284-
285262
### multicall
286263

287264
```solidity
@@ -545,30 +522,6 @@ function transferFrom(address from, address to, uint256 amount) external nonpaya
545522
|---|---|---|
546523
| _0 | bool | undefined |
547524

548-
### verify
549-
550-
```solidity
551-
function verify(ISignatureMintERC20.MintRequest _req, bytes _signature) external view returns (bool success, address signer)
552-
```
553-
554-
555-
556-
557-
558-
#### Parameters
559-
560-
| Name | Type | Description |
561-
|---|---|---|
562-
| _req | ISignatureMintERC20.MintRequest | undefined |
563-
| _signature | bytes | undefined |
564-
565-
#### Returns
566-
567-
| Name | Type | Description |
568-
|---|---|---|
569-
| success | bool | undefined |
570-
| signer | address | undefined |
571-
572525
### verifyClaim
573526

574527
```solidity
@@ -722,24 +675,6 @@ event TokensClaimed(address indexed claimer, address indexed receiver, uint256 i
722675
| startTokenId `indexed` | uint256 | undefined |
723676
| quantityClaimed | uint256 | undefined |
724677

725-
### TokensMintedWithSignature
726-
727-
```solidity
728-
event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, ISignatureMintERC20.MintRequest mintRequest)
729-
```
730-
731-
732-
733-
734-
735-
#### Parameters
736-
737-
| Name | Type | Description |
738-
|---|---|---|
739-
| signer `indexed` | address | undefined |
740-
| mintedTo `indexed` | address | undefined |
741-
| mintRequest | ISignatureMintERC20.MintRequest | undefined |
742-
743678
### Transfer
744679

745680
```solidity

‎docs/ERC20DropVote.md

+1-66
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66

7-
BASE: ERC20Votes EXTENSION: SignatureMintERC20, DropSinglePhase The `ERC20Drop` contract uses the `ERC20Vote` contract, along with the `SignatureMintERC20` and `DropSinglePhase` extensions. The 'signature minting' mechanism in the `SignatureMintERC20` extension is a way for a contract admin to authorize an external party's request to mint tokens on the admin's contract. At a high level, this means you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint tokens.
7+
BASE: ERC20Votes EXTENSION: DropSinglePhase The `ERC20Drop` contract uses the `DropSinglePhase` extensions, along with `ERC20Votes`. It implements the ERC20 standard, along with the following additions to standard ERC20 logic: - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2612 compliance: See {ERC20-permit} method, which can be used to change an account's ERC20 allowance by presenting a message signed by the account. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint tokens.
88

99

1010

@@ -408,29 +408,6 @@ function increaseAllowance(address spender, uint256 addedValue) external nonpaya
408408
|---|---|---|
409409
| _0 | bool | undefined |
410410

411-
### mintWithSignature
412-
413-
```solidity
414-
function mintWithSignature(ISignatureMintERC20.MintRequest _req, bytes _signature) external payable returns (address signer)
415-
```
416-
417-
418-
419-
420-
421-
#### Parameters
422-
423-
| Name | Type | Description |
424-
|---|---|---|
425-
| _req | ISignatureMintERC20.MintRequest | undefined |
426-
| _signature | bytes | undefined |
427-
428-
#### Returns
429-
430-
| Name | Type | Description |
431-
|---|---|---|
432-
| signer | address | undefined |
433-
434411
### multicall
435412

436413
```solidity
@@ -716,30 +693,6 @@ function transferFrom(address from, address to, uint256 amount) external nonpaya
716693
|---|---|---|
717694
| _0 | bool | undefined |
718695

719-
### verify
720-
721-
```solidity
722-
function verify(ISignatureMintERC20.MintRequest _req, bytes _signature) external view returns (bool success, address signer)
723-
```
724-
725-
726-
727-
728-
729-
#### Parameters
730-
731-
| Name | Type | Description |
732-
|---|---|---|
733-
| _req | ISignatureMintERC20.MintRequest | undefined |
734-
| _signature | bytes | undefined |
735-
736-
#### Returns
737-
738-
| Name | Type | Description |
739-
|---|---|---|
740-
| success | bool | undefined |
741-
| signer | address | undefined |
742-
743696
### verifyClaim
744697

745698
```solidity
@@ -929,24 +882,6 @@ event TokensClaimed(address indexed claimer, address indexed receiver, uint256 i
929882
| startTokenId `indexed` | uint256 | undefined |
930883
| quantityClaimed | uint256 | undefined |
931884

932-
### TokensMintedWithSignature
933-
934-
```solidity
935-
event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, ISignatureMintERC20.MintRequest mintRequest)
936-
```
937-
938-
939-
940-
941-
942-
#### Parameters
943-
944-
| Name | Type | Description |
945-
|---|---|---|
946-
| signer `indexed` | address | undefined |
947-
| mintedTo `indexed` | address | undefined |
948-
| mintRequest | ISignatureMintERC20.MintRequest | undefined |
949-
950885
### Transfer
951886

952887
```solidity

‎docs/ERC721Drop.md

+1-67
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66

7-
BASE: ERC721A EXTENSION: SignatureMintERC721, DropSinglePhase The `ERC721Drop` contract uses the `ERC721Base` contract, along with the `SignatureMintERC721` and `DropSinglePhase` extension. The 'signature minting' mechanism in the `SignatureMintERC721` extension is a way for a contract admin to authorize an external party's request to mint tokens on the admin's contract. At a high level, this means you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism for lazy minted tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint lazy minted tokens. The `ERC721Drop` contract lets you lazy mint tokens, and distribute those lazy minted tokens via signature minting, or via the drop mechanism.
7+
BASE: ERC721A EXTENSION: DropSinglePhase The `ERC721Drop` contract implements the ERC721 NFT standard, along with the ERC721A optimization to the standard. It includes the following additions to standard ERC721 logic: - Contract metadata for royalty support on platforms such as OpenSea that use off-chain information to distribute roaylties. - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2981 compliance for royalty support on NFT marketplaces. The `drop` mechanism in the `DropSinglePhase` extension is a distribution mechanism for lazy minted tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint lazy minted tokens. The `ERC721Drop` contract lets you lazy mint tokens, and distribute those lazy minted tokens via the drop mechanism.
88

99

1010

@@ -389,29 +389,6 @@ Lets an authorized address lazy mint a given amount of NFTs.
389389
|---|---|---|
390390
| batchId | uint256 | A unique integer identifier for the batch of NFTs lazy minted together. |
391391

392-
### mintWithSignature
393-
394-
```solidity
395-
function mintWithSignature(ISignatureMintERC721.MintRequest _req, bytes _signature) external payable returns (address signer)
396-
```
397-
398-
399-
400-
401-
402-
#### Parameters
403-
404-
| Name | Type | Description |
405-
|---|---|---|
406-
| _req | ISignatureMintERC721.MintRequest | undefined |
407-
| _signature | bytes | undefined |
408-
409-
#### Returns
410-
411-
| Name | Type | Description |
412-
|---|---|---|
413-
| signer | address | undefined |
414-
415392
### multicall
416393

417394
```solidity
@@ -821,30 +798,6 @@ function transferFrom(address from, address to, uint256 tokenId) external nonpay
821798
| to | address | undefined |
822799
| tokenId | uint256 | undefined |
823800

824-
### verify
825-
826-
```solidity
827-
function verify(ISignatureMintERC721.MintRequest _req, bytes _signature) external view returns (bool success, address signer)
828-
```
829-
830-
831-
832-
833-
834-
#### Parameters
835-
836-
| Name | Type | Description |
837-
|---|---|---|
838-
| _req | ISignatureMintERC721.MintRequest | undefined |
839-
| _signature | bytes | undefined |
840-
841-
#### Returns
842-
843-
| Name | Type | Description |
844-
|---|---|---|
845-
| success | bool | undefined |
846-
| signer | address | undefined |
847-
848801
### verifyClaim
849802

850803
```solidity
@@ -1087,25 +1040,6 @@ event TokensLazyMinted(uint256 indexed startTokenId, uint256 endTokenId, string
10871040
| baseURI | string | undefined |
10881041
| encryptedBaseURI | bytes | undefined |
10891042

1090-
### TokensMintedWithSignature
1091-
1092-
```solidity
1093-
event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, uint256 indexed tokenIdMinted, ISignatureMintERC721.MintRequest mintRequest)
1094-
```
1095-
1096-
1097-
1098-
1099-
1100-
#### Parameters
1101-
1102-
| Name | Type | Description |
1103-
|---|---|---|
1104-
| signer `indexed` | address | undefined |
1105-
| mintedTo `indexed` | address | undefined |
1106-
| tokenIdMinted `indexed` | uint256 | undefined |
1107-
| mintRequest | ISignatureMintERC721.MintRequest | undefined |
1108-
11091043
### Transfer
11101044

11111045
```solidity

0 commit comments

Comments
 (0)