Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FullMinter

This encapsulates all the parts necessary for creating a Video NFT in a single environment.

remarks

You might prefer not to use this in a production application, unless:

  • You are running a proxy to the Livepeer API that simply injects an API key to the requests from your frontend. See the Split backend and browser example in the SDK readme for more information.
  • You are OK exposing an API key in the Api component in your frontend. Doing that means that anyone can grab the key from your web page and call any Livepeer API on your behalf, so use with caution.
  • You are doing the whole flow from your backend, including the Web3 minting part. This means that you will be calling the Ethereum-compatible blockchain and paying for the transactions yourself. The users will likely have less control of what is being done as well.
  • Something else that we haven't considered! Do not limit yourself by this documentation, but do consider the security and ownership implications of any such setup.

Hierarchy

  • FullMinter

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

api

api: Api

uploader

uploader: Uploader

web3

web3: Web3

Methods

createNft

  • createNft(args: { file?: string | File | ReadableStream; mint?: { contractAddress?: string; to?: string }; name: string; nftMetadata?: string | Record<string, any>; skipNormalize?: boolean }): Promise<MintedNftInfo>

  • Demonstrates the entire NFT minting process. Check the source code of this function to have a better idea of the whole process.

    remarks

    The filename parameter must be provided in a node.js environment, and cannot be provided in a browser environment.

    Parameters

    • args: { file?: string | File | ReadableStream; mint?: { contractAddress?: string; to?: string }; name: string; nftMetadata?: string | Record<string, any>; skipNormalize?: boolean }

      Aggregated arguments for all the functions that are called along the process.

      • Optional file?: string | File | ReadableStream
      • Optional mint?: { contractAddress?: string; to?: string }
        • Optional contractAddress?: string
        • Optional to?: string
      • name: string
      • Optional nftMetadata?: string | Record<string, any>
      • Optional skipNormalize?: boolean

    Returns Promise<MintedNftInfo>

    Information about the minted NFT.

Generated using TypeDoc