Decouple GetMember and SetMember methods from the interpreter

Author: SupunS

cmd/cmd.go

@@ -261,7 +261,7 @@ func (*StandardLibraryHandler) GetAccountAvailableBalance(_ common.Address) (uin
 	return 0, goerrors.New("accounts are not supported in this environment")
 }
 
-func (*StandardLibraryHandler) CommitStorageTemporarily(_ *interpreter.Interpreter) error {
+func (*StandardLibraryHandler) CommitStorageTemporarily(_ interpreter.ValueTransferContext) error {
 	// NO-OP
 	return nil
 }

cmd/decode-state-values/main.go

@@ -235,7 +235,7 @@ type interpreterStorage struct {
 var _ interpreter.Storage = &interpreterStorage{}
 
 func (i interpreterStorage) GetDomainStorageMap(
-	_ *interpreter.Interpreter,
+	_ interpreter.StorageMutationTracker,
 	_ common.Address,
 	_ common.StorageDomain,
 	_ bool,

interpreter/account_storagemap.go

@@ -95,7 +95,7 @@ func (s *AccountStorageMap) DomainExists(domain common.StorageDomain) bool {
 // is created and inserted into account storage map with given domain as key.
 func (s *AccountStorageMap) GetDomain(
 	gauge common.MemoryGauge,
-	interpreter *Interpreter,
+	storageMutationTracker StorageMutationTracker,
 	domain common.StorageDomain,
 	createIfNotExists bool,
 ) *DomainStorageMap {
@@ -112,7 +112,7 @@ func (s *AccountStorageMap) GetDomain(
 			// Create domain storage map if needed.
 
 			if createIfNotExists {
-				return s.NewDomain(gauge, interpreter, domain)
+				return s.NewDomain(gauge, storageMutationTracker, domain)
 			}
 
 			return nil
@@ -128,10 +128,10 @@ func (s *AccountStorageMap) GetDomain(
 // NewDomain creates new domain storage map and inserts it to AccountStorageMap with given domain as key.
 func (s *AccountStorageMap) NewDomain(
 	gauge common.MemoryGauge,
-	interpreter *Interpreter,
+	storageMutationTracker StorageMutationTracker,
 	domain common.StorageDomain,
 ) *DomainStorageMap {
-	interpreter.recordStorageMutation()
+	storageMutationTracker.RecordStorageMutation()
 
 	domainStorageMap := NewDomainStorageMap(gauge, s.orderedMap.Storage, s.orderedMap.Address())
 
@@ -162,24 +162,24 @@ func (s *AccountStorageMap) NewDomain(
 // If the given storage map is non-nil, domain is added/updated.
 // Returns true if domain storage map previously existed at the given domain.
 func (s *AccountStorageMap) WriteDomain(
-	interpreter *Interpreter,
+	context ValueTransferContext,
 	domain common.StorageDomain,
 	domainStorageMap *DomainStorageMap,
 ) (existed bool) {
 	if domainStorageMap == nil {
-		return s.removeDomain(interpreter, domain)
+		return s.removeDomain(context, domain)
 	}
-	return s.setDomain(interpreter, domain, domainStorageMap)
+	return s.setDomain(context, domain, domainStorageMap)
 }
 
 // setDomain sets domain storage map in the account storage map and returns true if domain previously existed.
 // If the given domain already stores a domain storage map, it is overwritten.
 func (s *AccountStorageMap) setDomain(
-	interpreter *Interpreter,
+	context ValueTransferContext,
 	domain common.StorageDomain,
 	newDomainStorageMap *DomainStorageMap,
 ) (existed bool) {
-	interpreter.recordStorageMutation()
+	context.RecordStorageMutation()
 
 	key := Uint64StorageMapKey(domain)
 
@@ -199,13 +199,13 @@ func (s *AccountStorageMap) setDomain(
 		existingDomainStorageMap := newDomainStorageMapWithAtreeStorable(s.orderedMap.Storage, existingValueStorable)
 
 		// Deep remove elements in domain storage map
-		existingDomainStorageMap.DeepRemove(interpreter, true)
+		existingDomainStorageMap.DeepRemove(context, true)
 
 		// Remove domain storage map slab
-		interpreter.RemoveReferencedSlab(existingValueStorable)
+		RemoveReferencedSlab(context, existingValueStorable)
 	}
 
-	interpreter.MaybeValidateAtreeValue(s.orderedMap)
+	context.MaybeValidateAtreeValue(s.orderedMap)
 
 	// NOTE: Don't call maybeValidateAtreeStorage() here because it is possible
 	// that domain storage map is in the process of being migrated to account
@@ -215,8 +215,8 @@ func (s *AccountStorageMap) setDomain(
 }
 
 // removeDomain removes domain storage map with given domain in account storage map, if it exists.
-func (s *AccountStorageMap) removeDomain(interpreter *Interpreter, domain common.StorageDomain) (existed bool) {
-	interpreter.recordStorageMutation()
+func (s *AccountStorageMap) removeDomain(context ValueTransferContext, domain common.StorageDomain) (existed bool) {
+	context.RecordStorageMutation()
 
 	key := Uint64StorageMapKey(domain)
 
@@ -238,7 +238,7 @@ func (s *AccountStorageMap) removeDomain(interpreter *Interpreter, domain common
 
 	// NOTE: Key is just an atree.Value (Uint64AtreeValue), not an interpreter.Value,
 	// so do not need (can) convert and not need to deep remove
-	interpreter.RemoveReferencedSlab(existingKeyStorable)
+	RemoveReferencedSlab(context, existingKeyStorable)
 
 	// Value
 
@@ -248,14 +248,14 @@ func (s *AccountStorageMap) removeDomain(interpreter *Interpreter, domain common
 		domainStorageMap := newDomainStorageMapWithAtreeStorable(s.orderedMap.Storage, existingValueStorable)
 
 		// Deep remove elements in domain storage map
-		domainStorageMap.DeepRemove(interpreter, true)
+		domainStorageMap.DeepRemove(context, true)
 
 		// Remove domain storage map slab
-		interpreter.RemoveReferencedSlab(existingValueStorable)
+		RemoveReferencedSlab(context, existingValueStorable)
 	}
 
-	interpreter.MaybeValidateAtreeValue(s.orderedMap)
-	interpreter.MaybeValidateAtreeStorage()
+	context.MaybeValidateAtreeValue(s.orderedMap)
+	context.MaybeValidateAtreeStorage()
 
 	return
 }

interpreter/account_test.go

@@ -71,7 +71,7 @@ type testAccountHandler struct {
 	generateAccountID          func(address common.Address) (uint64, error)
 	getAccountBalance          func(address common.Address) (uint64, error)
 	getAccountAvailableBalance func(address common.Address) (uint64, error)
-	commitStorageTemporarily   func(inter *interpreter.Interpreter) error
+	commitStorageTemporarily   func(context interpreter.ValueTransferContext) error
 	getStorageUsed             func(address common.Address) (uint64, error)
 	getStorageCapacity         func(address common.Address) (uint64, error)
 	validatePublicKey          func(key *stdlib.PublicKey) error
@@ -160,11 +160,11 @@ func (t *testAccountHandler) GetAccountAvailableBalance(address common.Address)
 	return t.getAccountAvailableBalance(address)
 }
 
-func (t *testAccountHandler) CommitStorageTemporarily(inter *interpreter.Interpreter) error {
+func (t *testAccountHandler) CommitStorageTemporarily(context interpreter.ValueTransferContext) error {
 	if t.commitStorageTemporarily == nil {
 		panic(errors.NewUnexpectedError("unexpected call to CommitStorageTemporarily"))
 	}
-	return t.commitStorageTemporarily(inter)
+	return t.commitStorageTemporarily(context)
 }
 
 func (t *testAccountHandler) GetStorageUsed(address common.Address) (uint64, error) {
@@ -471,8 +471,8 @@ func testAccountWithErrorHandler(
 					return baseActivation
 				},
 				ContractValueHandler: makeContractValueHandler(nil, nil, nil),
-				AccountHandler: func(inter *interpreter.Interpreter, address interpreter.AddressValue) interpreter.Value {
-					return stdlib.NewAccountValue(inter, nil, address)
+				AccountHandler: func(context interpreter.FunctionCreationContext, address interpreter.AddressValue) interpreter.Value {
+					return stdlib.NewAccountValue(context, nil, address)
 				},
 			},
 			HandleCheckerError: checkerErrorHandler,
@@ -1333,7 +1333,7 @@ func TestInterpretAccountStorageFields(t *testing.T) {
 	const storageCapacity = 43
 
 	handler := &testAccountHandler{
-		commitStorageTemporarily: func(_ *interpreter.Interpreter) error {
+		commitStorageTemporarily: func(_ interpreter.ValueTransferContext) error {
 			return nil
 		},
 		getStorageUsed: func(_ common.Address) (uint64, error) {

interpreter/composite_value_test.go

@@ -110,7 +110,7 @@ func testCompositeValue(t *testing.T, code string) *interpreter.Interpreter {
 		map[string]interpreter.Value{
 			"name": interpreter.NewUnmeteredStringValue("Apple"),
 		},
-		func(name string, _ *interpreter.Interpreter, _ interpreter.LocationRange) interpreter.Value {
+		func(name string, _ interpreter.MemberAccessibleContext, _ interpreter.LocationRange) interpreter.Value {
 			if name == "color" {
 				return interpreter.NewUnmeteredStringValue("Red")
 			}

interpreter/conversion.go

@@ -95,9 +95,9 @@ func ByteValueToByte(memoryGauge common.MemoryGauge, element Value, locationRang
 	return b, nil
 }
 
-func ByteSliceToByteArrayValue(interpreter *Interpreter, buf []byte) *ArrayValue {
+func ByteSliceToByteArrayValue(context ArrayCreationContext, buf []byte) *ArrayValue {
 
-	common.UseMemory(interpreter, common.NewBytesMemoryUsage(len(buf)))
+	common.UseMemory(context, common.NewBytesMemoryUsage(len(buf)))
 
 	var values []Value
 
@@ -110,7 +110,7 @@ func ByteSliceToByteArrayValue(interpreter *Interpreter, buf []byte) *ArrayValue
 	}
 
 	return NewArrayValue(
-		interpreter,
+		context,
 		EmptyLocationRange,
 		ByteArrayStaticType,
 		common.ZeroAddress,

interpreter/domain_storagemap.go

@@ -146,19 +146,19 @@ func (s *DomainStorageMap) ReadValue(gauge common.MemoryGauge, key StorageMapKey
 // If the given value is nil, the key is removed.
 // If the given value is non-nil, the key is added/updated.
 // Returns true if a value previously existed at the given key.
-func (s *DomainStorageMap) WriteValue(interpreter *Interpreter, key StorageMapKey, value atree.Value) (existed bool) {
+func (s *DomainStorageMap) WriteValue(context ValueTransferContext, key StorageMapKey, value atree.Value) (existed bool) {
 	if value == nil {
-		return s.RemoveValue(interpreter, key)
+		return s.RemoveValue(context, key)
 	} else {
-		return s.SetValue(interpreter, key, value)
+		return s.SetValue(context, key, value)
 	}
 }
 
 // SetValue sets a value in the storage map.
 // If the given key already stores a value, it is overwritten.
 // Returns true if given key already exists and existing value is overwritten.
-func (s *DomainStorageMap) SetValue(interpreter *Interpreter, key StorageMapKey, value atree.Value) (existed bool) {
-	interpreter.recordStorageMutation()
+func (s *DomainStorageMap) SetValue(context ValueTransferContext, key StorageMapKey, value atree.Value) (existed bool) {
+	context.RecordStorageMutation()
 
 	existingStorable, err := s.orderedMap.Set(
 		key.AtreeValueCompare,
@@ -172,20 +172,20 @@ func (s *DomainStorageMap) SetValue(interpreter *Interpreter, key StorageMapKey,
 
 	existed = existingStorable != nil
 	if existed {
-		existingValue := StoredValue(interpreter, existingStorable, interpreter.Storage())
-		existingValue.DeepRemove(interpreter, true) // existingValue is standalone because it was overwritten in parent container.
-		interpreter.RemoveReferencedSlab(existingStorable)
+		existingValue := StoredValue(context, existingStorable, context.Storage())
+		existingValue.DeepRemove(context, true) // existingValue is standalone because it was overwritten in parent container.
+		RemoveReferencedSlab(context, existingStorable)
 	}
 
-	interpreter.MaybeValidateAtreeValue(s.orderedMap)
-	interpreter.MaybeValidateAtreeStorage()
+	context.MaybeValidateAtreeValue(s.orderedMap)
+	context.MaybeValidateAtreeStorage()
 
 	return
 }
 
 // RemoveValue removes a value in the storage map, if it exists.
-func (s *DomainStorageMap) RemoveValue(interpreter *Interpreter, key StorageMapKey) (existed bool) {
-	interpreter.recordStorageMutation()
+func (s *DomainStorageMap) RemoveValue(context ValueRemoveContext, key StorageMapKey) (existed bool) {
+	context.RecordStorageMutation()
 
 	existingKeyStorable, existingValueStorable, err := s.orderedMap.Remove(
 		key.AtreeValueCompare,
@@ -204,19 +204,19 @@ func (s *DomainStorageMap) RemoveValue(interpreter *Interpreter, key StorageMapK
 
 	// NOTE: Key is just an atree.Value, not an interpreter.Value,
 	// so do not need (can) convert and not need to deep remove
-	interpreter.RemoveReferencedSlab(existingKeyStorable)
+	RemoveReferencedSlab(context, existingKeyStorable)
 
 	// Value
 
 	existed = existingValueStorable != nil
 	if existed {
-		existingValue := StoredValue(interpreter, existingValueStorable, interpreter.Storage())
-		existingValue.DeepRemove(interpreter, true) // existingValue is standalone because it was removed from parent container.
-		interpreter.RemoveReferencedSlab(existingValueStorable)
+		existingValue := StoredValue(context, existingValueStorable, context.Storage())
+		existingValue.DeepRemove(context, true) // existingValue is standalone because it was removed from parent container.
+		RemoveReferencedSlab(context, existingValueStorable)
 	}
 
-	interpreter.MaybeValidateAtreeValue(s.orderedMap)
-	interpreter.MaybeValidateAtreeStorage()
+	context.MaybeValidateAtreeValue(s.orderedMap)
+	context.MaybeValidateAtreeStorage()
 
 	return
 }
@@ -250,13 +250,13 @@ func (s *DomainStorageMap) DeepRemove(context ValueRemoveContext, hasNoParentCon
 
 		// NOTE: Key is just an atree.Value, not an interpreter.Value,
 		// so do not need (can) convert and not need to deep remove
-		context.RemoveReferencedSlab(keyStorable)
+		RemoveReferencedSlab(context, keyStorable)
 
 		// Value
 
 		value := StoredValue(context, valueStorable, storage)
 		value.DeepRemove(context, false) // value is an element of v.dictionary because it is from PopIterate() callback.
-		context.RemoveReferencedSlab(valueStorable)
+		RemoveReferencedSlab(context, valueStorable)
 	})
 	if err != nil {
 		panic(errors.NewExternalError(err))