Skip to content

Latest commit

 

History

History
152 lines (108 loc) · 4.18 KB

README.md

File metadata and controls

152 lines (108 loc) · 4.18 KB
Raw

creator-core-extensions-solidity

The Manifold Creator Core Extension Applications (Apps) Contracts

A library of base implementations and examples Apps for use with Manifold Creator Core.

This repo contains reference implementations and examples for apps that you can add to any Manifold Creator Core contract. Examples include:

  • Platform level extensions (for examples, see contracts/manifold, which are singular extensions that can be installed by every contract to enable new functionality)
  • ERC721 Editions
  • ERC721 Enumerable subcollection
  • Dynamic NFTs
  • Redemption mechanics (claim or burn and redeem)

Overview

Installation

$ npm install @manifoldxyz/creator-core-extensions-solidity

Usage

Once installed, you can use the contracts in the library by importing and extending them. To add an app to a Creator Core contract, you need to approve the app by calling:

registerExtension(address extension, string memory baseURI)

baseURI can be blank if you are overriding the tokenURI functionality.

See the developer documentation for further info about Extension Applications.

Platform Extensions

These are extensions that can be installed by any Manifold Creator contract to give enhanced additional functionality. There is a single deployed instance of these extensions, and every creator contract installs the same instance, and accesses the new functionality via that extension.

Manifold ERC721 Edition

Provides a more efficient way to batch mint NFTs to one or many addresses

Goerli

0x9cac159ec266E76ed7377b801f3b5d2cC7bcf40d

Mainnet

0xc68afc6A3B47b108Db5e48fB53a10D2D9c11b094

Manifold Lazy Claim

These are ERC721 and ERC1155 Lazy Claim extensions.

ERC721 Goerli

0xC3Ba6907a64d63A28E5BE8bFF9c6c1EaD7Ce7EA7

ERC721 Mainnet

0xa46f952645D4DeEc07A7Cd98D1Ec9EC888d4b61E

ERC1155 Goerli

0xa402f5e27b5da8D6593f6bEDE97BE5820529D64a

ERC1155 Mainnet

0x44e94034AFcE2Dd3CD5Eb62528f239686Fc8f162

Customized Lightweight Proxies

You can deploy customized lightweight Proxy implementations of the following Application Extensions by referring to their templates and deploying against the appropriate network's reference Implementations.

ERC721 Editions

There are two styles of editions: Prefix Editions and Numbered Editions.

Prefix

Prefix Editions assume that all the metadata URI will be prefixed with the same string, and the suffix for each metadata will be the edition number, starting from 1. e.g. prefix = 'https://arweave.net/' The URI for the first item in the edition will be 'https://arweave.net/{HASH}/1', second will be 'https://arweave.net/{HASH}/2' and so forth.

contracts/edition/ERC721PrefixEditionTemplate.sol and referring to the following implementation addresses:

Goerli

0x...

Mainnet

0x...
Numbered

Numbered editions assume that all metadata is unchanging except for the Edition number. Numbered editions are instantiated by passing the metadata as a 'uriParts' array, which is recomposed to inject the edition number (and total edition count if desired). Good for open editions.

contracts/edition/ERC721NumberedEditionTemplate.sol and referring to the following implementation addresses:

Goerli

0x...

Mainnet

0x...

Nifty Gateway Open Editions

Numbered editions which may be used for Nifty Gateway open edition sales.

contracts/edition/nifty/NiftyGatewayERC721NumberedEditionTemplate.sol and referring to the following implementation addresses:

Goerli

0x...

Mainnet

0x...

Running the package unit tests

Visit the github repo and clone the repo. It uses the truffle framework and ganache-cli.

Install both:

npm install -g truffle
npm install -g ganache-cli

install dependencies

npm install

Compile

truffle compile

Start development server

ganache-cli -l 20000000

Deploy migrations

truffle migrate

Run tests

truffle test