@xact-wallet-sdk/nft-cli

nft-minting

• nft-minting
• Usage
• Config file
• Example of how to use
• Commands

Usage

$ npm install -g @xact-wallet-sdk/nft-cli
$ nft COMMAND
running command...
$ nft (--version)
@xact-wallet-sdk/nft-cli/0.0.5 darwin-x64 node-v14.18.1
$ nft --help [COMMAND]
USAGE
  $ nft COMMAND
...

Config file

The configuration file provided to mint command should looks like this:

{
  "nftStorageApiKey": "YOUR_STORAGE_API_KEY",
  "hederaAccount": {
    "accountId": "0.0.12345678",
    "privateKey": "YOUR_PRIVATE_KEY",
    "environment": "testnet"
  },
  // Only needed for mint-multiple command
  "metadata": {
    // The following will be applied to the token
    "name": "TOKEN_NAME",
    "symbol": "TOKEN_SYMBOL",
        "customRoyaltyFee": [
      {
        "collectorAccountId": "0.0.12345678",
        "fallbackFee": 100,
        "numerator": 10,
        "denominator": 100
      }
    ],
    // The following will be applied to the nft
    "category": "Art",
    "creator": "TOKEN_CREATOR"
  }
}

To pass this file to your command use --config option.

Example of how to use

1. Create a folder mint with a config.json file inside and your output folder from hashlips
2. Move into your folder mint

$ cd mint

1. Run mint-multiple command:

$ nft mint-multiple --from ./output

Commands

• nft commands
• nft help [COMMAND]
• nft mint-multiple
• nft mint-single

nft commands

list all the commands

USAGE
  $ nft commands [-h] [-j] [--hidden] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help         Show CLI help.
  -j, --json         display unfiltered api data in json format
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

nft help [COMMAND]

Display help for nft.

USAGE
  $ nft help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for nft.

See code: @oclif/plugin-help

nft mint-multiple

Mint NFT's with multiple metadata

USAGE
  $ nft mint-multiple -f <value> [-c <value>]

FLAGS
  -c, --config=<value>  [default: /Users/tailorweb./Lab/xact/nft-cli/config.json] Path of your config file
  -f, --from=<value>    (required) Path from which you want to create your NFT's

DESCRIPTION
  Mint NFT's with multiple metadata

EXAMPLES
  $ nft mint multiple -c sample.config.json -f ~/Downloads/nfts
        Checking your configuration...
        Checking if the path is a directory...
        Reading the content of all the paired files...
        Running minting of your directory...
        ...

See code: dist/commands/mint-multiple/index.ts

nft mint-single

Mint NFT's with single metadata

USAGE
  $ nft mint-single -m <value> -i <value> [-c <value>] [-s <value>]

FLAGS
  -c, --config=<value>    [default: /Users/tailorweb./Lab/xact/nft-cli/config.json] Path of your config file
  -i, --image=<value>     (required) Path of your image file
  -m, --metadata=<value>  (required) Path of your json metadata file
  -s, --supply=<value>    [default: 1] Amount of supply

DESCRIPTION
  Mint NFT's with single metadata

EXAMPLES
  $ nft mint single -c sample.config.json -m ~/Downloads/nft/metadata.json -i ~/Downloads/nft/image.png -s 1500
        Checking your configuration...
        Checking if your paths...
        Reading the content of your file...
        Running minting...
        ...

See code: dist/commands/mint-single/index.ts