MinaNFTNameServiceContract

MinaNFTNameServiceContract is a smart contract that implements the Mina NFT Name Service standard.

Hierarchy

• TokenContract
  • MinaNFTNameServiceContract

Index

Constructors

• constructor

Properties

• events
• oracle

Methods

• approveBase
• approveEscrow
• deploy
• escrowTransfer
• init
• isNFT
• mint
• setOracle
• update
• upgrade

Constructors

externalconstructor

• new MinaNFTNameServiceContract(address: PublicKey, tokenId?: Field): MinaNFTNameServiceContract

• Inherited from TokenContract.constructor

  Parameters

  • externaladdress: PublicKey

  • externaloptionaltokenId: Field

  Returns MinaNFTNameServiceContract

Properties

events

events: { approveEscrow: typeof EscrowApproval; escrowTransfer: typeof EscrowTransfer; mint: typeof NFTMintData; update: typeof Update; upgrade: typeof PublicKey } = ...

Overrides TokenContract.events

Type declaration

• approveEscrow: typeof EscrowApproval

• escrowTransfer: typeof EscrowTransfer

• mint: typeof NFTMintData

• update: typeof Update

• upgrade: typeof PublicKey

oracle

oracle: State<PublicKey> = ...

The oracle of the contract - the public key used to sign name allowances

Methods

approveBase

• approveBase(forest: AccountUpdateForest): Promise<void>

• Overrides TokenContract.approveBase

  Parameters

  • forest: AccountUpdateForest

  Returns Promise<void>

approveEscrow

• approveEscrow(address: PublicKey, proof: EscrowTransferProof): Promise<void>

• Approve setting of the new escrow

  ---

  Parameters

  • address: PublicKey

    address of the NFT

  • proof: EscrowTransferProof

    EscrowTransferProof - escrow proof

  Returns Promise<void>

deploy

• deploy(args: DeployArgs): Promise<void>

• Overrides TokenContract.deploy

  Parameters

  • args: DeployArgs

  Returns Promise<void>

escrowTransfer

• escrowTransfer(address: PublicKey, data: EscrowTransfer, signature1: Signature, signature2: Signature, signature3: Signature, escrow1: PublicKey, escrow2: PublicKey, escrow3: PublicKey): Promise<void>

• Transfer the NFT to new owner

  ---

  Parameters

  • address: PublicKey

    address of the NFT

  • data: EscrowTransfer

    EscrowTransfer - data for the transfer

  • signature1: Signature

    signature of the first escrow

  • signature2: Signature

    signature of the second escrow

  • signature3: Signature

    signature of the third escrow

  • escrow1: PublicKey

    public key of the first escrow

  • escrow2: PublicKey

    public key of the second escrow

  • escrow3: PublicKey

    public key of the third escrow

  Returns Promise<void>

init

• init(): void

• Overrides TokenContract.init

  Returns void

isNFT

• isNFT(address: PublicKey): void

• Parameters

  • address: PublicKey

  Returns void

mint

• mint(data: MintData): Promise<void>

• Mints the NFT

  ---

  Parameters

  • data: MintData

    the MintData of the NFT

  Returns Promise<void>

setOracle

• setOracle(newOracle: PublicKey, signature: Signature): Promise<void>

• Parameters

  • newOracle: PublicKey

  • signature: Signature

  Returns Promise<void>

update

• update(address: PublicKey, update: Update, signature: Signature, owner: PublicKey, proof: MinaNFTMetadataUpdateProof): Promise<void>

• Updates metadata of the NFT

  ---

  Parameters

  • address: PublicKey

    address of the NFT

  • update: Update

    Update - data for the update

  • signature: Signature

    signature of the owner

  • owner: PublicKey

    owner's public key

  • proof: MinaNFTMetadataUpdateProof

    MinaNFTMetadataUpdateProof - proof of the update of the metadata to be correctly inserted into the Merkle Map

  Returns Promise<void>

upgrade

• upgrade(address: PublicKey, vk: VerificationKey, signature: Signature): Promise<void>

• Upgrade the NFT to the new version

  ---

  Parameters

  • address: PublicKey

    the address of the NFT

  • vk: VerificationKey

    the verification key of the new MinaNFTContract

  • signature: Signature

    the signature of the name service allowing the upgrading of the NFT

  Returns Promise<void>