The builtin-actors from filecoin-project

TestCommitPoStFlow
~~- [ ] TestMeasurePreCommitGas~~
~~- [ ] TestMeasurePoRepGas~~
TestBatchOnboarding
TestAggregateOnePreCommitExpires
TestAggregateBadSender
TestAggregateSizeLimits
TestAggregateBadSectorNumber
~~- [ ] TestMeasureAggregatePorepGas~~

power scenario integration tests

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/power_scenario_test.go

TestCreateMiner
TestCronTick

Initial Coverage:

|| actors/cron/src/lib.rs: 23/28

Unit tests to migrate/check

cron $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

TestConstructor
- TestConstructor/construct_with_empty_entries
- TestConstructor/construct_with_non-empty_entries
TestEpochTick
- TestEpochTick/epoch_tick_with_empty_entries
- TestEpochTick/epoch_tick_with_non-empty_entries
- TestEpochTick/built-in_entries

Make room in runtime policy for market, reward policies

#68 extracted miner policy constants to a runtime Policy object, but ignored other built-in actors with similar policy settings.

Restructure to make room for configurable policy settings for all built-in actors, maybe something like Policy.Miner.xyz .

specs-actors implements the CheckState function for all actors. This function traverses actor state looking for inconsistencies. This check is used both in testing (unit and integration) and in live checks of main net state.

This issue tracks work to duplicate the existing CheckState methods and the top-level traversal of filecoin network state

Move the runtime directory to a peer of actors, rather than child

Move the runtime directory out from under actors so that only actors are in the actors dir.

Reward Actor Test Coverage

Initial coverage

|| actors/reward/src/expneg.rs: 6/6
|| actors/reward/src/lib.rs: 67/115
|| actors/reward/src/logic.rs: 30/30
|| actors/reward/src/state.rs: 39/50

Unit tests to migrate/check

go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

Create reference rust vm for integration test

Similar to https://github.com/filecoin-project/specs-actors/blob/master/support/vm/vm.go - we need a simplified message execution framework that FVM like for integration tests.

Prefer ActorID where possible

Prefer ActorID where possible - check that's the case in rust actor (may impact gases)

similar to filecoin-project/ref-fvm#289

Perform operations in sorted order (in builtin actors)

Proposal

I'm switching out our "hash" maps/sets with "btree" maps/sets (in actors, at least) due to filecoin-project/ref-fvm#232. Given this, I'd like to switch some of our parameter processing from "first encountered deadline/partition" to "sorted order" because btrees are ordered anyways.

If we do this right, clients that pass pre-sorted parameters should get a bit of a gas discount as well.

Background

In order to be deterministic pre-FVM, built-in actors that need to "group" inputs either needed to execute these groups based on the order in which they were encountered in the params, or sort them before executing.

By example:

Group, then execute based on first encountered:

let mut grouped = HashMap::<_, Vec<_>>::new();
// Keep track of the order in which we first encounter "keys" (groups).
let mut keys = Vec::new();

for inp in inputs {
    let key = key(&inp);
    grouped.entry(key).or_insert_with(||{ keys.push(key); key }).push(inp);
}

// Execute based on that order.
for key in keys {
    let value = grouped[key];
}

Group then sort:

let mut grouped = HashMap::<_, Vec<_>>::new();
for inp in inputs {
    grouped.entry(key(&inp)).or_default().push(inp);
}

// Once we've grouped, extract the keys.
let mut keys = grouped.keys();
// Sort them.
keys.sort();

// Execute based on these keys.
for key in keys {
    let value = grouped[key];
}

However, two things have changed:

Actors now have no access to system randomness so the original reason no longer stands.
We can't securely use hash-maps in many cases at all due to filecoin-project/ref-fvm#232. As a part of this, I've been switching HashMaps and HashSets to BTreeMap/Sets.

Power Actor Test Coverage

Initial coverage

|| actors/power/src/lib.rs: 0/368
|| actors/power/src/state.rs: 16/166

Unit tests to migrate/check

power ⟩ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

ExpectAbort and ExpectAbortContainsMessage

We've discussed bringing these testing helpers to rust actors and this issue tracks the discussion.

I think it makes sense to bring both things over. Less controversially we should at least try to bring ExpectAbort over. There's probably some reason this wasn't added in the first place related to things being different in rust. We should try adding this functionality to the mock runtime and see what happens.

Init Actor Test Coverage

Initial Coverage

|| actors/init/src/lib.rs: 41/55
|| actors/init/src/state.rs: 17/19

Unit tests to migrate/check

init $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

TestConstructor
TestExec
- TestExec/abort_actors_that_cannot_call_exec
- TestExec/happy_path_exec_create_2_payment_channels
- TestExec/happy_path_exec_create_storage_miner
- TestExec/happy_path_create_multisig_actor
- TestExec/sending_to_constructor_failure

Add a simple Makefile [edit: and use it for CI]

Add basic rules to help people unfamiliar with Rust development environment get started.

Ensure there is a rule that replicates the checks that will run on CI.

Account Actor Test Coverage

Initial Coverage

|| actors/account/src/lib.rs: 17/22

Unit tests to migrate/check

account $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

TestAccountactor
- TestAccountactor/happy_path_construct_SECP256K1_address
- TestAccountactor/happy_path_construct_BLS_address
- TestAccountactor/fail_to_construct_account_actor_using_ID_address
- TestAccountactor/fail_to_construct_account_actor_using_Actor_address

Validate proof types on decode

Currently, we validate proof types manually inside our actors to match go's behavior. It would be safer to simply reject invalid proof types when we attempt to decode state/messages.

Doing this for NV16 (M1) is pretty easy: we'd just remove the Invalid cases from our enums. E.g.:

https://github.com/filecoin-project/ref-fvm/blob/0692d5bbb4d7ca588278a3544a48504a7f5ed0ee/shared/src/sector/registered_proof.rs#L30

Doing this after Nv16 is possible, but slightly tricker as these types tend to be "shared" between versions. Although it shouldn't be too bad as we won't re-compile nv16 actors in nv17.

replica update integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/replica_update_test.go

verifreg remove datacap integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/verifreg_remove_datacap_test.go

TestRemoveDataCapSimpleSuccessfulPath

Add/Refactor error handling to Actors V7

As agreed with @raulk and @Stebalien - we will add error handling, next to the V7 actor's version.
We will then put everything together in the actors V8, which will be used for internal and external audits, which we plan to conduct from Mid March.

could not compile as a result of the car file output localtion

warning: bundle=/home/dtynn/proj/github.com/filecoin-project/builtin-actors/target/release/build/filecoin_canonical_actors_bundle-29a911457ca77f1f/out/bundle/bundle.car
error: couldn't read /home/dtynn/proj/github.com/filecoin-project/builtin-actors/target/release/build/filecoin_canonical_actors_bundle-29a911457ca77f1f/out/bundle.car: No such file or directory (os error 2)
  --> bundle/src/lib.rs:23:31
   |
23 | pub const BUNDLE_CAR: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/bundle.car"));
   |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this error originates in the macro `include_bytes` (in Nightly builds, run with -Z macro-backtrace for more info)

The following warnings were emitted during compilation:

error occurs for cargo build --release

difference between

https://github.com/filecoin-project/builtin-actors/blob/master/bundle/build.rs#L41

and

https://github.com/filecoin-project/builtin-actors/blob/master/bundle/src/lib.rs#L23

Rename this repo to builtin-actors

In the past, without a real VM, a name like spec-actors or canonical-actors made sense because there were no other actors and this code defined the precise behaviour. But the FVM will introduce a flourishing of new, user-programmed actors that will do all kinds of wonderful things. Some of those will become "canonical" in the loose sense of the work, e.g. by setting standard APIs for tokens, loans, deals, derivatives etc. Using the name canonical for this repo somehow downgrades the importance of the user actors we're seeking to enable.

The axis that will distinguish the actors in this repo from all the others will be that these are built-in to the network, forming part of the consensus rules, and change only with network upgrades. The built-in/user-programmed axis is clear, but I don't think canonical/non-canonical makes as much sense.

Extend sector with deals integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/extend_sectors_test.go

TestExtendSectorWithDeals

Eager bitfield validation in parameters

The rust actors lazily validate bitfields because that's what go does. We do want to lazily validate bitfields in state (too expensive to validate them every time we load state), but we should be eagerly validating bitfields in parameters and return values.

Once we start making consensus breaking changes, we should replace all UnvalidatedBitFields in parameters with BitField.

Remove old CC upgrade/replace params

Now SnapDeal is live in the network, we should remove all code that's only for the old cc upgrade path, including ReplaceCapacity params.ReplaceSectorNumber and so on.

bundle: make Manifest top-level structure fully IPLD-compatible

See #6 (comment).

Use custom error types and remove error downcasting

Currently, we have a lot of "anyhow" errors and rely on error downcasting to figure out the right exit code. Unfortunately, this makes it very difficult to figure out what the exit code should be.

Instead, we'd ideally:

Abort immediately once we know the right exit code (#282).
Return situation-specific errors from state types like partitions & deadlines, so we can figure out the correct exit code.

Market Actor Test Coverage

Initial coverage

|| actors/market/src/deal.rs: 0/15
|| actors/market/src/lib.rs: 9/816
|| actors/market/src/policy.rs: 0/18
|| actors/market/src/state.rs: 21/311

Unit tests to migrate/check

market $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

Paych Actor Test Coverage

Initial coverage

|| actors/paych/src/lib.rs: 113/171
|| actors/paych/src/state.rs: 2/2
|| actors/paych/src/types.rs: 14/14

Unit tests to migrate/check

paych $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

determine final versioning strategy

Continuing the discussion started in #12.

There are two version numbers that come into play when reasoning about built-in actor evolution and versioning schemes:

builtin-actors crate version number (vX.Y.Z, semver semantics)
network actor version number (I suspect this doesn't technically exist in the protocol, but it's a de-facto reality that all clients model actor version as a single vN ordinal).

IMO, there are roughly two approaches we can take:

Try to make crate versions numbers align with network actor versions numbers.
- Actor version numbers are modelled as single int ordinal, so we would abandon minor version usage in crate versioning, and allow patch version bumping to denote bugfix releases before they hit mainnet (e.g. we made a definitive v10.0.0 release, but during the last mile of testing we discovered a bug and we released v10.0.1, which is ultimately what hit mainnet).
- All releases prior to the definitive release would be pre-final releases (e.g. beta, RC, etc.). These releases would be deployed in testnets.
Only match on the major version, but give total freedom for bumping minor and patch versions in crate versioning.
- This means that for ActorVersion=10, the crate version hitting the network could be v10.2.3.
- We'd need an authoritative table somewhere tracking which crate version went live with each network version.
- This approach gives the community more flexibility when releasing, but we'd need to have a second discussion on what events lead to major, minor, and patch bumping. Perhaps it creates more organizational complexity.

msig signer self removal integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/multisig_delete_self_test.go

TestMultisigDeleteSelf2Of3RemovedIsProposer
TestMultisigDeleteSelf2Of3RemovedIsApprover
TestMultisigDeleteSelf2Of2
TestMultisigSwapsSelf2Of3
TestMultisigDeleteSigner1Of2
TestMultisigSwapsSelf1Of2

Use a fixed byte array to represent randomness

Currently, we use a vector to match go's behavior of decoding any byte array as "randomness", then later asserting that it's the right length. In M1, we should be able to change this type to just a fixed-length byte array.

[EPIC]Test Coverage

Our task is to improve coverage across the board, by porting the spec-actors test suite and ensuring 1-to-1 correspondence (to the point it makes sense).
This issue is here to track progress towards that goal

Actor Coverage

Initial Test Coverage Details

This is the current coverage as reported by tarpaulin:

Mar 02 18:29:54.671  INFO cargo_tarpaulin::report: Coverage Results:
|| Tested/Total Lines:
|| actors/account/src/lib.rs: 17/22
|| actors/account/tests/account_actor_test.rs: 30/32
|| actors/cron/src/lib.rs: 23/28
|| actors/cron/tests/cron_actor_test.rs: 71/71
|| actors/init/src/lib.rs: 41/55
|| actors/init/src/state.rs: 17/19
|| actors/init/tests/init_actor_test.rs: 130/132
|| actors/market/src/deal.rs: 0/15
|| actors/market/src/lib.rs: 9/816
|| actors/market/src/policy.rs: 0/18
|| actors/market/src/state.rs: 21/311
|| actors/market/tests/market_actor_test.rs: 23/69
|| actors/miner/src/bitfield_queue.rs: 0/55
|| actors/miner/src/deadline_assignment.rs: 0/51
|| actors/miner/src/deadline_info.rs: 0/40
|| actors/miner/src/deadline_state.rs: 0/594
|| actors/miner/src/deadlines.rs: 0/34
|| actors/miner/src/expiration_queue.rs: 0/438
|| actors/miner/src/lib.rs: 0/2353
|| actors/miner/src/monies.rs: 0/65
|| actors/miner/src/partition_state.rs: 0/382
|| actors/miner/src/policy.rs: 0/52
|| actors/miner/src/sector_map.rs: 0/64
|| actors/miner/src/sectors.rs: 0/67
|| actors/miner/src/state.rs: 0/475
|| actors/miner/src/termination.rs: 0/15
|| actors/miner/src/vesting_state.rs: 0/55
|| actors/multisig/src/lib.rs: 0/345
|| actors/multisig/src/state.rs: 0/41
|| actors/multisig/src/types.rs: 0/2
|| actors/paych/src/lib.rs: 113/171
|| actors/paych/src/state.rs: 2/2
|| actors/paych/src/types.rs: 14/14
|| actors/paych/tests/paych_actor_test.rs: 478/500
|| actors/power/src/lib.rs: 0/368
|| actors/power/src/state.rs: 16/166
|| actors/reward/src/expneg.rs: 6/6
|| actors/reward/src/lib.rs: 67/115
|| actors/reward/src/logic.rs: 30/30
|| actors/reward/src/state.rs: 39/50
|| actors/reward/tests/reward_actor_test.rs: 131/137
|| actors/runtime/src/actor_error.rs: 6/16
|| actors/runtime/src/builtin/network.rs: 0/3
|| actors/runtime/src/builtin/sector.rs: 0/4
|| actors/runtime/src/builtin/shared.rs: 3/16
|| actors/runtime/src/builtin/singletons.rs: 4/10
|| actors/runtime/src/lib.rs: 13/13
|| actors/runtime/src/runtime/actor_blockstore.rs: 0/3
|| actors/runtime/src/runtime/fvm.rs: 0/160
|| actors/runtime/src/runtime/mod.rs: 2/12
|| actors/runtime/src/test_utils.rs: 232/369
|| actors/runtime/src/util/balance_table.rs: 33/41
|| actors/runtime/src/util/chaos/mod.rs: 0/84
|| actors/runtime/src/util/downcast.rs: 16/56
|| actors/runtime/src/util/multimap.rs: 27/34
|| actors/runtime/src/util/set.rs: 23/27
|| actors/runtime/src/util/set_multimap.rs: 31/42
|| actors/runtime/src/util/unmarshallable.rs: 9/13
|| actors/runtime/tests/alpha_beta_filter_test.rs: 82/82
|| actors/runtime/tests/balance_table_test.rs: 31/31
|| actors/runtime/tests/multimap_test.rs: 39/39
|| actors/runtime/tests/set_multimap_test.rs: 27/27
|| actors/runtime/tests/set_test.rs: 26/26
|| actors/system/src/lib.rs: 0/8
|| actors/verifreg/src/lib.rs: 0/294
|| actors/verifreg/src/state.rs: 0/7
|| actors/verifreg/src/types.rs: 0/1
|| bundle/bundler/src/bin/bundler.rs: 0/13
|| bundle/bundler/src/lib.rs: 71/75
|| 
19.97% coverage, 1953/9781 lines covered

As we can see, we have quite low coverage with some actors not covered at all.

Handle or migrate away from non-utf8 DealProposal Labels

See filecoin-project/FIPs#187 and https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0027.md.

According to the FIP, these should be migrated to byte strings.
For now, we should accept non-utf8 strings. But that's... nasty.
An alternative is to just migrate labels to utf8.

At the moment, we reject non-utf8 labels. But we need to make a decision before we ship.

Introduce the actors V7 changes

Needed to support nv15 onwards

Audit actors params after ref-fvm gas changes

@jennijuju points out that after we have the revised gas values from the FVM, we should audit those params in actors that could be affected. It's possible that the PreCommitBatch max size, for instance, might need to be lowered if the old max can't theoretically fit in a message anymore.

I do not expect any of these to need to change.

generate and integrate CAR bundle

This issue tracks work being carried out in the raulk/initial branch of this repo:

Verifreg Actor Test Coverage

Initial coverage

|| actors/verifreg/src/lib.rs: 0/294
|| actors/verifreg/src/state.rs: 0/7
|| actors/verifreg/src/types.rs: 0/1

Unit tests to migrate/check

verifreg $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

market / miner withdrawal integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/market_miner_withdrawal_test.go

TestMarketWithdraw
TestMinerWithdraw

TestPublishStorageDealsFailure

terminate sector integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/terminate_sectors_scenario_test.go

TestTerminateSectors

move 2 fixes over to FVM

Built-in actors abort versus errors

In go actors, we panic (abort) with an exit code on error.
In rust actors, we bubble an error all the way to the caller.

We should abort in rust actors as well:

It's easier to say we exit with code X on error E, because nothing can intercept/downcast/etc. the error.
It's faster (we exit immediately) and helps the compiler optimize for the non-error path.

System Actor Test Coverage

Initial coverage

|| actors/system/src/lib.rs: 0/8

Unit tests to migrate/check

system $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

TestConstruction

Multisig actor test coverage

Initial coverage

|| actors/multisig/src/lib.rs: 0/345
|| actors/multisig/src/state.rs: 0/41
|| actors/multisig/src/types.rs: 0/2

Unit tests to migrate/check

multisig $ go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

Miner Actor Test Coverage

Initial coverage

|| actors/miner/src/bitfield_queue.rs: 0/55
|| actors/miner/src/deadline_assignment.rs: 0/51
|| actors/miner/src/deadline_info.rs: 0/40
|| actors/miner/src/deadline_state.rs: 0/594
|| actors/miner/src/deadlines.rs: 0/34
|| actors/miner/src/expiration_queue.rs: 0/438
|| actors/miner/src/lib.rs: 0/2353
|| actors/miner/src/monies.rs: 0/65
|| actors/miner/src/partition_state.rs: 0/382
|| actors/miner/src/policy.rs: 0/52
|| actors/miner/src/sector_map.rs: 0/64
|| actors/miner/src/sectors.rs: 0/67
|| actors/miner/src/state.rs: 0/475
|| actors/miner/src/termination.rs: 0/15
|| actors/miner/src/vesting_state.rs: 0/55

Unit tests to migrate/check

go test -v ./... | grep PASS | sed 's/--- PASS:/- [ ]/g' | sed 's/ (.*)//g' | grep -v PASS

msig proposal hash integration test

refer to https://github.com/filecoin-project/specs-actors/blob/master/actors/test/multisig_proposal_hash_test.go

TestProposalHash

filecoin-project / builtin-actors Goto Github PK

builtin-actors's People

Contributors

Stargazers

Watchers

Forkers

builtin-actors's Issues

Initial Coverage:

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Initial Coverage

Unit tests to migrate/check

Initial Coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Actor Coverage

Initial Test Coverage Details

Initial coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Initial coverage

Unit tests to migrate/check

Recommend Projects

Recommend Topics

Recommend Org