Smart Contract | Extensions Improving the base functionalities of smart contract standards with Extensions.
Swagger Doc | ReDoc
Pausable
Pause token transfers, minting and burning.
Get pausable state of the smart contract.
Curl
Copy curl -X GET "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/paused" \
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
Pause smart contract
Curl
Copy curl -X POST "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/pause" \
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI
contract
: smart contract address
Unpause smart contract
Curl
Copy curl -X POST "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/unpause" -H
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
Burnable
Pause token burning.
Get burnable state of the smart contract.
Curl
Copy curl -X GET "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/burnable"
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
Activate/Deactivate burnable feature.
Curl Request body details
Copy curl -X POST "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/burnable" \
-H "Content-Type: application/json" \
-d '{"burnable":false}'
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
burnable
: [boolean] set to true
if you want to activate the burn token feature and false
if not.
Burn an NFT token.
Curl
Copy curl -X DELETE "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/token/1"
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
token
: token ID
Update NFT metadata
Curl Request body details
Copy curl -X PUT "http://0.0.0.0:7000/nftkit/nft/extensions/chain/MUMBAI/contract/0xf277BE034881eE38A9b270E5b6C5c6f333Af2517/token/1/tokenURI?signedAccount=0x6E7448a6335d5C947953994d071D4Dc1F6e5BE96" \
-H "Content-Type: application/json" \
-d '{"metadataUri":"string","metadata":{"description":"string","name":"string","image":"string","image_data":"string","external_url":"string","attributes":[{"trait_type":"string","value":"string"}]}}'
chain
: chain to work with.
Main chains: ETHEREUM, POLYGON
Testnet chains: SEPOLIA, GOERLI, MUMBAI, SHIMMEREVM
contract
: smart contract address
token
: token ID
signedAccount
: the account used to sign the transaction.
Copy {
"metadataUri" : "string" ,
"metadata" : {
"description" : "string" ,
"name" : "string" ,
"image" : "string" ,
"image_data" : "string" ,
"external_url" : "string" ,
"attributes" : [
{
"trait_type" : "string" ,
"value" : "string"
}
]
}
metadataUri
: [string] metadata URI of the token.If you want to generate metadata URI using NFT KIT, set the "metadataUri "value as an empty string.
metadata
: NFT KIT will use values inside metadata to generate metadata URI of the token. It confirms the structure defined by ERC721 and ERC1155 standards. For more details about NFT metadata standard .
description
: [string] a description of the token
name
: [string] the name of this specific token
image
: [string] this is the URL to the image of the item. Can be just about any type of image and can be IPFS URLs or paths.
image_data
: [string] Raw SVG image data, if you want to generate images on the fly (not recommended). Only use this if you're not including the image parameter.
external_url
: [string] This is the URL that will appear below the asset's image on OpenSea and will allow users to leave OpenSea and view the item on your site.
attributes
: [string] To give your items a little more pizazz, we also allow you to add custom "attributes" to your metadata that will show up underneath each of your assets.
trait_type
: [string] the name of the trait
value
: [string] the value of the trait