Request Custom NFT Contract Deployment

post

https://api.testnet.octet.im/2.0/wallets/{walletIdx}/nfts/contracts/custom-deployments

Requests deployment of a custom NFT contract. Returns the uuid of the deployment transaction upon success.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

walletIdx

number

required

Wallet index

Body Params

requestId

string

required

Unique ID that can be specified when submitting the request. The request fails if a request with the same requestId already exists.

encryptedUserKey

string

User key encrypted with the RSA public key. Required when the key management type of the main address is co-managed (HEXLANT_MULTISIG) and the operation is signed by the main address. Not used for operations performed from a child address (e.g. NFT withdrawal from a child address).
The RSA public key is available in the developer tools of the Octet console.

nftTransactionMemo

string

Description that can be entered with the request. It is not recorded on the blockchain; it is stored only in Octet’s database.

useFeeDelegation

boolean

Whether to create a fee-delegated transaction. If true, the wallet’s fee address pays the transaction fee. Applies only to platforms that support fee delegation (e.g. Kaia).

contractSpec

string

enum

required

Type of the NFT contract to deploy. Custom NFT deployment currently supports only the Ethereum spec.
Ethereum: ERC721, ERC1155
Kaia: KIP17, KIP37

Allowed:

contractName

string

required

length ≤ 40

Name of the NFT contract (max 40 characters)
The request fails if a contract with the same name and token symbol already exists.

tokenSymbol

string

required

length ≤ 10

NFT symbol (max 10 characters)
The request fails if a contract with the same name and token symbol already exists.

baseUri

string

length ≤ 150

Base URI that determines the tokenUri of NFTs (max 150 characters)
Optional for ERC721 and required for ERC1155.
When minting NFTs through Octet, the URI must end with /.
The tokenUri is then base URI + tokenId.
Example)
baseUri: ipfs://HEXLANT/
tokenId: 1
=> tokenUri: ipfs://HEXLANT/1

nftIconUrl

string

Image URL of the NFT symbol

nftRoleSystem

string

enum

required

Determines the permission system of the contract.

ownable: The admin holds all permissions.
roles: Permissions can be separated per feature.

Allowed:

nftFeatures

array of strings

required

NFT features to enable.

BURNABLE: NFT owners can burn their own NFTs.
OWNER_BURNABLE: The admin can burn specific NFTs.
PAUSABLE: The admin can pause the contract.
MINTABLE: The admin can mint NFTs. When this option is not enabled, NFT items cannot be minted.
AIRDROP: The admin can mint the same kind of NFT to multiple addresses. Octet does not currently support calling this method.
ENUMERABLE: The full list of NFTs can be checked on the blockchain. Supported only in the ERC721 spec.
URI_STORAGE: A URI is provided and linked to each NFT when it is minted. Supported only in the ERC721 spec.
INCREMENTAL: NFT item numbers are assigned sequentially starting from 0. tokenId is not entered when minting NFT items. Supported only in the ERC721 spec.
SUPPLY: The total minted amount per tokenId can be checked. Supported only in the ERC1155 spec.
UPDATABLE_URI: The admin can update the URI. Supported only in the ERC1155 spec.

nftFeatures*

senderAddress

string

required

Sending address. Must be an address in the wallet.
Wallets of the Centralized type (CENTRALIZED) cannot use a child address as the senderAddress.

string

PIN of the sending address. Required if the sending address is a child address that uses a PIN.

Headers

Authorization

string

required

Defaults to Bearer

API token

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success