givepraise/reputation-token

Table of Contents

• ReputationToken
  • Functionality
    • Initialization
    • Burning Tokens
    • Minting Tokens
    • Setting Transferability
  • Methods
    • initialize
    • burn
    • mint
    • mintMany
    • setTransferable
  • Events
    • TransferableSet
  • Thrown Errors
• ReputationTokenFactory
  • Methods
    • initialize
    • createToken
    • updateTokenImplementation
  • Events
    • event TokenCreated(address _token)
    • event TokenImplementationUpdated

ReputationToken

This contract is a ERC20Votes token with additional functionality. The Owner can burn tokens, if burnable is true and mint tokens. The Owner can also set whether the token is transferable or not.

Functionality

Initialization

The initialize function is called after the deployment of the contract and sets up the basic properties of the token such as the name, symbol, decimals, owner, and whether the token is transferable and burnable. This function can only be called once and is protected by the initializer modifier.

Burning Tokens

The burn function allows the owner of the contract to burn tokens from a specified account. This function can only be called when the burnable property is set to true. The function checks if the specified account has enough tokens to burn and if the address passed is not the zero address. If all checks pass, the _burn internal function is called to burn the specified amount of tokens.

Minting Tokens

The mint function allows the owner of the contract to mint tokens to a specified account. This function calls the internal _mint function to mint the specified amount of tokens.

The mintMany function allows the owner of the contract to mint tokens to multiple accounts at once. It takes in an array of MintData structs, which contain the account and amount to mint to. The function then iterates through the array and calls the internal _mint function for each struct.

Setting Transferability

The setTransferable function allows the owner of the contract to set whether the token is transferable or not. The function takes in a boolean flag and sets the transferable property accordingly. An event, TransferableSet, is emitted with the new flag value.

Methods

initialize

Initializer for the ReputationToken contract.

• _name:string: The name of the token.
• _symbol:string: The symbol of the token.
• _decimals:uint256: The number of decimals of the token.
• _owner:address: The owner of the token.
• _transferable:bool: Whether the token is transferable.
• _burnable:bool: Whether the token is burnable.

burn

Burns tokens from the specified account. Can only be called by owner when burnable is set to true.

• _account:address: The account to burn tokens from.
• _amount:uint256: The amount of tokens to burn.

mint

Mints tokens to a specified account. Can only be called by owner.

• _account:address: The account to mint tokens to.
• _amount:uint256: The amount of tokens to mint.

mintMany

Mints tokens to multiple accounts. Can only be called by owner.

struct MintData {
  address account;
  uint256 amount;
}

• _data:MintData[]: The data to mint tokens to multiple accounts.

setTransferable

Sets whether the token is burnable or not.

_flag:bool: Whether the token is burnable or not.

Events

TransferableSet

Triggered when the transferable flag is set. _flag: The new value of the transferable flag.

Thrown Errors

NotBurnable: Thrown when the burn function is called when the burnable flag is set to false. NotEnoughTokens: Thrown when the burn function is called with an amount greater than the balance of the specified account. ZeroAddress: Thrown when the burn function is called with an address of 0. NotTransferable: Thrown when the _transfer function is called and the transferable flag is set to false.

ReputationTokenFactory

This contract is a factory for creating proxy instances of the ReputationToken contract. It allows anyone to deploy new instances of the ReputationToken contract.

Methods

initialize

Initializer for the ReputationTokenFactory contract.

• _owner:address: Owner of the factory contract.

createToken

Allows anyone to create new instances of the ReputationToken contract. It takes in the following parameters:

• _name:string: The name of the token
• _symbol:string: The symbol of the token
• _decimals:uint256: The number of decimals of the token
• _transferable:bool: A boolean that determines whether the token is transferable or not
• _burnable:bool: A boolean that determines whether the token is burnable or not

updateTokenImplementation

Updates the implementation contract for future token creations.

• _tokenImplementation:address: Address of the new implementation.

Events

event TokenCreated(address _token)

Triggered when a new instance of the ReputationToken contract is deployed.

• _token:address: Address of the created token.

event TokenImplementationUpdated

Triggered when the implementation is updated.

• _tokenImplementation: address: Address of the new token implementation contract.