Initial implementation of app-specific actions #580

lukasz-zimnoch · 2020-10-14T11:28:40Z

Refs: #574
Depends on: keep-network/tbtc#739

Here we introduce the backbone which allows adding application-specific actions straight into the keep-ecdsa client. As its first use, we also add the TBTC extension which allows invoking retrieveSignerPubkey action on new deposits which are close to exceeding the signing group formation timeout. Here is a brief summary of major changes:

Added a new [Extensions.TBTC] section in the config which allows configuring the TBTC extension
Implemented a TBTC wrapper around the existing Ethereum chain implementation which takes advantage of Add Go contract bindings tbtc#739 and use these bindings to interact with TBTC contracts
Developed a structure for app-specific extensions allowing to handle multiple applications and chains
Implemented a TBTC extension with one retrieveSignerPubkey action allowing to add new actions as well
Created a TBTC wrapper around the local chain implementation and developed several unit test scenarios which leverage that chain

Added a new sections to the config file. It allows to configure some properties needed by the app-specific actions feature.

Implemented a starting point for TBTC-specific actions. This also includes several chain extensions needed by TBTC actions.

`Connect` function should return struct instead of the chain interface. This is because the caller invokes that function explicitly to obtain a specific implementation of the chain. That change also follows the Go `accept interfaces return structs` principle.

Added initialization of the app-specific actions directly in the start command.

configs/config.toml.SAMPLE

cmd/start.go

pkg/chain/ethereum/tbtc_extensions.go

pkg/actions/tbtc_actions.go

Removed the `DepositLog` binding usage in favor of `TBTCSystem` binding as it is the actual contract emitting deposit lifecycle events. Apart that, a refactoring of the config structure has been made.

Move the app-specific parts of the chain implementation into the application package.

Implemented the backbone for TBTC actions and added the `retrievePubkey` action.

cmd/start.go

configs/config.toml.SAMPLE

cmd/start.go

pkg/applications/tbtc/chain/ethereum/ethereum.go

pkg/applications/tbtc/tbtc.go

pkg/chain/ethereum/connect.go

configs/config.toml.SAMPLE

pkg/extensions/tbtc/chain.go

pkg/chain/ethereum/tbtc.go

cmd/start.go

Implemented a basic unit test checking the happy path of the retrieve pubkey TBTC extension using a local chain implementation.

pdyraga

Some comments on general naming and logs.

pkg/extensions/tbtc/tbtc.go

Implemented new unit test scenarios for retrieve pubkey TBTC extension using a local chain implementation.

lukasz-zimnoch · 2020-10-20T12:04:48Z

@pdyraga all comments addressed! I'm starting tests on my local environment but I don't expect any big changes in the code. Also, I think those TODOs listed in pkg/extensions/tbtc/tbtc.go should be addressed in separate PRs.

pdyraga

Some additional comments, mostly about naming, docs, and logs.

Reviewing tests now.

configs/config.toml.SAMPLE

go.sum

internal/config/config.go

pkg/extensions/tbtc/tbtc.go

pkg/chain/local/bonded_ecdsa_keep_factory.go

pkg/chain/local/local.go

pkg/extensions/tbtc/tbtc_test.go

pkg/extensions/tbtc/tbtc.go

pdyraga

🚀

lukasz-zimnoch added 4 commits October 14, 2020 13:04

Add actions to the config file

fd7f82d

Added a new sections to the config file. It allows to configure some properties needed by the app-specific actions feature.

Add TBTC actions and chain extensions stub

624400b

Implemented a starting point for TBTC-specific actions. This also includes several chain extensions needed by TBTC actions.

Enable app-specific actions in the start command

52b3e48

Added initialization of the app-specific actions directly in the start command.

lukasz-zimnoch requested a review from pdyraga October 14, 2020 11:28

lukasz-zimnoch changed the title ~~App specific actions~~ Initial implementation of app-specific actions Oct 14, 2020

pdyraga added the 📟 client label Oct 14, 2020

Use TBTC contract bindings

3f318a3

pdyraga reviewed Oct 14, 2020

View reviewed changes

configs/config.toml.SAMPLE Outdated Show resolved Hide resolved

cmd/start.go Outdated Show resolved Hide resolved

pkg/chain/ethereum/tbtc_extensions.go Outdated Show resolved Hide resolved

pkg/actions/tbtc_actions.go Outdated Show resolved Hide resolved

lukasz-zimnoch added 9 commits October 14, 2020 20:18

Bump up tbtc go bindings

ce789c2

Align with tbtc bindings changes

a48c965

Actions structure change

3890ebf

Merge branch 'master' into app-specific-actions

c378e7e

Use TBTCSystem contract binding and config rework

40f2f9c

Removed the `DepositLog` binding usage in favor of `TBTCSystem` binding as it is the actual contract emitting deposit lifecycle events. Apart that, a refactoring of the config structure has been made.

Rework the ethereum extensions structure

a438ec0

Move the app-specific parts of the chain implementation into the application package.

Merge branch 'master' into app-specific-actions

31e98b6

Implementation of the retrievePubkey action

2d3019a

Implemented the backbone for TBTC actions and added the `retrievePubkey` action.

Add GoSec exception for random jitter generator

e97914a

pdyraga reviewed Oct 19, 2020

View reviewed changes

cmd/start.go Outdated Show resolved Hide resolved

configs/config.toml.SAMPLE Outdated Show resolved Hide resolved

cmd/start.go Outdated Show resolved Hide resolved

pkg/applications/tbtc/chain/ethereum/ethereum.go Outdated Show resolved Hide resolved

lukasz-zimnoch added 5 commits October 19, 2020 12:40

Simplify extension section in the config sample

d6d2a26

Use extension-centric naming

a64dbc2

Move TBTCEthereumChain to the ethereum package

f6dd208

Merge branch 'master' into app-specific-actions

6025d32

Update tbtc bindings dependency

81118a8

pdyraga reviewed Oct 19, 2020

View reviewed changes

pkg/applications/tbtc/tbtc.go Outdated Show resolved Hide resolved

pkg/applications/tbtc/tbtc.go Outdated Show resolved Hide resolved

pkg/applications/tbtc/tbtc.go Outdated Show resolved Hide resolved

pdyraga reviewed Oct 19, 2020

View reviewed changes

pkg/applications/tbtc/tbtc.go Outdated Show resolved Hide resolved

pdyraga reviewed Oct 19, 2020

View reviewed changes

pkg/chain/ethereum/connect.go Show resolved Hide resolved

pdyraga reviewed Oct 19, 2020

View reviewed changes

configs/config.toml.SAMPLE Outdated Show resolved Hide resolved

lukasz-zimnoch added 2 commits October 19, 2020 13:55

Use extension-centric naming - next part

4a88afb

Extract TBTC chain interfaces to separate file

e475ff7

Align some naming in the tbtc extensions code

3523e60

pdyraga reviewed Oct 19, 2020

View reviewed changes

configs/config.toml.SAMPLE Outdated Show resolved Hide resolved

pkg/extensions/tbtc/chain.go Outdated Show resolved Hide resolved

pkg/chain/ethereum/tbtc.go Outdated Show resolved Hide resolved

cmd/start.go Show resolved Hide resolved

Basic unit tests for app-specific extensions

a7c3cd0

Implemented a basic unit test checking the happy path of the retrieve pubkey TBTC extension using a local chain implementation.

pdyraga reviewed Oct 19, 2020

View reviewed changes

lukasz-zimnoch added 7 commits October 20, 2020 11:19

Extended unit tests for app-specific extensions

302323f

Implemented new unit test scenarios for retrieve pubkey TBTC extension using a local chain implementation.

Add new GoSec exceptions

caeb475

Change the comment describing Extensions.TBTC

71851ad

Change pkg/chain alias in tbtc extensions code

2f046a2

Improve general naming and logs

7899037

Satisfy the GoSec checker

6c88853

Update tbtc bindings

4a8b996

lukasz-zimnoch marked this pull request as ready for review October 20, 2020 12:04

lukasz-zimnoch mentioned this pull request Oct 22, 2020

Redemption flow actions #585

Merged

pdyraga reviewed Oct 22, 2020

View reviewed changes

pkg/chain/local/bonded_ecdsa_keep_factory.go Outdated Show resolved Hide resolved

pkg/chain/local/local.go Outdated Show resolved Hide resolved

pkg/extensions/tbtc/tbtc_test.go Show resolved Hide resolved

pkg/extensions/tbtc/tbtc_test.go Show resolved Hide resolved

lukasz-zimnoch added 8 commits October 23, 2020 10:17

Merge branch 'master' into app-specific-actions

57fa352

Add additional explanation to [Extensions.TBTC]

8cac02d

Tidy the go.sum

bb6f6f0

Improve docs for TBTC config struct

b51ce89

Minor naming improvements of tbtc extensions

89f436b

Minor naming improvements of local chain and tests

71efdea

Add a panic in case of createKeepWithMembers err

3b6082d

Remove the nosec from local OpenKeep

0be18c6

pdyraga reviewed Oct 23, 2020

View reviewed changes

pkg/extensions/tbtc/tbtc.go Outdated Show resolved Hide resolved

pdyraga added this to the v1.5.0 milestone Oct 23, 2020

Change timeout message for tbtc extension

becf9e3

pdyraga approved these changes Oct 23, 2020

View reviewed changes

pdyraga merged commit f49e8c4 into master Oct 23, 2020

pdyraga deleted the app-specific-actions branch October 23, 2020 08:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial implementation of app-specific actions #580

Initial implementation of app-specific actions #580

lukasz-zimnoch commented Oct 14, 2020 •

edited

Loading

pdyraga left a comment

lukasz-zimnoch commented Oct 20, 2020

pdyraga left a comment

pdyraga left a comment

Initial implementation of app-specific actions #580

Initial implementation of app-specific actions #580

Conversation

lukasz-zimnoch commented Oct 14, 2020 • edited Loading

pdyraga left a comment

Choose a reason for hiding this comment

lukasz-zimnoch commented Oct 20, 2020

pdyraga left a comment

Choose a reason for hiding this comment

pdyraga left a comment

Choose a reason for hiding this comment

lukasz-zimnoch commented Oct 14, 2020 •

edited

Loading