LogoLogo
Return 🡥
  • Welcome
  • General
    • Overview
    • About AO
  • Learn
    • Concepts
      • Products Overview
      • Agents Architecture
    • User Guides
      • Setting Up a Wallet
      • Funding on AO
      • AO Tutorials
      • How to Create a Dapp
      • Whitelist for External Tokens
      • Batch Tranfers for Tokens
      • Fair Launch Process
        • Introduction to Fair Launch on AO
        • Creating a Fair Launch Process
        • Managing your Fair Launch Process
    • Research
  • Products
    • Platforms
      • Botega
        • Market Making Models
          • AMM V2
          • AMM V3
          • Orderbook
          • Fees
        • Swap Assets & Run Agents
          • How to do a simple Swap
          • Limit Orders (Agents)
          • DCA Dollar Cost Averaging (Agents)
          • Stop Loss Order (Agents)
          • My Account
        • Botega Pools
          • Create a New Pool
          • Add & Remove Liquidity on an Existing Pool
          • Managing LP Pools and Stats
        • Botega Tokenomics
          • Protocol Mechanics of the $BOTG Token
          • Earn $BOTG by Delegating Your Yield
          • FAQs
      • Dexi
        • Platform Architecture
        • Dexi Terminal
        • Agent Data-Streams Subscription
        • Create Autonomous Agents
          • 📊 Portfolio Agent
          • 🔢Agent Index
        • Subscribe to Liquidity Pools
      • CoinMaker
        • Create Coins
        • Add Liquidity and make your Asset Tradable
        • Listing your Pool on Dexi
        • Locking Liquidity
        • Updating Token Info
        • Whitelist for CoinMaker Tokens
        • Renounce Token Ownership
        • Bonding Curve
      • DataOS
    • Ecosystem Tooling
      • Ownable
      • Process Testing
      • Subscribable
      • AO Form
      • AO Teal
      • AO Link
      • Coin Burn
  • Resources
    • Media Kit
    • Links
  • Core Financial Infrastructure
    • Permanent Index (PI)
Powered by GitBook
On this page
  • Whitelist Module Actions
  • Enable Transfer Restrictions
  • Disable Transfer Restrictions
  • Add Allowed Sender
  • Add Allowed Sender Batch
  • Remove Allowed Sender
  • Get Allowed Senders

Was this helpful?

  1. Learn
  2. User Guides

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.

PreviousHow to Create a DappNextBatch Tranfers for Tokens

Last updated 28 days ago

Was this helpful?

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:

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.

https://gist.github.com/micovi/113e538bb74996e779c1a2c826b1eabd