builtin-actors
builtin-actors copied to clipboard
chore: docs: add user contract api docs
This work is heavily based of @longfeiWan9's work at https://github.com/longfeiWan9/BuiltIn-Actor-API
Todos before merge:
- [x] Miner WithdrawBalance missing method num
- [x] add datacap mint method
- [x] add datacap destroy method
- [x] update datacap Granularity docs (see https://github.com/filecoin-project/builtin-actors/pull/1197)
- [x] audit the method numbers in README and the docs
- [x] add hyperlinks to each method in the mega table
@jennijuju I have no access to directly push to your branch in this repo. Will you grant me access?
@jennijuju I have no access to directly push to your branch in this repo. Will you grant me access?
Done
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.
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 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 ?
@jennijuju we want this merged into master right?