Class Arc19

Class representing an ARC-19 compliant NFT on Algorand. Extends CoreAsset with metadata handling for the ARC-19 standard.

Hierarchy (view full)

Constructors

constructor

Properties

assetParams id metadata network

Methods

get getAmountInBaseUnits getAmountInDecimals getClawback getCreator getDecimals getDefaultFrozen getFreeze getImageBase64 getImageUrl getIndex getManager getMetadata getMetadataHash getMetadataUrl getName getReserve getTotal getTotalSupply getUnitName getUrl getUrlProtocol hasClawback hasFreeze hasHttpUrl hasIpfsUrl hasManager hasReserve hasTemplateUrl calculateSHA256 codeToCodec create createReserveAddressFromIpfsCid fetchAssetParams fromAssetParams fromId getMetadataVersions hasValidUrl isArc19 resolveNormalUrl resolveUrl update

Constructors

Private constructor

  • new Arc19(id, params, network, metadata): Arc19

  • Creates an instance of Arc19.

    Parameters

    • id: number

      The asset ID

    • params: AssetParams

      The asset parameters from the Algorand blockchain

    • network: Network

      The Algorand network this asset exists on

    • metadata: any

      The metadata associated with the asset

    Returns Arc19

Properties

assetParams

assetParams: AssetParams

The asset parameters retrieved from the Algorand blockchain

id

id: number

The asset ID on the Algorand blockchain

metadata

metadata: any

The metadata associated with this ARC-19 asset

network

network: Network

The Algorand network to use

Methods

get

  • get(): AssetParams

  • Gets the asset parameters

    Returns AssetParams

    The asset parameters

getAmountInBaseUnits

  • getAmountInBaseUnits(amount): number

  • Converts an amount from decimal-adjusted units to base units

    Parameters

    • amount: number

      The amount in decimal-adjusted units

    Returns number

    The amount in base units

getAmountInDecimals

  • getAmountInDecimals(amount): number

  • Converts an amount from base units to decimal-adjusted units

    Parameters

    • amount: number

      The amount in base units

    Returns number

    The amount adjusted for decimals

getClawback

  • getClawback(): string

  • Gets the clawback address of the asset

    Returns string

    The clawback address or the zero address if not set

getCreator

getDecimals

getDefaultFrozen

getFreeze

  • getFreeze(): string

  • Gets the freeze address of the asset

    Returns string

    The freeze address or the zero address if not set

getImageBase64

  • getImageBase64(): Promise<string>

  • Gets the image as a base64 encoded string

    Returns Promise<string>

    A promise resolving to the base64 encoded image

    Throws

    Error if no image is available or fetch fails

getImageUrl

  • getImageUrl(): string

  • Gets the image URL for this ARC-19 asset

    Returns string

    The resolved image URL

getIndex

getManager

  • getManager(): string

  • Gets the manager address of the asset

    Returns string

    The manager address or the zero address if not set

getMetadata

  • getMetadata(): any

  • Gets the metadata associated with this ARC-19 asset

    Returns any

    The metadata object

getMetadataHash

getMetadataUrl

  • getMetadataUrl(): string

  • Gets the metadata URL for this ARC-19 asset using the reserve address

    Returns string

    The resolved metadata URL

getName

getReserve

  • getReserve(): string

  • Gets the reserve address of the asset

    Returns string

    The reserve address or the zero address if not set

getTotal

getTotalSupply

getUnitName

getUrl

getUrlProtocol

hasClawback

  • hasClawback(): boolean

  • Checks if the asset has a clawback address

    Returns boolean

    True if the asset has a clawback address

hasFreeze

  • hasFreeze(): boolean

  • Checks if the asset has a freeze address

    Returns boolean

    True if the asset has a freeze address

hasHttpUrl

  • hasHttpUrl(): boolean

  • Checks if the asset URL uses HTTP or HTTPS protocol

    Returns boolean

    True if the URL uses HTTP or HTTPS

hasIpfsUrl

hasManager

  • hasManager(): boolean

  • Checks if the asset has a manager address

    Returns boolean

    True if the asset has a manager address

hasReserve

  • hasReserve(): boolean

  • Checks if the asset has a reserve address

    Returns boolean

    True if the asset has a reserve address

hasTemplateUrl

Static Private calculateSHA256

  • calculateSHA256(blobContent): Promise<string>
  • Private

    Calculates SHA256 hash of blob content

    Parameters

    • blobContent: undefined | Blob

      The blob content to hash

    Returns Promise<string>

    Promise resolving to hex-encoded hash string

    Throws

    Error if no blob content provided

Static Private codeToCodec

  • codeToCodec(code): "raw" | "dag-pb" | "dag-cbor"
  • Private

    Converts numeric codec code to string representation

    Parameters

    • code: number

      The numeric codec code

    Returns "raw" | "dag-pb" | "dag-cbor"

    The string representation of the codec

Static create

  • create(options): Promise<{
        assetId: number;
        transactionId: string;
    }>

  • Creates a new ARC-19 compliant NFT on the Algorand blockchain

    Parameters

    • options: {
          clawback?: string;
          creator: {
              address: string;
              signer: TransactionSigner;
          };
          decimals?: number;
          defaultFrozen?: boolean;
          freeze?: string;
          image: {
              file: string | File;
              name: string;
          };
          ipfs: IPFS;
          manager?: string;
          name: string;
          network: Network;
          properties: any;
          total?: number;
          unitName: string;
      }

      The configuration options for creating the ARC-19 NFT

      • Optional clawback?: string

        The clawback address

      • creator: {
            address: string;
            signer: TransactionSigner;
        }

        The creator of the asset, including address and signer

        • address: string
        • signer: TransactionSigner
      • Optional decimals?: number

        The decimals for the asset

      • Optional defaultFrozen?: boolean

        Whether the asset should be frozen by default

      • Optional freeze?: string

        The freeze address

      • image: {
            file: string | File;
            name: string;
        }

        The path to the image file

        • file: string | File
        • name: string
      • ipfs: IPFS

        The IPFS instance to use for uploading

      • Optional manager?: string

        The manager address

      • name: string

        The name of the asset

      • network: Network

        The Algorand network to use

      • properties: any

        Additional properties to include in the metadata

      • Optional total?: number

        The total number of assets

      • unitName: string

        The unit name for the asset

    Returns Promise<{
        assetId: number;
        transactionId: string;
    }>

    A promise resolving to an object containing the transaction ID and asset ID

    Throws

    Error if creation fails

Static Private createReserveAddressFromIpfsCid

  • createReserveAddressFromIpfsCid(ipfsCid): {
        assetURL: string;
        reserveAddress: string;
    }
  • Private

    Creates a reserve address from an IPFS CID for ARC-19 template resolution

    Parameters

    • ipfsCid: string

      The IPFS CID to convert

    Returns {
        assetURL: string;
        reserveAddress: string;
    }

    The Algorand address derived from the CID

    • assetURL: string
    • reserveAddress: string

Static fetchAssetParams

  • fetchAssetParams(id, network): Promise<AssetParams>

  • Fetches asset parameters from the Algorand blockchain

    Parameters

    • id: number

      The asset ID to fetch

    • network: Network

      The Algorand network to use

    Returns Promise<AssetParams>

    A promise resolving to the asset parameters

Static fromAssetParams

  • fromAssetParams(id, assetParams, network): Promise<Arc19>

  • Creates an Arc19 instance from existing asset parameters

    Parameters

    • id: number

      The asset ID

    • assetParams: AssetParams

      The asset parameters from the blockchain

    • network: Network

      The Algorand network to use

    Returns Promise<Arc19>

    A promise resolving to an Arc19 instance

Static fromId

  • fromId(id, network): Promise<Arc19>

  • Creates an Arc19 instance from an existing asset ID

    Parameters

    • id: number

      The asset ID to load

    • network: Network

      The Algorand network to use

    Returns Promise<Arc19>

    A promise resolving to an Arc19 instance

    Throws

    Error if the asset cannot be loaded

Static getMetadataVersions

  • getMetadataVersions(assetId, network): Promise<Record<string, any>[]>

  • Gets all metadata versions for an ARC-19 asset by examining transaction history

    Parameters

    • assetId: number

      The asset ID to get metadata versions for

    • network: Network

      The Algorand network to search on

    Returns Promise<Record<string, any>[]>

    Promise resolving to array of metadata versions with timestamps

    Throws

    Error if unable to fetch transaction history

Static hasValidUrl

  • hasValidUrl(url): boolean

  • Validates if a URL conforms to ARC-19 template-ipfs format

    Parameters

    • url: string

      The URL to validate

    Returns boolean

    True if the URL is valid ARC-19 template format

Static isArc19

  • isArc19(url): boolean

  • Checks if an asset is ARC-19 compliant based on its URL

    Parameters

    • url: string

      The asset URL to check

    Returns boolean

    True if the asset follows ARC-19 standards

Static Private resolveNormalUrl

  • resolveNormalUrl(url): string
  • Private

    Resolves standard URLs (HTTP/HTTPS and IPFS)

    Parameters

    • url: string

      The URL to resolve

    Returns string

    The resolved URL with proper protocol

Static resolveUrl

  • resolveUrl(url, reserveAddr): string

  • Resolves template-ipfs URLs to standard IPFS URLs using reserve address Handles the ARC-19 template format: template-ipfs://{ipfscid:1:raw:reserve:sha2-256}

    Parameters

    • url: string

      The template-ipfs URL to resolve

    • reserveAddr: string

      The reserve address to use for CID generation

    Returns string

    The resolved IPFS URL or empty string if invalid

Static update

  • update(options): Promise<{
        confirmedRound: undefined | bigint;
        transactionId: string;
    }>

  • Updates an existing ARC-19 NFT's metadata

    Parameters

    • options: {
          assetId: number;
          image?: {
              file: string | File;
              name: string;
          };
          ipfs: IPFS;
          manager: {
              address: string;
              signer: TransactionSigner;
          };
          network: Network;
          properties?: any;
      }

      The configuration options for updating the ARC-19 NFT

      • assetId: number

        The asset ID of the NFT to update

      • Optional image?: {
            file: string | File;
            name: string;
        }

        The new image to upload and set

        • file: string | File
        • name: string
      • ipfs: IPFS

        IPFS instance for uploading content

      • manager: {
            address: string;
            signer: TransactionSigner;
        }

        The manager account with address and transaction signer

        • address: string
        • signer: TransactionSigner
      • network: Network

        The Algorand network the NFT exists on

      • Optional properties?: any

        The new properties to set in the metadata

    Returns Promise<{
        confirmedRound: undefined | bigint;
        transactionId: string;
    }>

    A promise resolving to the transaction confirmation

    Throws

    Error if update fails or manager doesn't have permission

Settings

Member Visibility

Theme

On This Page

constructorassetParamsidmetadatanetworkgetgetAmountInBaseUnitsgetAmountInDecimalsgetClawbackgetCreatorgetDecimalsgetDefaultFrozengetFreezegetImageBase64getImageUrlgetIndexgetManagergetMetadatagetMetadataHashgetMetadataUrlgetNamegetReservegetTotalgetTotalSupplygetUnitNamegetUrlgetUrlProtocolhasClawbackhasFreezehasHttpUrlhasIpfsUrlhasManagerhasReservehasTemplateUrlcalculateSHA256codeToCodeccreatecreateReserveAddressFromIpfsCidfetchAssetParamsfromAssetParamsfromIdgetMetadataVersionshasValidUrlisArc19resolveNormalUrlresolveUrlupdate