NFT Client

# Create a new SPG NFT collection
#
# NOTE: Use this code to create a new SPG NFT collection. You can then use the
# `new_collection["nft_contract"]` address as the `nft_contract` argument in
# functions like `mint_and_register_ip_asset_with_pil_terms` in the DATA Foundation SDK.
#
# You will mostly only have to do this once. Once you get your nft contract address,
# you can use it in SPG functions.
#
new_collection = story_client.NFTClient.create_nft_collection(
  name="Test NFT",
  symbol="TEST",
  is_public_minting=True,
  mint_open=True,
  mint_fee_recipient="0x0000000000000000000000000000000000000000",  # Zero address
  contract_uri=""
)

print(f"New SPG NFT collection created at transaction hash {new_collection['tx_hash']}")
print(f"NFT contract address: {new_collection['nft_contract']}")

name: str  # The name of the collection
symbol: str  # The symbol of the collection
is_public_minting: bool  # If true, anyone can mint from the collection
mint_open: bool  # Whether the collection is open for minting on creation
mint_fee_recipient: str  # The address to receive mint fees
contract_uri: str  # The contract URI for the collection
base_uri: str = ""  # Optional: The base URI for the collection
max_supply: int = None  # Optional: The maximum supply of the collection
mint_fee: int = None  # Optional: The cost to mint a token
mint_fee_token: str = None  # Optional: The token to mint
owner: str = None  # Optional: The owner of the collection
tx_options: dict = None  # Optional: Transaction options dictionary

{
  "tx_hash": str,  # The transaction hash
  "nft_contract": str  # The address of the newly created contract
}

mint_fee_token = story_client.NFTClient.get_mint_fee_token("0x01")

nft_contract: str  # The address of the NFT contract

str  # The address of the mint fee token

mint_fee = story_client.NFTClient.get_mint_fee("0x01")

nft_contract: str  # The address of the NFT contract

int  # The mint fee amount.