Class TernoaIPFS

Implements

Hierarchy

  • TernoaIPFS

Constructors

constructor

Properties

apiKey? apiUrl

Methods

getFile storeCollection storeFile storeMarketplace storeNFT get storeCollection storeFile storeMarketplace storeNFT upload

Constructors

constructor

Properties

Optional apiKey

apiKey?: string

apiUrl

apiUrl: URL

Methods

getFile

  • Parameters

    • hash: string

    Returns Promise<unknown>

storeCollection

  • Type Parameters

    • T

    Parameters

    • profileFile: File
    • bannerFile: File
    • metadata: CollectionMetadataType<T>

    Returns Promise<IpfsAddDataResponseType>

storeFile

storeMarketplace

  • Type Parameters

    • T

    Parameters

    • file: File
    • metadata: MarketplaceMetadataType<T>

    Returns Promise<IpfsAddDataResponseType>

storeNFT

  • Type Parameters

    • T

    Parameters

    • file: File
    • metadata: NftMetadataType<T>

    Returns Promise<IpfsAddDataResponseType>

Static get

  • Get file from IPFS.

    Returns

    IPFS file

    Parameters

    • ternoaIpfsService: IServiceIPFS
    • hash: string

    Returns Promise<unknown>

Static storeCollection

  • Store a single Ternoa Collection's metadata & assets on IPFS.

    Returns

    IPFS data (Hash, Size, Name)

    Type Parameters

    • T

    Parameters

    • service: IServiceIPFS
    • profileFile: File

      Collection's profile asset

    • bannerFile: File

      Collection's banner asset

    • metadata: CollectionMetadataType<T>

      Ternoa Collection metadata structure here.

    Returns Promise<IpfsAddDataResponseType>

Static storeFile

  • Store a single file on IPFS.

    Returns

    IPFS data (hash, size, name)

    Parameters

    • service: IServiceIPFS
    • file: File

    Returns Promise<IpfsAddDataResponseType>

Static storeMarketplace

  • Store a single Ternoa Marketplace's metadata & asset on IPFS.

    Returns

    IPFS data (Hash, Size, Name)

    Type Parameters

    • T

    Parameters

    • service: IServiceIPFS
    • file: File

      Marketplace's logo asset

    • metadata: MarketplaceMetadataType<T>

      Ternoa Marketplace metadata structure here.

    Returns Promise<IpfsAddDataResponseType>

Static storeNFT

  • Store a Ternoa basic NFT's metadata & asset on IPFS.

    Returns

    IPFS data (Hash, Size, Name)

    Type Parameters

    • T

    Parameters

    • service: IServiceIPFS
    • file: File

      NFT's asset

    • metadata: NftMetadataType<T>

      Ternoa basic NFT metadata structure here.

    Returns Promise<IpfsAddDataResponseType>

Static upload

  • Upload file form data to IPFS.

    Returns

    IPFS data (hash, size, name)

    Parameters

    Returns Promise<IpfsAddDataResponseType>

Settings

Member Visibility

Theme

Generated using TypeDoc