stevennevins/account-bound-proxies

extending functionality of EOAs

account-bound-proxies's Issues

Sweep (slow): Create documentation and diagrams for contracts

Details

• For each file in the src directory, create an overview markdown file
• Write an overview for each contract in the src directory
• The overview of each contract in the src directory should contain information about how the contracts function
• The overview of each contract in the src directory should contain a description of how and when each external and public function is used
• The overview of each contract in the src directory should contain a mermaid.js diagram for how a user interacts with the contracts

Checklist

• docs/Router.md

• Write an overview of the Router contract, including its purpose and functionalities.
• Document each public and external function in the Router contract, explaining how and when they are used.
• Create a mermaid.js diagram to visually represent how a user interacts with the Router contract. Include this diagram in the markdown file.

• docs/RouterRegistry.md

• Write an overview of the RouterRegistry contract, including its purpose and functionalities.
• Document each public and external function in the RouterRegistry contract, explaining how and when they are used.
• Create a mermaid.js diagram to visually represent how a user interacts with the RouterRegistry contract. Include this diagram in the markdown file.

• docs/IOwner.md

• Write an overview of the IOwner interface, including its purpose and functionalities.
• Document each public and external function in the IOwner interface, explaining how and when they are used.
• Create a mermaid.js diagram to visually represent how a user interacts with the IOwner interface. Include this diagram in the markdown file.

• docs/MultiSendCallOnly.md

• Write an overview of the MultiSendCallOnly library, including its purpose and functionalities.
• Document each public and external function in the MultiSendCallOnly library, explaining how and when they are used.
• Create a mermaid.js diagram to visually represent how a user interacts with the MultiSendCallOnly library. Include this diagram in the markdown file.

• README.md

• Add a section that provides an overview of the documentation available for each contract in the src directory.
• Include links to the markdown files for each contract in the new section.

Sweep: Add the ability for the router to accept a transaction bundle signed by the owner

• Add a nonce to Router.sol
• Add a second multisend function that accepts a signed transaction bundle and nonce
• The signature should recover to the owner of the router
• Randomly increment the nonce value when a signed transaction bundle is executed

Checklist

• src/Router.sol

• Add a nonce variable of type uint256
  • Add a signedMultiSend function that accepts bytes calldata transactions, bytes calldata signature, and uint256 nonce
  • Verify the signature and recover the owner address
  • Check if the recovered owner address matches the current owner of the router
  • Increment the nonce value randomly
  • Call the multiSend function with the provided transactions parameter

• test/Router.t.sol

• Add test cases for the new signedMultiSend function
  • Test the functionality of verifying the signature, recovering the owner address, and incrementing the nonce

Sweep (fast): Write unit tests for Router contract

Details

• Test when the caller is and is not the owner of the Router
• Test the Multisend function with large transactions bundles

Checklist

• test/RouterTest.sol

• Import the Router contract, the MultiSendCallOnly library, and the necessary testing libraries.
• Define the RouterTest contract.
• Write a test function to check if the caller is the owner of the Router. This function should create a Router contract, call a function on the contract with the owner as the caller, and assert that the function call is successful.
• Write a test function to check if the caller is not the owner of the Router. This function should create a Router contract, call a function on the contract with a non-owner as the caller, and assert that the function call reverts.
• Write a test function to check the multiSend function with large transaction bundles. This function should create a Router contract, create a large transaction bundle, call the multiSend function with the transaction bundle, and assert that the function call is successful.