/UpDawg-Smart-Contract

Primary LanguageSolidityThe UnlicenseUnlicense

UpDawg Smart Contract











Satoshi Nakamoto -

“If you don't believe me or don't get it, I don't have time to try to convince you, sorry.”











Table of Contents

  1. What is UpDawg?
  2. Technology
  3. Launchpad
  4. Price Formula
  5. Dawg DEX
  6. Fee Schedule
  7. Functions




What is UpDawg?

UpDawg Smart Contract is a TRC20 contract on the TRON blockchain. The Smart Contract consists of a token (UDAWG) with an in-built DEX (dawgDEX). UDAWG is a Proof Of Reserve token backed by TRX. UDAWG can be purchased & sold on the dawgDEX.





Technology

Once deployed on the blockchain, the Launchpad will be in effect and initially the TRX Reserve will have 0.000001 TRX sent by DawgDAO in exchange for 21 UDAWG tokens to set the price of UDAWG tokens as : 1 TRX = 21 Million UDAWG.





Launchpad

Once deployed on the blockchain, the Launchpad will be in effect and initially the TRX Reserve will have 1 TRX sent by DawgDAO in exchange for 21 million UDAWG tokens to set the price of UDAWG tokens as : 21 Million UDAWG = 1 TRX.





Price Formula

The price formula of UDAWG token is based on the simple weight expression.


The price formula of UDAWG token =

Price Formula





dawgDEX

The conclusion of Launchpad marks the inception of the dawgDEX. The exchange fee will be set at 1% for purchasing tokens and 10% for selling tokens. The exchange fee will automatically change based on the TRX reserve of the UpDawg contract, according to the below Fee Schedule.





Fee schedule

The Transaction Fee Distribution is as follows :

  • 0 TRX <= Reserve < 1 TRX:

    • 1% Deposit Fee;
    • 10% Withdraw Fee;

  • 1 TRX <= Reserve < 10 TRX:

    • 0.9% Deposit Fee;
    • 9% Withdraw Fee;

  • 10 TRX <= Reserve < 100 TRX:

    • 0.8% Deposit Fee;
    • 8% Withdraw Fee;

  • 100 TRX <= Reserve < 1k TRX:

    • 0.7% Deposit Fee;
    • 7% Withdraw Fee;

  • 1k TRX <= Reserve < 10k TRX:

    • 0.6% Deposit Fee;
    • 6% Withdraw Fee;

  • 10k TRX <= Reserve < 100k TRX:

    • 0.5% Deposit Fee;
    • 5% Withdraw Fee;

  • 100k TRX <= Reserve < 1M TRX:

    • 0.4% Deposit Fee;
    • 4% Withdraw Fee;

  • 1M TRX <= Reserve < 10M TRX:

    • 0.3% Deposit Fee;
    • 3% Withdraw Fee;

  • 10M TRX <= Reserve < 100M TRX:

    • 0.2% Deposit Fee;
    • 2% Withdraw Fee;

  • 100M TRX <= Reserve < 1B TRX:

    • 0.1% Deposit Fee;
    • 1% Withdraw Fee;

  • Reserve >= 1B TRX:

    • 0.09% Deposit Fee;
    • 0.9% Withdraw Fee;




Functions

The UpDawg Smart Contract implements the following functions :



READ METHODS



Name

  • Function Name: name
  • Function Type: READ
  • Function Description: Returns the name of the token. This is an immutable state variable; i.e. It can only be set at the time of deployment and can never be changed. eg. UpDawg
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: string]
  • Function Return Value: UpDawg
  • Function Signature:
name()


Symbol

  • Function Name: symbol
  • Function Type: READ
  • Function Description: Returns the symbol of the token, usually a shorter version of the name. eg. UDAWG
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: string]
  • Function Return Value: UDAWG
  • Function Signature:
symbol()


Decimals

  • Function Name: decimals
  • Function Type: READ
  • Function Description: Returns the number of decimals used to get its user representation.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint8]
  • Function Return Value: 6
  • Function Signature:
decimals()
  • Function Note: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {ITRC20-balanceOf} and {ITRC20-transfer}. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei.


Circulating Supply

  • Function Name: circulatingSupply
  • Function Type: READ
  • Function Description: Returns the sum of amount of tokens in contract-user's accounts.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
circulatingSupply()
  • Function Dev-Note: circulatingSupply


HODL Supply

  • Function Name: hodlSupply
  • Function Type: READ
  • Function Description: Returns the total amount of tokens in hodler pool of the contract.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
hodlSupply()
  • Function Dev-Note: hodlSupply


Total Supply

  • Function Name: totalSupply
  • Function Type: READ
  • Function Description: Returns the total amount of tokens in existence. This is the sum of circulatingSupply & hodlSupply
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
totalSupply()
  • Function Dev-Note: totalSupply


Reserve

  • Function Name: reserve
  • Function Type: READ
  • Function Description: Returns the amount of asset tokens in the contracts reserve.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
reserve()
  • Function Dev-Note: reserve


Claim Period

  • Function Name: claimPeriod
  • Function Type: READ
  • Function Description: Returns the base time period for claim rewards.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
claimPeriod()
  • Function Dev-Note: claimPeriod


Basis Point

  • Function Name: basisPoint
  • Function Type: READ
  • Function Description: Returns the number of basis Points used by the contract as ratio representation.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
basisPoint()
  • Function Dev-Note: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract. For example, if basisPoint equals 3, a buyFees of 25 represents a deposit fee of 2.5% (per cent or percentage) and should be displayed to a user as 2.5% by the formula (FeePoints * 100/ (10 ** basisPoint)).


Buy Fees

  • Function Name: buyFees
  • Function Type: READ
  • Function Description: Returns the buyFees of the contract.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
buyFees()
  • Function Dev-Note: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract. For example, if basisPoint equals 3, a buyFees of 25 represents a deposit fee of 2.5% (per cent or percentage) and should be displayed to a user as 2.5% by the formula (buyFees * 100/ (10 ** basisPoint)).


Sell Fees

  • Function Name: sellFees
  • Function Type: READ
  • Function Description: Returns the sell fees of the contract.
  • Function Requirements: -nil-
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
sellFees()
  • Function Dev-Note: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract. For example, if basisPoint equals 3, a sellFees of 25 represents a withdraw fee of 2.5% (per cent or percentage) and should be displayed to a user as 2.5% by the formula (sellFees * 100/ (10 ** basisPoint)).


Balance Of

  • Function Name: balanceOf
  • Function Type: READ
  • Function Description: This function returns the amount of tokens owned by the specific account.
  • Function Requirements: -nil-
  • Function Parameters:
    • param1: [account][@type: address]
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
balanceOf(address account)
  • Function Dev-Note: balanceOf


Allowance

  • Function Name: allowance
  • Function Type: READ
  • Function Description: Returns the remaining number of tokens that spender will be allowed to spend on behalf of owner through {transferFrom}. This is zero by default. This value changes when {approve} or {transferFrom} are called.
  • Function Requirements: -nil-
  • Function Parameters:
    • param1: [owner][@type: address]
    • param2: [spender][@type: address]
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
allowance(address owner, address spender)
  • Function Dev-Note: allowance


Previous Claim Of

  • Function Name: prevClaimOf
  • Function Type: READ
  • Function Description: Returns the timestamp of previous call to claimRewards of account.
  • Function Requirements: -nil-
  • Function Parameters:
    • param1: [account][@type: address]
  • Function Return:
    • return[0]: [@type: uint256]
  • Function Signature:
prevClaimOf(address account)
  • Function Dev-Note: prevClaimOf


WRITE METHODS



Approve

  • Function Name: approve
  • Function Type: WRITE
  • Function Description: Sets amount as the allowance of spender over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. Emits an {Approval} event.
  • Function Requirements:
    • owner cannot be the zero address.
    • spender cannot be the zero address.
  • Function Parameters:
    • param1: [spender][@type: address]
    • param2: [amount][@type: uint256]
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
approve(address spender, uint256 amount)
  • Function Dev-Note: IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: ethereum/EIPs#20 (comment)


Transfer

  • Function Name: transfer
  • Function Type: WRITE
  • Function Description: Moves amount tokens from the caller's account to recipient. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
  • Function Requirements:
    • caller cannot be the zero address.
    • recipient cannot be the zero address.
    • caller must have a balance of at least amount tokens.
  • Function Parameters:
    • param1: [recipient][@type: address]
    • param2: [amount][@type: uint256]
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
transfer(address recipient, uint256 amount)


Transfer From

  • Function Name: transferFrom
  • Function Type: WRITE
  • Function Description: Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
  • Function Requirements:
    • sender cannot be the zero address.
    • recipient cannot be the zero address.
    • sender must have a balance of at least amount.
    • caller must have an allowance of at least amount.
  • Function Parameters:
    • param1: [sender][@type: address]
    • param2: [recipient][@type: address]
    • param3: [amount][@type: uint256]
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
transferFrom(address sender, address recipient, uint256 amount)


Air Drop Claim

  • Function Name: airDropClaim
  • Function Type: WRITE
  • Function Description: Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
  • Function Requirements:
    • caller cannot be the zero address.
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
claimReward()


Claim Reward

  • Function Name: claimReward
  • Function Type: WRITE
  • Function Description: Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
  • Function Requirements:
    • caller cannot be the zero address.
  • Function Parameters: -nil-
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
claimReward()


Burn

  • Function Name: burn
  • Function Type: WRITE
  • Function Description: Destroys amount tokens from account, reducing the total supply. Emits a {Transfer} event with to set to the zero address.
  • Function Requirements:
    • caller cannot be the zero address.
    • caller must have a balance of at least amount tokens.
  • Function Parameters:
    • param1: [amount][@type: uint256]
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
burn(uint256 amount)


Buy

  • Function Name: buy
  • Function Type: WRITE
  • Function Description: Destroys amount tokens from account, reducing the total supply. Emits a {Transfer} event with to set to the zero address.
  • Function Requirements:
    • caller cannot be the zero address.
  • Function Parameters:
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
buy()


Sell

  • Function Name: sell
  • Function Type: WRITE
  • Function Description: Destroys amount tokens from account, reducing the total supply. Emits a {Transfer} event with to set to the zero address.
  • Function Requirements:
    • caller cannot be the zero address.
  • Function Parameters:
    • param1: [amount][@type: uint256]
  • Function Return:
    • return[0]: [@type: bool]
  • Function Signature:
sell(uint256 amount)




Every function will be executed by using the TronLink extension directly from the official TRON Blockchain Explorer website, protected by TLS. TRON blockchain native token (TRX) will be used for implementing UpDAWG operations. Generally fee will be less than 40 TRX and can be laid down to 0 TRX if the user has sufficient Energy & bandwidth available.





Transparency

The UpDawg Smart Contract manages the UDAWG token & the TRX reserve, ensuring a fully decentralised & trustless process. Contract owner can not interfere with the smart contract’s specifications except for 2 predetermined functions(updateBuyFee &updateSellFee), hard coded in the Smart Contract code, as the code is open source.



There is no method in the UpDawg Smart Contract to withdraw the TRX Reserve or UDAWG HODLpool. The internal reserves in the Smart Contract is viewable to make sure token value is backed by the expected amount of collateral. To look into the reserve users can visit UpDAWG website or TRON blockchain explorer, as UpDAWG is an TRC20 Smart Contract all the reserves are on-chain.



To ensure no chance of scam or security risk, the UpDawg Smart Contract will be audited.











Satoshi Nakamoto -

“We shouldn’t delay forever until every possible feature is done. There’s always going to be one more thing to do.”