Skip to content

Instantly share code, notes, and snippets.

@tommyz7

tommyz7/README.md

Created December 28, 2018 17:40
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save tommyz7/fa807bd03d5a94b26a9415f4fd309df8 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save tommyz7/fa807bd03d5a94b26a9415f4fd309df8 to your computer and use it in GitHub Desktop.
Download ZIP
Simple documentation reference for ERC1404 & R-Token
Raw
README.md

ERC1404 Security Token

Implementation of Regulated Token Standard (R-Token) and ERC 1404 with Regulator Service and Service Registry

RegulatedTokenERC1404

It's ERC20 compatible token. It will work with any wallet that can interact with ERC20 standard.

RegulatorService

Stores permissions for the token. It has similar features to whitelist. Features:

1. Lock the token (disallow all transfers) - in case of emergency or needed transfer freeze to calculate dividents

To lock the token, one needs to call following funcion: setLocked with following parameters:

  • _token The address of the token, the RegulatedTokenERC1404 contract
  • _locked true to lock, false to unlock

2. Forbid partial transfers. Require full token trasnfers only. It disallows to transfer fractions of token.

To allow/disallow partial token transfers, one needs to call following funcion: setPartialTransfers with following parameters:

  • _token The address of the token, the RegulatedTokenERC1404 contract
  • _enabled true to allow partial transfers, false to disallow partial transfers

3. Set permissions for each user (whitelist)

Each user needs to be assigned proper permission by owner/admin before he/she can trade tokens. Permissions are as follows: 1 - Permission for allowing a participant to send tokens 2 - Permission for allowing a participant to receive tokens 3 - Permission for allowing a participant to send and receive tokens

To assign permission, one needs to call the funciton setPermission with following parameters:

  • _token The address of the token, the RegulatedTokenERC1404 contract
  • _participant The address of the trade participant
  • _permission Permission to be set

ServiceRegistry

RegulatedTokenERC1404 stores a reference to a service registry. That registry stores address to RegulatorService that holds all permissions for token. The purpose of registry is to allow update/change of RegulatorService contract in case when we want to use third-party service for transfers validation. To update RegulatorService one needs to call replaceService function with parameter _service that is address of a contract that implements new RegulatorService service.

Tutorials for most common scenarios

Helpful links

Mint tokens

Prepare for interaction

Mint tokens

  • Choose mint function from dropdown
  • _to is an address (wallet) that token will be minted to
  • _amount is the amount of token minted. Remember to include 18 decimal point zeros. If you want to mint 1 EVK, you need to put number 1000000000000000000 as _amount - 1 and 18 following zeros, if 1.5 then 15 and 17 following zeros and so on.
  • Connect the wallet you are using
  • Make sure all variables are correct and click write and approve transaction on your wallet

Whitelist an address (wallet) with send, receiver or send & receiver permissions

Prepare for interaction

Set permission

  • Choose setPermission function from dropdown
  • _token is an address of our token => 0x09D9e4A7ADe5e7c32623E3794093d09cbc8865f5
  • _participant is the address (wallet) we are assigning permissions for
  • _permission is the permission to be set. ** 1 - Permission for allowing a participant to send tokens ** 2 - Permission for allowing a participant to receive tokens ** 3 - Permission for allowing a participant to send and receive tokens
  • Connect the wallet you are using
  • Make sure all variables are correct and click write and approve transaction on your wallet

Lock and unlock the token

Prepare for interaction

Lock or unlock the token

  • Choose setLocked function from dropdown
  • _token is an address of our token => 0x09D9e4A7ADe5e7c32623E3794093d09cbc8865f5
  • _locked is true or false. It true, token will be locked, if false token will be unlocked
  • Connect the wallet you are using
  • Make sure all variables are correct and click write and approve transaction on your wallet

Error message query - find out the reason of an unsuccessful transfer

Get TX hash

  • TX hash should be delivered by user, without it we cannot do anything

Get error code

  • Open TX on etherscan and go to event logs tab
  • Find CheckStatus event and look at Data section. Choose number from dropbox on first row. It should return a single number. Copy it.

Get error message

  • Open RegulatorService contract on etherscan and click Read Contract tab.
  • Find messageForReason function and paste error code (the number you copided) to _reason input.
  • Click query and read the reason.

Token burn

Prepare for interaction

Run burn function

  • Choose burn function from dropbox
  • As _value put number of tokens you want to burn. Remember about 18 decinal points so if you want to burn 1 EVK, you need to put number 1000000000000000000 as _value
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment