builtin-actors icon indicating copy to clipboard operation
builtin-actors copied to clipboard

chore: docs: add user contract api docs

Open jennijuju opened this issue 2 years ago • 6 comments

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 avatar Feb 13 '23 02:02 jennijuju

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

longfeiWan9 avatar Feb 13 '23 14:02 longfeiWan9

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

Done

jennijuju avatar Feb 13 '23 14:02 jennijuju

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.

longfeiWan9 avatar Feb 13 '23 15:02 longfeiWan9

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 avatar Feb 14 '23 23:02 jennijuju

@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 ?

longfeiWan9 avatar Mar 07 '23 06:03 longfeiWan9

@jennijuju we want this merged into master right?

ZenGround0 avatar Apr 25 '24 15:04 ZenGround0