SDK Reference
NFT Client
Used to mint a new SPG collection for use with Story.
NftClient
Methods
- createNFTCollection
- getMintFeeToken
- getMintFee
createNFTCollection
Creates a new SPG NFT Collection.
Method | Type |
---|---|
createNFTCollection | (request: CreateNFTCollectionRequest) => Promise<CreateNFTCollectionResponse> |
Parameters:
request.name
: The name of the collection.request.symbol
: The symbol of the collection.request.isPublicMinting
: If true, anyone can mint from the collection. If false, only the addresses with the minter role can mint.request.mintOpen
: Whether the collection is open for minting on creation.request.mintFeeRecipient
: The address to receive mint fees.request.contractURI
: The contract URI for the collection. Follows ERC-7572 standard. See here.request.baseURI
: [Optional] The base URI for the collection. If baseURI is not empty, tokenURI will be either baseURI + token ID (if nftMetadataURI is empty) or baseURI + nftMetadataURI.request.maxSupply
: [Optional] The maximum supply of the collection.request.mintFee
: [Optional] The cost to mint a token.request.mintFeeToken
: [Optional] The token to mint.request.owner
: [Optional] The owner of the collection.request.txOptions
: [Optional] The transaction options.
getMintFeeToken
Returns the current mint token of the collection.
Method | Type |
---|---|
getMintFeeToken | (spgNftContract: Address) => Promise<Address> |
Parameters:
spgNftContract
: The address of the NFT contract.
getMintFee
Returns the current mint fee of the collection.
Method | Type |
---|---|
getMintFee | (spgNftContract: Address) => Promise<bigint> |
Parameters:
spgNftContract
: The address of the NFT contract.