Function createAuction

  • Name

    createAuction

    Summary

    Creates an auction for an NFT.

    Parameters

    • nftId: number

      The ID of the NFT.

    • marketplaceId: number

      The ID of the marketplace where the auction will take place.

    • startBlock: number

      The ID of the block at which the auction starts.

    • endBlock: number

      The ID of the block at which the auction ends.

    • startPrice: number | BN

      The price at which the auction starts.

    • buyItPrice: undefined | number | BN = undefined

      The price to directly buy the NFT before the auction starts. Optional Parameter.

    • keyring: IKeyringPair

      Account that will sign the transaction.

    • waitUntil: WaitUntil

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

    Returns Promise<AuctionCreatedEvent>

    AuctionCreatedEvent Blockchain event.

Generated using TypeDoc