Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: docs: add user contract api docs #1210

Open
wants to merge 10 commits into
base: release/v10
Choose a base branch
from
Open

Conversation

jennijuju
Copy link
Member

@jennijuju jennijuju commented Feb 13, 2023

This work is heavily based of @longfeiWan9's work at https://github.com/longfeiWan9/BuiltIn-Actor-API

Todos before merge:

  • Miner WithdrawBalance missing method num
  • add datacap mint method
  • add datacap destroy method
  • update datacap Granularity docs (see update Granularity export name  #1197)
  • audit the method numbers in README and the docs
  • add hyperlinks to each method in the mega table

@longfeiWan9
Copy link
Member

@jennijuju I have no access to directly push to your branch in this repo. Will you grant me access?

@jennijuju
Copy link
Member Author

@jennijuju I have no access to directly push to your branch in this repo. Will you grant me access?

Done

@longfeiWan9
Copy link
Member

longfeiWan9 commented Feb 13, 2023

Update this PR based on the checklist.
And then find out that we do not have ethaccount and evm actor docs, I already added ethaccount.md. But I have not write docs for evm actor since I still have not figure out what is it and how will it be used.

@jennijuju jennijuju changed the base branch from master to release/v10 February 14, 2023 23:10
@jennijuju
Copy link
Member Author

Update this PR based on the checklist.
And then find out that we do not have ethaccount and evm actor docs, I already added ethaccount.md. But I have not write docs for evm actor since I still have not figure out what is it and how will it be used.

for evm actor it doesn't have exported method tho!

@jennijuju jennijuju marked this pull request as ready for review February 14, 2023 23:12
@jennijuju jennijuju linked an issue Feb 14, 2023 that may be closed by this pull request
@longfeiWan9
Copy link
Member

@jennijuju added read-only flags according to the nature of built-in actor methods as well as read-only flags set in filecoin.solidity.

I think this is ready, maybe someone can review and sign off to merge ?

Copy link
Member

@anorth anorth left a comment

Choose a reason for hiding this comment

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

Rubber stamp. I haven't reviewed all the docs for accuracy. In this case we're deciding that something is better than nothing.

@ZenGround0
Copy link
Contributor

@jennijuju we want this merged into master right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for exported APIs
4 participants