Merge pull request #680 from onflow/improvement/flowkit-tx

devbugging · web-flow · commit 7a1c804d6e77 · 2022-11-23T20:26:07.000+01:00
Transaction API refactor
diff --git a/go.mod b/go.mod
@@ -7,10 +7,10 @@ require (
 	github.com/go-git/go-git/v5 v5.4.2
 	github.com/manifoldco/promptui v0.9.0
 	github.com/onflow/cadence v0.28.0
-	github.com/onflow/cadence-tools/languageserver v0.2.0
+	github.com/onflow/cadence-tools/languageserver v0.3.1
 	github.com/onflow/cadence-tools/test v0.2.1-0.20221012182900-f46efb551c55
 	github.com/onflow/fcl-dev-wallet v0.5.3
-	github.com/onflow/flow-cli/pkg/flowkit v0.0.0-20221012181819-8d43a4be0028
+	github.com/onflow/flow-cli/pkg/flowkit v0.0.0-20221123090817-587405125c1f
 	github.com/onflow/flow-emulator v0.38.1
 	github.com/onflow/flow-go-sdk v0.29.1
 	github.com/onflowser/flowser/v2 v2.0.8-beta
diff --git a/go.sum b/go.sum
@@ -673,8 +673,8 @@ github.com/onflow/cadence v0.15.0/go.mod h1:KMzDF6cIv6nb5PJW9aITaqazbmJX8MMeibFc
 github.com/onflow/cadence v0.20.1/go.mod h1:7mzUvPZUIJztIbr9eTvs+fQjWWHTF8veC+yk4ihcNIA=
 github.com/onflow/cadence v0.28.0 h1:18A1V9xqGewibEhuzqBNEoNvqG6OwVqHg7gKu3UliaM=
 github.com/onflow/cadence v0.28.0/go.mod h1:h+SbY8RNl6Q6sT6l/2cvpUZUJNCbzJya+3Bkwe/0YwY=
-github.com/onflow/cadence-tools/languageserver v0.2.0 h1:DwBBk2zlbjjbuftEU2Tl/2T2GKU18a2/+BiS8Gawzxo=
-github.com/onflow/cadence-tools/languageserver v0.2.0/go.mod h1:qCRa+S7sQ3cLIEgUu1d21Yft4oWEZAKadJ19ID4etzw=
+github.com/onflow/cadence-tools/languageserver v0.3.1 h1:I9au/BQgpcOL+P4dm60zbKP01la/DPt0L5mn9JO1yIE=
+github.com/onflow/cadence-tools/languageserver v0.3.1/go.mod h1:Jo1JI07xkrl/WlCRvuMfp+x1VyUCsXEtHXGsCnBC9/E=
 github.com/onflow/cadence-tools/lint v0.2.0 h1:i+Mvht3hQQNNxe4jV8BRTr97wFWlJSRGTOM03BSyloQ=
 github.com/onflow/cadence-tools/lint v0.2.0/go.mod h1:r4kEtmZe4XuKcx/JXEU027i6+cpMtRc0GaLCAE6EvYs=
 github.com/onflow/cadence-tools/test v0.2.1-0.20221012182900-f46efb551c55 h1:l/JqX4qnukAf2rCfZ0afPvK13eNPeL6gbv2GAweuVuE=
diff --git a/internal/accounts/contract-add.go b/internal/accounts/contract-add.go
@@ -57,12 +57,9 @@ func addContract(
 	srv *services.Services,
 	state *flowkit.State,
 ) (command.Result, error) {
-	filename := ""
-	if len(args) == 1 {
-		filename = args[0]
-	} else {
-		fmt.Println("⚠️Deprecation notice: using name argument in add contract " +
-			"command will be deprecated soon.")
+	filename := args[0]
+	if len(args) > 1 {
+		fmt.Println("⚠️Deprecation notice: using name argument in add contract command will be deprecated soon.")
 		filename = args[1]
 	}
 
@@ -90,10 +87,12 @@ func addContract(
 	account, err := srv.Accounts.AddContract(
 		to,
 		&services.Contract{
-			Source:   code,
-			Args:     contractArgs,
-			Filename: filename,
-			Network:  globalFlags.Network,
+			Script: &services.Script{
+				Code:     code,
+				Args:     contractArgs,
+				Filename: filename,
+			},
+			Network: globalFlags.Network,
 		},
 		false,
 	)
diff --git a/internal/accounts/contract-update.go b/internal/accounts/contract-update.go
@@ -57,13 +57,9 @@ func updateContract(
 	srv *services.Services,
 	state *flowkit.State,
 ) (command.Result, error) {
-	filename := ""
-
-	if len(args) == 1 {
-		filename = args[0]
-	} else {
-		fmt.Println("⚠️Deprecation notice: using name argument in update contract " +
-			"command will be deprecated soon.")
+	filename := args[0]
+	if len(args) > 1 {
+		fmt.Println("⚠️Deprecation notice: using name argument in add contract command will be deprecated soon.")
 		filename = args[1]
 	}
 
@@ -91,10 +87,12 @@ func updateContract(
 	account, err := srv.Accounts.AddContract(
 		to,
 		&services.Contract{
-			Source:   code,
-			Args:     contractArgs,
-			Filename: filename,
-			Network:  globalFlags.Network,
+			Script: &services.Script{
+				Code:     code,
+				Args:     contractArgs,
+				Filename: filename,
+			},
+			Network: globalFlags.Network,
 		},
 		true,
 	)
diff --git a/internal/scripts/execute.go b/internal/scripts/execute.go
@@ -50,7 +50,7 @@ func execute(
 	args []string,
 	readerWriter flowkit.ReaderWriter,
 	globalFlags command.GlobalFlags,
-	services *services.Services,
+	srv *services.Services,
 ) (command.Result, error) {
 	filename := args[0]
 
@@ -70,10 +70,12 @@ func execute(
 		return nil, fmt.Errorf("error parsing script arguments: %w", err)
 	}
 
-	value, err := services.Scripts.Execute(
-		code,
-		scriptArgs,
-		filename,
+	value, err := srv.Scripts.Execute(
+		&services.Script{
+			Code:     code,
+			Args:     scriptArgs,
+			Filename: filename,
+		},
 		globalFlags.Network,
 	)
 	if err != nil {
diff --git a/internal/tools/flowser.go b/internal/tools/flowser.go
@@ -24,14 +24,15 @@ import (
 	"os"
 	"runtime"
 
+	"github.com/onflowser/flowser/v2/pkg/flowser"
+	"github.com/spf13/cobra"
+
 	"github.com/onflow/flow-cli/internal/command"
 	"github.com/onflow/flow-cli/internal/settings"
 	"github.com/onflow/flow-cli/pkg/flowkit"
 	"github.com/onflow/flow-cli/pkg/flowkit/config"
 	"github.com/onflow/flow-cli/pkg/flowkit/output"
 	"github.com/onflow/flow-cli/pkg/flowkit/services"
-	"github.com/onflowser/flowser/v2/pkg/flowser"
-	"github.com/spf13/cobra"
 )
 
 type FlagsFlowser struct{}
diff --git a/internal/transactions/build.go b/internal/transactions/build.go
@@ -21,6 +21,8 @@ package transactions
 import (
 	"fmt"
 
+	"github.com/onflow/flow-cli/pkg/flowkit/output"
+
 	"github.com/onflow/cadence"
 	"github.com/onflow/flow-go-sdk"
 	"github.com/spf13/cobra"
@@ -57,7 +59,7 @@ func build(
 	args []string,
 	readerWriter flowkit.ReaderWriter,
 	globalFlags command.GlobalFlags,
-	services *services.Services,
+	srv *services.Services,
 	state *flowkit.State,
 ) (command.Result, error) {
 	proposer, err := getAddress(buildFlags.Proposer, state)
@@ -92,29 +94,31 @@ func build(
 	} else {
 		transactionArgs, err = flowkit.ParseArgumentsWithoutType(filename, code, args[1:])
 	}
-
 	if err != nil {
 		return nil, fmt.Errorf("error parsing transaction arguments: %w", err)
 	}
 
-	build, err := services.Transactions.Build(
-		proposer,
-		authorizers,
-		payer,
+	tx, err := srv.Transactions.Build(
+		services.NewTransactionAddresses(proposer, payer, authorizers),
 		buildFlags.ProposerKeyIndex,
-		code,
-		filename,
+		&services.Script{
+			Code:     code,
+			Args:     transactionArgs,
+			Filename: filename,
+		},
 		buildFlags.GasLimit,
-		transactionArgs,
 		globalFlags.Network,
-		globalFlags.Yes,
 	)
 	if err != nil {
 		return nil, err
 	}
 
+	if !globalFlags.Yes && !output.ApproveTransactionForBuildingPrompt(tx) {
+		return nil, fmt.Errorf("transaction was not approved")
+	}
+
 	return &TransactionResult{
-		tx:      build.FlowTransaction(),
+		tx:      tx.FlowTransaction(),
 		include: []string{"code", "payload", "signatures"},
 	}, nil
 }
diff --git a/internal/transactions/send-signed.go b/internal/transactions/send-signed.go
@@ -21,6 +21,8 @@ package transactions
 import (
 	"fmt"
 
+	"github.com/onflow/flow-cli/pkg/flowkit/output"
+
 	"github.com/onflow/flow-cli/pkg/flowkit"
 
 	"github.com/spf13/cobra"
@@ -61,14 +63,23 @@ func sendSigned(
 		return nil, fmt.Errorf("error loading transaction payload: %w", err)
 	}
 
-	tx, result, err := services.Transactions.SendSigned(code, globalFlags.Yes)
+	tx, err := flowkit.NewTransactionFromPayload(code)
+	if err != nil {
+		return nil, err
+	}
+
+	if !globalFlags.Yes && !output.ApproveTransactionForSendingPrompt(tx) {
+		return nil, fmt.Errorf("transaction was not approved for sending")
+	}
+
+	sentTx, result, err := services.Transactions.SendSigned(tx)
 	if err != nil {
 		return nil, err
 	}
 
 	return &TransactionResult{
 		result:  result,
-		tx:      tx,
+		tx:      sentTx,
 		include: sendSignedFlags.Include,
 		exclude: sendSignedFlags.Exclude,
 	}, nil
diff --git a/internal/transactions/send.go b/internal/transactions/send.go
@@ -57,7 +57,7 @@ func send(
 	args []string,
 	readerWriter flowkit.ReaderWriter,
 	globalFlags command.GlobalFlags,
-	services *services.Services,
+	srv *services.Services,
 	state *flowkit.State,
 ) (command.Result, error) {
 	codeFilename := args[0]
@@ -82,17 +82,18 @@ func send(
 	} else {
 		transactionArgs, err = flowkit.ParseArgumentsWithoutType(codeFilename, code, args[1:])
 	}
-
 	if err != nil {
 		return nil, fmt.Errorf("error parsing transaction arguments: %w", err)
 	}
 
-	tx, result, err := services.Transactions.Send(
-		signer,
-		code,
-		codeFilename,
+	tx, result, err := srv.Transactions.Send(
+		services.NewSingleTransactionAccount(signer),
+		&services.Script{
+			Code:     code,
+			Args:     transactionArgs,
+			Filename: codeFilename,
+		},
 		sendFlags.GasLimit,
-		transactionArgs,
 		globalFlags.Network,
 	)
 
diff --git a/internal/transactions/sign.go b/internal/transactions/sign.go
@@ -105,10 +105,15 @@ func sign(
 	})
 
 	for _, signer := range signers {
-		signed, err = services.Transactions.Sign(signer, payload, globalFlags.Yes)
+		if !globalFlags.Yes && !output.ApproveTransactionForSigningPrompt(tx) {
+			return nil, fmt.Errorf("transaction was not approved for signing")
+		}
+
+		signed, err = services.Transactions.Sign(signer, payload)
 		if err != nil {
 			return nil, err
 		}
+
 		payload = []byte(hex.EncodeToString(signed.FlowTransaction().Encode()))
 	}
 
diff --git a/pkg/flowkit/go.mod b/pkg/flowkit/go.mod
@@ -121,7 +121,6 @@ require (
 	github.com/onflow/flow-go/crypto v0.24.4 // indirect
 	github.com/onflow/flow/protobuf/go/flow v0.3.1 // indirect
 	github.com/onflow/sdks v0.4.4 // indirect
-	github.com/onflowser/flowser v2.0.3-beta.0.20221111134556-ac0de9cfd29d+incompatible // indirect
 	github.com/opentracing/opentracing-go v1.2.0 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.2 // indirect
diff --git a/pkg/flowkit/go.sum b/pkg/flowkit/go.sum
@@ -644,10 +644,6 @@ github.com/onflow/flow/protobuf/go/flow v0.3.1 h1:4I8ykG6naR3n8Or6eXrZDaGVaoztb3
 github.com/onflow/flow/protobuf/go/flow v0.3.1/go.mod h1:gQxYqCfkI8lpnKsmIjwtN2mV/N2PIwc1I+RUK4HPIc8=
 github.com/onflow/sdks v0.4.4 h1:aJPGJJLAN+mlBWAQxsyuJXeRRMFeLwU6Mp4e/YL6bdU=
 github.com/onflow/sdks v0.4.4/go.mod h1:F0dj0EyHC55kknLkeD10js4mo14yTdMotnWMslPirrU=
-github.com/onflowser/flowser v2.0.3-beta+incompatible h1:65EQI3hiuslm8cL7bbF/kFplnS7aXckTnSzQUiO91iY=
-github.com/onflowser/flowser v2.0.3-beta+incompatible/go.mod h1:STRNiMaL+okmsNCBuNUdVuFQ81pTGaKY0iuyLK/k0UU=
-github.com/onflowser/flowser v2.0.3-beta.0.20221111134556-ac0de9cfd29d+incompatible h1:kAsI/4KtvNz3+syzhaQtDz4R4RgoI9Iw+2W2hP4a90E=
-github.com/onflowser/flowser v2.0.3-beta.0.20221111134556-ac0de9cfd29d+incompatible/go.mod h1:STRNiMaL+okmsNCBuNUdVuFQ81pTGaKY0iuyLK/k0UU=
 github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
diff --git a/pkg/flowkit/services/accounts.go b/pkg/flowkit/services/accounts.go
@@ -282,15 +282,13 @@ func (a *Accounts) Create(
 // source code, possible init arguments, the filename and network are only
 // required if a contract has imports that need resolving.
 type Contract struct {
-	Name     string
-	Source   []byte
-	Args     []cadence.Value
-	Filename string
-	Network  string
+	*Script
+	Name    string
+	Network string
 }
 
 func (c *Contract) validate(hasImports bool) error {
-	if c.Source == nil {
+	if c.Code == nil {
 		return fmt.Errorf("must provide contract source code")
 	}
 	if c.Name == "" {
@@ -311,7 +309,7 @@ func (a *Accounts) AddContract(
 	contract *Contract,
 	updateExisting bool,
 ) (*flow.Account, error) {
-	resolver, err := contracts.NewResolver(contract.Source)
+	resolver, err := contracts.NewResolver(contract.Code)
 	if err != nil {
 		return nil, err
 	}
@@ -333,7 +331,7 @@ func (a *Accounts) AddContract(
 			return nil, err
 		}
 
-		contract.Source, err = resolver.ResolveImports(
+		contract.Code, err = resolver.ResolveImports(
 			contract.Filename,
 			contractsNetwork,
 			a.state.AliasesForNetwork(contract.Network),
@@ -346,7 +344,7 @@ func (a *Accounts) AddContract(
 	tx, err := flowkit.NewAddAccountContractTransaction(
 		account,
 		contract.Name,
-		string(contract.Source),
+		string(contract.Code),
 		contract.Args,
 	)
 	if err != nil {
@@ -358,7 +356,7 @@ func (a *Accounts) AddContract(
 		tx, err = flowkit.NewUpdateAccountContractTransaction(
 			account,
 			contract.Name,
-			string(contract.Source),
+			string(contract.Code),
 		)
 		if err != nil {
 			return nil, err
diff --git a/pkg/flowkit/services/accounts_test.go b/pkg/flowkit/services/accounts_test.go
@@ -57,11 +57,12 @@ func setup() (*flowkit.State, *Services, *tests.TestGateway) {
 
 func resourceToContract(res tests.Resource) *Contract {
 	return &Contract{
-		Name:     res.Name,
-		Source:   res.Source,
-		Args:     nil,
-		Filename: res.Filename,
-		Network:  "",
+		Script: &Script{
+			Code:     res.Source,
+			Filename: res.Filename,
+		},
+		Name:    res.Name,
+		Network: "",
 	}
 }
 
@@ -609,10 +610,11 @@ func TestAccountsRemoveContract_Integration(t *testing.T) {
 	_, err := s.Accounts.AddContract(
 		srvAcc,
 		&Contract{
-			Name:     c.Name,
-			Source:   c.Source,
-			Args:     nil,
-			Filename: c.Filename,
+			Script: &Script{
+				Code:     c.Source,
+				Filename: c.Filename,
+			},
+			Name: c.Name,
 		},
 		false,
 	)
diff --git a/pkg/flowkit/services/scripts.go b/pkg/flowkit/services/scripts.go
diff --git a/pkg/flowkit/services/scripts_test.go b/pkg/flowkit/services/scripts_test.go
diff --git a/pkg/flowkit/services/transactions.go b/pkg/flowkit/services/transactions.go
diff --git a/pkg/flowkit/services/transactions_test.go b/pkg/flowkit/services/transactions_test.go
