Separate fee into home fee and foreign fee

[patitonar]

Added the following methods:

• setHomeFee
• getHomeFee
• setForeignFee
• getForeignFee

I had to update calculateFee to receive a parameter to know which fee it should use.

If the Fee Manager is in manages-one-direction mode (see #148) the method setFee will proxy one of the methods setHomeFee and setForeignFee depending on the side where the contract is deployed. Similar is for getFee.

Regarding this comment, I removed setFee and getFee since I couldn't find a use case for them unless I'm missing something. On bridge-ui using getFeeManagerMode I think it will be enough to know which fee to use.

Closes #149

[akolotov]

We also told about the updates in the gas consumption document.

[patitonar]

@akolotov Updated gas consumption document with latest changes

[akolotov]

Few questions appeared. Please share you view.

[akolotov]

I am a bit messed up. Let's clarify this together one more time:
Currently the examples of the .env file says that;

# Fee to be charged for each transfer on Home network
# Makes sense only when HOME_REWARDABLE=true
# e.g. 0.1% fee
HOME_TRANSACTIONS_FEE=0.001
# Fee to be charged for each transfer on Foreign network
# Makes sense only when FOREIGN_REWARDABLE=true
# e.g. 0.1% fee
FOREIGN_TRANSACTIONS_FEE=0.001

What does Fee to be charged for each transfer on Foreign network mean?
FOREIGN_FEE means fee that we take for every transaction that directed form the Foreign network to the Home network.
So, HOME_FEE means fee that we take for every transaction that directed form the Home network to the Foreign network
Is it your understanding also? If so, does it make sense to re-phrase the statements in the examples?

[patitonar]

Thanks for clarification. Yes, that's my understanding too. I'll update documentation

[patitonar]

Fixed on b54cd53

[akolotov]

Does it make sense to move these methods to the corresponding implementations of the bridges:

• erc20_to_native/RewardableHomeBridgeErcToNative.sol:
  • setHomeFee
  • setForeignFee
  • getHomeFee
  • getForeignFee
• native_to_erc20/RewardableHomeBridgeNativeToErc.sol
  • setForeignFee
  • getForeignFee
• native_to_erc20/RewardableForeignBridgeNativeToErc.sol
  • setHomeFee
  • getHomeFee

By doing this we would:

1. slightly reduce the code deployed.
2. get rid of mess up especially in rhe case of native-to-erc mode.

What do you think?

[patitonar]

I agree on the changes, this would help on making code easier to follow

[patitonar]

Done 78d6c3b

[patitonar]

@akolotov Comments were addressed. Also fixed rewardableInitialize method to only initialize the correct fee parameter for each case and gas consumption docs

[akolotov]

Thanks for improving this!