removing added address field from MachineAccountInfo (#223)

* removing added field

* remove address check

* remove access node requirement

* add machine account address script

Author: joshuahannan

contracts/FlowIDTableStaking.cdc

@@ -1117,11 +1117,7 @@ pub contract FlowIDTableStaking {
     /// Checks if the amount of tokens is greater
     /// than the minimum staking requirement for the specified role
     pub fun isGreaterThanMinimumForRole(numTokens: UFix64, role: UInt8): Bool {
-        if role == UInt8(5) {
-            return numTokens > 0.0
-        } else {
-            return numTokens >= self.minimumStakeRequired[role]!
-        }
+        return numTokens >= self.minimumStakeRequired[role]!
     }
 
     /// Indicates if the specified networking address is claimed by a node

contracts/FlowStakingCollection.cdc

@@ -53,21 +53,23 @@ pub contract FlowStakingCollection {
     pub struct MachineAccountInfo {
         pub let nodeID: String
         pub let role: UInt8
-        pub let address: Address
         // Capability to the FLOW Vault to allow the owner
         // to withdraw or deposit to their machine account if needed
         access(contract) let machineAccountVaultProvider: Capability<&FlowToken.Vault>
 
-        init(nodeID: String, role: UInt8, machineAccountAddress: Address, machineAccountVaultProvider: Capability<&FlowToken.Vault>) {
+        init(nodeID: String, role: UInt8, machineAccountVaultProvider: Capability<&FlowToken.Vault>) {
             pre {
                 machineAccountVaultProvider.check(): "Invalid Flow Token Vault Provider"
-                machineAccountVaultProvider.borrow()!.owner!.address == machineAccountAddress: "Vault provider must be stored in the machine account address provided"
             }
             self.nodeID = nodeID
             self.role = role
-            self.address = machineAccountAddress
             self.machineAccountVaultProvider = machineAccountVaultProvider
         }
+
+        // Gets the address of the machine account
+        pub fun getAddress(): Address {
+            return self.machineAccountVaultProvider.borrow()!.owner!.address
+        }
     }
 
     /// Public interface that users can publish for their staking collection
@@ -424,7 +426,7 @@ pub contract FlowStakingCollection {
 
             // Get the vault capability and create the machineAccountInfo struct
             let machineAccountVaultProvider = machineAcct.link<&FlowToken.Vault>(/private/machineAccountPrivateVault, target: /storage/flowTokenVault)!
-            let machineAccountInfo = MachineAccountInfo(nodeID: nodeInfo.id, role: nodeInfo.role, machineAccountAddress: machineAcct.address, machineAccountVaultProvider: machineAccountVaultProvider)
+            let machineAccountInfo = MachineAccountInfo(nodeID: nodeInfo.id, role: nodeInfo.role, machineAccountVaultProvider: machineAccountVaultProvider)
 
             // If they are a collector node, create a QC Voter object and store it in the account
             if nodeInfo.role == FlowEpoch.NodeRole.Collector.rawValue {
@@ -436,7 +438,7 @@ pub contract FlowStakingCollection {
                 // set this node's machine account
                 self.machineAccounts[nodeInfo.id] = machineAccountInfo
 
-                emit MachineAccountCreated(nodeID: nodeInfo.id, role: FlowEpoch.NodeRole.Collector.rawValue, address: machineAcct.address)
+                emit MachineAccountCreated(nodeID: nodeInfo.id, role: FlowEpoch.NodeRole.Collector.rawValue, address: machineAccountVaultProvider.borrow()!.owner!.address)
 
                 return machineAcct
 
@@ -450,7 +452,7 @@ pub contract FlowStakingCollection {
                 // set this node's machine account
                 self.machineAccounts[nodeInfo.id] = machineAccountInfo
 
-                emit MachineAccountCreated(nodeID: nodeInfo.id, role: FlowEpoch.NodeRole.Consensus.rawValue, address: machineAcct.address)
+                emit MachineAccountCreated(nodeID: nodeInfo.id, role: FlowEpoch.NodeRole.Consensus.rawValue, address: machineAccountVaultProvider.borrow()!.owner!.address)
 
                 return machineAcct
             }
@@ -498,7 +500,7 @@ pub contract FlowStakingCollection {
             }
 
             // Create the new Machine account info object and store it
-            let machineAccountInfo = MachineAccountInfo(nodeID: nodeID, role: nodeInfo.role, machineAccountAddress: machineAccount.address, machineAccountVaultProvider: machineAccountVaultProvider)
+            let machineAccountInfo = MachineAccountInfo(nodeID: nodeID, role: nodeInfo.role, machineAccountVaultProvider: machineAccountVaultProvider)
             self.machineAccounts[nodeID] = machineAccountInfo
         }
 
@@ -837,7 +839,7 @@ pub contract FlowStakingCollection {
                     let unlockedVault = self.unlockedVault!.borrow()!
                     var availableBalance: UFix64 = 0.0
                     if FlowStorageFees.storageMegaBytesPerReservedFLOW != (0.0 as UFix64) {
-                        availableBalance = FlowStorageFees.defaultTokenAvailableBalance(machineAccountInfo.address)
+                        availableBalance = FlowStorageFees.defaultTokenAvailableBalance(machineAccountInfo.machineAccountVaultProvider.borrow()!.owner!.address)
                     } else {
                         availableBalance = vaultRef.balance
                     }

lib/go/contracts/internal/assets/assets.go

@@ -40,6 +40,7 @@ const (
 	collectionGetUnlockedTokensUsedFilename            = "stakingCollection/scripts/get_unlocked_tokens_used.cdc"
 	collectionDoesAccountHaveStakingCollectionFilename = "stakingCollection/scripts/does_account_have_staking_collection.cdc"
 	collectionGetMachineAccountsFilename               = "stakingCollection/scripts/get_machine_accounts.cdc"
+	collectionGetMachineAccountAddressFilename         = "stakingCollection/scripts/get_machine_account_address.cdc"
 
 	// tests
 	getCollectionTokensFilename     = "stakingCollection/test/get_tokens.cdc"
@@ -210,6 +211,12 @@ func GenerateCollectionGetMachineAccountsScript(env Environment) []byte {
 	return []byte(replaceAddresses(code, env))
 }
 
+func GenerateCollectionGetMachineAccountAddressScript(env Environment) []byte {
+	code := assets.MustAssetString(collectionGetMachineAccountAddressFilename)
+
+	return []byte(replaceAddresses(code, env))
+}
+
 // Test Templates
 
 func GenerateCollectionGetTokensScript(env Environment) []byte {

lib/go/templates/internal/assets/assets.go

@@ -634,7 +634,7 @@ func TestIDTableStaking(t *testing.T) {
 		result = executeScriptAndCheck(t, b, templates.GenerateReturnCurrentTableScript(env), nil)
 
 		idArray := result.(cadence.Array).Values
-		assert.Len(t, idArray, 0)
+		assert.Len(t, idArray, 1)
 
 		result = executeScriptAndCheck(t, b, templates.GenerateReturnProposedTableScript(env), nil)
 
@@ -658,7 +658,7 @@ func TestIDTableStaking(t *testing.T) {
 		result := executeScriptAndCheck(t, b, templates.GenerateReturnCurrentTableScript(env), nil)
 
 		idArray := result.(cadence.Array).Values
-		assert.Len(t, idArray, 0)
+		assert.Len(t, idArray, 1)
 
 		result = executeScriptAndCheck(t, b, templates.GenerateReturnProposedTableScript(env), nil)
 

lib/go/templates/staking_collection_templates.go

@@ -499,8 +499,8 @@ func verifyStakingCollectionInfo(
 		assertEqual(t, len(expectedInfo.machineAccounts), len(machineAccountsDictionary))
 		for _, accountPair := range machineAccountsDictionary {
 			nodeID := accountPair.Key.(cadence.String)
-			machineAccountInfo := accountPair.Value.(cadence.Struct).Fields
-			address := machineAccountInfo[2].(cadence.Address)
+			result = executeScriptAndCheck(t, b, templates.GenerateCollectionGetMachineAccountAddressScript(env), [][]byte{jsoncdc.MustEncode(cadence.Address(flow.HexToAddress(expectedInfo.accountAddress))), jsoncdc.MustEncode(nodeID)})
+			address := result.(cadence.Address)
 			assertEqual(t, cadence.NewAddress(expectedInfo.machineAccounts[nodeID]), address)
 		}
 	}

lib/go/test/flow_idtable_staking_test.go

@@ -0,0 +1,13 @@
+import FlowStakingCollection from 0xSTAKINGCOLLECTIONADDRESS
+
+/// Gets the machine account address for a specific node
+/// in an account's staking collection
+
+pub fun main(account: Address, nodeID: String): Address {
+    let machineAccounts = FlowStakingCollection.getMachineAccounts(address: account)
+
+    let accountInfo = machineAccounts[nodeID]
+        ?? panic("Could not find machine account info for the specified node ID")
+
+    return accountInfo.getAddress()
+}