https://github.com/dfstio/minanft-cli
Mina NFT CLI tool
https://github.com/dfstio/minanft-cli
cli mina-protocol nft offline
Last synced: 11 months ago
JSON representation
Mina NFT CLI tool
- Host: GitHub
- URL: https://github.com/dfstio/minanft-cli
- Owner: dfstio
- License: apache-2.0
- Created: 2023-07-27T10:58:27.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T15:06:00.000Z (about 2 years ago)
- Last Synced: 2024-05-15T13:38:05.530Z (about 2 years ago)
- Topics: cli, mina-protocol, nft, offline
- Language: TypeScript
- Homepage: https://minanft.io
- Size: 8.92 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mina NFT CLI tool
## Features
NEW: Rollup NFT support on Zeko network
```
rollup.blocks [options] Show information about the last 10 Rollup blocks
rollup.list List all Rollup NFT names
rollup.name Get the information about the Rollup NFT name
rollup.prove.keys [options] Prove Rollup NFT private values off-chain
rollup.prove.key [options] Prove Rollup NFT private value on-chain
verifier.deploy Deploy Rollup NFT verifier contract
verifier.upgrade Upgrade Rollup NFT verifier contract
```
- Reserve the NFT name using MinaNFT API (online mode) or frontend helper (offline mode)
- Create NFT locally (online mode) or locally with prepared in-advance IPFS or Arweave hashes (offline mode)
- Mint the NFT locally (online mode) or using frontend helper (offline mode)
- Add to the NFT during creation:
- Public or private key-value pairs
- Texts
- Text, PNG, Word or binary files
- Indexing new NFT for the frontend (online only)
- Creating the masks for redacting the text or png files
- Redact text files using regular expressions
- Redact text and png files using masks
- Creating and verifying proofs for texts and files
- Creating and verifying proofs for redacted text and png files
- Setting configuration:
- MinaNFT API JWT
- IPFS Pintata JWS
- Arweave key
- Encryption of user's data using user's password
- MINA accounts
- Creating MINA account
- Importing MINA account by using private or public key
- Checking account balance (online only)
- Exporting private and public keys of the account
## Installation
```sh
npm install -g minanft-cli
```
To confirm successful installation:
```sh
minanft --version
```
### Updating the MinaNFT CLI
```sh
npm update -g minanft-cli
```
## Development
You need to install node and git
and clone this repo
```
git clone https://github.com/dfstio/minanft-cli
cd minanft-cli
yarn
```
Make sure that minanft command is executable by running from the minanft-cli folder
```
chmod +x ./src/cli.ts
npm link
```
## Usage:
### minanft commands
```
Mina NFT CLI tool (c) DFST 2024 www.minanft.io
Usage: minanft [options] [command]
Mina NFT CLI tool
Options:
-V, --version output the version number
-p, --password password
-o, --offline offline mode
-d, --debug debug mode
-h, --help display help for command
Commands:
rollup.blocks [options] Show information about the last 10 Rollup blocks
rollup.list List all Rollup NFT names
rollup.name Get the information about the Rollup NFT name
rollup.prove.keys [options] Prove Rollup NFT private values off-chain
rollup.prove.key [options] Prove Rollup NFT private value on-chain
verifier.deploy Deploy Rollup NFT verifier contract
verifier.upgrade Upgrade Rollup NFT verifier contract
balance Check the balance of the existing MINA protocol account
createaccount [options] Create new MINA protocol account or import existing one
exportaccount Export existing MINA protocol account
reserve [account] Reserve NFT name
create [options] [owner] Create NFT
index Index NFT name for minanft.io frontend
prove [options] Prove NFT metadata
provefile [options] Prove NFT file
provetext [options] Prove NFT text
provepng [options] Prove NFT png image
verify Verify NFT metadata
verifyfile [options] Verify NFT file
verifytext Verify NFT redacted text file
verifypng Verify NFT redacted png file
mask Create or update file mask
redact [options] Create redacted file using mask
regexp Create redacted file using regular expression
redactedproof [options] Create redacted file proof
verifyredactedproof [options] Verify redacted file proof
jwt Set JWT token for the online MinaNFT API
exportjwt Export MinaNFT JWT token
word Convert word file to text
ipfs Set Pinata JWT token for the IPFS storage
arweave Set Arweave private key for the Arweave storage
changepassword Change password for existing file
help [command]
```
### create subcommands
```
Commands:
key [options] Add key-value pair to NFT
image [options] Add image to NFT
file [options] Add file to NFT
text [options] Add text to NFT
description Add description to NFT
help [command] display help for command
mint Mint NFT
exit Exit without minting
```
## Documentation
https://docs.minanft.io
## MinaNFT CLI tool repo
https://github.com/dfstio/minanft-cli
## Website
https://minanft.io
## Library
https://www.npmjs.com/package/minanft
## Faucet
https://faucet.minaprotocol.com