Move deployment of common contracts to Blockchain type

We also introduce a new option, called WithContracts, in order to
programmatically specify when a Blockchain instance should deploy
common contracts.

Author: m-Peter

Diff for: blockchain.go

@@ -158,6 +158,7 @@ type config struct {
 	TransactionValidationEnabled bool
 	ChainID                      flowgo.ChainID
 	CoverageReportingEnabled     bool
+	WithContracts                bool
 }
 
 func (conf config) GetStore() storage.Store {
@@ -215,6 +216,7 @@ var defaultConfig = func() config {
 		TransactionValidationEnabled: true,
 		ChainID:                      flowgo.Emulator,
 		CoverageReportingEnabled:     false,
+		WithContracts:                false,
 	}
 }()
 
@@ -403,6 +405,15 @@ func WithCoverageReportingEnabled(enabled bool) Option {
 	}
 }
 
+// WithContracts enables/disables deployment of common contracts, such as:
+// NFT, FUSD, MetadataViews, NFTStorefront/NFTStorefrontV2, ExampleNFT
+// The default value is falue.
+func WithContracts(enabled bool) Option {
+	return func(c *config) {
+		c.WithContracts = enabled
+	}
+}
+
 func (b *Blockchain) ReloadBlockchain() error {
 	var err error
 
@@ -430,8 +441,7 @@ func (b *Blockchain) ReloadBlockchain() error {
 
 // NewBlockchain instantiates a new emulated blockchain with the provided options.
 func NewBlockchain(opts ...Option) (*Blockchain, error) {
-
-	// apply options to the default config
+	// Apply options to the default config
 	conf := defaultConfig
 	for _, opt := range opts {
 		opt(&conf)
@@ -449,8 +459,18 @@ func NewBlockchain(opts ...Option) (*Blockchain, error) {
 	if err != nil {
 		return nil, err
 	}
-	return b, nil
+	if conf.WithContracts {
+		deployments, err := DeployContracts(b)
+		if err != nil {
+			conf.ServerLogger.Error().Err(err).Msg("❗  Failed to deploy contracts")
+		}
 
+		for _, contract := range deployments {
+			conf.ServerLogger.Info().Fields(map[string]any{
+				contract.Name: fmt.Sprintf("0x%s", contract.Address.Hex())}).Msg(contract.Description)
+		}
+	}
+	return b, nil
 }
 
 func (b *Blockchain) rollbackProvider() (storage.RollbackProvider, error) {

Diff for: server/contracts.go renamed to contracts.go

@@ -1,9 +1,8 @@
-package server
+package emulator
 
 import (
 	"fmt"
 
-	emulator "github.com/onflow/flow-emulator"
 	flowsdk "github.com/onflow/flow-go-sdk"
 	"github.com/onflow/flow-go-sdk/templates"
 	"github.com/onflow/flow-go/fvm"
@@ -14,12 +13,12 @@ import (
 )
 
 type DeployDescription struct {
-	name        string
-	address     flowsdk.Address
-	description string
+	Name        string
+	Address     flowsdk.Address
+	Description string
 }
 
-func deployContracts(b *emulator.Blockchain) ([]DeployDescription, error) {
+func DeployContracts(b *Blockchain) ([]DeployDescription, error) {
 	ftAddress := flowsdk.HexToAddress(fvm.FungibleTokenAddress(b.GetChain()).Hex())
 	serviceAddress := b.ServiceKey().Address
 
@@ -50,18 +49,18 @@ func deployContracts(b *emulator.Blockchain) ([]DeployDescription, error) {
 		},
 		{
 			name:        "NFTStorefrontV2",
-			description: "✨   NFT Storefront contract v2",
+			description: "✨  NFT Storefront contract v2",
 			source:      nftstorefront.NFTStorefront(2, ftAddress.String(), serviceAddress.String()),
 		},
 		{
 			name:        "NFTStorefront",
-			description: "✨   NFT Storefront contract",
+			description: "✨  NFT Storefront contract",
 			source:      nftstorefront.NFTStorefront(1, ftAddress.String(), serviceAddress.String()),
 		},
 	}
 
 	for _, c := range toDeploy {
-		err := deployContract(b, c.name, c.source)
+		err := DeployContract(b, c.name, c.source)
 		if err != nil {
 			return nil, err
 		}
@@ -81,18 +80,17 @@ func deployContracts(b *emulator.Blockchain) ([]DeployDescription, error) {
 		deployDescriptions = append(
 			deployDescriptions,
 			DeployDescription{
-				name:        c.name,
-				address:     serviceAddress,
-				description: c.description,
+				Name:        c.name,
+				Address:     serviceAddress,
+				Description: c.description,
 			},
 		)
 	}
 
 	return deployDescriptions, nil
 }
 
-func deployContract(b *emulator.Blockchain, name string, contract []byte) error {
-
+func DeployContract(b *Blockchain, name string, contract []byte) error {
 	serviceKey := b.ServiceKey()
 	serviceAddress := serviceKey.Address
 

Diff for: server/server.go

@@ -166,18 +166,6 @@ func NewEmulatorServer(logger *zerolog.Logger, conf *Config) *EmulatorServer {
 		logger.Info().Fields(map[string]any{contract: address}).Msg("📜  Flow contract")
 	}
 
-	if conf.WithContracts {
-		deployments, err := deployContracts(blockchain)
-		if err != nil {
-			logger.Error().Err(err).Msg("❗  Failed to deploy contracts")
-		}
-
-		for _, contract := range deployments {
-			logger.Info().Fields(map[string]any{
-				contract.name: fmt.Sprintf("0x%s", contract.address.Hex())}).Msg(contract.description)
-		}
-	}
-
 	be := configureBackend(logger, conf, blockchain)
 
 	livenessTicker := NewLivenessTicker(conf.LivenessCheckTolerance)
@@ -350,6 +338,7 @@ func configureBlockchain(logger *zerolog.Logger, conf *Config, store storage.Sto
 		emulator.WithChainID(conf.ChainID),
 		emulator.WithContractRemovalEnabled(conf.ContractRemovalEnabled),
 		emulator.WithCoverageReportingEnabled(conf.CoverageReportingEnabled),
+		emulator.WithContracts(conf.WithContracts),
 	}
 
 	if conf.SkipTransactionValidation {