Function createCapsule

  • Name

    createCapsule

    Summary

    Convert an existing basic NFT into a Capsule NFT.

    Parameters

    • offchainData: string

      Off-chain data related to the NFT metadata. Can be an IPFS Hash, an URL or plain text.

    • capsuleOffchainData: string

      Off-chain data related to the Capsule metadata. Can be an IPFS hash, a URL or plain text.

    • royalty: number = 0

      Percentage of all second sales that the creator will receive. It's a decimal number in range [0, 100]. Default is 0.

    • collectionId: undefined | number = undefined

      The collection to which the NFT belongs. Optional Parameter.

    • isSoulbound: boolean = false

      If true, makes the Capsule intransferable. Default is false.

    • keyring: IKeyringPair

      Account that will sign the transaction.

    • waitUntil: WaitUntil

      Execution trigger that can be set either to BlockInclusion or BlockFinalization.

    Returns Promise<CapsuleNFTData<NftData>>

    Capsule NFT data combining the data from NFTCreatedEvent and NFTConvertedToCapsuleEvent.

Settings

Member Visibility

Theme

Generated using TypeDoc