Skip to content

rlxyz/rlxyz-creator

Repository files navigation

NPM Package

A library for ERC721 development built on an optimzed contract standard

  • Wrapper around ERC721A by Chiru-Labs.
  • Incorporates public sale functionality
  • Incorporates pre-sale functionality that utilises merkle roots
  • Incorporates Promtoion NFTs to be minted

Overview

Installation

$ yarn add @rlxyz/contracts

RLXYZ Contracts features a stable API which means your contracts won't break unexpectedly when upgrading to a newer minor version.

Usage

Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.8.0;

import "@rlxyz/contracts/RhapsodyCreator.sol";

contract Example is RhapsodyCreator {
    constructor(bytes32 _presaleMerkleRoot)
        RhapsodyCreator("Example", "EXAM", _presaleMerkleRoot, 60, 10, 5, 0.05 ether)
    {}
}

If you're new to smart contract development, head to Developing Smart Contracts to learn about creating a new project and compiling your contracts.

To keep your system secure, you should always use the installed code as-is, and neither copy-paste it from online sources, nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.

Learn More

Check out Open Zeppelin's guides on their blog, which cover several common use cases and good practices. The following articles provide great background reading, though please note, some of the referenced tools have changed as the tooling in the ecosystem continues to rapidly evolve.

Security

This project is maintained by RLXYZ.

Critical bug fixes will be backported to past major releases.

Contribute

RLXYZ Contracts exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!

License

RLXYZ Contracts is released under the MIT License.