Create whitelisted contracts

post

https://your-protect-instance.example.com/api/rest/v1/whitelists/contracts

This endpoint creates a new whitelisted contracts.
For ETH, tokenId is left empty
For XTZ, tokenId is left empty for FA1.2 tokens and must have a value for FA2 tokens
For ALGO, we either need a tokenId which is the assetId for algorand, or we need a contractAddress (creator address) and a symbol (unit name), which will be used to identify the asset.
For XLM, we need a valid contractAddress (Stellar address) and tokenId (Stellar asset code).For ICP, we need a valid contractAddress (valid ICP principal).Required role: WhitelistedAddressCreator.

Body Params

blockchain

string

required

Symbol of the blockchain on which to whitelist a contract. Examples: BTC, ADA, SOL ...

contractAddress

string

Address of the smart contract.
For ALGO standard assets, this is the address of the creator of the asset.

For XLM, this is the Stellar address.

For ICP, this is the ICP principal.

symbol

string

required

Symbol of the token.
For ALGO it is the unit name of the standard asset.

name

string

Name for the contract.

decimals

string

Number of decimal places to consider as minimum unit of transfer.

tokenId

string

Unused for ETH and Polygon.
For XTZ, this is used to create a FA2 token.
For ALGO standard assets, this is the globally unique asset id.

kind

string

Examples: "" (default), "NFT_AUTO", "NFT_XTZ_FA2", "NFT_EVM_ERC721", "NFT_EVM_ERC1155", "SOL_TOKEN", "SOL_TOKEN2022", "NFT_EVM_CRYPTOPUNKS"

network

string

Name of the blockchain network, eg. mainnet, testnet, or sepolia.

vaultProvider

string

The provider of a vault contract. The only supported value is "morpho".

Responses

Language

Loading…

Response

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

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.