Contract

The contract API provide users the entries to interact with the ERC721 contracts, including deploying the contracts, setting the sponsors and so on.

Contract Actions

Deploy Contract

The Deploy contract API helps users to deploy a ERC721 or a ERC1155 contract.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Type	Required	Default
name	The name of the NFT	body	string
symbol	The symbol of the NFT	body	string
owner_address	The creater of the contract	body	string
type	The type of the contract, e.g., erc721, erc1155	body	string
base_uri	The uri of the NFT. For ERC721 contract, the token_uri is the base_uri. For ERC1155 contract, the token_uri is the base_uri/ token_id. During minting, if the metadata_uri is not null, the base_uri will be ignored.	body	string		null string
chain	The chain type, which can be conflux or conflux_test	body	string
royalties_bps	The price of the royalties. When a transferring happens, the projector or creator of the NFT can obtain from the transaction.	body	integer		0
royalties_address	The address of the beneficiary. When a transaferring happens, this address can obtain from the transaction.	body	string		The owner of the contract
tokens_burnable	Whether the function of burning tokens by the token owner is supported	body	bool		false
tokens_transferable_by_admin	Whether the function of transferring tokens by the contract admin is supported	body	bool		false
tokens_transferable_by_user	Whether the function of transferring tokens by contract user is supported	body	bool		false
transfer_cooldown_time	The cooldown time of transfering tokens. Once a transfer transaction is confirmed, the cooldown time must pass before the transfer transaction can be proposed again.	body	integer		false
is_sponsor_for_all_user	Whether the contract can be called by all users free. If the function opens, all uesrs can call the contract free.	body	bool
auto_sponsor	Whether auto set sponsor for new created contract	body	bool		true

Parameter Example

 {
    "chain": "conflux_test",
    "name": "NFT-name",
    "symbol": "ENFT",
    "owner_address": "cfxtest:aatk708nbb7573bkwumsu00h0r1rtkcdz2chwhttzk",
    "type": "erc721",
    "base_uri": "",
    "royalties_bps": 0,
    "royalties_address": "",
    "tokens_burnable": false,
    "tokens_transferable_by_admin": false,
    "tokens_transferable_by_user": false,
    "transfer_cooldown_time": 0,
    "is_sponsor_for_all_user": false
}

Response

Name	Meaning	Type
created_at	The time of creating the item in the database	string
updated_at	The time of updating the item in the database	string
deleted_at	The time of deleting the item in the database	string
id	The id of the item in the database, which can be used to query detail contract	integer
app_id	The id of the app	integer
chain_id	The id of the chain. 1029-mainnet, 1-testnet	integer
chain_type	The type of the chain. 1-CFX, 2-ETH	integer
name	The name of the NFT	string
symbol	The symbol of the NFT	string
owner_address	The admin of the contract	string
type	The type of the contract, e.g., erc721, erc1155	string
base_uri	The uri of the NFT. For ERC721 contract, the token_uri is the base_uri. For ERC1155 contract, the token_uri is the base_uri/ token_id. During minting, if the metadata_uri is not null, the base_uri will be ignored.	string
address	The address of the contract. The response will be null after calling this interface. After several seconds, it can call query contract according to the id.	string
royalties_bps	The price of the royalties. When a transferring happens, the projector or creator of the NFT can obtain from the transaction.	integer
royalties_address	The address of the beneficiary. When a transaferring happens, this address can obtain from the transaction.	string
tokens_burnable	Whether the function of burning tokens by the token owner is supported	bool
tokens_transferable_by_admin	Whether the function of transferring tokens by the contract admin is supported	bool
tokens_transferable_by_user	Whether the function of transferring tokens by contract user is supported	bool
transfer_cooldown_time	The cooldown time of transfering tokens. Once a transfer transaction is confirmed, the cooldown time must pass before the transfer transaction can be proposed again.	integer
status	The status of the transaction. 0-pending, 1-success, 2-failed. The response will be 0 after calling this interface. After several seconds, it can call query contract according to the id.	integer
tx_id	The id of the transaction	integer
hash	The hash of the transaction. The response will be null after calling this interface. After several seconds, it can call query contract according to the id.	string

Response Example

{
    "id": 20,
    "created_at": "2022-08-22T15:49:42.46+08:00",
    "updated_at": "2022-08-22T15:49:42.46+08:00",
    "deleted_at": null,
    "app_id": 4,
    "chain_type": 1,
    "chain_id": 1,
    "address": "",
    "owner_address": "cfxtest:aajb342mw5kzad6pjjkdz0wxx0tr54nfwpbu6yaj49",
    "type": 1,
    "base_uri": "",
    "name": "NFT-name",
    "symbol": "ENFT",
    "royalties_bps": 0,
    "royalties_address": "cfxtest:aajb342mw5kzad6pjjkdz0wxx0tr54nfwpbu6yaj49",
    "tokens_burnable": false,
    "tokens_transferable_by_admin": false,
    "tokens_transferable_by_user": false,
    "transfer_cooldown_time": 0,
    "hash": "",
    "tx_id": 64,
    "status": 0
}

Request Sample

curl --request POST \
  --url https://api.nftrainbow.cn/v1/contracts/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \
  --data-raw ' {
    "chain": "conflux_test",
    "name": "NFT-name",
    "symbol": "ENFT",
    "owner_address": "cfxtest:aatk708nbb7573bkwumsu00h0r1rtkcdz2chwhttzk",
    "type": "erc721",
    "base_uri": "",
    "royalties_bps": 0,
    "royalties_address": "",
    "tokens_burnable": false,
    "tokens_transferable_by_admin": false,
    "tokens_transferable_by_user": false,
    "transfer_cooldown_time": 0
}'

When the API is called successfully, we need to use the id in response to call Query contract detail API to get the contract address. It takes several seconds that the contract address can be obtained from Query contract detail API.

Update contract admin

The Update contract admin API provides users the entry to update the admin of the specific contract.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the contract	Path	string
admin_address	The address of the admin	body	string

Response

Name	Meaning	Type
tx_id	The id of the transaction	integer

Response Example

{
  "tx_id": 421312
}

Request Sample

curl --request PUT \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/admin \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Set Sponsor

Good to know: Conflux provides users the sponsor function. Once a contract is sponsored by an account, the accounts in the contract white list can call this contracts for free.

The Set sponsor API provides users to set a sponser for a specific contract according to the sponsor' address.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the contract	Path	string
chain	The blockchain name: conflux, conflux_test(default)	query	string
auto_sponsor	Whether auto recharge sponsor balance when not enough	query	bool

Response

Name	Meaning	Type
sponsor_gas_tx_id	The id of the sponsor gas setting transaction. gas is used for contract running.	integer
sponsor_collateral_tx_i	The id of the sponsor storage setting transaction. collateral is presented for storage.	integer

Response Example

{
    "sponsor_gas_tx_id": 8475,
    "sponsor_collateral_tx_id": 8476
}

Requst Sample

curl --request POST \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/sponsor \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Note: UP to now, Set sponsor API can only be called by users free in testnet. In mainnet, Users need to recharge their own wallet.

Add Contract Sponsor Users

The Add Contract Sponsor Users API provides users to add the address in the whitelist.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
users	The addresses being added into the whitelist	body	[]string
address	The address of the contract	Path	string

Response

Name	Meaning	Type
tx_id	The id of the transaction	integer

Response Example

{
  "tx_id": 421312
}

Requst Sample

curl --request POST \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/sponsor/whitelist/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \
  --data-raw `["cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8"]`

Remove Contract Sponsor Users

The Remove Contract Sponsor Users API provides users to remove the address from the whitelist.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the contract	Path	string

Response

Name	Meaning	Type
tx_id	The id of the transaction	integer

Response Example

{
  "tx_id": 421312
}

Requst Sample

curl --request DELETE \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/sponsor/whitelist/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json' \
  --data-raw `["cfxtest:aam1eawbm9pzp0dnwv96tts5shnbdfv9nuwu7zgzz8"]`
  

Query Informations

Obtain Contract List

The Obtain contarct list API provides users the entry to get the inforamtion of the contracts deployed in a specified app. The parameter page and size are optional parameters.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required	Default
page	Page Query	query	integer		1
limit	Page Query	query	integer		10

Response

Name	Meaning	Type
count	The number of the deployed contracts	integer
items	The contract information	[]Contract

The Contract Struct is listed as follow:

Name	Meaning	Type
created_at	The time of creating the item in the database	string
updated_at	The time of updating the item in the database	string
deleted_at	The time of deleting the item in the database	string
id	The id of the item in the database	integer
app_id	The id of the app	integer
chain_id	The id of the chain. 1029-mainnet, 1-testnet	integer
chain_type	The type of the chain. 1-CFX, 2-ETH	integer
name	The name of the NFT	string
symbol	The symbol of the NFT	string
owner_address	The admin of the contract	string
type	The type of the contract, e.g., erc721, erc1155	string
base_uri	The uri of the NFT. For ERC721 contract, the token_uri is the base_uri. For ERC1155 contract, the token_uri is the base_uri/ token_id. During minting, if the metadata_uri is not null, the base_uri will be ignored.	string
address	The address of the contract	string
royalties_bps	The price of the royalties. When a transferring happens, the projector or creator of the NFT can obtain from the transaction.	integer
royalties_address	The address of the beneficiary. When a transaferring happens, this address can obtain from the transaction.	string
tokens_burnable	Whether the function of burning tokens by the token owner is supported	bool
tokens_transferable_by_admin	Whether the function of transferring tokens by the contract admin is supported	bool
tokens_transferable_by_user	Whether the function of transferring tokens by contract user is supported	bool
transfer_cooldown_time	The cooldown time of transfering tokens. Once a transfer transaction is confirmed, the cooldown time must pass before the transfer transaction can be proposed again.	integer
status	The status of the transaction. 0-pending, 1-success, 2-failed	integer
tx_id	The id of the transaction	integer
hash	The hash of the transaction	string

Response Example

{
        "count": 1,
        "items": [
            {
                "id": 1,
                "created_at": "2022-08-19T10:48:13.049+08:00",
                "updated_at": "2022-08-19T10:49:15.853+08:00",
                "deleted_at": null,
                "app_id": 4,
                "chain_type": 1,
                "chain_id": 1,
                "address": "cfxtest:acdzrjc92rds9tuta8rdkx3mn10yzf0jny1z3s0s8e",
                "owner_address": "cfxtest:aajb342mw5kzad6pjjkdz0wxx0tr54nfwpbu6yaj49",
                "type": 1,
                "base_uri": "",
                "name": "ttt",
                "symbol": "test",
                "royalties_bps": 0,
                "royalties_address": "",
                "tokens_burnable": false,
               "tokens_transferable_by_admin": false,
                "tokens_transferable_by_user": false,
                "transfer_cooldown_time": 0,
                "hash": "0xcbcedb27eb941a9a4fb6008d343055d98d9fe1ccdba65268680f46af6bf3fa0a",
                "tx_id": 49,
                "status": 1
            }
        ]
    }

Request Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/contracts/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Query detail contract

The Query detail contract API provides users the entry to get the detail contract information of a specific contract according to the contract's id. The parameter chain is optional, which can be used to choose the test or main network of conflux.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
id	The id of the contract	Path	integer

Response

Name	Meaning	Type
created_at	The time of creating the item in the database	string
updated_at	The time of updating the item in the database	string
deleted_at	The time of deleting the item in the database	string
id	The id of the item in the database	integer
app_id	The id of the app	integer
chain_id	The id of the chain. 1029-mainnet, 1-testnet	integer
chain_type	The type of the chain. 1-CFX, 2-ETH	integer
name	The name of the NFT	string
symbol	The symbol of the NFT	string
owner_address	The admin of the contract	string
type	The type of the contract, e.g., erc721, erc1155	string
base_uri	The uri of the NFT. For ERC721 contract, the token_uri is the base_uri. For ERC1155 contract, the token_uri is the base_uri/ token_id. During minting, if the metadata_uri is not null, the base_uri will be ignored.	string
address	The address of the contract.	string
royalties_bps	The price of the royalties. When a transferring happens, the projector or creator of the NFT can obtain from the transaction.	integer
royalties_address	The address of the beneficiary. When a transaferring happens, this address can obtain from the transaction.	string
tokens_burnable	Whether the function of burning tokens by the token owner is supported	bool
tokens_transferable_by_admin	Whether the function of transferring tokens by the contract admin is supported	bool
tokens_transferable_by_user	Whether the function of transferring tokens by contract user is supported	bool
transfer_cooldown_time	The cooldown time of transfering tokens. Once a transfer transaction is confirmed, the cooldown time must pass before the transfer transaction can be proposed again.	integer
status	The status of the transaction. 0-pending, 1-success, 2-failed	integer
tx_id	The id of the transaction	integer
hash	The hash of the transaction	string

Response Example

{
    "id": 10,
    "created_at": "2022-08-19T10:48:13.049+08:00",
    "updated_at": "2022-08-19T10:49:15.853+08:00",
    "deleted_at": null,
    "app_id": 4,
    "chain_type": 1,
    "chain_id": 1,
    "address": "cfxtest:acdzrjc92rds9tuta8rdkx3mn10yzf0jny1z3s0s8e",
    "owner_address": "cfxtest:aajb342mw5kzad6pjjkdz0wxx0tr54nfwpbu6yaj49",
    "type": 1,
    "base_uri": "",
    "name": "ttt",
    "symbol": "test",
    "royalties_bps": 0,
    "royalties_address": "",
    "tokens_burnable": false,
    "tokens_transferable_by_admin": false,
    "tokens_transferable_by_user": false,
    "transfer_cooldown_time": 0,
    "hash": "0xcbcedb27eb941a9a4fb6008d343055d98d9fe1ccdba65268680f46af6bf3fa0a",
    "tx_id": 49,
    "status": 1
}

Request Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/contracts/detail/{id} \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Query Sponsor

The Query sponsor API provides users the entry to get the sponsors of a specific contract according to the contract's address. The parameter chain is optional, which can be used to choose the test or main network of conflux.

Good to know: Conflux Network can be divided into the main network and the test network. The later is used to test the developed functions for developers.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the sponsor	Path	string
chain	The chain type, which can be conflux or conflux_test	query	string

Response

Name	Meaning	Type
collateral_sponsor	The address of the collateral sponsor	string
collateral_sponsor_balance	The balance of the collateral sponsor	integer
gas_sponsor	The address of the gas sponsor	string
gas_sponsor_balance	The balance of the gas sponsor	integer
gas_upper_bound	The upper bound of using gas	integer
is_all_white_listed	wheter the sponsor in the all white list	bool

Response Example

{
        "gas_sponsor": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
        "gas_sponsor_balance": 10000000000000000000,
        "collateral_sponsor": "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0",
        "collateral_sponsor_balance": 100000000000000000000,
        "is_all_white_listed": true,
        "gas_upper_bound": 5000000000000000
}

Request Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/sponsor \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Good to know: For more detailed information, please refer to the following link.

Internal Contract | Conflux

SponsorWhitelistControl Contract

Query contract admin

The Query contract admin API provides users the entry to get the admin of the specific contract.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the contract	Path	string

Response Example

{
  "cfxtest:aasr1hmezez1wepvh8ew8sk9p40khhhj1ymxwmpaf0"
}

Request Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/admin \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Query Contract Whitelist

The Query Contract Whitelist API provides users to get the whitelist of the specific contract. Only the addresses in the whitelist can call the contract free.

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.0

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Name	Meaning	Param Type	Data Type	Required
address	The address of the contract	Path	string

Response

Return the slices of the addresses in the whiltelist.

Response Example

["cfxtest:acexyjf36ddwcct171wr1k5srd289zp9te70p67zc1"]

Requst Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/contracts/{address}/sponsor/whitelist/ \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'