ChainGPT AI NFT SDK

This library provides convenient access to the ChainGPT AI NFT REST API from TypeScript or JavaScript.

Installation

npm install --save @chaingpt/nft
# or
yarn add @chaingpt/nft

Usage

Generate an NFT

const { Nft } = require('@chaingpt/nft');

const nftInstance = new Nft({
  apiKey: 'Your ChainGPT API Key',
});

async function main() {
    const generatedImage = await nftInstance.generateNft({
        walletAddress: "", // Public Key of the wallet that will mint NFT
        prompt: "", // Prompt to be used to generate the NFT art
        model: "" // Model to be used to generate the NFT art
    });
}

main();

Generate an NFT and queue the generation instead of waiting for it to complete

const { Nft } = require('@chaingpt/nft');

const nftInstance = new Nft({
  apiKey: 'Your ChainGPT API Key',
});

async function main() {
    const generatedImageQueue = await nftInstance.generateNftWithQueue({
        walletAddress: "", // Public Key of the wallet that will mint NFT
        prompt: "", // Prompt to be used to generate the NFT art
        model: "" // Model to be used to generate the NFT art
    });
}

main();

Check the creation progress of your NFT Generation (useful with generateNftWithQueue())

const { Nft } = require('@chaingpt/nft');

const nftInstance = new Nft({
  apiKey: 'Your ChainGPT API Key',
});

async function main() {
    const getProgress = await nftInstance.getNftProgress({
        collectionId: "" // your NFT generation collection ID    
    });
}

main();

Retrieving required data to mint the generated NFT

const { Nft } = require('@chaingpt/nft');

const nftInstance = new Nft({
  apiKey: 'Your ChainGPT API Key',
});

async function main() {
    const mint = await nftInstance.mintNft({
        collectionId: "", // Your NFT generation Collection ID
        name: "", // A name for your NFT
        description: "", // A description for your NFT
    });
}

main();

Retrieving the NFT Mint Factory Contract ABI to call the Mint function

const { Nft } = require('@chaingpt/nft');

const nftInstance = new Nft({
  apiKey: 'Your ChainGPT API Key',
});

async function main() {
    const abi = await nftInstance.abi();
}

main();

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), an error of the class NftError will be thrown:

import { Errors } from '@chaingpt/nft';

async function main() {
  try {
    const response = await nftInstance.abi();
    console.log(response.data);
  } catch(error) {
    if (error instanceof Errors.NftError) {
      console.log(error.message)    
    }
  }
}

main();