Skip to content

Latest commit

 

History

History
125 lines (100 loc) · 4.53 KB

README.md

File metadata and controls

125 lines (100 loc) · 4.53 KB
Raw

New features

  • Optional fix and variable fees which fund the oracles
  • Freeze options for specific parts of the contract
  • Adjustable number of needed oracle confirmations for a receiving teleport
  • Adjustable minimum amount for deposits and teleports
  • Option to delete old teleport and cancel entries without losing consensus
  • Store all needed bridge data in stats table for interoperability with custom front end apps

Note

This version reduces the EOSIO RAM by half and therefore its running costs. Further reductions need breaking changes, therefore a second version will be provided by SavAct.

Deployment and initialization

  1. The EOSIO account of the contract needs the eosio.code permission activated.
  2. Deploy the contract
  3. Run the ini action of the contract with the following parameters
ACTION ini(asset min, uint64_t fixfee, double varfee, bool freeze, uint32_t threshold);
  • min Minimum amount for a deposit and teleport
  • fixfee Fix fee for teleports and receipts. Together with the variable fee (varfee) the resulting fee has to be less than the minimum transfer amount (min).
  • varfee Variable fee for teleports and receipts. This has to be between 0 and 0.20 which equals to 0% and 20%.
  • freeze True to freeze the contract until you unfreeze it with the freeze action.
  • threshold Amount of needed oracle confirmations for a receiving teleport
  1. Add the allowed ethereum chains
  ACTION addchain(string name, uint8_t chain_id, string teleaddr, string tokenaddr);
  • name Name of the chain to bridge
  • abbreviation Short name of the chain
  • chain_id Identification number for this new chain
  • net_id Unique network id to distinguish different chains. See "ChainID" for ethereum based chains on https://chainlist.org/
  • teleaddr Teleport contract address
  • tokenaddr Token contract address

With the freeze action you can freeze and unfreeze specific parts of the contract

ACTION freeze(const bool in, const bool out, const bool oracles, const bool cancel);
  • in True to freeze incoming funds, false to unfreeze
  • out True to freeze outgoing funds, false to unfreeze
  • oracles True to freeze oracles, false to unfreeze
  • cancel True to freeze cancel action, false to unfreeze

Register oracles with regoracle

  • oracle_name EOSIO account name of the oracle
ACTION regoracle(name oracle_name);

Upgrade from running teleport contract of alien world

Just deploy the contract over the old teleport contract account, run the ini action and add all connected chains by executing the addchain action.

Note: Additional tables are included in this upgrade, the structure of the old tables is not changed.

Maintenance

To pay off collected fees to the oracles run payoracles

ACTION payoracles();

Use delteles to free the EOSIO RAM of completed and canceled teleports to_id Delete all entries until this id

ACTION delteles(uint64_t to_id);

Note: You can use the SavAct WebApp in combination with the Anchor Wallet by Greymass to execute these actions.

Install test suite on windows

You need to activate the windows feature Hyper-V, but it is not available on Windows 10 Home. You might need to upgrade your Windows to Windows Pro.

Activate WSL 2

Start windows PowerShell as administrator and run the following commands

dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

wsl --set-default-version 2

Set up Linux environment

Install Debian from Microsoft store, start it, create your user account and run the following commands

sudo apt-get update

sudo apt-get upgrade

For yarn installation via npm

sudo apt-get install npm

Install yarn globally

sudo npm install --global yarn

Navigate in the console to the folder teleporteos in which you can install the modules (run the following command again if it fails)

sudo yarn install

Set up docker

Install and start Docker, check for updates and install them. Open the Dockers menu by double clicking the icon in the task bar and go to settings ⚙️.

Check "Use the WSL 2 based engine"

Enable Debian in the settings at Resources / WSL INTEGRATION

Run tests

Docker must be running. Start the tests with the following command in the debian console

sudo yarn test