Skip to content

ip-nft.md

Latest commit

 

History

History
148 lines (99 loc) · 3.8 KB

ip-nft.md

File metadata and controls

148 lines (99 loc) · 3.8 KB
Raw
icon transformer-bolt

IP-NFT

IP-NFT Contract Documentation

Overview

The IP-NFT contract is an ERC-721 NFT that represents on-chain intellectual property ownership. Each IP-NFT is a unique token that enables trading, fractionalization into IPTokens, and use as collateral for funding. They form the foundation of the Molecule Protocol, linking legal IP rights with on-chain ownership.

Contract Details

  • Contract: IPNFT v2.5.1
  • Standard: ERC-721 (with URI Storage)
  • Type: UUPS Upgradeable Proxy
  • Solidity: 0.8.18
  • License: MIT

Deployments

How It Works

IP-NFT Lifecycle

  1. RESERVE: reserve()
  2. MINT: mintReservation()
  3. USE:
    • Transfer/Trade
    • Tokenize (IPT)
    • Grant Access
    • Sell via Swap

Minting Paths

  • Reserve + Mint: Call reserve(), then mintReservation().
  • POI Mint (Direct): Use mintReservation() with Proof of Idea hash.

Functions

Write Functions

reserve

Reserves a new token ID.

function reserve() external whenNotPaused returns (uint256 reservationId)

mintReservation

Mints an IP-NFT using a reserved ID or POI hash.

{% code overflow="wrap" %}

function mintReservation(address to, uint256 reservationId, string calldata _tokenURI, string calldata _symbol, bytes calldata authorization) external payable whenNotPaused returns (uint256)

{% endcode %}

grantReadAccess

Grants time-limited read access to encrypted files.

function grantReadAccess(address reader, uint256 tokenId, uint256 until) external

amendMetadata

Updates the metadata URI of an IP-NFT.

{% code overflow="wrap" %}

function amendMetadata(uint256 tokenId, string calldata _newTokenURI, bytes calldata authorization) external

{% endcode %}

Read Functions

canRead

Checks if an address has read access.

function canRead(address reader, uint256 tokenId) external view returns (bool)

symbol

Returns the symbol of an IP-NFT.

function symbol(uint256 tokenId) external view returns (string memory)

tokenURI

Returns the metadata URI.

function tokenURI(uint256 tokenId) public view returns (string memory)

Events

  • Reserved: New token ID reserved
  • IPNFTMinted: IP-NFT minted
  • ReadAccessGranted: Read access granted

Errors

  • NotOwningReservation(uint256 id): Caller doesn't own the reservation.
  • Unauthorized(): Caller not authorized.
  • InsufficientBalance(): Caller doesn't own the IP-NFT.
  • BadDuration(): Expiration in the past.
  • MintingFeeTooLow(): Less than 0.001 ETH sent.
  • ToZeroAddress(): Cannot transfer to zero address.

Security Considerations

  • Symbolic Fee: 0.001 ETH minting fee.
  • Authorization: Required for all mints.
  • Read Access Expiration: Time-limited.
  • Pausable: Contract operations can be paused.
  • UUPS Upgradeable: Owner-upgradable implementation.

Constants

  • SYMBOLIC_MINT_FEE: 0.001 ETH
  • MAX_RESERVATION_ID: 2^128 - 1

Related Contracts

  • Tokenizer.md: Fractionalize IP-NFTs into IPTokens.
  • SchmackoSwap.md: Trade IP-NFTs.
  • Access-Resolver.md: File access integration.
  • Crowdsale.md: Fundraise via IPTokens.

Resources