RollupNFT

RollupNFT are the NFT used in the Rollup TODO: change parameters

Hierarchy

• BaseMinaNFT
  • RollupNFT

Index

Constructors

• constructor

Properties

• address
• external_url
• isSomeMetadata
• metadata
• metadataRoot
• name
• storage
• badgeVerificationKey
• badgeVerifierVerificationKey
• cache
• escrowVerificationKey
• namesVerificationKey
• redactedMapVerificationKey
• transferVerificationKey
• updateVerificationKey
• updaterVerificationKey
• verificationKey
• verifierVerificationKey

Methods

• getMetadata
• getMetadataRootAndMap
• getURL
• loadMetadata
• prepareCommitData
• toJSON
• update
• updateField
• updateFile
• updateFileData
• updateImage
• updateMap
• updateMetadata
• updateText
• compile
• compileBadge
• compileEscrow
• compileRedactedMap
• compileVerifier
• generateProof
• mapFromJSON
• setCache
• setCacheFolder
• stringFromField
• stringFromFields
• stringToField
• stringToFields
• urlFromStorage
• urlFromStorageString

Constructors

constructor

• new RollupNFT(params?: { address?: string | PublicKey; external_url?: string; name?: string; root?: Metadata; storage?: Storage }): RollupNFT

• Overrides BaseMinaNFT.constructor

  Create MinaNFT object

  ---

  Parameters

  • params: { address?: string | PublicKey; external_url?: string; name?: string; root?: Metadata; storage?: Storage } = {}

    arguments

  Returns RollupNFT

Properties

optionaladdress

address?: PublicKey

Public key of the NFT

optionalexternal_url

external_url?: string

External URL of the NFT

isSomeMetadata

isSomeMetadata: boolean = false

Boolean if there is some metadata

metadata

metadata: Map<string, PrivateMetadata>

Inherited from BaseMinaNFT.metadata

metadataRoot

metadataRoot: Metadata

Root of the Merkle Map of the metadata

optionalname

name?: string

Name of the NFT

storage

storage: undefined | Storage

Storage of the NFT - IPFS (i:...) or Arweave (a:...) hash string

staticbadgeVerificationKey

badgeVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.badgeVerificationKey

staticbadgeVerifierVerificationKey

badgeVerifierVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.badgeVerifierVerificationKey

staticcache

cache: undefined | Cache

Inherited from BaseMinaNFT.cache

staticescrowVerificationKey

escrowVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.escrowVerificationKey

staticnamesVerificationKey

namesVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.namesVerificationKey

staticredactedMapVerificationKey

redactedMapVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.redactedMapVerificationKey

statictransferVerificationKey

transferVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.transferVerificationKey

staticupdateVerificationKey

updateVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.updateVerificationKey

staticupdaterVerificationKey

updaterVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.updaterVerificationKey

staticverificationKey

verificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.verificationKey

staticverifierVerificationKey

verifierVerificationKey: undefined | VerificationKey

Inherited from BaseMinaNFT.verifierVerificationKey

Methods

publicgetMetadata

• getMetadata(key: string): undefined | PrivateMetadata

• Inherited from BaseMinaNFT.getMetadata

  Gets public attribute

  ---

  Parameters

  • key: string

    key of the attribute

  Returns undefined | PrivateMetadata

  value of the attribute

publicgetMetadataRootAndMap

• getMetadataRootAndMap(): { map: MetadataMap; root: Metadata }

• Inherited from BaseMinaNFT.getMetadataRootAndMap

  Calculates a root and MerkleMap of the publicAttributes

  ---

  Returns { map: MetadataMap; root: Metadata }

  Root and MerkleMap of the publicAttributes

  • map: MetadataMap

  • root: Metadata

publicgetURL

• getURL(): undefined | string

• Returns undefined | string

publicloadMetadata

• loadMetadata(metadataURI?: undefined | string, skipCalculatingMetadataRoot?: boolean): Promise<void>

• Load metadata from blockchain and IPFS/Arweave

  ---

  Parameters

  • metadataURI: undefined | string = undefined

    URI of the metadata. Obligatorily in case there is private metadata as private metadata cannot be fetched from IPFS/Arweave

  • skipCalculatingMetadataRoot: boolean = false

    Skip calculating metadata root in case metadataURI is not provided and NFT contains private data

  Returns Promise<void>

publicprepareCommitData

• prepareCommitData(commitData: RollupNFTCommit): Promise<undefined | RollupNFTCommitData>

• Prepare commit updates of the MinaNFT to blockchain

  ---

  Parameters

  • commitData: RollupNFTCommit

    MinaNFTPrepareCommit commit data

  Returns Promise<undefined | RollupNFTCommitData>

publictoJSON

• toJSON(params?: { includePrivateData?: boolean }): object

• Converts to JSON

  ---

  Parameters

  • params: { includePrivateData?: boolean } = {}

  Returns object

  JSON object

publicupdate

• update(data: MinaNFTStringUpdate): void

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTStringUpdate

    MinaNFTStringUpdate update data

  Returns void

publicupdateField

• updateField(data: MinaNFTFieldUpdate): void

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTFieldUpdate

    MinaNFTFieldUpdate update data

  Returns void

publicupdateFile

• updateFile(data: MinaNFTFileUpdate): Promise<void>

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTFileUpdate

    MinaNFTFileUpdate update data

  Returns Promise<void>

publicupdateFileData

• updateFileData(params: { data: FileData; isPrivate?: boolean; key: string; type?: string }): void

• updates PrivateMetadata

  ---

  Parameters

  • params: { data: FileData; isPrivate?: boolean; key: string; type?: string }

    arguments

  Returns void

publicupdateImage

• updateImage(data: MinaNFTImageUpdate): Promise<void>

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTImageUpdate

    MinaNFTImageUpdate update data

  Returns Promise<void>

publicupdateMap

• updateMap(data: MinaNFTMapUpdate): void

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTMapUpdate

    MinaNFTTextUpdate update data

  Returns void

publicupdateMetadata

• updateMetadata(key: string, value: PrivateMetadata): void

• updates Metadata

  ---

  Parameters

  • key: string

    key to update

  • value: PrivateMetadata

    value to update

  Returns void

publicupdateText

• updateText(data: MinaNFTTextUpdate): void

• updates PrivateMetadata

  ---

  Parameters

  • data: MinaNFTTextUpdate

    MinaNFTTextUpdate update data

  Returns void

publicstaticcompile

• compile(): Promise<VerificationKey>

• Overrides BaseMinaNFT.compile

  Compiles RollupNFT MetadataUpdate contract

  ---

  Returns Promise<VerificationKey>

  verification key

publicstaticcompileBadge

• compileBadge(): Promise<VerificationKey>

• Inherited from BaseMinaNFT.compileBadge

  Compiles MinaNFTVerifierBadge contract

  ---

  Returns Promise<VerificationKey>

  verification key

publicstaticcompileEscrow

• compileEscrow(): Promise<VerificationKey>

• Inherited from BaseMinaNFT.compileEscrow

  Compiles Escrow contract

  ---

  Returns Promise<VerificationKey>

  verification key

publicstaticcompileRedactedMap

• compileRedactedMap(): Promise<VerificationKey>

• Inherited from BaseMinaNFT.compileRedactedMap

  Compiles RedactedMinaNFTMapCalculation contract

  ---

  Returns Promise<VerificationKey>

  verification key

publicstaticcompileVerifier

• compileVerifier(): Promise<VerificationKey>

• Inherited from BaseMinaNFT.compileVerifier

  Compiles MinaNFTVerifier contract

  ---

  Returns Promise<VerificationKey>

  verification key

publicstaticgenerateProof

• generateProof(preparedCommitData: RollupNFTCommitData, verbose?: boolean): Promise<MinaNFTMetadataUpdateProof>

• Commit updates of the MinaNFT to blockchain using prepared data Generates recursive proofs for all updates, than verify the proof locally and send the transaction to the blockchain

  ---

  Parameters

  • preparedCommitData: RollupNFTCommitData

    RollupNFTCommitData commit data

  • verbose: boolean = false

    verbose mode

  Returns Promise<MinaNFTMetadataUpdateProof>

  proof MinaNFTMetadataUpdateProof

publicstaticmapFromJSON

• mapFromJSON(json: object): Map<string, string>

• Creates a Map from JSON

  ---

  Parameters

  • json: object

    json with map data

  Returns Map<string, string>

  map as JSON object

publicstaticsetCache

• setCache(cache: Cache): void

• Inherited from BaseMinaNFT.setCache

  Sets a cache for prover keys

  ---

  Parameters

  • cache: Cache

  Returns void

publicstaticsetCacheFolder

• setCacheFolder(folder?: string): void

• Inherited from BaseMinaNFT.setCacheFolder

  Sets a cache folder for prover keys

  ---

  Parameters

  • folder: string = "./cache"

    folder for prover keys default is "./cache"

  Returns void

publicstaticstringFromField

• stringFromField(field: Field): string

• Inherited from BaseMinaNFT.stringFromField

  Converts a Field to a string

  ---

  Parameters

  • field: Field

    Field to convert

  Returns string

  string

publicstaticstringFromFields

• stringFromFields(fields: Field[]): string

• Inherited from BaseMinaNFT.stringFromFields

  Converts a Field[] to a string

  ---

  Parameters

  • fields: Field[]

    Fields to convert

  Returns string

  string

publicstaticstringToField

• stringToField(item: string): Field

• Inherited from BaseMinaNFT.stringToField

  Converts a string to a Field

  ---

  Parameters

  • item: string

    string to convert

  Returns Field

  string as a Field

publicstaticstringToFields

• stringToFields(item: string): Field[]

• Inherited from BaseMinaNFT.stringToFields

  Converts a string to a Fields

  ---

  Parameters

  • item: string

    string to convert

  Returns Field[]

  string as a Field[]

publicstaticurlFromStorage

• urlFromStorage(storage: Storage): string

• Inherited from BaseMinaNFT.urlFromStorage

  Converts a Storage to a storage url string

  ---

  Parameters

  • storage: Storage

    Storage to convert

  Returns string

  string

publicstaticurlFromStorageString

• urlFromStorageString(storageStr: string): string

• Inherited from BaseMinaNFT.urlFromStorageString

  Converts a string "i:..." or "a:..." to a storage url string

  ---

  Parameters

  • storageStr: string

    string to convert

  Returns string

  string