fx(hash)

Core Contracts

1. FxContractRegistry: Registry contract that manages all deployed smart contracts registered by fxhash

2. FxGenArt721: ERC-721 implementation contract that allows for minting of new tokens, burning of existing tokens and managing of token royalties

3. FxIssuerFactory: Factory contract that clones the FxGenArt721 implementation to create new Generative Art Projects

4. FxMintTicket721: ERC-721 implementation contract that allows for minting of new tickets, burning of exisiting tickets, and enforcing of harberger taxes over ticket ownership

5. FxRoleRegistry: Registry contract that implements AccessControl to manage different roles within the system, such as admin, creator, minter, and moderator

6. FxTicketFactory: Factory contract that clones the FxMintTicket721 implementation to create new Mint Tickets for an existing FxGenArt721 project

Periphery Contracts

1. DutchAuction: Minter contract that distributes new FxGenArt721 and FxMintTicket721 tokens at a linear price over a fixed interval of time

2. FixedPrice: Minter contract that distributes new FxGenArt721 and FxMintTicket721 tokens at a fixed price

3. IPFSRenderer: Renderer contract that constructs offchain metadata of FxGenArt721 and FxMintTicket721 tokens pinned to IPFS

4. PseudoRandomizer: Randomizer contract that provides a pseudo-randomness keccak256 hash using the token ID, sender's address, current block number, and hash of the previous block

5. ONCHFSRenderer: Renderer contract that constructs onchain metadata of FxGenArt721 and FxMintTicket721 tokens stored through ONCHFS

6. TicketRedeemer: Minter contract that burns an existing FxMintTicket721 token and mints a new FxGenArt721 token

Setup

1. Clone repository

git clone https://github.com/fxhash/fxhash-evm-contracts.git

2. Create .env file in root directory

DEPLOYER_PRIVATE_KEY=
ETHERSCAN_API_KEY=
GOERLI_RPC_URL=
MAINNET_RPC_URL=
SEPOLIA_RPC_URL=

3. Install dependencies

forge install

npm ci

4. Activate husky and commitlint

npx husky install
npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

5. Run tests

npm run test

6. Run prettier

npm run prettier

7. Deploy contracts

forge script script/Deploy.s.sol --rpc-url $GOERLI_RPC_URL --private-key $DEPLOYER_PRIVATE_KEY --verify --etherscan-api-key $ETHERSCAN_API_KEY --broadcast

8. View documentation locally

forge doc --serve --port 3000

Contents

• FxIssuerFactory
• FxTicketFactory

FxIssuerFactory

Git Source

Inherits: IFxIssuerFactory, Ownable, Pausable

Author: fx(hash)

See the documentation in {IFxIssuerFactory}

State Variables

roleRegistry

Returns the address of the FxRoleRegistry contract

address public immutable roleRegistry;

implementation

Returns address of current FxGenArt721 implementation contract

address public implementation;

projectId

Returns counter of latest project ID

uint96 public projectId;

nonces

Mapping of deployer address to nonce value for precomputing token address

mapping(address => uint256) public nonces;

projects

Mapping of project ID to address of FxGenArt721 token contract

mapping(uint96 => address) public projects;

Functions

constructor

Initializes factory owner, FxRoleRegistry and FxGenArt721 implementation

constructor(address _admin, address _roleRegistry, address _implementation);

createProjectWithTicket

Creates new generative art project with new mint ticket in single transaction

function createProjectWithTicket(
    bytes calldata _projectCreationInfo,
    bytes calldata _ticketCreationInfo,
    address _ticketFactory
) external whenNotPaused returns (address genArtToken, address mintTicket);

Parameters

Returns

unpause

Enables new FxGenArt721 tokens from being created

function unpause() external onlyOwner;

pause

Stops new FxGenArt721 tokens from being created

function pause() external onlyOwner;

setImplementation

Sets new FxGenArt721 implementation contract

function setImplementation(address _implementation) external onlyOwner;

Parameters

createProject

Creates new generative art project with single parameter

function createProject(bytes memory _creationInfo) public returns (address genArt721);

Parameters

Returns

createProjectWithParams

Creates new generative art project

function createProjectWithParams(
    address _owner,
    InitInfo memory _initInfo,
    ProjectInfo memory _projectInfo,
    MetadataInfo memory _metadataInfo,
    MintInfo[] memory _mintInfo,
    address[] memory _royaltyReceivers,
    uint32[] memory _allocations,
    uint96 _basisPoints
) public whenNotPaused returns (address genArtToken);

Parameters

Returns

getTokenAddress

Calculates the CREATE2 address of a new FxGenArt721 proxy

function getTokenAddress(address _sender) external view returns (address);

_setImplementation

Sets the FxGenArt721 implementation contract

function _setImplementation(address _implementation) internal;

FxTicketFactory

Git Source

Inherits: IFxTicketFactory, Ownable

Author: fx(hash)

See the documentation in {IFxTicketFactory}

State Variables

implementation

Returns address of current FxMintTicket721 implementation contract

address public implementation;

minGracePeriod

Returns the minimum duration of time before a ticket enters harberger taxation

uint48 public minGracePeriod;

ticketId

Returns counter of latest token ID

uint48 public ticketId;

nonces

Mapping of deployer address to nonce value for precomputing ticket address

mapping(address => uint256) public nonces;

tickets

Mapping of token ID to address of FxMintTicket721 token contract

mapping(uint48 => address) public tickets;

Functions

constructor

Initializes factory owner, FxMintTicket721 implementation and minimum grace period

constructor(address _admin, address _implementation, uint48 _gracePeriod);

createTicket

Creates new mint ticket

function createTicket(bytes calldata _creationInfo) external returns (address mintTicket);

Parameters

setImplementation

Sets new FxMintTicket721 implementation contract

function setImplementation(address _implementation) external onlyOwner;

Parameters

setMinGracePeriod

Sets the new minimum grace period

function setMinGracePeriod(uint48 _gracePeriod) external onlyOwner;

Parameters

createTicket

Creates new mint ticket

function createTicket(
    address _owner,
    address _genArt721,
    address _redeemer,
    address _renderer,
    uint48 _gracePeriod,
    MintInfo[] memory _mintInfo
) public returns (address mintTicket);

Parameters

getTicketAddress

Calculates the CREATE2 address of a new FxMintTicket721 proxy

function getTicketAddress(address _sender) external view returns (address);

_setImplementation

Sets the FxMintTicket721 implementation contract

function _setImplementation(address _implementation) internal;

_setMinGracePeriod

Sets the minimum grace period of time for when token enters harberger taxation

function _setMinGracePeriod(uint48 _gracePeriod) internal;

Contents

• IDutchAuction
• IERC5192
• IFixedPrice
• IFxContractRegistry
• IFxGenArt721
• IFxIssuerFactory
• IFxMintTicket721
• IFxRoleRegistry
• IFxTicketFactory
• IIPFSRenderer
• IMinter
• IONCHFSRenderer
• IPseudoRandomizer
• IRandomizer
• IRenderer
• IRoyaltyManager
• ISeedConsumer
• ISplitsMain
• ITicketRedeemer
• IToken

IDutchAuction

Git Source

Inherits: IMinter

Author: fx(hash)

Minter for distributing tokens at linear prices over fixed periods of time

Functions

auctions

Mapping of token address to reserve ID to reserve information

function auctions(address, uint256) external view returns (bool, uint248);

buy

Purchases tokens at a linear price over fixed amount of time

function buy(address _token, uint256 _reserveId, uint256 _amount, address _to) external payable;

Parameters

buyAllowlist

Purchases tokens through an allowlist at a linear price over fixed amount of time

function buyAllowlist(
    address _token,
    uint256 _reserveId,
    address _to,
    uint256[] calldata _indexes,
    bytes32[][] calldata _proofs
) external payable;

Parameters

buyMintPass

Purchases tokens through a mint pass at a linear price over fixed amount of time

function buyMintPass(
    address _token,
    uint256 _reserveId,
    uint256 _amount,
    address _to,
    uint256 _index,
    bytes calldata _signature
) external payable;

Parameters

getFirstValidReserve

Returns the earliest valid reserveId that can mint a token

function getFirstValidReserve(address _token) external view returns (uint256);

getLatestUpdate

Gets the latest timestamp update made to token reserves

function getLatestUpdate(address _token) external view returns (uint40);

Parameters

Returns

getPrice

Gets the current auction price

function getPrice(address _token, uint256 _reserveId) external view returns (uint256);

Parameters

Returns

merkleRoots

Mapping of token address to reserve ID to merkle root

function merkleRoots(address, uint256) external view returns (bytes32);

numberMinted

Mapping of token address to reserve ID to number of tokens minted

function numberMinted(address _token, uint256 _reserveId) external view returns (uint256);

pause

Pauses all function executions where modifier is applied

function pause() external;

refund

Refunds an auction buyer with their rebate amount

function refund(address _token, uint256 _reserveId, address _buyer) external;

Parameters

refunds

Mapping of token address to reserve ID to refund amount

function refunds(address, uint256) external view returns (uint256);

reserves

Mapping of token address to reserve ID to reserve information (allocation, price, max mint)

function reserves(address _token, uint256 _reserveId) external view returns (uint64, uint64, uint128);

saleProceeds

Mapping of token address to reserve ID to amount of sale proceeds

function saleProceeds(address _token, uint256 _reserveId) external view returns (uint256);

setMintDetails

Sets the mint details for token reserves

Mint Details: struct of auction information, merkle root, and signer address

function setMintDetails(ReserveInfo calldata _reserveInfo, bytes calldata _mintDetails) external;

Parameters

unpause

Unpauses all function executions where modifier is applied

function unpause() external;

withdraw

Withdraws sale processed of primary sales to receiver

function withdraw(address _token, uint256 _reserveId) external;

Parameters

Events

MintDetailsSet

Event emitted when the mint details for a Dutch auction are set

event MintDetailsSet(
    address indexed _token,
    uint256 indexed _reserveId,
    ReserveInfo _reserveInfo,
    bytes32 _merkleRoot,
    address _mintPassSigner,
    AuctionInfo _auctionInfo
);

Parameters

Purchase

Event emitted when a purchase is made during the auction

event Purchase(
    address indexed _token,
    uint256 indexed _reserveId,
    address indexed _buyer,
    address _to,
    uint256 _amount,
    uint256 _price
);

Parameters

RefundClaimed

Event emitted when a refund is claimed by a buyer

event RefundClaimed(address indexed _token, uint256 indexed _reserveId, address indexed _buyer, uint256 _refundAmount);

Parameters

Withdrawn

Event emitted when the sale proceeds are withdrawn

event Withdrawn(address indexed _token, uint256 indexed _reserveId, address indexed _creator, uint256 _proceeds);

Parameters

Errors

AddressZero

Error thrown when receiver is zero address

error AddressZero();

InsufficientFunds

Error thrown when no funds available to withdraw

error InsufficientFunds();

InsufficientPrice

Error thrown when the price is insufficient

error InsufficientPrice();

InvalidAllocation

Error thrown when the allocation amount is zero

error InvalidAllocation();

InvalidAmount

Error thrown when the purchase amount is zero

error InvalidAmount();

InvalidPayment

Error thrown when payment does not equal price

error InvalidPayment();

InvalidPrice

Error thrown when the price is zero

error InvalidPrice();

InvalidPriceCurve

Error thrown when the passing a price curve with less than 2 points

error InvalidPriceCurve();

InvalidReserve

Error thrown when a reserve does not exist

error InvalidReserve();

InvalidStep

Error thrown when the step length is not equally divisible by the auction duration

error InvalidStep();

InvalidToken

Error thrown when the token is address zero

error InvalidToken();

NoAllowlist

Error thrown when buying through allowlist and no allowlist exists

error NoAllowlist();

NoPublicMint

Error thrown when calling buy when either an allowlist or signer exists

error NoPublicMint();

NoRefund

Error thrown when there is no refund available

error NoRefund();

NoSigningAuthority

Error thrown when buy with a mint pass and no signing authority exists

error NoSigningAuthority();

NotEnded

Error thrown if auction has not ended

error NotEnded();

NonRefundableDA

Error thrown if auction is not a refundable dutch auction

error NonRefundableDA();

NotStarted

Error thrown when the auction has not started

error NotStarted();

OnlyAuthorityOrAllowlist

Error thrown when setting both an allowlist and mint signer

error OnlyAuthorityOrAllowlist();

PricesOutOfOrder

Error thrown when the prices are out of order

error PricesOutOfOrder();

IERC5192

Git Source

Minimal Soulbound NFTs

Functions

locked

Returns the locking status of an Soulbound Token

SBTs assigned to zero address are considered invalid, and queries about them do throw

function locked(uint256 tokenId) external view returns (bool);

Parameters

Events

Locked

Emitted when the locking status is changed to locked

If a token is minted and the status is locked, this event should be emitted

event Locked(uint256 tokenId);

Parameters

Unlocked

Emitted when the locking status is changed to unlocked

If a token is minted and the status is unlocked, this event should be emitted

event Unlocked(uint256 tokenId);

Parameters

IFixedPrice

Git Source

Inherits: IMinter

Author: fx(hash)

Minter for distributing tokens at fixed prices

Functions

buy

Purchases tokens at a fixed price

function buy(address _token, uint256 _reserveId, uint256 _amount, address _to) external payable;

Parameters

buyAllowlist

Purchases tokens through an allowlist at a fixed price

function buyAllowlist(
    address _token,
    uint256 _reserveId,
    address _to,
    uint256[] calldata _indexes,
    bytes32[][] calldata _proofs
) external payable;

Parameters

buyMintPass

Purchases tokens through a mint pass at a fixed price

function buyMintPass(
    address _token,
    uint256 _reserveId,
    uint256 _amount,
    address _to,
    uint256 _index,
    bytes calldata _signature
) external payable;

Parameters

getFirstValidReserve

Returns the earliest valid reserveId that can mint a token

function getFirstValidReserve(address _token) external view returns (uint256);

getLatestUpdate

Gets the latest timestamp update made to token reserves

function getLatestUpdate(address _token) external view returns (uint40);

Parameters

Returns

getSaleProceed

Gets the proceed amount from a token sale

function getSaleProceed(address _token) external view returns (uint128);

Parameters

Returns

merkleRoots

Mapping of token address to reserve ID to merkle roots

function merkleRoots(address, uint256) external view returns (bytes32);

pause

Pauses all function executions where modifier is applied

function pause() external;

prices

Mapping of token address to reserve ID to prices

function prices(address, uint256) external view returns (uint256);

reserves

Mapping of token address to reserve ID to reserve information

function reserves(address, uint256) external view returns (uint64, uint64, uint128);

setMintDetails

Sets the mint details for token reserves

Mint Details: token price, merkle root, and signer address

function setMintDetails(ReserveInfo calldata _reserveInfo, bytes calldata _mintDetails) external;

Parameters

unpause

Unpauses all function executions where modifier is applied

function unpause() external;

withdraw

Withdraws the sale proceeds to the sale receiver

function withdraw(address _token) external;

Parameters

Events

MintDetailsSet

Event emitted when a new fixed price mint has been set

event MintDetailsSet(
    address indexed _token,
    uint256 indexed _reserveId,
    uint256 _price,
    ReserveInfo _reserveInfo,
    bytes32 _merkleRoot,
    address _mintPassSigner,
    bool _openEdition,
    bool _timeUnlimited
);

Parameters

Purchase

Event emitted when a purchase is made

event Purchase(
    address indexed _token,
    uint256 indexed _reserveId,
    address indexed _buyer,
    uint256 _amount,
    address _to,
    uint256 _price
);

Parameters

Withdrawn

Event emitted when sale proceeds are withdrawn

event Withdrawn(address indexed _token, address indexed _creator, uint256 _proceeds);

Parameters

Errors

AddressZero

Error thrown when receiver is zero address

error AddressZero();

Ended

Error thrown when the sale has already ended

error Ended();

InsufficientFunds

Error thrown when no funds available to withdraw

error InsufficientFunds();

InvalidAllocation

Error thrown when the allocation amount is zero

error InvalidAllocation();

InvalidPayment

Error thrown when payment does not equal price

error InvalidPayment();

InvalidReserve

Error thrown thrown when reserve does not exist

error InvalidReserve();

InvalidTimes

Error thrown when reserve start and end times are invalid

error InvalidTimes();

InvalidToken

Error thrown when token address is invalid

error InvalidToken();

NoAllowlist

Error thrown when buying through allowlist and no allowlist exists

error NoAllowlist();

NoPublicMint

Error thrown when calling buy when either an allowlist or signer exists

error NoPublicMint();

NoSigningAuthority

Error thrown when buy with a mint pass and no signing authority exists

error NoSigningAuthority();

NotStarted

Error thrown when the auction has not started

error NotStarted();

OnlyAuthorityOrAllowlist

Error thrown when setting both an allowlist and mint signer

error OnlyAuthorityOrAllowlist();

TooMany

Error thrown when amount purchased exceeds remaining allocation

error TooMany();

IFxContractRegistry

Git Source

Author: fx(hash)

Registry for managing fxhash smart contracts

Functions

configInfo

Returns the system config information

function configInfo() external view returns (address, uint32, uint32, uint32, uint64, string memory, string memory);

contracts

Mapping of hashed contract name to contract address

function contracts(bytes32) external view returns (address);

register

Registers deployed contract addresses based on hashed value of name

function register(string[] calldata _names, address[] calldata _contracts) external;

Parameters

setConfig

Sets the system config information

function setConfig(ConfigInfo calldata _configInfo) external;

Parameters

Events

ContractRegistered

Event emitted when contract gets registered

event ContractRegistered(string indexed _contractName, bytes32 indexed _hashedName, address indexed _contractAddr);

Parameters

ConfigUpdated

Event emitted when the config information is updated

event ConfigUpdated(address indexed _owner, ConfigInfo _configInfo);

Parameters

Errors

LengthMismatch

Error thrown when array lengths do not match

error LengthMismatch();

LengthZero

Error thrown when array length is zero

error LengthZero();

IFxGenArt721

Git Source

Inherits: ISeedConsumer, IToken

Author: fx(hash)

ERC-721 token for generative art projects created on fxhash

Functions

activeMinters

function activeMinters() external view returns (address[] memory);

burn

Burns token ID from the circulating supply

function burn(uint256 _tokenId) external;

Parameters

contractRegistry

Returns address of the FxContractRegistry contract

function contractRegistry() external view returns (address);

contractURI

Returns contract-level metadata for storefront marketplaces

function contractURI() external view returns (string memory);

fulfillSeedRequest

Fullfills the random seed request on the FxGenArt721 token contract

function fulfillSeedRequest(uint256 _tokenId, bytes32 _seed) external;

Parameters

genArtInfo

Mapping of token ID to GenArtInfo struct (minter, seed, fxParams)

function genArtInfo(uint256 _tokenId) external view returns (address, bytes32, bytes memory);

generateOnchainPointerHash

Generates typed data hash for setting project metadata onchain

function generateOnchainPointerHash(bytes calldata _data) external view returns (bytes32);

Parameters

Returns

generateRendererHash

Generates typed data hash for setting the primary receiver address

function generateRendererHash(address _renderer) external view returns (bytes32);

Parameters

Returns

initialize

Initializes new generative art project

function initialize(
    address _owner,
    InitInfo calldata _initInfo,
    ProjectInfo calldata _projectInfo,
    MetadataInfo calldata _metadataInfo,
    MintInfo[] calldata _mintInfo,
    address[] calldata _royaltyReceivers,
    uint32[] calldata _allocations,
    uint96 _basisPoints
) external;

Parameters

isMinter

Gets the authorization status for the given minter contract

function isMinter(address _minter) external view returns (bool);

Parameters

Returns

issuerInfo

Returns the issuer information of the project (primaryReceiver, ProjectInfo)

function issuerInfo() external view returns (address, ProjectInfo memory);

metadataInfo

Returns the metadata information of the project (baseURI, onchainPointer)

function metadataInfo() external view returns (bytes memory, address);

mint

Mints arbitrary number of tokens

Only callable by registered minter contracts

function mint(address _to, uint256 _amount, uint256 _payment) external;

Parameters

mintParams

Mints single fxParams token

Only callable by registered minter contracts

function mintParams(address _to, bytes calldata _fxParams) external;

Parameters

nonce

Current nonce for admin signatures

function nonce() external returns (uint96);

ownerMint

Mints single token with randomly generated seed

Only callable by contract owner

function ownerMint(address _to) external;

Parameters

ownerMintParams

Mints single fxParams token

Only callable by contract owner

function ownerMintParams(address _to, bytes calldata _fxParams) external;

Parameters

pause

Pauses all function executions where modifier is applied

function pause() external;

primaryReceiver

Returns address of primary receiver for token sales

function primaryReceiver() external view returns (address);

randomizer

Returns the address of the randomizer contract

function randomizer() external view returns (address);

reduceSupply

Reduces maximum supply of collection

function reduceSupply(uint120 _supply) external;

Parameters

registerMinters

Registers minter contracts with resereve info

function registerMinters(MintInfo[] memory _mintInfo) external;

Parameters

remainingSupply

Returns the remaining supply of tokens left to mint

function remainingSupply() external view returns (uint256);

renderer

Returns the address of the Renderer contract

function renderer() external view returns (address);

roleRegistry

Returns the address of the FxRoleRegistry contract

function roleRegistry() external view returns (address);

setBaseRoyalties

Sets the base royalties for all secondary token sales

function setBaseRoyalties(address[] calldata _receivers, uint32[] calldata _allocations, uint96 _basisPoints)
    external;

Parameters

setBaseURI

Sets the new URI of the token metadata

function setBaseURI(bytes calldata _uri) external;

Parameters

setBurnEnabled

Sets flag status of public burn to enabled or disabled

function setBurnEnabled(bool _flag) external;

Parameters

setMintEnabled

Sets flag status of public mint to enabled or disabled

function setMintEnabled(bool _flag) external;

Parameters

setOnchainPointer

Sets the onchain pointer for reconstructing project metadata onchain

function setOnchainPointer(bytes calldata _onchainData, bytes calldata _signature) external;

Parameters

setPrimaryReceivers

Sets the primary receiver address for primary sale proceeds

function setPrimaryReceivers(address[] calldata _receivers, uint32[] calldata _allocations) external;

Parameters

setRandomizer

Sets the new randomizer contract

function setRandomizer(address _randomizer) external;

Parameters

setRenderer

Sets the new renderer contract

function setRenderer(address _renderer, bytes calldata _signature) external;

Parameters

setTags

Emits an event for setting tag descriptions for the project

function setTags(uint256[] calldata _tagIds) external;

Parameters

totalSupply

Returns the current circulating supply of tokens

function totalSupply() external view returns (uint96);

unpause

Unpauses all function executions where modifier is applied

function unpause() external;

Events

BaseURIUpdated

Event emitted when the base URI is updated

event BaseURIUpdated(bytes _uri);

Parameters

BurnEnabled

Event emitted when public burn is enabled or disabled

event BurnEnabled(bool indexed _flag);

Parameters

MintEnabled

Event emitted when public mint is enabled or disabled

event MintEnabled(bool indexed _flag);

Parameters

ProjectDeleted

Event emitted when project is deleted only once supply is set to zero

event ProjectDeleted();

ProjectInitialized

Event emitted when new project is initialized

event ProjectInitialized(
    address indexed _primaryReceiver, ProjectInfo _projectInfo, MetadataInfo _metadataInfo, MintInfo[] _mintInfo
);

Parameters

PrimaryReceiverUpdated

Event emitted when the primary receiver address is updated

event PrimaryReceiverUpdated(address indexed _receiver, address[] _receivers, uint32[] _allocations);

Parameters

ProjectTags

Event emitted when project tags are set

event ProjectTags(uint256[] indexed _tagIds);

Parameters

RandomizerUpdated

Event emitted when Randomizer contract is updated

event RandomizerUpdated(address indexed _randomizer);

Parameters

RendererUpdated

Event emitted when Renderer contract is updated

event RendererUpdated(address indexed _renderer);

Parameters

OnchainPointerUpdated

Event emitted when onchain data of project is updated

event OnchainPointerUpdated(address _pointer);

Parameters

SupplyReduced

Event emitted when maximum supply is reduced

event SupplyReduced(uint120 indexed _prevSupply, uint120 indexed _newSupply);

Parameters

Errors

AllocationExceeded

Error thrown when total minter allocation exceeds maximum supply

error AllocationExceeded();

BurnInactive

Error thrown when burning is inactive

error BurnInactive();

FeeReceiverMissing

Error thrown when the fee receiver address is not included in the receiver allocations

error FeeReceiverMissing();

InsufficientSupply

Error thrown when remaining supply is zero

error InsufficientSupply();

InvalidAmount

Error thrown when max supply amount is invalid

error InvalidAmount();

InvalidInputSize

Error thrown when input size does not match actual byte size of params data

error InvalidInputSize();

InvalidStartTime

Error thrown when reserve start time is invalid

error InvalidStartTime();

InvalidEndTime

Error thrown when reserve end time is invalid

error InvalidEndTime();

InvalidFeeReceiver

Error thrown when the configured fee receiver is not valid

error InvalidFeeReceiver();

MintActive

Error thrown when minting is active

error MintActive();

MintInactive

Error thrown when minting is inactive

error MintInactive();

NotAuthorized

Error thrown when caller is not authorized to execute transaction

error NotAuthorized();

NotOwner

Error thrown when signer is not the owner

error NotOwner();

SupplyRemaining

Error thrown when supply is remaining

error SupplyRemaining();

UnauthorizedAccount

Error thrown when caller does not have the specified role

error UnauthorizedAccount();

UnauthorizedMinter

Error thrown when caller does not have minter role

error UnauthorizedMinter();

UnregisteredMinter

Error thrown when minter is not registered on token contract

error UnregisteredMinter();

IFxIssuerFactory

Git Source

Author: fx(hash)

Factory for managing newly deployed FxGenArt721 tokens

Functions

createProjectWithParams

Creates new generative art project

function createProjectWithParams(
    address _owner,
    InitInfo memory _initInfo,
    ProjectInfo memory _projectInfo,
    MetadataInfo memory _metadataInfo,
    MintInfo[] memory _mintInfo,
    address[] memory _royaltyReceivers,
    uint32[] memory _allocations,
    uint96 _basisPoints
) external returns (address);

Parameters

Returns

createProject

Creates new generative art project with single parameter

function createProject(bytes memory _creationInfo) external returns (address);

Parameters

Returns

createProjectWithTicket

Creates new generative art project with new mint ticket in single transaction

function createProjectWithTicket(
    bytes calldata _projectCreationInfo,
    bytes calldata _ticketCreationInfo,
    address _tickeFactory
) external returns (address, address);

Parameters

Returns

getTokenAddress

Calculates the CREATE2 address of a new FxGenArt721 proxy

function getTokenAddress(address _sender) external view returns (address);

implementation

Returns address of current FxGenArt721 implementation contract

function implementation() external view returns (address);

nonces

Mapping of deployer address to nonce value for precomputing token address

function nonces(address _deployer) external view returns (uint256);

pause

Stops new FxGenArt721 tokens from being created

function pause() external;

projectId

Returns counter of latest project ID

function projectId() external view returns (uint96);

projects

Mapping of project ID to address of FxGenArt721 token contract

function projects(uint96) external view returns (address);

roleRegistry

Returns the address of the FxRoleRegistry contract

function roleRegistry() external view returns (address);

setImplementation

Sets new FxGenArt721 implementation contract

function setImplementation(address _implementation) external;

Parameters

unpause

Enables new FxGenArt721 tokens from being created

function unpause() external;

Events

ImplementationUpdated

Event emitted when the FxGenArt721 implementation contract is updated

event ImplementationUpdated(address indexed _owner, address indexed _implementation);

Parameters

ProjectCreated

Event emitted when a new generative art project is created

event ProjectCreated(uint96 indexed _projectId, address indexed _genArtToken, address indexed _owner);

Parameters

Errors

InvalidOwner

Error thrown when owner is zero address

error InvalidOwner();

InvalidPrimaryReceiver

Error thrown when primary receiver is zero address

error InvalidPrimaryReceiver();

NotAuthorized

Error thrown when caller is not authorized to execute transaction

error NotAuthorized();

IFxMintTicket721

Git Source

Inherits: IToken

Author: fx(hash)

ERC-721 token for mint tickets used to redeem FxGenArt721 tokens

Functions

activeMinters

Returns the list of active minters

function activeMinters(uint256) external view returns (address);

balances

Mapping of wallet address to pending balance available for withdrawal

function balances(address) external view returns (uint256);

baseURI

Returns the decoded content identifier of the metadata pointer

function baseURI() external view returns (bytes memory);

burn

Burns token ID from the circulating supply

function burn(uint256 _tokenId) external;

Parameters

claim

Claims token at current price and sets new price of token with initial deposit amount

function claim(uint256 _tokenId, uint256 _maxPrice, uint80 _newPrice) external payable;

Parameters

contractRegistry

Returns the address of the FxContractRegistry contract

function contractRegistry() external view returns (address);

contractURI

Gets the contact-level metadata for the ticket

function contractURI() external view returns (string memory);

Returns

deposit

Deposits taxes for given token

function deposit(uint256 _tokenId) external payable;

Parameters

depositAndSetPrice

Deposits taxes for given token and set new price for same token

function depositAndSetPrice(uint256 _tokenId, uint80 _newPrice) external payable;

Parameters

initialize

Initializes new generative art project

function initialize(
    address _owner,
    address _genArt721,
    address _redeemer,
    address _renderer,
    uint48 _gracePeriod,
    MintInfo[] calldata _mintInfo
) external;

Parameters

isForeclosed

Checks if token is foreclosed

function isForeclosed(uint256 _tokenId) external view returns (bool);

Parameters

Returns

genArt721

Returns address of the FxGenArt721 token contract

function genArt721() external view returns (address);

getAuctionPrice

Gets the current auction price of the token

function getAuctionPrice(uint256 _currentPrice, uint256 _foreclosureTime) external view returns (uint256);

Parameters

getDailyTax

Gets the daily tax amount based on current price

function getDailyTax(uint256 _currentPrice) external pure returns (uint256);

Parameters

Returns

getDepositAmounts

Gets the deposit amount owed and remaining after change in price, claim or burn

function getDepositAmounts(uint256 _dailyTax, uint256 _depositAmount, uint256 _foreclosureTime)
    external
    view
    returns (uint256, uint256);

Parameters

Returns

getExcessTax

Gets the excess amount of taxes paid

function getExcessTax(uint256 _dailyTax, uint256 _depositAmount) external view returns (uint256);

Parameters

Returns

getNewForeclosure

Gets the new foreclosure timestamp

function getNewForeclosure(uint256 _dailyTax, uint256 _depositAmount, uint256 _foreclosureTime)
    external
    view
    returns (uint48);

Parameters

Returns

getTaxDuration

Gets the total duration of time covered

function getTaxDuration(uint256 _dailyTax, uint256 _depositAmount) external pure returns (uint256);

Parameters

Returns

gracePeriod

Returns default grace period of time for each token

function gracePeriod() external view returns (uint48);

mint

Mints arbitrary number of tokens

Only callable by registered minter contracts

function mint(address _to, uint256 _amount, uint256 _payment) external;

Parameters

minters

Returns the active status of a registered minter contract

function minters(address) external view returns (uint8);

pause

Pauses all function executions where modifier is set

function pause() external;

primaryReceiver

Returns address of primary receiver for token sales

function primaryReceiver() external view returns (address);

redeemer

Returns the address of the TickeRedeemer contract

function redeemer() external view returns (address);

renderer

Returns the address of the renderer contract

function renderer() external view returns (address);

registerMinters

Registers minter contracts with resereve info

function registerMinters(MintInfo[] memory _mintInfo) external;

roleRegistry

Returns the address of the FxRoleRegistry contract

function roleRegistry() external view returns (address);

setBaseURI

Sets the new URI of the token metadata

function setBaseURI(bytes calldata _uri) external;

Parameters

setPrice

Sets new price for given token

function setPrice(uint256 _tokenId, uint80 _newPrice) external;

Parameters

taxes

Mapping of ticket ID to tax information (grace period, foreclosure time, current price, deposit amount)

function taxes(uint256) external returns (uint48, uint48, uint80, uint80);

totalSupply

Returns the current circulating supply of tokens

function totalSupply() external returns (uint48);

unpause

Unpauses all function executions where modifier is set

function unpause() external;

updateStartTime

Updates taxation start time to the current timestamp

function updateStartTime(uint256 _tokenId) external;

Parameters

withdraw

Withdraws available balance amount to given address

function withdraw(address _to) external;

Parameters

Events

BaseURIUpdated

Event emitted when the base URI is updated

event BaseURIUpdated(bytes _uri);

Parameters

Claimed

Event emitted when token is claimed at either listing or auction price

event Claimed(
    uint256 indexed _tokenId,
    address indexed _claimer,
    uint128 _newPrice,
    uint48 _foreclosureTime,
    uint80 _depositAmount,
    uint256 _payment
);

Parameters

Deposited

Event emitted when additional taxes are deposited

event Deposited(uint256 indexed _tokenId, address indexed _depositer, uint48 _foreclosureTime, uint80 _depositAmount);

Parameters

SetPrice

Event emitted when new listing price is set

event SetPrice(uint256 indexed _tokenId, uint128 _newPrice, uint128 _foreclosureTime, uint128 _depositAmount);

Parameters

StartTimeUpdated

Event emitted when taxation start time is updated to current timestamp

event StartTimeUpdated(uint256 indexed _tokenId, address indexed _owner, uint128 _foreclosureTime);

Parameters

TicketInitialized

Event emitted when mint ticket is initialized

event TicketInitialized(
    address indexed _genArt721,
    address indexed _redeemer,
    address indexed _renderer,
    uint48 _gracePeriod,
    MintInfo[] _mintInfo
);

Parameters

Withdraw

Event emitted when balance is withdrawn

event Withdraw(address indexed _caller, address indexed _to, uint256 indexed _balance);

Parameters

Errors

AllocationExceeded

Error thrown when total minter allocation exceeds maximum supply

error AllocationExceeded();

Foreclosure

Error thrown when token is in foreclosure

error Foreclosure();

GracePeriodActive

Error thrown when token is being claimed within the grace period

error GracePeriodActive();

GracePeriodInactive

Error thrown when token is outside of the grace period

error GracePeriodInactive();

InsufficientDeposit

Error thrown when deposit amount is not for at least one day

error InsufficientDeposit();

InsufficientPayment

Error thrown when payment amount does not meet price plus daily tax amount

error InsufficientPayment();

InvalidEndTime

Error thrown when reserve end time is invalid

error InvalidEndTime();

InvalidPrice

Error thrown when new listing price is less than the mininmum amount

error InvalidPrice();

InvalidStartTime

Error thrown when reserve start time is invalid

error InvalidStartTime();

PriceExceeded

Error thrown when current price exceeds maximum payment amount

error PriceExceeded();

MintActive

Error thrown when minting is active

error MintActive();

NotAuthorized

Error thrown when caller is not authorized to execute transaction

error NotAuthorized();

UnauthorizedAccount

Error thrown when caller does not have the specified role

error UnauthorizedAccount();

UnauthorizedMinter

Error thrown when caller does not have minter role

error UnauthorizedMinter();

UnauthorizedRedeemer

Error thrown when caller does not have the redeemer role

error UnauthorizedRedeemer();

UnregisteredMinter

Error thrown when caller is not a registered minter

error UnregisteredMinter();

IFxRoleRegistry

Git Source

Author: fx(hash)

Registry for managing AccessControl roles throughout the system

Functions

setRoleAdmin

Sets the admin of a new or existing role

function setRoleAdmin(bytes32 _role) external;

Parameters

IFxTicketFactory

Git Source

Author: fx(hash)

Factory for managing newly deployed FxMintTicket721 tokens

Functions

createTicket

Creates new mint ticket

function createTicket(
    address _owner,
    address _genArt721,
    address _redeemer,
    address _renderer,
    uint48 _gracePeriod,
    MintInfo[] memory _mintInfo
) external returns (address);

Parameters

createTicket

Creates new mint ticket for new generative art project in single transaction

function createTicket(bytes calldata _creationInfo) external returns (address);

Parameters

Returns

getTicketAddress

Calculates the CREATE2 address of a new FxMintTicket721 proxy

function getTicketAddress(address _sender) external view returns (address);

implementation

Returns address of current FxMintTicket721 implementation contract

function implementation() external view returns (address);

minGracePeriod

Returns the minimum duration of time before a ticket enters harberger taxation

function minGracePeriod() external view returns (uint48);

nonces

Mapping of deployer address to nonce value for precomputing ticket address

function nonces(address _deployer) external view returns (uint256);

setMinGracePeriod

Sets the new minimum grace period

function setMinGracePeriod(uint48 _gracePeriod) external;

Parameters

setImplementation

Sets new FxMintTicket721 implementation contract

function setImplementation(address _implementation) external;

Parameters

ticketId

Returns counter of latest token ID

function ticketId() external view returns (uint48);

tickets

Mapping of token ID to address of FxMintTicket721 token contract

function tickets(uint48 _ticketId) external view returns (address);

Events

GracePeriodUpdated

Event emitted when the minimum grace period is updated

event GracePeriodUpdated(address indexed _owner, uint48 indexed _gracePeriod);

Parameters

ImplementationUpdated

Event emitted when the FxMintTicket721 implementation contract is updated

event ImplementationUpdated(address indexed _owner, address indexed _implementation);

Parameters

TicketCreated

Event emitted when new FxMintTicket721 is created

event TicketCreated(uint96 indexed _ticketId, address indexed _mintTicket, address indexed _owner);

Parameters

Errors

InvalidGracePeriod

Error thrown when grace period is less than minimum requirement of one day

error InvalidGracePeriod();

InvalidOwner

Error thrown when owner is zero address

error InvalidOwner();

InvalidRedeemer

Error thrown when redeemer contract is zero address

error InvalidRedeemer();

InvalidRenderer

Error thrown when renderer contract is zero address

error InvalidRenderer();

InvalidToken

Error thrown when token contract is zero address

error InvalidToken();

IIPFSRenderer

Git Source

Inherits: IRenderer

Author: fx(hash)

Renderer for constructing offchain metadata of FxGenArt721 tokens pinned to IPFS

Functions

contractRegistry

Returns address of the FxContractRegistry contract

function contractRegistry() external view returns (address);

contractURI

Gets the contact-level metadata for the project

function contractURI() external view returns (string memory);

Returns

getMetadataURL

Generates the metadata URL for a token ID

function getMetadataURL(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    external
    view
    returns (string memory);

Parameters

Returns

tokenURI

Gets the metadata for a token

function tokenURI(uint256 _tokenId, bytes calldata _data) external view returns (string memory);

Parameters

Returns

IMinter

Git Source

Author: fx(hash)

Interface for FxGenArt721 tokens to interact with minters

Functions

setMintDetails

Sets the mint details for token reserves

function setMintDetails(ReserveInfo calldata _reserveInfo, bytes calldata _mintDetails) external;

Parameters

IONCHFSRenderer

Git Source

Inherits: IRenderer

Author: fx(hash)

Renderer for reconstructing metadata of FxGenArt721 tokens stored onchain through ONCHFS

Functions

contractRegistry

Returns address of the FxContractRegistry contract

function contractRegistry() external view returns (address);

contractURI

Gets the contact-level metadata for the project

function contractURI() external view returns (string memory);

Returns

getAnimationURL

Generates the animation URL for a token ID

function getAnimationURL(bytes32 _onchfsCID, uint256 _tokenId, address _minter, bytes32 _seed, bytes memory _fxParams)
    external
    pure
    returns (string memory);

Parameters

Returns

getAttributes

Generates the list of attributes for a token ID

function getAttributes(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    external
    view
    returns (string memory);

Parameters

Returns

getExternalURL

Generates the external URL for a token ID

function getExternalURL(address _contractAddr, uint256 _tokenId) external view returns (string memory);

Parameters

Returns

getImageURL

Generates the image URL for a token ID

function getImageURL(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    external
    view
    returns (string memory);

Parameters

Returns

tokenURI

Gets the metadata for a token

function tokenURI(uint256 _tokenId, bytes calldata _data) external view returns (string memory);

Parameters

Returns

IPseudoRandomizer

Git Source

Inherits: IRandomizer

Author: fx(hash)

Randomizer for generating psuedorandom seeds for newly minted tokens

Functions

generateSeed

Generates random seed for token using entropy

function generateSeed(uint256 _tokenId) external view returns (bytes32);

Parameters

Returns

requestRandomness

Requests random seed for a given token

function requestRandomness(uint256 _tokenId) external;

Parameters

IRandomizer

Git Source

Author: fx(hash)

Interface for FxGenArt721 tokens to interact with randomizers

Functions

requestRandomness

Requests random seed for a given token

function requestRandomness(uint256 _tokenId) external;

Parameters

IRenderer

Git Source

Author: fx(hash)

Interface for FxGenArt721 tokens to interact with renderers

Functions

contractRegistry

Returns address of the FxContractRegistry contract

function contractRegistry() external view returns (address);

contractURI

Gets the contact-level metadata for the project

function contractURI() external view returns (string memory);

Returns

tokenURI

Gets the metadata for a token

function tokenURI(uint256 _tokenId, bytes calldata _data) external view returns (string memory);

Parameters

Returns

IRoyaltyManager

Git Source

Author: fx(hash)

Extension for managing secondary royalties of FxGenArt721 tokens

Functions

getRoyalties

Gets the royalties for a specific token ID

function getRoyalties(uint256 _tokenId) external view returns (address[] memory, uint256[] memory);

Parameters

Returns

royaltyInfo

Returns the royalty information for a specific token ID and sale price

function royaltyInfo(uint256 _tokenId, uint256 _salePrice) external view returns (address, uint256);

Parameters

Returns

Events

TokenIdRoyaltiesUpdated

Event emitted when the royalties for a token ID have been updated

event TokenIdRoyaltiesUpdated(uint256 indexed _tokenId, address _receiver, uint96 _basisPoints);

Parameters

TokenRoyaltiesUpdated

Event emitted when the royalties for a list of receivers have been updated

event TokenRoyaltiesUpdated(
    address indexed _receiver, address[] _receivers, uint32[] _allocations, uint96 _basisPoints
);

Parameters

Errors

BaseRoyaltiesNotSet

Error thrown when the royalties are not set

error BaseRoyaltiesNotSet();

InvalidRoyaltyConfig

Error thrown when royalty configuration is greater than or equal to 100%

error InvalidRoyaltyConfig();

LengthMismatch

Error thrown when array lengths do not match

error LengthMismatch();

MoreThanOneRoyaltyReceiver

Error thrown when more than one royalty receiver is set

error MoreThanOneRoyaltyReceiver();

NonExistentToken

Error thrown when the token ID does not exist

error NonExistentToken();

NoRoyaltyReceiver

Error thrown when royalty receiver is zero address

error NoRoyaltyReceiver();

OverMaxBasisPointsAllowed

Error thrown when total basis points exceeds maximum value allowed

error OverMaxBasisPointsAllowed();

TokenRoyaltiesNotSet

Error thrown when the token royalties are not set

error TokenRoyaltiesNotSet();

ISeedConsumer

Git Source

Author: fx(hash)

Interface for randomizers to interact with FxGenArt721 tokens

Functions

fulfillSeedRequest

Fullfills the random seed request on the FxGenArt721 token contract

function fulfillSeedRequest(uint256 _tokenId, bytes32 _seed) external;

Parameters

Events

SeedFulfilled

Event emitted when a seed request is fulfilled for a specific token

event SeedFulfilled(address indexed _randomizer, uint256 indexed _tokenId, bytes32 _seed);

Parameters

ISplitsMain

Git Source

Author: 0xSplits

Interface for SplitsFactory to interact with SplitsMain

Functions

createSplit

function createSplit(
    address[] calldata accounts,
    uint32[] calldata percentAllocations,
    uint32 distributorFee,
    address controller
) external returns (address);

distributeETH

function distributeETH(
    address split,
    address[] calldata accounts,
    uint32[] calldata percentAllocations,
    uint32 distributorFee,
    address distributorAddress
) external;

getHash

function getHash(address split) external view returns (bytes32);

predictImmutableSplitAddress

function predictImmutableSplitAddress(
    address[] calldata accounts,
    uint32[] calldata percentAllocations,
    uint32 distributorFee
) external view returns (address);

updateSplit

function updateSplit(
    address split,
    address[] calldata accounts,
    uint32[] calldata percentAllocations,
    uint32 distributorFee
) external;

withdraw

function withdraw(address account, uint256 withdrawETH, address[] calldata tokens) external;

ITicketRedeemer

Git Source

Inherits: IMinter

Author: fx(hash)

Minter for redeeming FxGenArt721 tokens by burning FxMintTicket721 tokens

Functions

pause

Pauses all function executions where modifier is applied

function pause() external;

redeem

Burns a ticket and mints a new token to the caller

function redeem(address _ticket, address _to, uint256 _tokenId, bytes calldata _fxParams) external;

Parameters

setMintDetails

Sets the mint details for token reserves

Mint Details: ticket contract address

function setMintDetails(ReserveInfo calldata _reserveInfo, bytes calldata _mintDetails) external;

Parameters

tickets

Mapping of FxGenArt721 token address to FxMintTicket721 token address

function tickets(address) external view returns (address);

unpause

Unpauses all function executions where modifier is applied

function unpause() external;

Events

MintDetailsSet

Event emitted when the mint details are set for a ticket contract

event MintDetailsSet(address indexed _ticket, address indexed _token);

Parameters

Redeemed

Event emitted when a ticket is burned and a new token is minted

event Redeemed(address indexed _ticket, uint256 indexed _tokenId, address indexed _owner, address _token);

Parameters

Errors

AlreadySet

Error thrown when mint details are already set for a ticket contract

error AlreadySet();

InvalidToken

Error thrown when token address is invalid

error InvalidToken();

NotAuthorized

Error thrown when the caller is not authorized

error NotAuthorized();

ZeroAddress

Error thrown when receiver is zero address

error ZeroAddress();

IToken

Git Source

Author: fx(hash)

Interface for minters to interact with tokens

Functions

mint

Mints arbitrary number of tokens

Only callable by registered minter contracts

function mint(address _to, uint256 _amount, uint256 _payment) external;

Parameters

primaryReceiver

Returns address of primary receiver for token sales

function primaryReceiver() external view returns (address);

Contents

• LibIPFSEncoder
• AuctionInfo
• ConfigInfo
• GenArtInfo
• InitInfo
• IssuerInfo
• MetadataInfo
• MintInfo
• MinterInfo
• ProjectInfo
• RefundInfo
• ReserveInfo
• RoyaltyInfo
• TaxInfo

LibIPFSEncoder

Git Source

Author: fx(hash)

Library for encoding IPFS CID hashes

Functions

encodeURL

Encodes IPFS CID hash to URL string format

function encodeURL(bytes32 _value) internal pure returns (string memory);

AuctionInfo

Git Source

Struct of dutch auction information

• refunded Flag indicating if refunds are enabled
• stepLength Duration (in seconds) of each auction step
• prices Array of prices for each step of the auction

struct AuctionInfo {
    bool refunded;
    uint248 stepLength;
    uint256[] prices;
}

ConfigInfo

Git Source

Struct of system config information

• feeReceiver Address receiving platform fees
• primaryFeeAllocation Amount of basis points allocated to calculate platform fees on primary sale proceeds
• secondaryFeeAllocation Amount of basis points allocated to calculate platform fees on royalty payments
• lockTime Locked time duration added to mint start time for unverified creators
• referrerShare Share amount distributed to accounts referring tokens
• defaultMetadataURI Default base URI of token metadata
• externalURI External URI for displaying tokens

struct ConfigInfo {
    address feeReceiver;
    uint32 primaryFeeAllocation;
    uint32 secondaryFeeAllocation;
    uint32 lockTime;
    uint64 referrerShare;
    string defaultMetadataURI;
    string externalURI;
}

GenArtInfo

Git Source

Struct of generative art information

• minter Address of initial token owner
• seed Hash of randomly generated seed
• fxParams Random sequence of fixed-length bytes used as token input

struct GenArtInfo {
    address minter;
    bytes32 seed;
    bytes fxParams;
}

InitInfo

Git Source

Struct of initialization information used on project creation

• name Name of project
• symbol Symbol of project
• primaryReceiver Address of splitter contract receiving primary sales
• randomizer Address of Randomizer contract
• renderer Address of Renderer contract
• tagIds Array of tag IDs describing the project
• 'onchainData' Onchain data to be stored using SSTORE2 and available to renderers

struct InitInfo {
    string name;
    string symbol;
    address[] primaryReceivers;
    uint32[] allocations;
    address randomizer;
    address renderer;
    uint256[] tagIds;
    bytes onchainData;
}

IssuerInfo

Git Source

Struct of issuer information

• primaryReceiver Address of splitter contract receiving primary sales
• projectInfo Project information
• activeMinters Array of authorized minter contracts used for enumeration
• minters Mapping of minter contract to authorization status

struct IssuerInfo {
    address primaryReceiver;
    ProjectInfo projectInfo;
    address[] activeMinters;
    mapping(address => uint8) minters;
}

MetadataInfo

Git Source

Struct of metadata information

• baseURI Decoded URI of content identifier
• onchainPointer Address of bytes-encoded data rendered onchain

struct MetadataInfo {
    bytes baseURI;
    address onchainPointer;
}

MintInfo

Git Source

Struct of mint information

• minter Address of the minter contract
• reserveInfo Reserve information
• params Optional bytes data decoded inside minter

struct MintInfo {
    address minter;
    ReserveInfo reserveInfo;
    bytes params;
}

MinterInfo

Git Source

Struct of minter information

• totalMints Total number of mints executed by the minter
• totalPaid Total amount paid by the minter

struct MinterInfo {
    uint128 totalMints;
    uint128 totalPaid;
}

ProjectInfo

Git Source

Struct of project information

• mintEnabled Flag inidicating if minting is enabled
• burnEnabled Flag inidicating if burning is enabled
• maxSupply Maximum supply of tokens
• inputSize Maximum input size of fxParams bytes data
• earliestStartTime Earliest possible start time for registering minters

struct ProjectInfo {
    bool mintEnabled;
    bool burnEnabled;
    uint120 maxSupply;
    uint88 inputSize;
    uint32 earliestStartTime;
}

RefundInfo

Git Source

Struct of refund information

• lastPrice Price of last sale before selling out
• minterInfo Mapping of minter address to struct of minter information

struct RefundInfo {
    uint256 lastPrice;
    mapping(address minter => MinterInfo) minterInfo;
}

ReserveInfo

Git Source

Struct of reserve information

• startTime Start timestamp of minter
• endTime End timestamp of minter
• allocation Allocation amount for minter

struct ReserveInfo {
    uint64 startTime;
    uint64 endTime;
    uint128 allocation;
}

RoyaltyInfo

Git Source

Struct of royalty information

• receiver Address receiving royalties
• basisPoints Points used to calculate the royalty payment (0.01%)

struct RoyaltyInfo {
    address receiver;
    uint96 basisPoints;
}

TaxInfo

Git Source

Struct of tax information

• startTime Timestamp of when harberger taxation begins
• foreclosureTime Timestamp of token foreclosure
• currentPrice Current listing price of token
• depositAmount Total amount of taxes deposited

struct TaxInfo {
    uint48 startTime;
    uint48 foreclosureTime;
    uint80 currentPrice;
    uint80 depositAmount;
}

Contents

• extensions
• DutchAuction
• FixedPrice
• TicketRedeemer

Contents

• Allowlist
• MintPass

Allowlist

Git Source

Author: fx(hash)

Extension for claiming tokens through merkle trees

Functions

_claimSlot

Claims a merkle tree slot

function _claimSlot(
    address _token,
    uint256 _reserveId,
    uint256 _index,
    address _claimer,
    bytes32[] memory _proof,
    LibBitmap.Bitmap storage _bitmap
) internal;

Parameters

_getMerkleRoot

Gets the merkle root of a token reserve

function _getMerkleRoot(address _token, uint256 _reserveId) internal view virtual returns (bytes32);

Parameters

Events

SlotClaimed

Event emitted when allowlist slot is claimed

event SlotClaimed(address indexed _token, uint256 indexed _reserveId, address indexed _claimer, uint256 _index);

Parameters

Errors

InvalidProof

Error thrown when the merkle proof for an index is invalid

error InvalidProof();

SlotAlreadyClaimed

Error thrown when an index in the merkle tree has already been claimed

error SlotAlreadyClaimed();

MintPass

Git Source

Inherits: EIP712

Author: fx(hash)

Extension for claiming tokens through mint passes

State Variables

reserveNonce

Mapping of token address to reserve ID to reserve nonce

mapping(address => mapping(uint256 => uint256)) public reserveNonce;

signingAuthorities

Mapping of token address to reserve ID to address of mint pass authority

mapping(address => mapping(uint256 => address)) public signingAuthorities;

Functions

constructor

Initializes EIP-712

constructor() EIP712("MINT_PASS", "1");

generateTypedDataHash

Generates the typed data hash for a mint pass claim

function generateTypedDataHash(
    address _token,
    uint256 _reserveId,
    uint256 _reserveNonce,
    uint256 _index,
    address _claimer
) public view returns (bytes32);

Parameters

Returns

_claimMintPass

Validates a mint pass claim

function _claimMintPass(
    address _token,
    uint256 _reserveId,
    uint256 _index,
    address _claimer,
    bytes calldata _signature,
    LibBitmap.Bitmap storage _bitmap
) internal;

Parameters

Events

PassClaimed

Event emitted when mint pass is claimed

event PassClaimed(address indexed _token, uint256 indexed _reserveId, address indexed _claimer, uint256 _index);

Parameters

Errors

InvalidSignature

Error thrown when the signature of mint pass claimer is invalid

error InvalidSignature();

PassAlreadyClaimed

Error thrown when a mint pass has already been claimed

error PassAlreadyClaimed();

DutchAuction

Git Source

Inherits: IDutchAuction, Allowlist, MintPass, Ownable, Pausable

Author: fx(hash)

See the documentation in {IDutchAuction}

State Variables

claimedMerkleTreeSlots

Mapping of token address to reserve ID to Bitmap of claimed merkle tree slots

mapping(address => mapping(uint256 => LibBitmap.Bitmap)) internal claimedMerkleTreeSlots;

claimedMintPasses

Mapping of token address to reserve ID to Bitmap of claimed mint passes

mapping(address => mapping(uint256 => LibBitmap.Bitmap)) internal claimedMintPasses;

latestUpdates

Mapping of token address to timestamp of latest update made for token reserves

LibMap.Uint40Map internal latestUpdates;

firstValidReserve

Mapping of token to the last valid reserveId that can mint on behalf of the token

LibMap.Uint40Map internal firstValidReserve;

auctions

Mapping of token address to reserve ID to reserve information

mapping(address => AuctionInfo[]) public auctions;

merkleRoots

Mapping of token address to reserve ID to merkle root

mapping(address => mapping(uint256 => bytes32)) public merkleRoots;

refunds

Mapping of token address to reserve ID to refund amount

mapping(address => mapping(uint256 => RefundInfo)) public refunds;

reserves

Mapping of token address to reserve ID to reserve information (allocation, price, max mint)

mapping(address => ReserveInfo[]) public reserves;

saleProceeds

Mapping of token address to reserve ID to amount of sale proceeds

mapping(address => mapping(uint256 => uint256)) public saleProceeds;

numberMinted

Mapping of token address to reserve ID to number of tokens minted

mapping(address => mapping(uint256 => uint256)) public numberMinted;

Functions

buy

Purchases tokens at a linear price over fixed amount of time

function buy(address _token, uint256 _reserveId, uint256 _amount, address _to) external payable whenNotPaused;

Parameters

buyAllowlist

Purchases tokens through an allowlist at a linear price over fixed amount of time

function buyAllowlist(
    address _token,
    uint256 _reserveId,
    address _to,
    uint256[] calldata _indexes,
    bytes32[][] calldata _proofs
) external payable whenNotPaused;

Parameters

buyMintPass

Purchases tokens through a mint pass at a linear price over fixed amount of time

function buyMintPass(
    address _token,
    uint256 _reserveId,
    uint256 _amount,
    address _to,
    uint256 _index,
    bytes calldata _signature
) external payable whenNotPaused;

Parameters

refund

Refunds an auction buyer with their rebate amount

function refund(address _token, uint256 _reserveId, address _buyer) external whenNotPaused;

Parameters

setMintDetails

Mint Details: struct of auction information, merkle root, and signer address

function setMintDetails(ReserveInfo calldata _reserve, bytes calldata _mintDetails) external whenNotPaused;

withdraw

Withdraws sale processed of primary sales to receiver

function withdraw(address _token, uint256 _reserveId) external whenNotPaused;

Parameters

pause

Pauses all function executions where modifier is applied

function pause() external onlyOwner;

unpause

Unpauses all function executions where modifier is applied

function unpause() external onlyOwner;

getFirstValidReserve

Returns the earliest valid reserveId that can mint a token

function getFirstValidReserve(address _token) public view returns (uint256);

getLatestUpdate

Gets the latest timestamp update made to token reserves

function getLatestUpdate(address _token) public view returns (uint40);

Parameters

Returns

getPrice

Gets the current auction price

function getPrice(address _token, uint256 _reserveId) public view returns (uint256);

Parameters

Returns

_buy

Purchases arbitrary amount of tokens at auction price and mints tokens to given account

function _buy(address _token, uint256 _reserveId, uint256 _amount, address _to) internal;

_setLatestUpdate

Sets timestamp of the latest update to token reserves

function _setLatestUpdate(address _token, uint256 _timestamp) internal;

_setFirstValidReserve

function _setFirstValidReserve(address _token, uint256 _reserveId) internal;

_getMerkleRoot

Gets the merkle root of a token reserve

function _getMerkleRoot(address _token, uint256 _reserveId) internal view override returns (bytes32);

_getPrice

Gets the current price of auction reserve

function _getPrice(ReserveInfo memory _reserve, AuctionInfo storage _daInfo) internal view returns (uint256);

_recordLastPrice

function _recordLastPrice(ReserveInfo memory _reserve, address _token, uint256 _reserveId)
    internal
    returns (uint256 lastPrice);

_validateInput

Validates token address, reserve information and given account

function _validateInput(address _token, uint256 _reserveId, address _buyer) internal view;

FixedPrice

Git Source

Inherits: IFixedPrice, Allowlist, MintPass, Ownable, Pausable

Author: fx(hash)

See the documentation in {IFixedPrice}

State Variables

claimedMerkleTreeSlots

Mapping of token address to reserve ID to Bitmap of claimed merkle tree slots

mapping(address => mapping(uint256 => LibBitmap.Bitmap)) internal claimedMerkleTreeSlots;

claimedMintPasses

Mapping of token address to reserve ID to Bitmap of claimed mint passes

mapping(address => mapping(uint256 => LibBitmap.Bitmap)) internal claimedMintPasses;

latestUpdates

Mapping of token address to timestamp of latest update made for token reserves

LibMap.Uint40Map internal latestUpdates;

firstValidReserve

Mapping of token to the last valid reserveId that can mint on behalf of the token

LibMap.Uint40Map internal firstValidReserve;

saleProceeds

Mapping of token address to sale proceeds

LibMap.Uint128Map internal saleProceeds;

merkleRoots

Mapping of token address to reserve ID to merkle roots

mapping(address => mapping(uint256 => bytes32)) public merkleRoots;

prices

Mapping of token address to reserve ID to prices

mapping(address => uint256[]) public prices;

reserves

Mapping of token address to reserve ID to reserve information

mapping(address => ReserveInfo[]) public reserves;

Functions

buy

Purchases tokens at a fixed price

function buy(address _token, uint256 _reserveId, uint256 _amount, address _to) external payable whenNotPaused;

Parameters

buyAllowlist

Purchases tokens through an allowlist at a fixed price

function buyAllowlist(
    address _token,
    uint256 _reserveId,
    address _to,
    uint256[] calldata _indexes,
    bytes32[][] calldata _proofs
) external payable whenNotPaused;

Parameters

buyMintPass

Purchases tokens through a mint pass at a fixed price

function buyMintPass(
    address _token,
    uint256 _reserveId,
    uint256 _amount,
    address _to,
    uint256 _index,
    bytes calldata _signature
) external payable whenNotPaused;

Parameters

setMintDetails

Mint Details: token price, merkle root, and signer address

function setMintDetails(ReserveInfo calldata _reserve, bytes calldata _mintDetails) external whenNotPaused;

withdraw

Withdraws the sale proceeds to the sale receiver

function withdraw(address _token) external whenNotPaused;

Parameters

pause

Pauses all function executions where modifier is applied

function pause() external onlyOwner;

unpause

Unpauses all function executions where modifier is applied

function unpause() external onlyOwner;

getFirstValidReserve

Returns the earliest valid reserveId that can mint a token

function getFirstValidReserve(address _token) public view returns (uint256);

getLatestUpdate

Gets the latest timestamp update made to token reserves

function getLatestUpdate(address _token) public view returns (uint40);

Parameters

Returns

getSaleProceed

Gets the proceed amount from a token sale

function getSaleProceed(address _token) public view returns (uint128);

Parameters

Returns

_buy

Purchases arbitrary amount of tokens at auction price and mints tokens to given account

function _buy(address _token, uint256 _reserveId, uint256 _amount, address _to) internal;

_setLatestUpdate

Sets timestamp of the latest update to token reserves

function _setLatestUpdate(address _token, uint256 _timestamp) internal;

_setFirstValidReserve

Sets earliest valid reserve

function _setFirstValidReserve(address _token, uint256 _reserveId) internal;

_setSaleProceeds

Sets the proceed amount from the token sale

function _setSaleProceeds(address _token, uint256 _amount) internal;

_getMerkleRoot

Gets the merkle root of a token reserve

function _getMerkleRoot(address _token, uint256 _reserveId) internal view override returns (bytes32);

TicketRedeemer

Git Source

Inherits: ITicketRedeemer, Ownable, Pausable

Author: fx(hash)

See the documentation in {ITicketRedeemer}

State Variables

tickets

Mapping of FxGenArt721 token address to FxMintTicket721 token address

mapping(address => address) public tickets;

Functions

redeem

Burns a ticket and mints a new token to the caller

function redeem(address _token, address _to, uint256 _ticketId, bytes calldata _fxParams) external whenNotPaused;

Parameters

setMintDetails

Mint Details: ticket contract address

function setMintDetails(ReserveInfo calldata, bytes calldata _mintDetails) external whenNotPaused;

pause

Pauses all function executions where modifier is applied

function pause() external onlyOwner;

unpause

Unpauses all function executions where modifier is applied

function unpause() external onlyOwner;

Contents

• PseudoRandomizer

PseudoRandomizer

Git Source

Inherits: IPseudoRandomizer

Author: fx(hash)

See the documentation in {IPseudoRandomizer}

Functions

requestRandomness

function requestRandomness(uint256 _tokenId) external;

generateSeed

Generates random seed for token using entropy

function generateSeed(uint256 _tokenId) public view returns (bytes32);

Parameters

Returns

Contents

• FxContractRegistry
• FxRoleRegistry

FxContractRegistry

Git Source

Inherits: IFxContractRegistry, Ownable

Author: fx(hash)

See the documentation in {IFxContractRegistry}

State Variables

configInfo

Returns the system config information

ConfigInfo public configInfo;

contracts

Mapping of hashed contract name to contract address

mapping(bytes32 => address) public contracts;

Functions

constructor

Initializes registry owner and system config information

constructor(address _admin, ConfigInfo memory _configInfo) Ownable;

register

Registers deployed contract addresses based on hashed value of name

function register(string[] calldata _names, address[] calldata _contracts) external onlyOwner;

Parameters

setConfig

Sets the system config information

function setConfig(ConfigInfo calldata _configInfo) external onlyOwner;

Parameters

_setConfigInfo

Sets the system config information

function _setConfigInfo(ConfigInfo memory _configInfo) internal;

FxRoleRegistry

Git Source

Inherits: AccessControl, IFxRoleRegistry

Author: fx(hash)

See the documentation in {IFxRoleRegistry}

Functions

constructor

Initializes registry owner and role admins

constructor(address _admin);

setRoleAdmin

Sets the admin of a new or existing role

function setRoleAdmin(bytes32 _role) external onlyRole(ADMIN_ROLE);

Parameters

Contents

• IPFSRenderer
• ONCHFSRenderer

IPFSRenderer

Git Source

Inherits: IIPFSRenderer

Author: fx(hash)

See the documentation in {IIPFSRenderer}

State Variables

contractRegistry

address public immutable contractRegistry;

Functions

constructor

Initializes FxContractRegistry

constructor(address _contractRegistry);

contractURI

function contractURI() external view returns (string memory);

tokenURI

function tokenURI(uint256 _tokenId, bytes calldata _data) external view returns (string memory);

getMetadataURL

Generates the metadata URL for a token ID

function getMetadataURL(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    public
    view
    returns (string memory);

Parameters

Returns

ONCHFSRenderer

Git Source

Inherits: IONCHFSRenderer

Author: fx(hash)

See the documentation in {IONCHFSRenderer}

State Variables

contractRegistry

address public immutable contractRegistry;

Functions

constructor

Initializes FxContractRegistry

constructor(address _contractRegistry);

contractURI

function contractURI() external view returns (string memory);

tokenURI

function tokenURI(uint256 _tokenId, bytes calldata _data) external view returns (string memory);

getAttributes

Generates the list of attributes for a token ID

function getAttributes(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    public
    view
    returns (string memory);

Parameters

Returns

getExternalURL

Generates the external URL for a token ID

function getExternalURL(address _contractAddr, uint256 _tokenId) public view returns (string memory);

Parameters

Returns

getImageURL

Generates the image URL for a token ID

function getImageURL(address _contractAddr, string memory _baseURI, uint256 _tokenId)
    public
    view
    returns (string memory);

Parameters

Returns

getAnimationURL

Generates the animation URL for a token ID

function getAnimationURL(bytes32 _onchfsCID, uint256 _tokenId, address _minter, bytes32 _seed, bytes memory _fxParams)
    public
    pure
    returns (string memory);

Parameters

Returns

_renderJSON

Reconstructs JSON metadata of token onchain

function _renderJSON(
    address _contractAddr,
    uint256 _tokenId,
    string memory _description,
    string memory _baseURI,
    string memory _animationURL
) internal view returns (string memory);

Contents

• extensions
• FxGenArt721
• FxMintTicket721

Contents

• RoyaltyManager

RoyaltyManager

Git Source

Inherits: IRoyaltyManager

Author: fx(hash)

See the documentation in {IRoyaltyManager}

State Variables

baseRoyalties

Returns royalty information of index in array list

RoyaltyInfo public baseRoyalties;

tokenRoyalties

Mapping of token ID to array of royalty information

mapping(uint256 => RoyaltyInfo) public tokenRoyalties;

Functions

getRoyalties

Gets the royalties for a specific token ID

function getRoyalties(uint256 _tokenId)
    external
    view
    returns (address[] memory receivers, uint256[] memory basisPoints);

Parameters

Returns

royaltyInfo

Returns the royalty information for a specific token ID and sale price

function royaltyInfo(uint256 _tokenId, uint256 _salePrice) external view returns (address receiver, uint256 amount);

Parameters

Returns

_getOrCreateSplit

function _getOrCreateSplit(address[] calldata _receivers, uint32[] calldata _allocations)
    internal
    returns (address receiver);

_setBaseRoyalties

Sets the base royalties for all tokens

function _setBaseRoyalties(address[] calldata _receivers, uint32[] calldata _allocations, uint96 _basisPoints)
    internal
    virtual;