Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix access(account) bug in contract staging validator #1523

Merged
merged 5 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions internal/migrate/staging_validator.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ type stagingValidator struct {
flow flowkit.Services
state *flowkit.State

// Location of the source code that is used for the update
sourceCodeLocation common.Location
// Location of the target contract that is being updated
targetLocation common.AddressLocation

// Cache for account contract names so we don't have to fetch them multiple times
accountContractNames map[common.Address][]string
// All resolved contract code
Expand Down Expand Up @@ -99,6 +104,9 @@ func (v *stagingValidator) ValidateContractUpdate(
// Code of the updated contract
updatedCode []byte,
) error {
v.sourceCodeLocation = sourceCodeLocation
v.targetLocation = location

// Resolve all system contract code & add to cache
v.loadSystemContracts()

Expand Down Expand Up @@ -192,8 +200,9 @@ func (v *stagingValidator) parseAndCheckContract(
// Only checking contracts, so no need to consider script standard library
return util.NewStandardLibrary().BaseValueActivation
},
LocationHandler: v.resolveLocation,
ImportHandler: v.resolveImport,
LocationHandler: v.resolveLocation,
ImportHandler: v.resolveImport,
MemberAccountAccessHandler: v.resolveAccountAccess,
},
)
if err != nil {
Expand Down Expand Up @@ -381,6 +390,26 @@ func (v *stagingValidator) resolveLocation(
return resolvedLocations, nil
}

func (v *stagingValidator) resolveAccountAccess(checker *sema.Checker, memberLocation common.Location) bool {
if checker == nil {
return false
}

checkerLocation, ok := checker.Location.(common.StringLocation)
if !ok {
return false
}

memberAddressLocation, ok := memberLocation.(common.AddressLocation)
if !ok {
return false
}

// If the source code of the update is being checked, we should check account access based on the
// targeted network location of the contract & not the source code location
return checkerLocation == v.sourceCodeLocation && memberAddressLocation.Address == v.targetLocation.Address
}

func (v *stagingValidator) resolveAddressContractNames(address common.Address) ([]string, error) {
// Check if the contract names are already cached
if names, ok := v.accountContractNames[address]; ok {
Expand Down
61 changes: 61 additions & 0 deletions internal/migrate/staging_validator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,65 @@ func Test_StagingValidator(t *testing.T) {
err := validator.ValidateContractUpdate(location, sourceCodeLocation, []byte(newContract))
require.NoError(t, err)
})

t.Run("resolves account access correctly", func(t *testing.T) {
location := common.NewAddressLocation(nil, common.Address{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}, "Test")
sourceCodeLocation := common.StringLocation("./Test.cdc")
oldContract := `
import ImpContract from 0x01
pub contract Test {
pub fun test() {}
}`
newContract := `
import ImpContract from 0x01
access(all) contract Test {
access(all) fun test() {}
init() {
ImpContract.test()
}
}`
impContract := `
access(all) contract ImpContract {
access(account) fun test() {}
init() {}
}`
mockScriptResultString, err := cadence.NewString(impContract)
require.NoError(t, err)

mockAccount := &flow.Account{
Address: flow.HexToAddress("01"),
Balance: 1000,
Keys: nil,
Contracts: map[string][]byte{
"Test": []byte(oldContract),
},
}

// setup mocks
require.NoError(t, rw.WriteFile(sourceCodeLocation.String(), []byte(newContract), 0o644))
srv.GetAccount.Run(func(args mock.Arguments) {
require.Equal(t, flow.HexToAddress("01"), args.Get(1).(flow.Address))
}).Return(mockAccount, nil)
srv.Network.Return(config.Network{
Name: "testnet",
}, nil)
srv.ExecuteScript.Run(func(args mock.Arguments) {
script := args.Get(1).(flowkit.Script)

assert.Equal(t, templates.GenerateGetStagedContractCodeScript(MigrationContractStagingAddress("testnet")), script.Code)

assert.Equal(t, 2, len(script.Args))
actualContractAddressArg, actualContractNameArg := script.Args[0], script.Args[1]

contractName, _ := cadence.NewString("ImpContract")
contractAddr := cadence.NewAddress(flow.HexToAddress("01"))
assert.Equal(t, contractName, actualContractNameArg)
assert.Equal(t, contractAddr, actualContractAddressArg)
}).Return(cadence.NewOptional(mockScriptResultString), nil)

// validate
validator := newStagingValidator(srv.Mock, state)
err = validator.ValidateContractUpdate(location, sourceCodeLocation, []byte(newContract))
require.NoError(t, err)
})
}
Loading