feat: add filecoin to CLI, `Filecoin.ChainNotify` method, and Filecoin support for websockets/subscriptions #768

mikeseese · 2021-02-04T19:04:14Z

This PR is a continuation of both #767 (which was a continuation of #726) and #712. Here is what this PR adds:

Add the Filecoin package to the CLI interface properly
- This includes keeping the @ganache/filecoin package as a peerDependency for @ganache/flavors and failing if the package cannot be found
- This peer dependency architecture required me to provide separate type declarations to prevent a circular dependency. I have a strong feeling @davidmurdoch will not be a fan of this, but I believe this is the only setup that will work in production. I could be wrong and am open to alternatives. I provided a root script tsc.filecoin.declarations to allow for quick ease and file cleaning via pretty-quick
- Neither of these two things (root linking script and type declaration generation) are currently automated (meaning the developer has to call them when they need it). I'm not sure if/who you want this in your development process, so I left it out as it's a trivial thing to setup later. I can do this if you let me know what the desired dev experience should be.
Preliminary reorganization of tests in @ganache/filecoin. This branch also fixes existing tests.
Some other minor housekeeping stuff (some code styling, etc)
Supports the Chain Explorer feature in the https://github.com/filecoin-shipyard/filecoin-network-inspector example
Adds support for truffle preserve
Corrects all of the Filecoin types to be consistent with the Filecoin API v1.4.0

It working with the Chain Explorer:

It working with truffle preserve:

davidmurdoch

This is a partial review. I just want to get this feedback to you sooner rather than later.

.github/workflows/pr.yml

scripts/lerna-ttsc.sh

src/chains/ethereum/options/src/index.ts

src/chains/ethereum/options/src/miner-options.ts

src/chains/ethereum/ethereum/tests/api/debug/debug.test.ts

src/chains/filecoin/filecoin/src/api.ts

src/chains/filecoin/filecoin/src/blockchain.ts

src/packages/utils/src/utils/random-number-generator.ts

src/packages/options/src/definition.ts

tcoulter

Lots of awesome work here, and it's great to see this progressing. Aside, it's super cool you got Websockets in there.

I made a handful of comments. The majority of them are related to code style for one specific pattern you use within the code. Would love for you to change that. The rest are questions.

Thanks again!

src/chains/filecoin/filecoin/src/api.ts

src/chains/filecoin/filecoin/src/provider.ts

src/chains/filecoin/filecoin/src/schema.ts

src/chains/filecoin/filecoin/src/things/beacon-entry.ts

src/chains/filecoin/filecoin/src/things/channel-id.ts

src/chains/filecoin/filecoin/src/things/start-deal-params.ts

src/chains/filecoin/filecoin/src/things/storage-market-data-ref.ts

src/chains/filecoin/filecoin/src/things/ticket.ts

src/chains/filecoin/filecoin/src/things/tipset.ts

src/chains/filecoin/filecoin/tests/blockchain/blockchain.test.ts

Co-authored-by: David Murdoch <[email protected]>

…hods

mikeseese · 2021-02-11T21:07:35Z

@tcoulter approved this on Slack

…n support for websockets/subscriptions (#768) Co-authored-by: David Murdoch <[email protected]>

mikeseese added the filecoin label Feb 4, 2021

mikeseese requested a review from tcoulter February 4, 2021 19:04

mikeseese self-assigned this Feb 4, 2021

mikeseese changed the title ~~feat: add filecoin to CLI, Filecoin.ChainNotify metho, and Filecoin support for websockets/subscriptions~~ feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoin support for websockets/subscriptions Feb 4, 2021

davidmurdoch suggested changes Feb 4, 2021

View reviewed changes

mikeseese force-pushed the feat/filecoin-chainnotify branch from e6da8f8 to ec414e0 Compare February 5, 2021 04:29

tcoulter suggested changes Feb 5, 2021

View reviewed changes

mikeseese requested a review from tcoulter February 5, 2021 19:44

mikeseese and others added 22 commits February 5, 2021 12:14

get filecoin cli working

902b5e2

make sure deterministic wallet option comes before seed

21b8487

add option to change the rpc endpoint to support filecoin

99789c5

update to use cliDescription instead of shortDescription

dd81c95

set rpcEndpoint default in the definition instead of CLI args.ts

0f7e4b1

set the default logger to console (as stated in docs)

154d72f

disable logging in filecoin tests

2531d26

apply changes from code review

c94d41a

change default description of rpcEndpoint

1fe428e

Co-authored-by: David Murdoch <[email protected]>

fix blocktime after removing automine option

a6b6932

disable logging in blockchain tests

8e28d54

fix blocktime to be seconds instead of milliseconds

376f008

add colors to tests! 🎨

b5aaa28

fix non-filecoin tests affected by filecoin

69a0306

reorganize provider option types

f473b95

rename FilecoinApi's blockchain member to be consistent with ethereum

05ad5fc

break up api tests

f776edc

update lotus schema

bc21428

add test to check that we report invalid method for unimplemented met…

ff1a44a

…hods

ensure Filecoin prefixed api calls are all valid api methods

d1dc627

add test for Ganache.MineTipset method

77e9e95

support peer dependency for @ganache/filecoin due to node@12 requirement

ca3d1de

mikeseese added 20 commits February 5, 2021 12:14

add a longer timeout for filecoin tests

af0e793

make sure we return the serialized input if it's the last resort

30ed41e

make sure we run tsc in CI to catch all compiler errors

0f0091c

fix server tests

a003393

increase timeout for memory footprint test

a492ce6

try a more forgiving block interval test

11685a2

try adding a timeout for filecoin websocket tests for github ci

d8223e0

adjust websocket timeouts

275b970

try ws.terminate for better erroring?

697c6b1

make sure that we process an empty string for deserializing buffers

9bd0bee

fix RNG imports

6f88626

update type declarations

8e45f7c

remove link.filecoin script in favor of flavors devDependency

2988e4d

fix errors from filecoin type declarations generation

305af80

remove unused file

69ef141

change RandomNumberGenerate.getBuffer to be [0, 255] inclusive

e112f50

change expected address after changing RNG behavior

86900de

move external types to the proper directory

14529cf

update comment about executor's execute params

d77e8d0

remove helper type per requested change on code review

96a633a

mikeseese force-pushed the feat/filecoin-chainnotify branch from c5a0cef to 96a633a Compare February 5, 2021 20:14

update type declarations

13e14bf

mikeseese force-pushed the filecoin branch from cd1efca to 0402719 Compare February 8, 2021 18:25

mikeseese merged commit 5972ff0 into filecoin Feb 11, 2021

mikeseese deleted the feat/filecoin-chainnotify branch February 11, 2021 21:08

mikeseese added a commit that referenced this pull request Feb 16, 2021

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoi…

a956cc8

…n support for websockets/subscriptions (#768) Co-authored-by: David Murdoch <[email protected]>

mikeseese added a commit that referenced this pull request Mar 25, 2021

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoi…

9a143b6

…n support for websockets/subscriptions (#768) Co-authored-by: David Murdoch <[email protected]>

mikeseese added a commit that referenced this pull request Mar 30, 2021

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoi…

384bfa4

…n support for websockets/subscriptions (#768) Co-authored-by: David Murdoch <[email protected]>

mikeseese added a commit that referenced this pull request Mar 30, 2021

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoi…

d16dd6a

…n support for websockets/subscriptions (#768) Co-authored-by: David Murdoch <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add filecoin to CLI, `Filecoin.ChainNotify` method, and Filecoin support for websockets/subscriptions #768

feat: add filecoin to CLI, `Filecoin.ChainNotify` method, and Filecoin support for websockets/subscriptions #768

mikeseese commented Feb 4, 2021 •

edited

Loading

davidmurdoch left a comment

tcoulter left a comment

mikeseese commented Feb 11, 2021

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoin support for websockets/subscriptions #768

feat: add filecoin to CLI, Filecoin.ChainNotify method, and Filecoin support for websockets/subscriptions #768

Conversation

mikeseese commented Feb 4, 2021 • edited Loading

davidmurdoch left a comment

Choose a reason for hiding this comment

tcoulter left a comment

Choose a reason for hiding this comment

mikeseese commented Feb 11, 2021

feat: add filecoin to CLI, `Filecoin.ChainNotify` method, and Filecoin support for websockets/subscriptions #768

feat: add filecoin to CLI, `Filecoin.ChainNotify` method, and Filecoin support for websockets/subscriptions #768

mikeseese commented Feb 4, 2021 •

edited

Loading