Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 3.59 KB

README.md

File metadata and controls

117 lines (83 loc) · 3.59 KB
Raw

Proton Marketplace

This application shows the basic functionality of NFTs on the Proton chain through the use of the Proton Web SDK.

This is built off of atomicassets NFT framework.

To build and run locally

Docker

Run a docker container:

docker build nft-demo .

docker images

docker run -p 3000:3000 -i -d [image id]

npm

git clone https://github.com/ProtonProtocol/nft-demo.git

npm install

npm run dev

Set up a Cloud Firestore

This project uses Firebase for the dynamic configuration of homepage templates. Please refer to the Firebase documentation to set up your firestore.

Note you'll need to set the following environment variables:

  • FIREBASE_API_KEY
  • FIREBASE_AUTH_DOMAIN
  • FIREBASE_PROJECT_ID

If you do not want to implement Firebase, remove the invocation of useFirebaseFeaturedTemplates and fetch templates directly from Atomic Assets (for example, with the http://proton.api.atomicassets.io/atomicassets/docs/swagger/#/templates/get_v1_templates endpoint).

The API response will contain an array of templates which you can pass as the items prop of the Grid component rendered.

// pages/index.tsx

const MarketPlace = (): JSX.Element => {
  const featuredTemplates = useFirebaseFeaturedTemplates();
  return (
    <PageLayout>
      <Banner modalType={MODAL_TYPES.CLAIM} />
      <ExploreCard />
      <HomepageStatistics />
      <Title>New &amp; Noteworthy</Title>
      <Grid items={featuredTemplates} />
    </PageLayout>
  );
};

Environment

Create a copy of .env.template and name it .env.local:

For mainnet:

NEXT_PUBLIC_CHAIN_ENDPOINTS='https://proton.eoscafeblock.com, https://proton.greymass.com'
NEXT_PUBLIC_BLOCK_EXPLORER='https://proton.bloks.io/block/'
NEXT_PUBLIC_NFT_ENDPOINT='https://proton.api.atomicassets.io'
FIREBASE_API_KEY=string
FIREBASE_AUTH_DOMAIN=string
FIREBASE_PROJECT_ID=string

For testnet:

NEXT_PUBLIC_CHAIN_ENDPOINTS='https://testnet.protonchain.com'
NEXT_PUBLIC_BLOCK_EXPLORER='https://proton-test.bloks.io/block/'
NEXT_PUBLIC_NFT_ENDPOINT='https://test.proton.api.atomicassets.io'
FIREBASE_API_KEY=string
FIREBASE_AUTH_DOMAIN=string
FIREBASE_PROJECT_ID=string

Marketplace

The marketplace page consists of templates of a specific collection_name.

Custom flags

  • The Template object is extended with the following custom property: lowestPrice.
    • lowestPrice (string) is determined by checking the Sales API for assets listed for sale and finding the lowest price of the assets of that particular template.

My NFTs

The My NFTs page consists of the current user's assets. Each user is only allowed to view their own collection page in this demo.

Custom flags

  • The Asset object is extended with the following custom properties: isForSale and salePrice.
    • isForSale (boolean) is determined by checking the Sales API for currently listed sales using the asset_id and seller (current user's chainAccount)
    • salePrice (string) is determined by checking the Sales API and combining an asset's listing_price and listing_symbol