Class Arc3

Class representing an ARC-3 compliant NFT on Algorand. Extends CoreAsset with metadata handling for the ARC-3 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 create fetchAssetParams fetchMetadata fromAssetParams fromId hasValidName hasValidUrl isArc3 makeAssetCreateTransaction resolveUrl

Constructors

Private constructor

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

  • Creates an instance of Arc3.

    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 Arc3

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-3 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 associated with the asset

    Returns string

    The resolved image URL or empty string if no image

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 the asset

    Returns any

    The metadata object

getMetadataHash

getMetadataUrl

  • getMetadataUrl(): string

  • Gets the metadata URL for this ARC-3 asset

    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 create

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

  • Creates a new ARC-3 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;
      }

      The configuration options for creating the ARC-3 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 reserve?: string

        The reserve address

      • 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 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(url): Promise<any>

  • Fetches metadata from a given URL

    Parameters

    • url: string

      The URL to fetch metadata from

    Returns Promise<any>

    A promise resolving to the metadata object

    Throws

    Error if metadata cannot be fetched or parsed

Static fromAssetParams

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

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

    A promise resolving to an Arc3 instance

Static fromId

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

  • Creates an Arc3 instance from an existing asset ID

    Parameters

    • id: number

      The asset ID to load

    • network: Network

      The Algorand network to use

    Returns Promise<Arc3>

    A promise resolving to an Arc3 instance

    Throws

    Error if the asset cannot be loaded

Static hasValidName

  • hasValidName(name): boolean

  • Checks if the asset has a valid ARC-3 name

    Parameters

    • name: string

      The asset name to validate

    Returns boolean

    True if the asset name is ARC-3 compliant

Static hasValidUrl

  • hasValidUrl(url, id): boolean

  • Checks if the asset has a valid ARC-3 URL

    Parameters

    • url: string

      The asset URL to validate

    • id: number

      The asset ID for URL resolution

    Returns boolean

    True if the asset URL is ARC-3 compliant

Static isArc3

  • isArc3(name, url, id): boolean

  • Checks if the asset is ARC-3 compliant

    Parameters

    • name: string

      The asset name to check

    • url: string

      The asset URL to check

    • id: number

      The asset ID for URL resolution

    Returns boolean

    True if the asset is ARC-3 compliant

Static makeAssetCreateTransaction

  • makeAssetCreateTransaction(options): Promise<Transaction>

  • Creates a new ARC-3 compliant NFT Transaction 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;
      }

      The configuration options for creating the ARC-3 NFT Transaction

      • 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 reserve?: string

        The reserve address

      • Optional total?: number

        The total number of assets

      • unitName: string

        The unit name for the asset

    Returns Promise<Transaction>

    A promise resolving to an algosdk.Transaction object

    Throws

    Error if transaction creation fails

Static resolveUrl

  • resolveUrl(url, id): string

  • Resolves URLs, handling IPFS protocol and ID replacements

    Parameters

    • url: string

      The URL to resolve (may contain {id} placeholder)

    • id: number

      The asset ID to replace in the URL if needed

    Returns string

    The resolved URL with proper protocol

Settings

Member Visibility

Theme

On This Page

constructorassetParamsidmetadatanetworkgetgetAmountInBaseUnitsgetAmountInDecimalsgetClawbackgetCreatorgetDecimalsgetDefaultFrozengetFreezegetImageBase64getImageUrlgetIndexgetManagergetMetadatagetMetadataHashgetMetadataUrlgetNamegetReservegetTotalgetTotalSupplygetUnitNamegetUrlgetUrlProtocolhasClawbackhasFreezehasHttpUrlhasIpfsUrlhasManagerhasReservehasTemplateUrlcalculateSHA256createfetchAssetParamsfetchMetadatafromAssetParamsfromIdhasValidNamehasValidUrlisArc3makeAssetCreateTransactionresolveUrl