Export stable methods for public access #807

arajasek · 2022-11-06T19:06:08Z

This is work towards #772, and is the first steps towards an implementation of filecoin-project/FIPs#401.

Using the pattern developed in #797, this PR exports the methods agreed upon in this spreadsheet. It is somewhat sparingly tested.

This PR does not ADD any new methods, that work is deferred to a separate PR, nor does it implement other changes needed to make these exported useful (eg. #806).

codecov-commenter · 2022-11-06T19:28:00Z

Codecov Report

❗ No coverage uploaded for pull request base (integration/builtin-api@1f9aba6). Click here to learn what that means.
The diff coverage is n/a.

Additional details and impacted files

@@                    Coverage Diff                     @@
##             integration/builtin-api     #807   +/-   ##
==========================================================
  Coverage                           ?   88.17%           
==========================================================
  Files                              ?       95           
  Lines                              ?    19653           
  Branches                           ?        0           
==========================================================
  Hits                               ?    17329           
  Misses                             ?     2324           
  Partials                           ?        0

ZenGround0 · 2022-11-06T22:49:22Z

This seems to be missing account actor exports. Also note that the market actor call to AuthenticateMessage should change to AuthenticateMessageExported. Any other method that we expect user actors to implement and builtin actors to call should also be handled this way.

anorth · 2022-11-06T23:22:52Z

actors/datacap/src/lib.rs

+
+/// Datacap actor methods available
+/// Some methods are available under 2 method nums -- a static number for "private" builtin actor usage,
+/// and via FRC-XXXX calling convention, with number determined by method name.


I think we should drop the private versions of the standard methods, and invoke the exported ones from verifreg. I also think we should do it now (in a follow-up PR).

#808

actors/miner/src/lib.rs

actors/verifreg/tests/verifreg_actor_test.rs

arajasek · 2022-11-07T14:46:58Z

This seems to be missing account actor exports. Also note that the market actor call to AuthenticateMessage should change to AuthenticateMessageExported. Any other method that we expect user actors to implement and builtin actors to call should also be handled this way.

@ZenGround0 The account actor exports were added in #797.

I'm going to add your flag to the list of changes we want in #424.

ZenGround0 · 2022-11-07T15:12:38Z

@arajasek #797 got one of the account actor exports but I think its missing the second one: https://github.com/filecoin-project/builtin-actors/blob/integration/builtin-api/actors/account/src/lib.rs#L128

arajasek · 2022-11-07T15:14:25Z

@ZenGround0 That one is already an "exported" method, no?

ZenGround0 · 2022-11-07T15:15:41Z

Aha yes thanks

arajasek · 2022-11-07T15:19:11Z

Thanks for looking, appreciate the 👀

ZenGround0 · 2022-11-07T15:21:25Z

No problem, love it when all my concerns are already taken care of!

* Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review

* Remove the market actor state mutation pattern (#734) Fixes #656 * Proof of concept exported API for Account actor (#797) * Export stable methods for public access (#807) * Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review * Restrict internal APIs of all actors (#809) * Exported API method for market actor escrow/locked balance (#812) * Power actor: Add exported getters for raw power (#810) * Power actor: Add exported getters for raw power * FRC-XXXX is FRC-0042 * Power actor: network_raw_power: Return this_epoch_raw_byte_power * Power actor: miner_raw_power: Return whether above consensus min power * Power actor: types: serialize one-element structs transparently * Address review * Miner actor: Add exported getters for info and monies (#811) * Miner actor: Add exported getters for info and monies * Tweak comment * Miner actor: Replace GetWorker and GetControls with IsControllingAddress * Miner actor: Add exported GetAvailableBalance * Miner actor: Add exported GetVestingFunds * Miner actor: Remove exported monies getters * Miner actor: types: serialize one-element structs transparently * Address review * Address review * Built-in market API for deal proposal metadata (#818) * Call exported authenticate method from PSD (#829) Co-authored-by: zenground0 <[email protected]> * Drop CALLER_TYPES_SIGNABLE and signable caller validation (#821) * Market actor: Minor improvements to two exported getters (#826) * Market actor: GetDealTermExported: Return (start_epoch, duration) * Market actor: Export getter for deal total price * Exported API for market deal activation state (#819) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs (#824) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs * Address review * Address review * Account actor: Deprecate AuthenticateMessage (#856) * Market actor: Export PublishStorageDeals (#857) * Miner: Export several more methods (#863) * Miner: Export ChangeWorkerAddress * Miner: Export ChangePeerID * Miner: Export WithdrawBalance * Miner: Export ChangeMultiaddrs * Miner: Export ConfirmUpdateWorkerKey * Miner: Export RepayDebt * Miner: Export ChangeOwnerAddress * Miner: Add exported getters for PeerID & multiaddrs * Miner: Refactor: Rename ConfirmUpdateWorkerKey to ConfirmChangeWorkerAddress * Power actor: Export methods to CreateMiner and get miner counts (#868) * Power: Export CreateMiner * Power Actor: Export MinerCount and MinerConsensusCount * Update actors/power/src/lib.rs Co-authored-by: Alex <[email protected]> Co-authored-by: Alex <[email protected]> * Verifreg: Export AddVerifiedClient and GetClaims (#873) * Verifreg: Rename AddVerifierClientParams to AddVerifiedClientParams * Verifreg: Export AddVerifiedClient and GetClaims * Datacap actor: Modify exported methods (#909) * Datacap: Export Mint and Destroy * Datacap actor: Deprecate all internal methods * Datacap actor: Rename BalanceOf to Balance * Datacap actor: Add Granularity method * fix: comments on newly exported methods (#910) Co-authored-by: RK <[email protected]> Co-authored-by: Alex <[email protected]> Co-authored-by: ZenGround0 <[email protected]> Co-authored-by: zenground0 <[email protected]>

* Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review

* Proof of concept exported API for Account actor (#797) * Export stable methods for public access (#807) * Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review * Restrict internal APIs of all actors (#809) * Exported API method for market actor escrow/locked balance (#812) * Power actor: Add exported getters for raw power (#810) * Power actor: Add exported getters for raw power * FRC-XXXX is FRC-0042 * Power actor: network_raw_power: Return this_epoch_raw_byte_power * Power actor: miner_raw_power: Return whether above consensus min power * Power actor: types: serialize one-element structs transparently * Address review * Miner actor: Add exported getters for info and monies (#811) * Miner actor: Add exported getters for info and monies * Tweak comment * Miner actor: Replace GetWorker and GetControls with IsControllingAddress * Miner actor: Add exported GetAvailableBalance * Miner actor: Add exported GetVestingFunds * Miner actor: Remove exported monies getters * Miner actor: types: serialize one-element structs transparently * Address review * Address review * Built-in market API for deal proposal metadata (#818) * Call exported authenticate method from PSD (#829) Co-authored-by: zenground0 <[email protected]> * Drop CALLER_TYPES_SIGNABLE and signable caller validation (#821) * Market actor: Minor improvements to two exported getters (#826) * Market actor: GetDealTermExported: Return (start_epoch, duration) * Market actor: Export getter for deal total price * Exported API for market deal activation state (#819) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs (#824) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs * Address review * Address review * Account actor: Deprecate AuthenticateMessage (#856) * Market actor: Export PublishStorageDeals (#857) * Miner: Export several more methods (#863) * Miner: Export ChangeWorkerAddress * Miner: Export ChangePeerID * Miner: Export WithdrawBalance * Miner: Export ChangeMultiaddrs * Miner: Export ConfirmUpdateWorkerKey * Miner: Export RepayDebt * Miner: Export ChangeOwnerAddress * Miner: Add exported getters for PeerID & multiaddrs * Miner: Refactor: Rename ConfirmUpdateWorkerKey to ConfirmChangeWorkerAddress * Power actor: Export methods to CreateMiner and get miner counts (#868) * Power: Export CreateMiner * Power Actor: Export MinerCount and MinerConsensusCount * Update actors/power/src/lib.rs Co-authored-by: Alex <[email protected]> Co-authored-by: Alex <[email protected]> * Verifreg: Export AddVerifiedClient and GetClaims (#873) * Verifreg: Rename AddVerifierClientParams to AddVerifiedClientParams * Verifreg: Export AddVerifiedClient and GetClaims * Datacap actor: Modify exported methods (#909) * Datacap: Export Mint and Destroy * Datacap actor: Deprecate all internal methods * Datacap actor: Rename BalanceOf to Balance * Datacap actor: Add Granularity method * fix: comments on newly exported methods (#910) * Miner: Export method to GetPendingOwner * MarketNotifyDeal (#944) Co-authored-by: zenground0 <[email protected]> * Verifreg: Call AuthenticateMessage instead of validating siggys * Multisig: Do not export any functionality (#967) * use const for EX_DEAL_EXPIRED (#954) * Address review Co-authored-by: Alex <[email protected]> Co-authored-by: ZenGround0 <[email protected]> Co-authored-by: zenground0 <[email protected]> Co-authored-by: Shashank <[email protected]>

* Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review

…ecoin-project#1004) * Proof of concept exported API for Account actor (filecoin-project#797) * Export stable methods for public access (filecoin-project#807) * Export Datacap Actor methods * Export Init Actor methods * Export Market Actor methods * Export Miner Actor methods * Export Multisig Actor methods * Export Verifreg Actor methods * Address review * Restrict internal APIs of all actors (filecoin-project#809) * Exported API method for market actor escrow/locked balance (filecoin-project#812) * Power actor: Add exported getters for raw power (filecoin-project#810) * Power actor: Add exported getters for raw power * FRC-XXXX is FRC-0042 * Power actor: network_raw_power: Return this_epoch_raw_byte_power * Power actor: miner_raw_power: Return whether above consensus min power * Power actor: types: serialize one-element structs transparently * Address review * Miner actor: Add exported getters for info and monies (filecoin-project#811) * Miner actor: Add exported getters for info and monies * Tweak comment * Miner actor: Replace GetWorker and GetControls with IsControllingAddress * Miner actor: Add exported GetAvailableBalance * Miner actor: Add exported GetVestingFunds * Miner actor: Remove exported monies getters * Miner actor: types: serialize one-element structs transparently * Address review * Address review * Built-in market API for deal proposal metadata (filecoin-project#818) * Call exported authenticate method from PSD (filecoin-project#829) Co-authored-by: zenground0 <[email protected]> * Drop CALLER_TYPES_SIGNABLE and signable caller validation (filecoin-project#821) * Market actor: Minor improvements to two exported getters (filecoin-project#826) * Market actor: GetDealTermExported: Return (start_epoch, duration) * Market actor: Export getter for deal total price * Exported API for market deal activation state (filecoin-project#819) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs (filecoin-project#824) * Paych actor: Drop account req, use AuthenticateMessage to verify sigs * Address review * Address review * Account actor: Deprecate AuthenticateMessage (filecoin-project#856) * Market actor: Export PublishStorageDeals (filecoin-project#857) * Miner: Export several more methods (filecoin-project#863) * Miner: Export ChangeWorkerAddress * Miner: Export ChangePeerID * Miner: Export WithdrawBalance * Miner: Export ChangeMultiaddrs * Miner: Export ConfirmUpdateWorkerKey * Miner: Export RepayDebt * Miner: Export ChangeOwnerAddress * Miner: Add exported getters for PeerID & multiaddrs * Miner: Refactor: Rename ConfirmUpdateWorkerKey to ConfirmChangeWorkerAddress * Power actor: Export methods to CreateMiner and get miner counts (filecoin-project#868) * Power: Export CreateMiner * Power Actor: Export MinerCount and MinerConsensusCount * Update actors/power/src/lib.rs Co-authored-by: Alex <[email protected]> Co-authored-by: Alex <[email protected]> * Verifreg: Export AddVerifiedClient and GetClaims (filecoin-project#873) * Verifreg: Rename AddVerifierClientParams to AddVerifiedClientParams * Verifreg: Export AddVerifiedClient and GetClaims * Datacap actor: Modify exported methods (filecoin-project#909) * Datacap: Export Mint and Destroy * Datacap actor: Deprecate all internal methods * Datacap actor: Rename BalanceOf to Balance * Datacap actor: Add Granularity method * fix: comments on newly exported methods (filecoin-project#910) * Miner: Export method to GetPendingOwner * MarketNotifyDeal (filecoin-project#944) Co-authored-by: zenground0 <[email protected]> * Verifreg: Call AuthenticateMessage instead of validating siggys * Multisig: Do not export any functionality (filecoin-project#967) * use const for EX_DEAL_EXPIRED (filecoin-project#954) * Address review Co-authored-by: Alex <[email protected]> Co-authored-by: ZenGround0 <[email protected]> Co-authored-by: zenground0 <[email protected]> Co-authored-by: Shashank <[email protected]>

arajasek added 6 commits November 6, 2022 14:03

Export Datacap Actor methods

b9b53fd

Export Init Actor methods

3425911

Export Market Actor methods

fe2d0e5

Export Miner Actor methods

695a26e

Export Multisig Actor methods

5cdec30

Export Verifreg Actor methods

bc1051e

anorth self-requested a review November 6, 2022 23:18

anorth approved these changes Nov 7, 2022

View reviewed changes

arajasek mentioned this pull request Nov 7, 2022

Audit and remove unwanted builtin-actor code for FVM #424

Open

Address review

264cf90

arajasek merged commit d876d42 into integration/builtin-api Nov 7, 2022

arajasek deleted the asr/builtin-apis branch November 7, 2022 14:49

arajasek mentioned this pull request Nov 7, 2022

Restrict internal APIs of all actors #809

Merged

jennijuju linked an issue Nov 7, 2022 that may be closed by this pull request

Allow differentiation between private and public APIs #772

Closed

jennijuju added this to the Reenginering built-in actors API milestone Dec 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Export stable methods for public access #807

Export stable methods for public access #807

Uh oh!

arajasek commented Nov 6, 2022 •

edited

Loading

Uh oh!

codecov-commenter commented Nov 6, 2022

Uh oh!

ZenGround0 commented Nov 6, 2022

Uh oh!

anorth Nov 6, 2022

Uh oh!

Uh oh!

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

Uh oh!

Export stable methods for public access #807

Export stable methods for public access #807

Uh oh!

Conversation

arajasek commented Nov 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Nov 6, 2022

Codecov Report

Uh oh!

ZenGround0 commented Nov 6, 2022

Uh oh!

anorth Nov 6, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

arajasek commented Nov 7, 2022

Uh oh!

ZenGround0 commented Nov 7, 2022

Uh oh!

Uh oh!

arajasek commented Nov 6, 2022 •

edited

Loading