one binary, multiple networks #8158

coryschwartz · 2022-02-19T11:14:14Z

Related Issues

Proposed Changes

Allow the same binary to be used across multiple networks.

Additionally, parameters can be overridden by environment variables.

Additional Info

Checklist

Before you mark the PR ready for review, please make sure that:

All commits have a clear commit message.
The PR title is in the form of of <PR type>: <area>: <change being made>
- example: fix: mempool: Introduce a cache for valid signatures
- PR type: fix, feat, INTERFACE BREAKING CHANGE, CONSENSUS BREAKING, build, chore, ci, docs,perf, refactor, revert, style, test
- area: api, chain, state, vm, data transfer, market, mempool, message, block production, multisig, networking, paychan, proving, sealing, wallet, deps
This PR has tests for new functionality or change in behaviour
If new user-facing features are introduced, clear usage guidelines and / or documentation updates should be included in https://lotus.filecoin.io or Discussion Tutorials.
CI is green

coryschwartz · 2022-02-19T11:21:52Z

WIP.

This will make it easier to change parameters, allowing the same binary to be used on multiple networks.

This removes the const, and in their place we access through getters.

I've submitted a similar proof-of-concept PR in the past and there was some consternation about removing the const's -- open to other ideas.

The justification for doing this is to ease operations. We want to be able to easily manage applications that should operate on multiple lotus networks without building and managing multiple binaries/images.

LOTUS_NETWORK=butterflynet ./lotus daemon

2022-02-19T03:21:26.919-0800	INFO	modules	modules/services.go:162	subscribing to pubsub topic /fil/blocks/butterflynet
2022-02-19T03:21:26.919-0800	INFO	messagepool	messagepool/messagepool.go:439	mpool ready
2022-02-19T03:21:26.920-0800	INFO	importmgr	imports/manager.go:62	sanity checking imports
2022/02/19 03:21:26 storess: Query
2022/02/19 03:21:26 storess: q.Prefix: 
2022/02/19 03:21:26 storess: q.KeysOnly: true
2022/02/19 03:21:26 storess: q.Filters: 0
2022/02/19 03:21:26 storess: q.Orders: 0
2022/02/19 03:21:26 storess: q.Offset: 0
2022-02-19T03:21:26.921-0800	INFO	importmgr	imports/manager.go:99	sanity check completed	{"broken": 0, "total": 0}
2022-02-19T03:21:26.922-0800	INFO	dt-impl	impl/impl.go:145	start data-transfer module
2022-02-19T03:21:26.931-0800	INFO	markets	loggers/loggers.go:55	module ready	{"module": "discovery"}
2022-02-19T03:21:26.933-0800	INFO	markets	loggers/loggers.go:55	module ready	{"module": "client data transfer"}
2022-02-19T03:21:26.936-0800	INFO	markets	loggers/loggers.go:55	module ready	{"module": "storage client"}
2022-02-19T03:21:26.937-0800	INFO	markets	loggers/loggers.go:55	module ready	{"module": "retrieval client"}
2022-02-19T03:21:31.639-0800	INFO	basichost	basic/natmgr.go:84	DiscoverNAT error:no NAT found
2022-02-19T03:21:31.917-0800	INFO	peermgr	peermgr/peermgr.go:210	connecting to bootstrap peers

travisperson · 2022-03-04T17:35:56Z

I think this is a good first pass at this, nothing jump out at me in regard to setting up or managing networks. I think we should discuss this with @arajasek.

coryschwartz · 2022-03-25T01:27:38Z

This allows you to switch networks with the same binary.

There are lots of of reasons it would be good to have a binary that can switch networks, particularly, this makes it easier to operate multiple netowrks with the same packages, docker images, etc.

Additionally, this adds the ability to specify a network definition file aside from the built-in file. Allowing external network definitions will help build new netowrks on the fly with custom parameters.

Currently, this is configured using only environment variables -- I'm not really stuck on this design. I considered re-writing this as a dependency injection, and could be convinced that this would be a better choice.

The current design takes previously constant values and instead exports them as getters only, so they cannot be easily changed at runtime.

jennijuju · 2022-04-15T00:42:34Z

woo this looks cool

magik6k

Conflicts/tests need fixing, but this looks really good

magik6k · 2022-04-25T18:19:45Z

itests/wdpost_test.go

-	och := build.UpgradeClausHeight
-	build.UpgradeClausHeight = 0
-	t.Cleanup(func() { build.UpgradeClausHeight = och })


We probably can just drop this entire test

travisperson

This is a pretty big changes and will require communication.

This PR doesn't touch the Makefile. However, a lot of the targets are no longer needed and should be removed (all the network builds).

The BuildType + version string should also be addressed.

lotus/build/version.go

Lines 8 to 37 in 97b92cd

    
           const ( 
        
           	BuildDefault      = 0 
        
           	BuildMainnet      = 0x1 
        
           	Build2k           = 0x2 
        
           	BuildDebug        = 0x3 
        
           	BuildCalibnet     = 0x4 
        
           	BuildInteropnet   = 0x5 
        
           	BuildButterflynet = 0x7 
        
           ) 
        
           func BuildTypeString() string { 
        
           	switch BuildType { 
        
           	case BuildDefault: 
        
           		return "" 
        
           	case BuildMainnet: 
        
           		return "+mainnet" 
        
           	case Build2k: 
        
           		return "+2k" 
        
           	case BuildDebug: 
        
           		return "+debug" 
        
           	case BuildCalibnet: 
        
           		return "+calibnet" 
        
           	case BuildInteropnet: 
        
           		return "+interopnet" 
        
           	case BuildButterflynet: 
        
           		return "+butterflynet" 
        
           	default: 
        
           		return "+huh?" 
        
           	} 
        
           }

It would probably be good to keep this version reporting, but make it defined by the LOTUS_NETWORK / LOTUS_NETWORK_DEFINITION_FILE. This will allow people to ask the daemon what network it's talking too, we shouldn't remove this piece of information from users. It's an important bit to gather when users fill out issues.

travisperson · 2022-04-25T18:39:41Z

build/params_debug.go

-	BuildType |= BuildDebug
-}
-
-// NOTE: Also includes settings from params_2k


Deleting this file breaks make debug, and no longer does anything. We need to keep the functionality that this file brings.

Disabling PoSt

Adding the +debug to the version string (this is done by the BuildType |= BuildDebug).

oo, good point.

I was hoping debug networks could be a runtime rather than build time decision. But there are some things that aren't ready for that, and I don't really want to make this PR any bigger than it already is.

I've added a params_debug back in. It sets the SlashablePowerDelay, Insecure PoSt, and sets the "BuildType" to debug.

codecov · 2022-04-25T19:14:46Z

Codecov Report

Merging #8158 (3c6db2b) into master (88f8c7d) will decrease coverage by 0.00%.
The diff coverage is 66.01%.

@@            Coverage Diff             @@
##           master    #8158      +/-   ##
==========================================
- Coverage   40.86%   40.86%   -0.01%     
==========================================
  Files         686      686              
  Lines       75710    75784      +74     
==========================================
+ Hits        30939    30966      +27     
- Misses      39445    39466      +21     
- Partials     5326     5352      +26

Impacted Files	Coverage Δ
chain/gen/slashfilter/slashfilter.go	`40.00% <0.00%> (ø)`
chain/store/messages.go	`73.58% <0.00%> (ø)`
chain/vm/gas.go	`79.16% <ø> (ø)`
chain/vm/syscalls.go	`39.07% <0.00%> (ø)`
chain/vm/vm.go	`62.16% <0.00%> (-0.54%)`	⬇️
cli/sync.go	`35.79% <0.00%> (ø)`
cmd/lotus-health/main.go	`16.26% <0.00%> (ø)`
cmd/lotus-miner/info.go	`60.50% <0.00%> (ø)`
cmd/lotus-pcr/main.go	`0.00% <0.00%> (ø)`
cmd/lotus-seed/genesis.go	`0.00% <0.00%> (ø)`
... and 68 more

coryschwartz · 2022-04-26T05:31:18Z

This is a pretty big changes and will require communication.

This PR doesn't touch the Makefile. However, a lot of the targets are no longer needed and should be removed (all the network builds).

The BuildType + version string should also be addressed.

lotus/build/version.go

Lines 8 to 37 in 97b92cd

const (

BuildDefault = 0

BuildMainnet = 0x1

Build2k = 0x2

BuildDebug = 0x3

BuildCalibnet = 0x4

BuildInteropnet = 0x5

BuildButterflynet = 0x7

)

func BuildTypeString() string {

switch BuildType {

case BuildDefault:

return ""

case BuildMainnet:

return "+mainnet"

case Build2k:

return "+2k"

case BuildDebug:

return "+debug"

case BuildCalibnet:

return "+calibnet"

case BuildInteropnet:

return "+interopnet"

case BuildButterflynet:

return "+butterflynet"

default:

return "+huh?"

}

}

It would probably be good to keep this version reporting, but make it defined by the LOTUS_NETWORK / LOTUS_NETWORK_DEFINITION_FILE. This will allow people to ask the daemon what network it's talking too, we shouldn't remove this piece of information from users. It's an important bit to gather when users fill out issues.

Updated the version string so it includes the network name.

It also occurs to me that anyone could create a network that matches a well-known built-in network, so I included a hash of the genesis there as well.

vyzo · 2022-04-26T05:33:40Z

we will need to rethink bundle loading for nv16 with this.

magik6k

I think we can land this if we get the backwards compatibility working

magik6k · 2022-05-06T18:29:16Z

Makefile

-2k: GOFLAGS+=-tags=2k
-2k: build-devnets
-
-calibnet: GOFLAGS+=-tags=calibnet
-calibnet: build-devnets
-
-butterflynet: GOFLAGS+=-tags=butterflynet
-butterflynet: build-devnets
-
-interopnet: GOFLAGS+=-tags=interopnet
-interopnet: build-devnets


We may want to keep those for compat for now - just changing the default network in the binary.

vyzo · 2022-05-06T18:50:33Z

Can we delay until after m1 ships, so that we figure out the bundling strategy?
Right now it would create irreconcilable conflicts with nv16.

ianconsolata · 2022-11-14T20:16:55Z

How is this going to affect #9625?

Kubuxu · 2022-11-15T01:02:27Z

How is this going to affect #9625?

It would no longer be required.

rjan90 · 2024-09-10T14:38:47Z

If somebody else wants this, it is probably better to start from scratch given the long list of conflicts, and how outdated this PR is by now. Closing for now.

one binary, multiple networks

3b39c40

coryschwartz changed the title ~~one binary, multiple networks~~ WIP: one binary, multiple networks Feb 19, 2022

Cory Schwartz added 7 commits February 19, 2022 03:50

remaining bins

9cfe4f6

fix tests, except wdpost_test

e39bbf9

add calibrationnet

3af4af3

add interopnet

0e77d63

no change claus height

1a672e0

make debug

3ba8941

lint

95ae097

coryschwartz mentioned this pull request Feb 23, 2022

Running dealbot on other networks filecoin-project/dealbot#361

Open

Cory Schwartz added 2 commits March 24, 2022 16:37

Merge branch 'master' into feat/multi-network-binary

3898588

allow specifying an external file

427bde1

coryschwartz changed the title ~~WIP: one binary, multiple networks~~ one binary, multiple networks Mar 25, 2022

Cory Schwartz added 2 commits March 24, 2022 18:02

handle err

1b53c56

add params test file

97b92cd

coryschwartz marked this pull request as ready for review March 25, 2022 01:27

coryschwartz requested a review from a team as a code owner March 25, 2022 01:27

magik6k self-requested a review April 16, 2022 10:49

magik6k reviewed Apr 25, 2022

View reviewed changes

travisperson reviewed Apr 25, 2022

View reviewed changes

Cory Schwartz added 5 commits April 25, 2022 18:49

Merge branch 'master' into feat/multi-network-binary

3dc3bae

fix networkVersion return

32214df

remove devnets from Makefile

14ed6d5

remove calibration/butterfly from circleci

ce61b76

remove calibration/butterfly packer scripts

ae03013

Cory Schwartz added 3 commits April 25, 2022 20:04

add network (and hash) to Version string

2f02587

add debug back in

dff2573

remove policy from debug

6df782a

Cory Schwartz added 5 commits April 25, 2022 22:37

fix buildall

20d1e5c

edit testplan

a4529c6

skip TestWindowPostBaseFeeNoBurn

51dce86

Merge branch 'master' into feat/multi-network-binary

5039828

add test

e609b29

magik6k reviewed May 6, 2022

View reviewed changes

Cory Schwartz added 2 commits May 8, 2022 20:55

Restore Makefile from master (compatibility)

5b03edc

workflow compatibility

c314735

vyzo mentioned this pull request May 10, 2022

Builtin Actor Bundling Strategy #8625

Closed

use the default

3c6db2b

magik6k mentioned this pull request Jun 14, 2022

integrate upgrade codenames into upgrade schedule. #4891

Closed

arajasek mentioned this pull request Nov 17, 2022

feature request: not require actor versions below network's genesis version #9677

Open

rjan90 closed this Sep 10, 2024

rjan90 deleted the feat/multi-network-binary branch February 3, 2025 08:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

one binary, multiple networks #8158

one binary, multiple networks #8158

coryschwartz commented Feb 19, 2022

coryschwartz commented Feb 19, 2022 •

edited

Loading

travisperson commented Mar 4, 2022

coryschwartz commented Mar 25, 2022

jennijuju commented Apr 15, 2022

magik6k left a comment

magik6k Apr 25, 2022

travisperson left a comment •

edited

Loading

travisperson Apr 25, 2022

coryschwartz Apr 26, 2022

codecov bot commented Apr 25, 2022 •

edited

Loading

coryschwartz commented Apr 26, 2022

vyzo commented Apr 26, 2022

magik6k left a comment

magik6k May 6, 2022

vyzo commented May 6, 2022

ianconsolata commented Nov 14, 2022

Kubuxu commented Nov 15, 2022

rjan90 commented Sep 10, 2024

	const (
	BuildDefault = 0
	BuildMainnet = 0x1
	Build2k = 0x2
	BuildDebug = 0x3
	BuildCalibnet = 0x4
	BuildInteropnet = 0x5
	BuildButterflynet = 0x7
	)

	func BuildTypeString() string {
	switch BuildType {
	case BuildDefault:
	return ""
	case BuildMainnet:
	return "+mainnet"
	case Build2k:
	return "+2k"
	case BuildDebug:
	return "+debug"
	case BuildCalibnet:
	return "+calibnet"
	case BuildInteropnet:
	return "+interopnet"
	case BuildButterflynet:
	return "+butterflynet"
	default:
	return "+huh?"
	}
	}

one binary, multiple networks #8158

one binary, multiple networks #8158

Conversation

coryschwartz commented Feb 19, 2022

Related Issues

Proposed Changes

Additional Info

Checklist

coryschwartz commented Feb 19, 2022 • edited Loading

travisperson commented Mar 4, 2022

coryschwartz commented Mar 25, 2022

jennijuju commented Apr 15, 2022

magik6k left a comment

Choose a reason for hiding this comment

magik6k Apr 25, 2022

Choose a reason for hiding this comment

travisperson left a comment • edited Loading

Choose a reason for hiding this comment

travisperson Apr 25, 2022

Choose a reason for hiding this comment

coryschwartz Apr 26, 2022

Choose a reason for hiding this comment

codecov bot commented Apr 25, 2022 • edited Loading

Codecov Report

coryschwartz commented Apr 26, 2022

vyzo commented Apr 26, 2022

magik6k left a comment

Choose a reason for hiding this comment

magik6k May 6, 2022

Choose a reason for hiding this comment

vyzo commented May 6, 2022

ianconsolata commented Nov 14, 2022

Kubuxu commented Nov 15, 2022

rjan90 commented Sep 10, 2024

coryschwartz commented Feb 19, 2022 •

edited

Loading

travisperson left a comment •

edited

Loading

codecov bot commented Apr 25, 2022 •

edited

Loading