Class Arc69

Class representing an ARC-69 compliant NFT on Algorand. ARC-69 NFTs store metadata in transaction notes rather than external URLs. Extends CoreAsset with metadata handling for the ARC-69 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 getName getReserve getTotal getTotalSupply getUnitName getUrl getUrlProtocol hasClawback hasFreeze hasHttpUrl hasIpfsUrl hasManager hasReserve hasTemplateUrl calculateSHA256 create fetchAssetParams fetchMetadata fromAssetParams fromId getMetadataVersions hasValidMetadata hasValidUrl isArc69 resolveNormalUrl resolveUrl update

Constructors

Private constructor

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

  • Creates an instance of Arc69.

    Parameters

    • id: number

      The asset ID on the Algorand blockchain

    • 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 (from transaction notes)

    Returns Arc69

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-69 asset, stored in transaction notes

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

getImageUrl

  • getImageUrl(): string

  • Gets the resolved image URL for this ARC-69 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-69 asset

    Returns any

    The metadata object

getMetadataHash

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 the SHA256 hash of a file's content

    Parameters

    • blobContent: undefined | Blob

      The file content as a Blob

    Returns Promise<string>

    A promise resolving to the hex-encoded hash

Static create

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

  • Creates a new ARC-69 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;
          reserve?: string;
          total?: number;
          unitName: string;
      }

      Configuration options for creating the ARC-69 NFT

      • Optional clawback?: string

        The clawback address for the asset

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

        The creator account with address and transaction signer

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

        The number of decimal places for the asset

      • Optional defaultFrozen?: boolean

        Whether the asset should be frozen by default

      • Optional freeze?: string

        The freeze address for the asset

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

        Image file and metadata

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

        IPFS instance for uploading the image

      • Optional manager?: string

        The manager address for the asset

      • name: string

        The name of the NFT

      • network: Network

        The Algorand network to create the NFT on

      • properties: any

        Additional properties for the NFT metadata

      • Optional reserve?: string

        The reserve address for the asset

      • Optional total?: number

        The total number of units to create

      • unitName: string

        The unit name for the NFT

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

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

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 Private fetchMetadata

  • fetchMetadata(assetId, network): Promise<any>

  • Fetches ARC-69 metadata from transaction notes for a given asset

    Parameters

    • assetId: number

      The asset ID to fetch metadata for

    • network: Network

      The Algorand network to search on

    Returns Promise<any>

    A promise resolving to the metadata object, or undefined if not found

Static fromAssetParams

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

  • Creates an Arc69 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<Arc69>

    A promise resolving to an Arc69 instance

Static fromId

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

  • Creates an Arc69 instance from an existing asset ID

    Parameters

    • id: number

      The asset ID to load

    • network: Network

      The Algorand network to use

    Returns Promise<Arc69>

    A promise resolving to an Arc69 instance

Static getMetadataVersions

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

  • Retrieves all historical versions of metadata for an ARC-69 asset

    Parameters

    • assetId: number

      The asset ID to get metadata versions for

    • network: Network

      The Algorand network to search on

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

    A promise resolving to an array of metadata objects

Static hasValidMetadata

  • hasValidMetadata(assetId, network): Promise<boolean>

  • Checks if an asset has valid ARC-69 metadata in its transaction notes

    Parameters

    • assetId: number

      The asset ID to check

    • network: Network

      The Algorand network to search on

    Returns Promise<boolean>

    True if the asset has valid ARC-69 metadata

Static hasValidUrl

  • hasValidUrl(url): boolean

  • Validates if a URL conforms to ARC-69 standards

    Parameters

    • url: string

      The URL to validate

    Returns boolean

    True if the URL is valid for ARC-69

Static isArc69

  • isArc69(url, id, network): Promise<boolean>

  • Determines if an asset is ARC-69 compliant

    Parameters

    • url: string

      The asset URL to check

    • id: number

      The asset ID

    • network: Network

      The Algorand network to check on

    Returns Promise<boolean>

    True if the asset is ARC-69 compliant

Static Private resolveNormalUrl

  • resolveNormalUrl(url): string

  • Resolves standard URLs, handling HTTP/HTTPS and IPFS protocols

    Parameters

    • url: string

      The URL to resolve

    Returns string

    The resolved URL with proper protocol

Static resolveUrl

  • resolveUrl(url): string

  • Public method to resolve URLs for ARC-69 assets

    Parameters

    • url: string

      The URL to resolve

    Returns string

    The resolved URL

Static update

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

  • Updates the metadata properties of an existing ARC-69 NFT

    Parameters

    • options: {
          assetId: number;
          manager: {
              address: string;
              signer: TransactionSigner;
          };
          network: Network;
          properties: any;
      }

      Configuration options for updating the NFT metadata

      • assetId: number

        The asset ID of the NFT to update

      • 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

      • properties: any

        The new properties to set in the metadata

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

    A promise resolving to an object containing the transaction ID and confirmed round

Settings

Member Visibility

Theme

On This Page

constructorassetParamsidmetadatanetworkgetgetAmountInBaseUnitsgetAmountInDecimalsgetClawbackgetCreatorgetDecimalsgetDefaultFrozengetFreezegetImageBase64getImageUrlgetIndexgetManagergetMetadatagetMetadataHashgetNamegetReservegetTotalgetTotalSupplygetUnitNamegetUrlgetUrlProtocolhasClawbackhasFreezehasHttpUrlhasIpfsUrlhasManagerhasReservehasTemplateUrlcalculateSHA256createfetchAssetParamsfetchMetadatafromAssetParamsfromIdgetMetadataVersionshasValidMetadatahasValidUrlisArc69resolveNormalUrlresolveUrlupdate