1.0.4 • Published 2 years ago
@nekoproject/nfts v1.0.4
@nekoproject/tokens
A complete crypto wallet base support for cross-chain
Table of contents
Build
Re-build project from scratch
- Clean project
npm run clean
- Build
npm run build
- Unit test
```bash npm run test:cover ```
Install
Install@nekoproject/nft
withnpm
Importnpm i @nekoproject/nft
import { NFT, NFTToken } from '@nekoproject/nft'
Documents
Create new Token instant
import { SPLNetwork } from '@nekoproject/networks';
const nfttokenConfig: NFTTokenInfo = {
mintAddress: 'mint address'
}
const config = {
rpcUrl: 'rpc URL',
explorer: 'https://solscan.io',
}
let network: Network;
let nft: NFT;
network = new SPLNetwork(config)
nft = new NFTToken(network, nfttokenConfig)
Token methods
Mint NFT
/**
* Static method mint an NFT
* @param mintNFTOrder: type `MintNFTOrder`
* @param wallet: wallet
* @param network: Network
* @returns : NFTToken instant
*/
const order = {
uri: 'uri URL',
maxSupply: 1
}
const nft = await NFTToken.mintNFT(network, wallet, order)
Create transaction Order
/**
* Instant method create transaction order
* @param order: NFTOrderRequest
* @returns : NFTTransferOrder
*/
const order: NFTOrderRequest = {
from: 'address',
to: 'address',
amount: '1'
}
const transactionOrder = await nft.createTransferOrder(order)
Transfer Token
/**
* Instant method transfer NFT
* @param transactionOrder: NFTTransferOrder
* @param wallet : Wallet
* @returns : signature
*/
const signature = await nft.transfer(wallet, transactionOrder)
Get information
/**
* Instant method get all information about NFT
* @param
* @returns : NFTTokenInfo
*/
const info = await nft.getInfo()
Get NFT Owner
static method
/**
* Static method get owner of NFT
* @param network: Network
* @param mintAddress: mint address
* @returns : Address of owner's NFT
*/
const owner = await NFTToken.getNFTOwner(network, mintAddress)
Instant method
/**
* Instant method get owner of NFT
* @returns : Address of owner's NFT
*/
const owner = await nft.getNFTOwner()
Get NFT Mint Address
/**
* Static method get mint address by candy machine Id (first creator address) using candy machine v2
* @NOTICE: this version is unstable, use late when new update release
* @param network: Network
* @param candyMachineId: candy machine id
* @returns : new instant of NFTToken with gotten mint address
*/
const nft = await NFTToken.getNFTMintAddress(network, candyMachineId)
Get All NFT
/**
* Static method get all NFT in wallet
* @param network: Network
* @param walletAddress: address of wallet to get all nft
* @returns : list of `NFTToken instant` in wallet
*/
const nftToken = await nft.getAllNFT(network, walletAddress)