Skip to content
This repository has been archived by the owner on Feb 28, 2022. It is now read-only.

Adding documentation detailing Funnel contract code #78

Closed
wants to merge 3 commits into from
Closed

Adding documentation detailing Funnel contract code #78

wants to merge 3 commits into from

Conversation

shahankhatch
Copy link
Contributor

No description provided.

@shahankhatch shahankhatch self-assigned this Aug 26, 2020
@shahankhatch shahankhatch mentioned this pull request Aug 26, 2020
Closed
adlerjohn
adlerjohn approved these changes Aug 27, 2020
View reviewed changes
Copy link
Contributor

@adlerjohn adlerjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@shahankhatch
Copy link
Contributor Author

Thanks for reviewing @adlerjohn!

@shahankhatch shahankhatch marked this pull request as draft August 27, 2020 14:46
@shahankhatch
Copy link
Contributor Author

From discussion with @adlerjohn, we've identified some improvements to this PR:

  • add clarity around 60-byte offset in calldata from Funnel to Fuel, which has to do with 32-byte values when only last 4 bytes are needed to get the function selector.
  • document relationship of Funnel smart contract wrt FunnelFactory.yulp and Deposit.yulp.
  • document a sequence diagram capturing actors and smart contract actions.

@adlerjohn
Copy link
Contributor

@SilentCicero can you finish documenting as above.

@adlerjohn adlerjohn closed this Feb 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@adlerjohn adlerjohn adlerjohn approved these changes

Assignees

@SilentCicero SilentCicero

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shahankhatch @adlerjohn @SilentCicero