Creating Your Shop

(In Beta for Polygon, Ethereum coming soon)

circle-info

Check out the examplearrow-up-right in the Github repo and its deployed version herearrow-up-right.

Our Ethereum and Polygon shops are built on Opensea's Seaportarrow-up-right smart contract, which is open source and the standard for NFT trading and auctions on EVM chains. Candy Shop provides a backend that powers marketplace features such as verified collections, filter, search and more.

You can create and configure your Candy Shop through the Admin Panelarrow-up-right, including the following:

  • Create a shop with ETH, MATIC or an ERC20 token as transaction currency

  • Define and restrict NFT collections that can be bought and sold on your shop

Install Candy Shop

npm install @liqnft/candy-shop

or

yarn add @liqnft/candy-shop

Use Candy Shop

Create a CandyShop instance in your code base to use Candy Shop.

const candyShop = await EthCandyShop.initEthCandyShop({
  shopCreatorAddress: "0x36326211D644a78b74B92d69eebB475545Ef4537", // Candy Shop owner address
  treasuryMint: "0x0000000000000000000000000000000000000000", // Candy Shop transaction currency
  programId: "0x00000000006c3852cbEf3e08E8dF289169EdE581", // Candy Shop program ID
  env: "MUMBAI", // network
  settings: settings // (optional) additional shop settings
});

Network can take one of the following parameters:

  • Ethereum Mainnet: ETH

  • Ethereum Goerli Testnet: GOERLI

  • Polygon Mainnet: MATIC

  • Polygon Mumbai Testnet: MUMBAI

Additional Settings

You may pass an additional settings object to customize your shop:

  • priceDecimals: number

    • number of decimals to display for price numbers (default is 3)

  • volumeDecimals: number

    • number of decimals to display for volume numbers (default is 1)

Default settings

Last updated