Skip to main content

contracts.nft_collection

Interface for interacting with an nft collection contract

NFTCollection Objects​

class NFTCollection(ERC721[TokenERC721])

Create a collection of one-of-one NFTs.

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_nft_collection("{{contract_address}}")

get_owned​

def get_owned(address: str = "") -> List[NFTMetadataOwner]

Get the metadata of all tokens owned by a specific address

nfts = contract.get_owned("{{wallet_address}}")
print(nfts)

Arguments:

  • address: the address to get the metadata for

Returns:

the metadata of all tokens owned by the address

get_owned_token_ids​

def get_owned_token_ids(address: str = "") -> List[int]

Get the token IDs owned by a specific address

Arguments:

  • address: the address to get the token IDs for

Returns:

the token IDs owned by the address

mint​

def mint(
    metadata: Union[NFTMetadataInput,
                    str]) -> TxResultWithId[NFTMetadataOwner]

Mint a new NFT to the connected wallet

Arguments:

  • metadata: metadata of the NFT to mint

Returns:

receipt, id, and metadata for the mint

mint_to​

def mint_to(
    to: str, metadata: Union[NFTMetadataInput,
                             str]) -> TxResultWithId[NFTMetadataOwner]

Mint a new NFT to the specified wallet

from thirdweb.types.nft import NFTMetadataInput

# Note that you can customize this metadata however you like
metadata = NFTMetadataInput.from_json({
    "name": "Cool NFT",
    "description": "This is a cool NFT",
    "image": open("path/to/file.jpg", "rb"),
})

# You can pass in any address here to mint the NFT to
tx = contract.mint_to("{{wallet_address}}", metadata)
receipt = tx.receipt
token_id = tx.id
nft = tx.data()

Arguments:

  • to: wallet address to mint the NFT to
  • metadata: metadata of the NFT to mint

Returns:

receipt, id, and metadata for the mint

mint_batch​

def mint_batch(
    metadatas: List[Union[NFTMetadataInput, str]]
) -> List[TxResultWithId[NFTMetadataOwner]]

Mint a batch of new NFTs to the connected wallet

Arguments:

  • metadatas: list of metadata of the NFTs to mint

Returns:

receipts, ids, and metadatas for each mint

mint_batch_to​

def mint_batch_to(
    to: str, metadatas: List[Union[NFTMetadataInput, str]]
) -> List[TxResultWithId[NFTMetadataOwner]]

Mint a batch of new NFTs to the specified wallet

from thirdweb.types.nft import NFTMetadataInput

# You can customize this metadata however you like
metadatas = [
    NFTMetadataInput.from_json({
        "name": "Cool NFT",
        "description": "This is a cool NFT",
        "image": open("path/to/file.jpg", "rb"),
    }),
    NFTMetadataInput.from_json({
        "name": "Cooler NFT",
        "description": "This is a cooler NFT",
        "image": open("path/to/file.jpg", "rb"),
    }),
]

# You can pass in any address here to mint the NFT to
txs = contract.mint_batch_to("{{wallet_address}}", metadatas)
receipt = txs[0].receipt
first_token_id = txs[0].id
first_nft = txs[0].data()

Arguments:

  • to: wallet address to mint the NFTs to
  • metadatas: list of metadata of the NFTs to mint

Returns:

receipts, ids, and metadatas for each mint