The ARC1 standard contains the following modules:
The core module should be present on all fungible token contracts.
The other modules are optional. You can add them to your contract if you need the functionality they provide.
-- Type check
-- @type internal
-- @param x variable to check
-- @param t (string) expected type
local function _typecheck(x, t) end
-- Call this at constructor
-- @type internal
-- @param name (string) name of this token
-- @param symbol (string) symbol of this token
-- @param decimals (number) decimals of this token
local function _init(name, symbol, decimals)
-- Get a token name
-- @type query
-- @return (string) name of this token
function name()
-- Get a token symbol
-- @type query
-- @return (string) symbol of this token
function symbol()
-- Get a token decimals
-- @type query
-- @return (number) decimals of this token
function decimals()
-- Get a balance of an account
-- @type query
-- @param owner (address)
-- @return (ubig) balance of owner
function balanceOf(owner)
-- Get total supply
-- @type query
-- @return (ubig) total supply of this token
function totalSupply()
-- Hook "tokensReceived" function on the recipient after a 'transfer'
-- @type internal
-- @param from (address) sender's address
-- @param to (address) recipient's address
-- @param amount (ubig) amount of token to send
-- @param ... additional data, is sent unaltered in call to 'tokensReceived' on 'to'
-- @return value returned from 'tokensReceived' callback, or nil
local function _callTokensReceived(from, to, amount, ...)
-- Transfer tokens from an account to another
-- @type internal
-- @param from (address) sender's address
-- @param to (address) recipient's address
-- @param amount (ubig) amount of token to send
-- @param ... additional data, is sent unaltered in call to 'tokensReceived' on 'to'
-- @return value returned from 'tokensReceived' callback, or nil
local function _transfer(from, to, amount, ...)
-- Mint new tokens to an account
-- @type internal
-- @param to (address) recipient's address
-- @param amount (ubig) amount of tokens to mint
-- @return value returned from 'tokensReceived' callback, or nil
local function _mint(to, amount, ...)
-- Burn tokens from an account
-- @type internal
-- @param from (address)
-- @param amount (ubig) amount of tokens to burn
local function _burn(from, amount)
-- Transfer tokens to an account (from TX sender)
-- @type call
-- @param to (address) recipient's address
-- @param amount (ubig) amount of tokens to send
-- @param ... additional data, is sent unaltered in call to 'tokensReceived' on 'to'
-- @return value returned from 'tokensReceived' callback, or nil
-- @event transfer(from, to, amount)
function transfer(to, amount, ...)-- Burn tokens (from TX sender)
-- @type call
-- @param amount (ubig) amount of tokens to burn
-- @event burn(from, amount)
function burn(amount)
-- Burn tokens from an account, Tx sender have to be approved to spend from the account
-- This function can only be used if the All Approval extension is included
-- @type call
-- @param from (address) address of the account from which the tokens will be burn
-- @param amount (ubig) amount of tokens to burn
-- @event burn(from, amount, operator)
function burnFrom(from, amount)
-- Burn tokens from an account using the allowance mechanism
-- This function can only be used if the Limited Approval extension is included
-- @type call
-- @param from (address) address of the account from which the tokens will be burn
-- @param amount (ubig) amount of tokens to burn
-- @event burn(from, amount, operator)
function limitedBurnFrom(from, amount)-- set Max Supply
-- @type internal
-- @param amount (ubig) amount of tokens to mint
local function _setMaxSupply(amount)
-- Indicate if an account is a minter
-- @type query
-- @param account (address)
-- @return (bool) true/false
function isMinter(account)
-- Add an account to minters
-- @type call
-- @param account (address)
-- @event addMinter(account)
function addMinter(account)
-- Remove an account from minters
-- @type call
-- @param account (address)
-- @event removeMinter(account)
function removeMinter(account)
-- Renounce the Minter Role of TX sender
-- @type call
-- @event removeMinter(TX sender)
function renounceMinter()
-- Mint new tokens at an account
-- @type call
-- @param account (address) recipient's address
-- @param amount (ubig) amount of tokens to mint
-- @return value returned from 'tokensReceived' callback, or nil
-- @event mint(account, amount)
function mint(account, amount)
-- return Max Supply
-- @type query
-- @return amount (ubig) amount of tokens to mint
function maxSupply()
-- Indicate an account has the Pauser Role
-- @type query
-- @param account (address)
-- @return (bool) true/false
function isPauser(account)
-- Grant the Pauser Role to an account
-- @type call
-- @param account (address)
-- @event addPauser(account)
function addPauser(account)
-- Remove the Pauser Role form an account
-- @type call
-- @param account (address)
-- @event removePauser(account)
function removePauser(account)
-- Renounce the graned Pauser Role of TX sender
-- @type call
-- @event removePauser(TX sender)
function renouncePauser()
-- Indecate if the contract is paused
-- @type query
-- @return (bool) true/false
function paused()
-- Trigger stopped state
-- @type call
-- @event pause(TX sender)
function pause()
-- Return to normal state
-- @type call
-- @event unpause(TX sender)
function unpause()-- Indicate the allowance from an account to another
-- @type query
-- @param owner (address) owner's address
-- @param operator (address) allowed address
-- @return (bool) true/false
function isApprovedForAll(owner, operator)
-- Allow an account to use all TX sender's tokens
-- @type call
-- @param operator (address) operator's address
-- @param approved (boolean) true/false
-- @event setApprovalForAll(TX sender, operator, approved)
function setApprovalForAll(operator, approved)
-- Transfer tokens from an account to another, Tx sender have to be approved to spend from the account
-- @type call
-- @param from (address) sender's address
-- @param to (address) recipient's address
-- @param amount (ubig) amount of tokens to send
-- @param ... additional data, is sent unaltered in call to 'tokensReceived' on 'to'
-- @return value returned from 'tokensReceived' callback, or nil
-- @event transfer(from, to, amount, operator)
function transferFrom(from, to, amount, ...)
-- Burn tokens from an account, Tx sender have to be approved to spend from the account
-- This function can only be used if the Burnable extension is included
-- @type call
-- @param from (address) address of the account from which the tokens will be burn
-- @param amount (ubig) amount of tokens to burn
-- @event burn(from, amount, operator)
function burnFrom(from, amount)-- Approve an account to spend the specified amount of Tx sender's tokens
-- @type call
-- @param operator (address) operator's address
-- @param amount (ubig) amount of allowed tokens
-- @event approve(owner, operator, amount)
function approve(operator, amount)
-- Increase the amount of tokens that Tx sender allowed to an account
-- @type call
-- @param operator (address) operator's address
-- @param amount (ubig) amount of increased tokens
-- @event increaseAllowance(owner, operator, amount)
function increaseAllowance(operator, amount)
-- Decrease the amount of tokens that Tx sender allowed to an account
-- @type call
-- @param operator (address) operator's address
-- @param amount (ubig) amount of decreased tokens
-- @event decreaseAllowance(owner, operator, amount)
function decreaseAllowance(operator, amount)
-- Get amount of remaining tokens that an account allowed to another
-- @type query
-- @param owner (address) owner's address
-- @param operator (address) operator's address
-- @return (number) amount of remaining tokens
function allowance(owner, operator)
-- Transfer tokens from an account to another using the allowance mechanism
-- @type call
-- @param from (address) sender's address
-- @param to (address) recipient's address
-- @param amount (ubig) amount of tokens to send
-- @param ... additional data, is sent unaltered in call to 'tokensReceived' on 'to'
-- @return value returned from 'tokensReceived' callback, or nil
-- @event transfer(from, to, amount, operator)
function limitedTransferFrom(from, to, amount, ...)
-- Burn tokens from an account using the allowance mechanism
-- This function can only be used if the Burnable extension is included
-- @type call
-- @param from (address) address of the account from which the tokens will be burn
-- @param amount (ubig) amount of tokens to burn
-- @event burn(from, amount, operator)
function limitedBurnFrom(from, amount)-- Add accounts to blacklist
-- @type call
-- @param account_list (list of address)
-- @event addToBlacklist(account_list)
function addToBlacklist(account_list)
-- Remove accounts from blacklist
-- @type call
-- @param account_list (list of address)
-- @event removeFromBlacklist(account_list)
function removeFromBlacklist(account_list)
-- Indicate if an account is on blacklist
-- @type query
-- @param account (address)
function isOnBlacklist(account)
This function is required to receive ARC1 tokens
Contracts that want to receive tokens must implement the following function in order to receive them. In most cases it also means that your contract must have methods to transfer these tokens.
If your contract is not intended to handle fungible tokens, then do not add this function. In this case any attempt to transfer a token to your contract will fail (as expected).
This function can also be used to define how to handle the tokens they receive.
-- The ARC1 smart contract calls this function on the recipient after a 'transfer'
-- @type call
-- @param operator (address) a address which called token 'transfer' function
-- @param from (address) a sender's address
-- @param value (ubig) amount of tokens to send
-- @param ... additional data, by-passed from 'transfer' arguments
function tokensReceived(operator, from, value, ...)
-- do nothing
end
⚠️ ATTENTION: anyone can call this function!⚠️ Do NOT assume a token was received just because this function was called!
If a token was really sent, we can get the token contract address with:
local token_contract = system.getSender()But on most cases the function can be empty.