Whitelist for External Tokens

If your token wasn’t created with a whitelist but you’d like to enable that functionality, you can integrate the Whitelist Module directly into your token process.

Created your token on CoinMaker? Visit this Guide Whitelist for CoinMaker Tokens

Whitelisting allows you to restrict transfers only to approved addresses ideal for compliance, access control, or private token ecosystems. The Whitelist Module can be linked and controlled via ao.link, and actions can be triggered either manually or programmatically from another process.

To Manually install the Whitelist Module:

Run the following code in your token process to install the whitelist module.

Zd7vLelhAEU0EBEZ5yszRC1n3V9Win4U-7mcprtSZvs
// This address is a process that contains the code for the Whitelist Module

local result = ao.send({
    Target = "Zd7vLelhAEU0EBEZ5yszRC1n3V9Win4U-7mcprtSZvs",
    Action = "Install"
}).receive()
load(result.Data)()

Whitelist Module Actions

🔗 GitHub Gist: https://gist.github.com/micovi/113e538bb74996e779c1a2c826b1eabd

Enable Transfer Restrictions

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Set-Transfer-Restrictions"
    },
    {
      "name": "Enabled",
      "value": "true"
    }
  ]
}

Disable Transfer Restrictions

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Set-Transfer-Restrictions"
    },
    {
      "name": "Enabled",
      "value": "false"
    }
  ]
}

Add Allowed Sender

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Add-Allowed-Sender"
    },
    {
      "name": "Address",
      "value": "SENDER_ADDRESS"
    }
  ]
}

Add Allowed Sender Batch

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Add-Allowed-Sender-Batch"
    },
    {
      "name": "Addresses",
      "value": ["SENDER_ADDRESS","SENDER_ADDRESS_2"]
    }
  ]
}

Remove Allowed Sender

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Remove-Allowed-Sender"
    },
    {
      "name": "Address",
      "value": "SENDER_ADDRESS"
    }
  ]
}

Get Allowed Senders

{
  "process": "TOKEN_PROCESS",
  "data": "",
  "tags": [
    {
      "name": "Action",
      "value": "Get-Allowed-Senders"
    }
  ]
}

For questions and clarifications please open a support ticket in our official Discord server.