Whitelist Proxy Contracts

Authorize your DApp User's Proxy Contracts

If you have implemented native meta transactions via external contract wallet approach like Gnosis or Argent, you need to whitelist all proxy contracts registered in your DApp before using meta transaction APIs.

This guide will help you whitelist, list and update the status of the whitelisted proxy contracts.

Before using this API, make sure you have generated an access token from the dashboard which is visible in you View DApp section on dashboard.

/api/v1/dapp/whitelist/proxy-contracts

POST https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts

Whitelist proxy addresses. Only whitelisted proxy addresses will be authorized to do meta transactions.

Headers

Name	Type	Description
Authorization	string	Token present on the dashboard for your DApp after you have generated token. This is specific to DApp registered and should be in the format "User <token generated>"

Request Body

Name	Type	Description
addresses	array	An array of proxy contract addresses for whitelisting for your dapp.

200 Proxy contracts whitelisted successfully.

{
    "code": 200,
    "message": "Proxy contracts whitelisted successfully"
}

400 No proxy address found in the request

{
    "code": 400,
    "message": "No proxy address found in the request"
}

401 Invalid/missing dapp token in request

{
    "code": 401,
    "message": "Token is required in the request header"
}

/api/v1/dapp/whitelist/proxy-contracts

GET https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts

Get a list of whitelisted proxy contracts.

Headers

Name	Type	Description
Authorization	string	Token present on the dashboard for your Dapp after you have generated token. It should be in the format "User <token generated>"

200 Proxy addresses fetched successfully.

{
    "code": 200,
    "message": "Proxy addresses fetched successfully",
    "total": 5,
    "addresses": [ {
        address : "",
        status : true
    } ]
}

401 Invalid/ missing dapp token in the request

{
    "code": 401,
    "message": "Token is required in the request header"
}

/api/v1/dapp/whitelist/proxy-contracts

PATCH https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts

Make your proxy contracts status active or inactive via this api. Only active proxy contracts will be allowed to relay meta transactions.

Headers

Name	Type	Description
Authorization	string	Token present on the dashboard for your Dapp after you have generated token. This is specific to DApp registered and should be in the format "User <token generated>"

Request Body

Name	Type	Description
status	boolean	Either 0 or 1. 0 => Inactive 1 => active
address	string	Address for changing the status.

200 Address status updated successfully

{
    "code": 200,
    "message": "Address status updated successfully"
}

400 Either invalid address format or invalid status parameter

{
    "code": 400,
    "message": "Contract address format is invalid"
}

or 

{
    "code": 400,
    "message": "Address status should be a number of either 0 or 1"
}

401 Invalid / missing dapp token in the request.

{
    "code": 401,
    "message": "Token is required in the request header"
}

404 Contract address does exist.

{
    "code": 404,
    "message": "Contract address does not exist"
}