wip

Author: ciaranightingale

thirdweb/contracts/maps.py

@@ -11,6 +11,7 @@
     Marketplace,
     NFTDrop,
     EditionDrop,
+    TokenDrop,
     Multiwrap,
 )
 
@@ -22,6 +23,7 @@
     Marketplace.contract_type: Marketplace,  # type: ignore
     NFTDrop.contract_type: NFTDrop,  # type: ignore
     EditionDrop.contract_type: EditionDrop,  # type: ignore
+    TokenDrop.contract_type: TokenDrop,  # type: ignore
     Multiwrap.contract_type: Multiwrap,  # type: ignore
 }
 
@@ -32,6 +34,7 @@
     Marketplace.contract_type: "Marketplace",
     NFTDrop.contract_type: "DropERC721",
     EditionDrop.contract_type: "DropERC1155",
+    TokenDrop.contract_type: "DropERC20",
     Multiwrap.contract_type: "Multiwrap",
 }
 
@@ -42,5 +45,6 @@
     "Marketplace": Marketplace.contract_type,
     "DropERC721": NFTDrop.contract_type,
     "DropERC1155": EditionDrop.contract_type,
+    "DropERC20": TokenDrop.contract_type,
     "Multiwrap": Multiwrap.contract_type,
 }

thirdweb/contracts/token_drop.py

@@ -0,0 +1,80 @@
+from typing import Any, Final, List, Optional
+from thirdweb.abi import DropERC20
+from thirdweb.abi.drop_erc20 import IDropAllowlistProof
+from thirdweb.constants.role import Role
+from thirdweb.core.classes.contract_events import ContractEvents
+from thirdweb.core.classes.contract_metadata import ContractMetadata
+from thirdweb.core.classes.contract_platform_fee import ContractPlatformFee
+from thirdweb.core.classes.contract_roles import ContractRoles
+from thirdweb.core.classes.contract_sales import ContractPrimarySale
+from thirdweb.core.classes.contract_wrapper import ContractWrapper
+from thirdweb.core.classes.drop_claim_conditions import DropClaimConditions
+from thirdweb.core.classes.erc_20_standard import ERC20Standard
+from thirdweb.core.classes.ipfs_storage import IpfsStorage
+from thirdweb.types.contract import ContractType
+from thirdweb.types.currency import CurrencyValue, Price, TokenAmount
+from thirdweb.types.sdk import SDKOptions
+from thirdweb.types.settings.metadata import TokenDropContractMetadata
+from eth_account.account import LocalAccount
+from web3 import Web3
+
+from thirdweb.types.tx import TxResultWithId
+
+
+class TokenDrop(ERC20Standard[DropERC20]):
+    """
+    Setup Tokens that are minted as users claim them.
+
+    ```python
+    from thirdweb import ThirdwebSDK
+
+    # You can customize this to a supported network or your own RPC URL
+    network = "mumbai"
+
+    # Now we can create a new instance of the SDK
+    sdk = ThirdwebSDK(network)
+
+    # If you want to send transactions, you can instantiate the SDK with a private key instead:
+    #   sdk = ThirdwebSDK.from_private_key(PRIVATE_KEY, network)
+
+    contract = sdk.get_token_drop("{{contract_address}}")
+    ```
+    """
+
+    _abi_type = DropERC20
+
+    contract_type: Final[ContractType] = ContractType.TOKEN_DROP
+    contract_roles: Final[List[Role]] = [Role.ADMIN, Role.MINTER, Role.TRANSFER]
+
+    metadata: ContractMetadata[DropERC20, TokenDropContractMetadata]
+    roles: ContractRoles
+    primary_sale: ContractPrimarySale[DropERC20]
+    platform_fee: ContractPlatformFee[DropERC20]
+    claim_conditions: DropClaimConditions
+    events: ContractEvents[DropERC20]
+
+    def __init__(
+        self,
+        provider: Web3,
+        address: str,
+        storage: IpfsStorage,
+        signer: Optional[LocalAccount] = None,
+        options: SDKOptions = SDKOptions(),
+    ):
+        abi = DropERC20(provider, address)
+        contract_wrapper = ContractWrapper(abi, provider, signer, options)
+        super().__init__(contract_wrapper, storage)
+
+        self.metadata = ContractMetadata(
+            contract_wrapper, storage, TokenDropContractMetadata
+        )
+        self.roles = ContractRoles(contract_wrapper, self.contract_roles)
+        self.primary_sale = ContractPrimarySale(contract_wrapper)
+        self.platform_fee = ContractPlatformFee(contract_wrapper)
+        self.claim_conditions = DropClaimConditions(
+            self._contract_wrapper, self.metadata, self._storage
+        )
+        self.events = ContractEvents(contract_wrapper)
+
+    def call(self, fn: str, *args) -> Any:
+        return self._contract_wrapper.call(fn, *args)

thirdweb/core/classes/contract_deployer.py

@@ -18,6 +18,7 @@
     MarketplaceContractMetadata,
     NFTCollectionContractMetadata,
     TokenContractMetadata,
+    TokenDropContractMetadata,
 )
 
 
@@ -78,6 +79,13 @@ def deploy_edition_drop(self, metadata: EditionDropContractMetadata) -> str:
         """
 
         return self._deploy_contract(ContractType.EDITION_DROP, metadata.to_json())
+    
+    def deploy_token_drop(self, metadata: TokenDropContractMetadata) -> str:
+        """
+        Deploy a Token Drop contract
+        """
+
+        return self._deploy_contract(ContractType.TOKEN_DROP, metadata.to_json())
 
     def deploy_multiwrap(self, metadata: MultiwrapContractMetadata) -> str:
         """

thirdweb/types/contract.py

@@ -12,6 +12,7 @@
     IERC1155,
     DropERC721,
     DropERC1155,
+    DropERC20,
     Multiwrap,
 )
 from thirdweb.abi.i_mintable_erc20 import IMintableERC20
@@ -31,6 +32,7 @@
         TWFactory,
         DropERC721,
         DropERC1155,
+        DropERC20,
         Multiwrap,
         IMintableERC20
     ],
@@ -41,13 +43,13 @@
 
 TPrimarySaleABI = TypeVar(
     "TPrimarySaleABI",
-    bound=Union[TokenERC721, TokenERC1155, TokenERC20, DropERC721, DropERC1155],
+    bound=Union[TokenERC721, TokenERC1155, TokenERC20, DropERC721, DropERC1155, DropERC20],
 )
 
 TPlatformFeeABI = TypeVar(
     "TPlatformFeeABI",
     bound=Union[
-        TokenERC721, TokenERC1155, TokenERC20, Marketplace, DropERC721, DropERC1155
+        TokenERC721, TokenERC1155, TokenERC20, Marketplace, DropERC721, DropERC1155, DropERC20
     ],
 )
 
@@ -65,6 +67,7 @@
         Marketplace,
         DropERC721,
         DropERC1155,
+        DropERC20,
         Multiwrap,
     ],
 )
@@ -75,6 +78,7 @@ class ContractType(Enum):
     NFT_COLLECTION = "nft-collection"
     EDITION = "edition"
     TOKEN = "token"
+    TOKEN_DROP = "token-drop"
     MARKETPLACE = "marketplace"
     NFT_DROP = "nft-drop"
     EDITION_DROP = "edition-drop"

thirdweb/types/settings/metadata.py

@@ -95,6 +95,19 @@ class TokenContractMetadata(
     @staticmethod
     def from_json(json: Dict[str, Any]) -> "TokenContractMetadata":
         return from_dict(TokenContractMetadata, json)
+    
+@dataclass
+class TokenDropContractMetadata(
+    ContractMetadataSchema,
+    ContractSymbolSchema,
+    ContractPrimarySaleSchema,
+    ContractTrustedForwarderSchema,
+    ContractPlatformFeeSchema,
+    MerkleSchema,
+):
+    @staticmethod
+    def from_json(json: Dict[str, Any]) -> "TokenDropContractMetadata":
+        return from_dict(TokenDropContractMetadata, json)
 
 
 @dataclass