WFIL Factory

WFIL Factory

WFIL Factory allow Merchants and Custodians to interact with WFIL ERC20 Wrapper.
WFIL DAO can add/remove Merchants and Custodians providing trust and transparency for the community.
Merchants can add WFIL Mint/Burn requests that need to be confirmed by Custodians.

Sections

• Building Blocks
• Setup
• Audit
• About

Building Blocks

WFILFactory

Implements WFIL Factory by leveraging on OpenZeppelin Library.

It allows the WFIL DAO, dao_, to add/remove Merchants via addMerchant, removeMerchant and to add/remove Custodians via addCustodian, removeCustodian.

The WFILFactory contract is linked to WFIL token in the constructor, wfil_, allowing Merchants and Custodians to add WFIL Mint/Burn requests via addMintRequest, addBurnRequest.

The steps needed to Mint WFIL are the following:

• The Custodian need to set the custodian filecoin deposit address via setCustodianDeposit by specifying the merchant address and the deposit address.
• The Merchant can add a WFIL Mint Request via addMintRequest by specifying the amount of WFIL it wants to mint, txId correspondent to the filecoin transaction and the custodian address (this allow each merchant to opt for a different custodian for each mint request to provide a flexible service).
• The Merchant can cancel the WFIL Mint Request via cancelMintRequest by specyfing the requestHash generated when adding a new mint request.
• The Custodian can either confirm the WFIL Mint Request via confirmMintRequest by specifying the requestHash and calling wfil.wrap function or reject the WFIL Mint Request via rejectMintRequest by specifying the requestHash.

The steps needed to Burn WFIL are the following:

• The Merchant need to set the merchant filecoin deposit address via setMerchantDeposit by specifying the deposit address.
• The Merchant can add a WFIL Burn Request via addBurnRequest by specyfing the amount of WFIL it wants to burn and the custodian address and calling wfil.unwrapFrom function.
• The Custodian can either confirm the WFIL Burn Request via confirmBurnRequest by specyfing the requestHash generated when adding an new burn request and txId correspondent to the filecoin transaction or reject the WFIL Burn Request via rejectMintRequest and returning the amount burned to the merchant via wfil.wrap function.

When the addMintRequest is called by a Merchant it generates a Mint Request with the following fields:

• requester, Merchant address
• custodian, Custodian address
• amount, WFIL amount to Mint
• deposit, custodian filecoin deposit address, set before by the custodian
• txId, filecoin transaction identifier, passed by the merchant
• nonce, serial number allocated for each mint request, generated via _mintsIdTracker
• timestamp, time of the mint request creation, generated via _timestamp
• status, status of the mint request that can be: PENDING, CANCELED, APPROVED, REJECTED

When the addBurnRequest is called by a Custodian it generates a Burn Request with the following fields:

• requester, Merchant address
• custodian, Custodian address
• amount, WFIL amount to Burn
• deposit, merchant filecoin deposit address, set before by the merchant
• txId, filecoin transaction identifier, passed by the custodian when confirming the burn request
• nonce, serial number allocated for each mint request, generated via _burnsIdTracker
• timestamp, time of the burn request creation, generated via _timestamp
• status, status of the burn request that can be: PENDING, CANCELED, APPROVED, REJECTED

The WFILFactory inherits OpenZeppelin AccessControl module to set the Pauser role to the WFIL DAO that can call the pause, unpause functions in case of emergency (Circuit Breaker Design Pattern).

Finally the WFILFactory allows the WFIL DAO to claim ERC20 tokens sent to the contract, including WFIL token, via reclaimToken by specifying the the token address as well as the recipient address to sent the tokens to, that can be sent to a charities or support projects in the space via Gitcoin Grants.

Setup

Clone this GitHub repository.

Steps to compile and test

• Local dependencies:
  • Truffle
  • Ganache CLI
  • OpenZeppelin Contracts v3.2.0
  • Truffle HD Wallet Provider
  • Truffle-Plugin-Verify
  • Solhint

  $ npm i

• Global dependencies:
  • Truffle (recommended):

  $ npm install -g truffle

  • Ganache CLI (recommended):

  $ npm install -g ganache-cli

  • Slither (optional):

  $ git clone https://github.com/crytic/slither.git && cd slither
  $ sudo python3 setup.py install

Running the project with local test network (ganache-cli)

• Start ganache-cli with the following command (global dependency):

  $ ganache-cli

• Compile the smart contract using Truffle with the following command (global dependency):

  $ truffle compile

• Deploy the smart contracts using Truffle & Ganache with the following command (global dependency):

  $ truffle migrate

• Test the smart contracts using Mocha & OpenZeppelin Test Environment with the following command:

  $ npm test

• Analyze the smart contracts using Slither with the following command (optional):

  $ slither .

Development deployment

DAO Multisig (Rinkeby): 0x3bBcA3216Dbafdfa61B3bbAaCb9C6FEbe4C45f2F
WFIL (Rinkeby): 0xA04bbe85d91C3125d577AF17e4EB5d4E579100Cf
WFIL Factory (Rinkeby): 0xD27B309B0Fd0E251674a6A52765934ef961E38Df

Current Mainnet Contracts

• WFIL DAO: 0x44443407e196298a0aD68207Aa93eA919df53961 (Dec-03-2020 06:36:39 PM +UTC)
• WFIL: 0xd187C6C8C6aeE0F021F92cB02887A21D529e26cb (Dec-03-2020 09:31:02 PM +UTC)
• WFIL Factory: 0x97A995E8b36A14C5586a19a99a282e9B53Ad890D (Dec-20-2020 11:50:22 PM +UTC)

Audit

• Quantstamp

About

Inspiration & References