@xact-wallet-sdk/nft
TypeScript icon, indicating that this package has built-in type declarations

1.1.8 • Public • Published

@xact-wallet-sdk/nft

Create a NFT with Hedera and FileCoin

Installation

  1. Install package from npm and dependencies.

npm i @xact-wallet-sdk/nft

Before Starting

  1. Please create your account on Hedera Portal.

  2. Please create your account on NFT Storage.

Usage

/* Create a new instance of Client */
const hederaAccount = {
    accountId: 'YOUR_ACCOUNTID',
    privateKey: 'YOUR_PRIVATEKEY',
    environment: HederaEnvironment.TESTNET, /* Default to MAINNET */
};
    
/* Construct an instance of Client */
const client = new ClientNFT({hederaAccount, nftStorageApiKey: 'YOUR_TOKEN', debugLevel:DebugLevel.DEBUG /* Default to OFF */});

/* Get NFT's creation Fees */
const fees = await client.getFees();

/* Create NFT with unique metadata */
const name = 'NFT Test';
const description = 'Description of my NFT';
const category = CategoryNFT.ART;
const creator = 'Johny.B';
const media = ''; /* File or Base64 format */
const supply = 1; /* Nb of NFT available */
const customRoyaltyFee = [{
    numerator: 1,
    denominator: 10,
    fallbackFee: 100,
    collectorAccountId: '0.0.123456',
}]
await client.createAndMint({name, description, category, creator, media, supply, customRoyaltyFee});

/* Create NFT with multiple metadata under one token */
const name = 'NFT Test';
const customRoyaltyFee = [{
    numerator: 1,
    denominator: 10,
    fallbackFee: 100,
    collectorAccountId: '0.0.123456',
}]
const nfts: NFT = [
    {
        name: 'NFT Test 1',
        description: 'Description of my first NFT',
        category: CategoryNFT.ART,
        creator: 'Johny.B',
        attributes: [],
        customProperties: null,
        media: '', /* File or Base64 format */
    },
    {
        name: 'NFT Test 2',
        description: 'Description of my second NFT',
        category: CategoryNFT.ART,
        creator: 'Johny.B',
        attributes: [],
        customProperties: null,
        media: '', /* File or Base64 format */
    }
]
await client.createAndMint({name, customRoyaltyFee, nfts});

Readme

Keywords

Package Sidebar

Install

npm i @xact-wallet-sdk/nft

Weekly Downloads

3

Version

1.1.8

License

MIT

Unpacked Size

26.5 kB

Total Files

15

Last publish

Collaborators

  • magrinj
  • wincey