augustol / quick-wallet Goto Github PK

Add a folder with docs generated from the natspec comments in js-lib/src.

The actual implementation of the wallet contract allows the creation one tx with multiple fees, the user can create set different amount of fee to be paid based on certain time limit.

What if instead of that the user sends a maximum amount of gas to be payed with a time limit?
For this the relayer would need to also send how much gas is willing to spend in the wallet call execution.

The calculation would be like:

relayerWeiProfit = (totalGas - relayTxCost + quickTxCost) * maxRelayerGas / (now - txSignedTime)

• totalGas: Can be obtained with gasLeft() at the beginning of the function.
• relayTxCost: Fixed cost of gas pre calculated in the wallet contract.
• quickTxCost: Total gas to be spend in the quickTx call, this has to be sent as parameter by the relayer. Is calculated by using estimateGas from web3.
• maxRelayerGas: The maximum amount of gas to be payed by the wallet.
• txSignedTime: The timestamp of the time that the quickTx was signed.

Based on discussion with @cwhinfrey

Write the a single document with documentation that explains how the wallet contracts works and can be used.

Add methods to improve the usability of the wallet with the js-lib when it is needed to calculate the gas in wei that will cost the execution of a call.
To use estimateGas the sender needs to specify the token and amount of the fee, there is two options here, it is payed with eth or erc20, get the estimate cost for both types of fee.

Right now to run the tests in the relayer the dev needs to run two processes at the same time, one for testnet and another for api, improve the tests scripts to do it in one process and watch for changes in src and tests.