Skip to content

Latest commit

 

History

History
329 lines (214 loc) · 8.36 KB

README.md

File metadata and controls

329 lines (214 loc) · 8.36 KB

SafeHaven Node Token

Contracts for SafeHaven Node Token on the VeChainThor blockchain.

Install

    npm install

Usage

Deploy the contracts

    node src/cli.js deploy --endpoint http://localhost:8669 --operator <your_deploy_privatekey> --token 0x123...

    Usage: cli [options] [command]

    Options:
    -V, --version          output the version number
    --endpoint <endpoint>  [required] Thor RESTful Endpoint (default: "")
    --operator <priv>      [optional] Private Key with 0x prefixed (default: "")
    --token <address>      [required] Token that we use to check required balances
    -h, --help             output usage information

    Commands:
    deploy                 deploy the contracts

Safe Node Token Diagram

ContracOverview

Table of Contents

Project Construct

The project includes the following files:

    ├── SupportsInterface.sol
    ├── ThunderFactory.sol
    ├── TokenAuction.sol
    ├── XAccessControl.sol
    ├── XOwnership.sol
    ├── auction
    │       ├── ClockAuction.sol
    │       └── ClockAuctionBase.sol
    └── utility
            ├── Ownable.sol
            ├── Pausable.sol
            ├── SafeMath.sol
            ├── Strings.sol
            └── interfaces
                    ├── IERC165.sol
                    ├── IVIP181.sol
                    └── IVIP181Basic.sol

Contracts Overview

ContracOverview

The smart contracts are split into modules.

  • XAccessControl - Defines the organizational permission and black lists.
  • ThunderFactory - Defines the Token struct and storage, it's the core contract
  • XOwnership - Implements VIP181 and defines ownership and transfer rights
  • TokenAuction - Calls auction contract and Implements token auction
  • ClockAuction - Implements token auction logic
  • ClockAuctionBase - Defines internal variables, functions for token auction

TokenAuction.sol

TokenAuction

ClockAuction.sol

ClockAuction

Contract Address

Testnet

  • TokenAuction: 0x2890E2fD4522EA0f48F506FfD0f301ef5Cf98644
  • ClockAuction: 0x8e9340B2F880809CCefC829EbB1d55922fDab28F

Mainnet

  • TokenAuction: 0x119D9C14130aBf6870451ab76CBb2D9CB3afD630
  • ClockAuction: 0x542d7f0Ae91Fd73ef666a0F5530e89D6ff43A97b

API

getMetadata

    function getMetadata(uint256 _tokenId) public view
            returns(
                    address owner,
                    uint8 level,
                    bool isOnUpgrade,
                    bool isOnAuction,
                    uint64 lastTransferTime,
                    uint64 createdAt,
                    uint64 updatedAt
            )

Get the information about the given token.

Params:

  • _tokenId: token id

Return:

  • owner: the address that owns token
  • level: the level of the token
  • isOnUpgrade: return true when the token is upgrading
  • isOnAuction: return true when the token is on auction
  • lastTransferTime: the timestamp that the token
  • createdAt: when the token is genearted
  • updatedAt: when the token data is updated

applyUpgrade

    function applyUpgrade(strengthLevel _toLvl)

Apply for upgrading your node token.

Params:

  • _toLvl: the next level index.
Level Index Level Name
1 SafeHaven Connect Node
2 SafeHaven Harbor Node
3 SafeHaven Consensus Node
4 SafeHaven Legacy Node

enum strengthLevel {

    None,
    Connect,
    Harbor,
    Consensus,
    Legacy
}

constructor(address requiredTokenAddress) public {

    requiredToken = IVIP181(requiredTokenAddress);
    // the index of valid tokens should start from 1
    tokens.push(Token(0, 0, false, strengthLevel.None, 0));
    strengthParams[1] = TokenParameters(1000000 ether, 30, 0);     // Connect
    strengthParams[2] = TokenParameters(2500000 ether, 45, 8);    // Harbor
    strengthParams[3] = TokenParameters(10000000 ether, 60, 32);  // Consensus
    strengthParams[4] = TokenParameters(30000000 ether, 90, 57);  // Legacy
}

cancelUpgrade

    function cancelUpgrade(uint256 _tokenId)

Cancel the application of upgrading node token.

Params:

  • _tokenId: the id of the token

getTokenParams

    function getTokenParams(strengthLevel _level) public view
            returns(
                    uint256 minBalance,
                    uint64 ripeDays,
                    uint64 rewardRatio,
                    uint64 rewardRatioX
            )

Get Node Level parameters

Return:

  • minBalance: the minimum VET balance needed
  • ripeDays: the days of being the level
  • rewardRatio: reward ratio for normal node token
  • rewardRatioX: reward ratio for X node token

idToOwner

    function idToOwner(uint256 _tokenId) public view
            returns (address)

Get the owner of the given node token.

Params:

  • _tokenId: the id of node token

Return: the owner of the token

ownerToId

    function ownerToId(address _owner) public view
            returns (uint256)

Get the node token id of the given address owns.

Params:

  • _owner: the address that owns token

Return: the node token id of the given address owns

createSaleAuction

    function createSaleAuction(
            uint256 _tokenId,
            uint128 _startingPrice,
            uint128 _endingPrice,
            uint64 _duration
    ) public

Create an public auction.

Params:

  • _tokenId: the id of token
  • _startingPrice: starting price
  • _endingPrice: ending price
  • _duration: the duration of the auction from 2 hours to 7 days

createDirectionalSaleAuction

    function createDirectionalSaleAuction(
            uint256 _tokenId,
            uint128 _price,
            uint64 _duration,
            address _toAddress
    ) public

Create a directional auction.

Params:

  • _tokenId: the id of token
  • _price: the selling price
  • _duration: the duration of the auction from 2 hours to 7 days
  • _toAddress: the receiver address

bid

    function bid(uint256 _tokenId) public payable

Purchase or bid an auction.

Params:

  • _tokenId: the id of token

cancelAuction

    function cancelAuction(uint256 _tokenId) public

Cancel the auction.

Params:

  • _tokenId: the id of token

addAuctionWhiteList

    function addAuctionWhiteList(uint256 _tokenId, address _address) public

Add an address to whitelist.

Params:

  • _tokenId: the id of token
  • _address: the target address

removeAuctionWhiteList

    function removeAuctionWhiteList(uint256 _tokenId, address _address) public

Remove an address from whitelist.

Params:

  • _tokenId: the id of token
  • _address: the target address

Audit Report

Security audit performed by SlowMist Team.

License

It is licensed under the GNU Lesser General Public License v3.0, also included in LICENSE file in repository.