Skip to content

MADFactory721.md

Latest commit

 

History

History
602 lines (409 loc) · 18 KB

MADFactory721.md

File metadata and controls

602 lines (409 loc) · 18 KB

MADFactory721

Methods

colInfo

function colInfo(bytes32) external view returns (address creator, enum Types.ERC721Type colType, bytes32 colSalt, uint256 blocknumber, address splitter)

colIDs are derived from adding 12 bytes of zeros to an collection's address.colID => colInfo(salt/type/addr/time/splitter)

Parameters

Name Type Description
_0 bytes32 undefined

Returns

Name Type Description
creator address undefined
colType enum Types.ERC721Type undefined
colSalt bytes32 undefined
blocknumber uint256 undefined
splitter address undefined

createCollection

function createCollection(uint8 _tokenType, string _tokenSalt, string _name, string _symbol, uint256 _price, uint256 _maxSupply, string _baseURI, address _splitter, uint256 _royalty) external nonpayable

Core public ERC721 token types deployment pusher.

Function Sighash := 0x73fd6808Args passed as params in this function serve as common denominator for all token types.Extra config options must be set directly by through token type specific functions in MADRouter contract.Frontend must attent that salt values must have common pattern so to not replicate same output.

Parameters

Name Type Description
_tokenType uint8 Values legend: 0=Minimal; 1=Basic; 2=Whitelist; 3=Lazy.
_tokenSalt string Nonce/Entropy factor used by CREATE3 method to generate collection deployment address. Must be always different to avoid address collision.
_name string Name of the collection to be deployed.
_symbol string Symbol of the collection to be deployed.
_price uint256 Public mint price of the collection to be deployed.
_maxSupply uint256 Maximum supply of tokens to be minted of the collection to be deployed (Not used for ERC721Minimal token type, since it always equals to one).
_baseURI string The URL + CID to be added the tokenID and suffix (.json) by the tokenURI function in the collection to be deployed (baseURI used as tokenURI itself for the ERC721Minimal token type).
_splitter address Previously deployed Splitter implementation so to validate and attach to collection.
_royalty uint256 Ranges in between 0%-10%, in percentage basis points, accepted (Min tick := 25).

creatorAuth

function creatorAuth(address _token, address _user) external view returns (bool stdout)

Authority validator for no-fee marketplace listing.

Function Sighash := 0x76de0f3dBinds Marketplace's pull payment methods to Factory storage.

Parameters

Name Type Description
_token address Address of the traded token.
_user address Token Seller that must match collection creator for no-fee listing.

Returns

Name Type Description
stdout bool := 1 as boolean standard output.

creatorCheck

function creatorCheck(bytes32 _colID) external view returns (address creator, bool check)

Authority validator for MADRouter creator settings and withdraw functions.

Function Sighash := 0xb64bd5eb

Parameters

Name Type Description
_colID bytes32 32 bytes collection ID value.

Returns

Name Type Description
creator address bb
check bool Boolean output to either approve or reject call's tx.origin function access.

erc20

function erc20() external view returns (contract ERC20)

ERC20 payment token address

Returns

Name Type Description
_0 contract ERC20 undefined

getColID

function getColID(address _colAddress) external pure returns (bytes32 colID)

Convert address to colID (20bytes => 32bytes).Function Sighash := 0x617d1d3b

Parameters

Name Type Description
_colAddress address undefined

Returns

Name Type Description
colID bytes32 undefined

getDeployedAddr

function getDeployedAddr(string _salt) external view returns (address)

Parameters

Name Type Description
_salt string undefined

Returns

Name Type Description
_0 address undefined

getIDsLength

function getIDsLength(address _user) external view returns (uint256)

Everything in storage can be fetch through the getters natively provided by all public mappings.

This public getter serve as a hook to ease frontend fetching whilst estimating user's colID indexes.Function Sighash := 0x8691fe46

Parameters

Name Type Description
_user address undefined

Returns

Name Type Description
_0 uint256 undefined

market

function market() external view returns (address)

Instance of MADMarketplace being passed as parameter of creatorAuth.

Returns

Name Type Description
_0 address undefined

name

function name() external pure returns (string)

Function SigHash: 0x06fdde03

Returns

Name Type Description
_0 string undefined

owner

function owner() external view returns (address)

Returns

Name Type Description
_0 address undefined

pause

function pause() external nonpayable

Paused state initializer for security risk mitigation pratice.

Function Sighash := 0x8456cb59

paused

function paused() external view returns (bool)

Returns

Name Type Description
_0 bool undefined

router

function router() external view returns (address)

Instance of MADRouter being passed as parameter of collection's constructor.

Returns

Name Type Description
_0 address undefined

setMarket

function setMarket(address _market) external nonpayable

_MADMarketplace instance setter.Function Sighash := _

Parameters

Name Type Description
_market address undefined

setOwner

function setOwner(address newOwner) external nonpayable

Function Signature := 0x13af4035

Parameters

Name Type Description
newOwner address undefined

setRouter

function setRouter(address _router) external nonpayable

MADRouter instance setter.Function Sighash := 0xc0d78655

Parameters

Name Type Description
_router address undefined

setSigner

function setSigner(address _signer) external nonpayable

Setter for EIP712 signer/validator instance.Function Sighash := 0x6c19e783

Parameters

Name Type Description
_signer address undefined

splitterCheck

function splitterCheck(string _splitterSalt, address _ambassador, address _project, uint256 _ambShare, uint256 _projectShare) external nonpayable

Splitter deployment pusher.

Function Sighash := 0x9e5c4b70

Parameters

Name Type Description
_splitterSalt string Nonce/Entropy factor used by CREATE3 method. Must be always different to avoid address collision. to generate payment splitter deployment address.
_ambassador address User may submit an addresses to donate 1%-20% of secondary sales royalties (optional, will be disregarded if left empty(value == address(0)).
_project address User may submit an addresses to donate 1%-100% of creators secondary sales royalties (optional, will be disregarded if left empty(value == address(0)).
_ambShare uint256 Percentage (1%-20%) of secondary sales royalties to be donated to an ambassador (optional, will be disregarded if left empty(value == 0)).
_projectShare uint256 Percentage (1%-100%) of secondary sales royalties to be donated to a project taken from the creators resale share (optional, will be disregarded if left empty(value == 0)).

splitterInfo

function splitterInfo(address, address) external view returns (address splitter, bytes32 splitterSalt, address ambassador, address project, uint256 ambShare, uint256 projectShare, bool valid)

Nested mapping that takes an collection creator as key of an hashmap of splitter contracts to its respective deployment configs.

Parameters

Name Type Description
_0 address undefined
_1 address undefined

Returns

Name Type Description
splitter address undefined
splitterSalt bytes32 undefined
ambassador address undefined
project address undefined
ambShare uint256 undefined
projectShare uint256 undefined
valid bool undefined

typeChecker

function typeChecker(bytes32 _colID) external view returns (uint8 pointer)

Returns the collection type uint8 value in case token and user are authorized.Function Sighash := 0xd93cb8fd

Parameters

Name Type Description
_colID bytes32 undefined

Returns

Name Type Description
pointer uint8 undefined

unpause

function unpause() external nonpayable

Unpaused state initializer for security risk mitigation pratice.

Function Sighash := 0x3f4ba83a

userTokens

function userTokens(address, uint256) external view returns (bytes32)

Maps an collection creator, of type address, to an array of colIDs.

Parameters

Name Type Description
_0 address undefined
_1 uint256 undefined

Returns

Name Type Description
_0 bytes32 undefined

Events

ERC721BasicCreated

event ERC721BasicCreated(address indexed newSplitter, address indexed newCollection, string name, string symbol, uint256 royalties, uint256 maxSupply, uint256 mintPrice)

Parameters

Name Type Description
newSplitter indexed address undefined
newCollection indexed address undefined
name string undefined
symbol string undefined
royalties uint256 undefined
maxSupply uint256 undefined
mintPrice uint256 undefined

ERC721LazyCreated

event ERC721LazyCreated(address indexed newSplitter, address indexed newCollection, string name, string symbol, uint256 royalties, uint256 maxSupply, uint256 mintPrice)

Parameters

Name Type Description
newSplitter indexed address undefined
newCollection indexed address undefined
name string undefined
symbol string undefined
royalties uint256 undefined
maxSupply uint256 undefined
mintPrice uint256 undefined

ERC721MinimalCreated

event ERC721MinimalCreated(address indexed newSplitter, address indexed newCollection, string name, string symbol, uint256 royalties, uint256 maxSupply, uint256 mintPrice)

Parameters

Name Type Description
newSplitter indexed address undefined
newCollection indexed address undefined
name string undefined
symbol string undefined
royalties uint256 undefined
maxSupply uint256 undefined
mintPrice uint256 undefined

ERC721WhitelistCreated

event ERC721WhitelistCreated(address indexed newSplitter, address indexed newCollection, string name, string symbol, uint256 royalties, uint256 maxSupply, uint256 mintPrice)

Parameters

Name Type Description
newSplitter indexed address undefined
newCollection indexed address undefined
name string undefined
symbol string undefined
royalties uint256 undefined
maxSupply uint256 undefined
mintPrice uint256 undefined

MarketplaceUpdated

event MarketplaceUpdated(address indexed newMarket)

Parameters

Name Type Description
newMarket indexed address undefined

OwnerUpdated

event OwnerUpdated(address indexed user, address indexed newOwner)

Parameters

Name Type Description
user indexed address undefined
newOwner indexed address undefined

Paused

event Paused(address account)

Parameters

Name Type Description
account address undefined

PaymentTokenUpdated

event PaymentTokenUpdated(address indexed newPaymentToken)

Parameters

Name Type Description
newPaymentToken indexed address undefined

RouterUpdated

event RouterUpdated(address indexed newRouter)

Parameters

Name Type Description
newRouter indexed address undefined

SignerUpdated

event SignerUpdated(address indexed newSigner)

Parameters

Name Type Description
newSigner indexed address undefined

SplitterCreated

event SplitterCreated(address indexed creator, uint256[] shares, address[] payees, address splitter, uint256 flag)

Parameters

Name Type Description
creator indexed address undefined
shares uint256[] undefined
payees address[] undefined
splitter address undefined
flag uint256 undefined

Unpaused

event Unpaused(address account)

Parameters

Name Type Description
account address undefined

Errors

AccessDenied

error AccessDenied()

0x4ca88867

InvalidRoyalty

error InvalidRoyalty()

0xe0e54ced

InvalidSplitter

error InvalidSplitter()

0x00adecf0