Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.25 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.25 KB
Raw

Apillon NFTs Service - NFTS

NFTs Service provides functionality for creating NFT collections on blockchains. Currently supports Moonbeam and Astar network.

Table of Contents

  1. Getting Started
  2. Configuration
  3. Deployment
  4. License

Getting Started

Please read Development and Debug and Test documentation. These instructions will help you set up the development environment and run the microservice locally.

Configuration

Environment variables that have to be set:

/************************************************************
 * NFTS - Apillon NFTs Service
 ************************************************************/
/**
 *  function name
 */
NFTS_FUNCTION_NAME: string;
NFTS_FUNCTION_NAME_TEST: string;

/**
 * NFTS dev server port
 */
NFTS_SOCKET_PORT: number;
NFTS_SOCKET_PORT_TEST: number;

/**
 * NFTS Database config
 */

NFTS_MYSQL_HOST: string;
NFTS_MYSQL_PORT: number;
NFTS_MYSQL_USER: string;
NFTS_MYSQL_PASSWORD: string;
NFTS_MYSQL_DEPLOY_USER: string;
NFTS_MYSQL_DEPLOY_PASSWORD: string;
NFTS_MYSQL_DATABASE: string;

// TEST
NFTS_MYSQL_HOST_TEST: string;
NFTS_MYSQL_PORT_TEST: number;
NFTS_MYSQL_USER_TEST: string;
NFTS_MYSQL_PASSWORD_TEST: string;
NFTS_MYSQL_DATABASE_TEST: string;

/**
 * NFT workers config
 */
NFTS_AWS_WORKER_SQS_URL: string;
NFTS_AWS_WORKER_LAMBDA_NAME: string;

NFT Collection Contract versioning

The underlying smart contracts for the NFT Collections are versioned such that if there are ever new breaking changes introduces to the smart contract, it will not break the functionality of previously created collections. For each collection type and corresponding chain type, there is an entry in the contract_version table which contains all the versions for that collection and chain type. By default, when creating a new collection, the highest version is considered. For example: If the record for collectionType=1 (generic) has value version=3, the collection will use the ABI and bytecode from that contract_version record for deployment and all other actions.

Deployment

Please read Deployment documentation.

License

Copyright (c) Apillon - all rights reserved