Update Account to namespace, fix docs #297
Conversation
docs/Account.md
Outdated
|
|
||
| 2. The `__execute__` method creates an empty array which is passed with the `AccountCallArray` and calldata into the `_from_call_array_to_call` method. This method iterates through the `AccountCallArray` messages and converts each message into a `Call`. | ||
|
|
||
| 3. A new empty array is created and passed with the list of calls (populated from `from_call_array_to_call`) to `_execute_list`. This method iterates and executes a contract call for each `Call` and pushes each result into the array. Once all contract calls are finished, the array holding each contract call response is returned. |
There was a problem hiding this comment.
I think this is just an implementation detail, it's the interface what we want to document, right?
There was a problem hiding this comment.
Correct. I broke this down for myself so I could better explain/understand the process. A blog post or something might be better suited to document the implementation details. Good call
There was a problem hiding this comment.
I think it's a bit confusing to go that deep into this kind details, e.g. we could say "An array of Calls is passed to _execute_list" instead -- no need to explain that a new array is allocated, iterated, etc. I'd remove this section alltogether.
There was a problem hiding this comment.
sorry by "section" I only meant point 3! Quick recap: I do believe this explanation is useful for users to understand why do we have an intermediate representation of the Multicall, so interfaces + structures should be described. How the functions work internally to handle these interfaces + structs is what I think is not necessary.
There was a problem hiding this comment.
Hahaha whoops :) my mistake
Co-authored-by: Martín Triay <martriay@gmail.com>
This PR updates the Account library and contract to utilize namespace. This PR also updates the Account documentation. Since users requested better documentation, this not only updates the docs but provides a more thorough explanation regarding
AccountCallArrayand the flow of transactions.This resolves #258 and resolves #271.