Add feature snippets (#127)

* Fix super()

* Update

* Fix standards with functions

* Add erc20, erc721, and erc1155 extensions

* Fix duplicate functions

* Add docs setup to make init, update docs for erc20, erc721, erc1155

* Add feature snippets generation

* Delete scripts

---------

Co-authored-by: Adam Majmudar <adam@Adams-MacBook-Pro.local>
Co-authored-by: Adam Majmudar <adam@Adams-MBP.localdomain>

Author: 3 people

Makefile

@@ -13,6 +13,9 @@ init:
 	poetry run pip3 install eth-brownie
 	npm install -g @0x/abi-gen
 	yarn
+	poetry shell
+	pip3 install pydoc-markdown
+	pip3 install 0x-order-utils
 
 test:
 	poetry run brownie test --network hardhat

docs/docs/contract-metadata.md

@@ -20,6 +20,11 @@ def get() -> TContractSchema
 
 Get the metadata associated with this contract.
 
+```python
+metadata = contract.metadata.get()
+print(metadata)
+```
+
 **Returns**:
 
 metadata associated with this contract
@@ -34,6 +39,18 @@ def set(metadata: TContractSchema) -> TxReceipt
 
 Set the metadata associated with this contract.
 
+```python
+from thirdweb.types import ContractMetadataSchema
+
+metadata = ContractMetadataSchema.from_json({
+    "name": "My Contract",
+    "description": "This is my contract!",
+    "image": open("path/to/file.jpg", "rb")
+})
+
+receipt = contract.metadata.set(metadata)
+```
+
 **Arguments**:
 
 - `metadata`: metadata to set

docs/docs/contract-platform-fee.md

@@ -20,6 +20,12 @@ def get() -> ContractPlatformFeeSchema
 
 Get the platform fee of this contract.
 
+```python
+platform_fees = contract.platform_fee.get()
+print(platform_fees.platform_fee_basis_points)
+print(platform_fees.platform_fee_recipient)
+```
+
 **Returns**:
 
 the platform fee.
@@ -34,6 +40,17 @@ def set(platform_fee_info: ContractPlatformFeeSchema) -> TxReceipt
 
 Set the platform fee of this contract.
 
+```python
+from thirdweb.types import ContractPlatformFeeSchema
+
+platform_fee_info = ContractPlatformFeeSchema(
+    platform_fee_basis_points=100 # 1%
+    platform_fee_receipient="{{wallet_address}}"
+)
+
+receipt = contract.platform_fee.set(platform_fee_info)
+```
+
 **Arguments**:
 
 - `platform_fee_info`: the platform fee info to set.

docs/docs/contract-roles.md

@@ -20,6 +20,11 @@ def get_all() -> Dict[Role, List[str]]
 
 Get all role members on this contract.
 
+```python
+all_role_members = contract.roles.get_all()
+print(all_role_members)
+```
+
 **Returns**:
 
 a dictionary of role members for each role
@@ -34,6 +39,16 @@ def get(role: Role) -> List[str]
 
 Get all members of a role on this contract.
 
+```python
+from thirdweb.constants.role import Role
+
+# Select any role to filter by
+role = Role.ADMIN
+
+role_members = contract.roles.get(role)
+print(role_members)
+```
+
 **Arguments**:
 
 - `role`: role to get members of
@@ -52,6 +67,15 @@ def grant(role: Role, address: str) -> TxReceipt
 
 Grant a role to an address.
 
+```python
+from thirdweb.constants.role import Role
+
+address = "{{wallet_address}}" # Address to grant a role
+role = Role.ADMIN # Select a role to grant
+
+receipt = contract.roles.grant(role, address)
+```
+
 **Arguments**:
 
 - `role`: role to grant
@@ -71,6 +95,15 @@ def revoke(role: Role, address: str) -> TxReceipt
 
 Revoke a role from an address.
 
+```python
+from thirdweb.constants.role import Role
+
+address = "{{wallet_address}}" # Address to revoke a role from
+role = Role.MINTER # The role to revoke
+
+receipt = contract.roles.revoke(role, address)
+```
+
 **Arguments**:
 
 - `role`: role to revoke

docs/docs/contract-royalty.md

@@ -20,6 +20,11 @@ def get_default_royalty_info() -> ContractRoyaltySchema
 
 Get the default royalty information for this contract.
 
+```python
+royalty_info = contract.royalties.get_default_royalty_info()
+print(royalty_info)
+```
+
 **Returns**:
 
 the default royalty information.
@@ -34,6 +39,13 @@ def get_token_royalty_info(token_id: int) -> ContractRoyaltySchema
 
 Get the royalty information for a specific token.
 
+```python
+token_id = 0
+
+royalty_info = contract.royalties.get_token_royalty_info(token_id)
+print(royalty_info)
+```
+
 **Arguments**:
 
 - `token_id`: the id of the token.
@@ -52,6 +64,17 @@ def set_default_royalty_info(royalty_data: ContractRoyaltySchema) -> TxReceipt
 
 Set the default royalty information for this contract.
 
+```python
+from thirdweb.types import ContractRoyaltySchema
+
+royalty_data = ContractRoyaltySchema(
+    seller_fee_basis_points=100,
+    fee_recipient="{{wallet_address}}"
+)
+
+receipt = contract.royalties.set_default_royalty_info()
+```
+
 **Arguments**:
 
 - `royalty_data`: the default royalty information.
@@ -71,6 +94,18 @@ def set_token_royalty_info(token_id: int,
 
 Set the royalty information for a specific token.
 
+```python
+from thirdweb.types import ContractRoyaltySchema
+
+token_id = 0
+royalty_data = ContractRoyaltySchema(
+    seller_fee_basis_points=100,
+    fee_recipient="{{wallet_address}}"
+)
+
+receipt = contract.royalties.set_token_royalty_info(token_id, royalty_data)
+```
+
 **Arguments**:
 
 - `token_id`: the id of the token.

docs/docs/contract-sales.md

@@ -20,6 +20,11 @@ def get_recipient() -> str
 
 Get the primary sale recipient of this contract.
 
+```python
+primary_sale_recipient = contract.sales.get_recipient()
+print(primary_sale_recipient)
+```
+
 **Returns**:
 
 the address of the primary sale recipient.
@@ -34,6 +39,12 @@ def set_recipient(recipient: str) -> TxReceipt
 
 Set the primary sale recipient of this contract
 
+```python
+primary_sale_recipient = "{{wallet_address}}"
+
+receipt = contract.sales.set_recipient(primary_sale_recipient)
+```
+
 **Arguments**:
 
 - `recipient`: the address of the primary sale recipient.

docs/docs/edition-drop.md

@@ -7,7 +7,7 @@
 ## EditionDrop Objects
 
 ```python
-class EditionDrop(ERC1155[DropERC1155])
+class EditionDrop(ERC1155Standard[DropERC1155])
 ```
 
 Setup a collection of NFTs with a customizable number of each NFT that are minted as users claim them.
@@ -80,10 +80,8 @@ List of tx results with ids for created NFTs.
 #### claim\_to
 
 ```python
-def claim_to(destination_address: str,
-             token_id: int,
-             quantity: int,
-             proofs: List[str] = [DEFAULT_MERKLE_ROOT]) -> TxReceipt
+def claim_to(destination_address: str, token_id: int,
+             quantity: int) -> TxReceipt
 ```
 
 Claim NFTs to a destination address.
@@ -115,9 +113,7 @@ tx receipt of the claim
 #### claim
 
 ```python
-def claim(token_id: int,
-          quantity: int,
-          proofs: List[str] = [DEFAULT_MERKLE_ROOT]) -> TxReceipt
+def claim(token_id: int, quantity: int) -> TxReceipt
 ```
 
 Claim NFTs.

docs/docs/edition.md

@@ -9,7 +9,7 @@ Interface for interacting with an edition contract
 ## Edition Objects
 
 ```python
-class Edition(ERC1155[TokenERC1155])
+class Edition(ERC1155Standard[TokenERC1155])
 ```
 
 Create a collection of NFTs that lets you mint multiple copies of each NFT.