staking del minimum for locked token register delegator

Author: joshuahannan

contracts/LockedTokens.cdc

@@ -220,6 +220,11 @@ pub contract LockedTokens {
 
             let vaultRef = self.vault.borrow()!
 
+            assert(
+                vaultRef.balance >= FlowIDTableStaking.getDelegatorMinimumStakeRequirement(),
+                message: "Must have the delegation minimum FLOW requirement in the locked vault to register a node"
+            )
+
             let tokens <- vaultRef.withdraw(amount: amount)
 
             let delegator <- self.nodeDelegator <- FlowIDTableStaking.registerNewDelegator(nodeID: nodeID, tokensCommitted: <-tokens)
@@ -347,9 +352,9 @@ pub contract LockedTokens {
 
         /// The user calls this function if they want to register as a node operator
         /// They have to provide the node ID for the node they want to delegate to
-        pub fun createNodeDelegator(nodeID: String, amount: UFix64) {
+        pub fun createNodeDelegator(nodeID: String) {
 
-            self.borrowTokenManager().registerDelegator(nodeID: nodeID, amount: amount)
+            self.borrowTokenManager().registerDelegator(nodeID: nodeID, amount: FlowIDTableStaking.getDelegatorMinimumStakeRequirement())
 
             // create a new delegator proxy that can be accessed in transactions
             self.nodeDelegatorProxy = LockedNodeDelegatorProxy(tokenManager: self.tokenManager)

contracts/testContracts/TestFlowIDTableStaking.cdc

@@ -264,6 +264,12 @@ pub contract FlowIDTableStaking {
         return <-create NodeDelegator(id: 1, nodeID: nodeID)
     }
 
+    /// Gets the minimum stake requirement for delegators
+    pub fun getDelegatorMinimumStakeRequirement(): UFix64 {
+        return self.account.copy<UFix64>(from: /storage/delegatorStakingMinimum)
+            ?? 0.0
+    }
+
     init(_ epochTokenPayout: UFix64, _ rewardCut: UFix64, _ candidateLimits: {UInt8: UInt64}) {
     }
 }

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

@@ -289,7 +289,7 @@
     {
       "id": "TH.17",
       "name": "Register Delegator",
-      "source": "import FlowToken from 0x1654653399040a61\nimport LockedTokens from 0x8d0e87b65159ae63\n\ntransaction(id: String, amount: UFix64) {\n\n    let holderRef: \u0026LockedTokens.TokenHolder\n\n    let vaultRef: \u0026FlowToken.Vault\n\n    prepare(account: AuthAccount) {\n        self.holderRef = account.borrow\u003c\u0026LockedTokens.TokenHolder\u003e(from: LockedTokens.TokenHolderStoragePath) \n            ?? panic(\"TokenHolder is not saved at specified path\")\n\n        self.vaultRef = account.borrow\u003c\u0026FlowToken.Vault\u003e(from: /storage/flowTokenVault)\n            ?? panic(\"Could not borrow flow token vault reference\")\n    }\n\n    execute {\n        let lockedBalance = self.holderRef.getLockedAccountBalance()\n\n        if amount \u003c= lockedBalance {\n\n            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)\n\n        } else if ((amount - lockedBalance) \u003c= self.vaultRef.balance) {\n\n            self.holderRef.deposit(from: \u003c-self.vaultRef.withdraw(amount: amount - lockedBalance))\n\n            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)\n\n        } else {\n            panic(\"Not enough tokens to stake!\")\n        }\n    }\n}\n",
+      "source": "import FlowToken from 0x1654653399040a61\nimport LockedTokens from 0x8d0e87b65159ae63\nimport FlowIDTableStaking from 0x8624b52f9ddcd04a\n\ntransaction(id: String, amount: UFix64) {\n\n    let holderRef: \u0026LockedTokens.TokenHolder\n\n    let vaultRef: \u0026FlowToken.Vault\n\n    prepare(account: AuthAccount) {\n        self.holderRef = account.borrow\u003c\u0026LockedTokens.TokenHolder\u003e(from: LockedTokens.TokenHolderStoragePath) \n            ?? panic(\"TokenHolder is not saved at specified path\")\n\n        self.vaultRef = account.borrow\u003c\u0026FlowToken.Vault\u003e(from: /storage/flowTokenVault)\n            ?? panic(\"Could not borrow flow token vault reference\")\n    }\n\n    execute {\n        let lockedBalance = self.holderRef.getLockedAccountBalance()\n\n        if amount \u003c= lockedBalance {\n\n            self.holderRef.createNodeDelegator(nodeID: id)\n\n            let stakerProxy = self.holderRef.borrowDelegator()\n\n            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())\n\n        } else if ((amount - lockedBalance) \u003c= self.vaultRef.balance) {\n\n            self.holderRef.deposit(from: \u003c-self.vaultRef.withdraw(amount: amount - lockedBalance))\n\n            self.holderRef.createNodeDelegator(nodeID: id)\n\n            let stakerProxy = self.holderRef.borrowDelegator()\n\n            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())\n\n        } else {\n            panic(\"Not enough tokens to stake!\")\n        }\n    }\n}\n",
       "arguments": [
         {
           "type": "String",
@@ -315,7 +315,7 @@
         }
       ],
       "network": "mainnet",
-      "hash": "38b3863f83ae9920c3bedf6db9cbfb67c2c6f73fab7fa96c116511419d4cec3c"
+      "hash": "35bd380710b471bc5efb41b2f1e8538aec2985f3e2bf196d5b2846a7d2db89ec"
     },
     {
       "id": "TH.19",

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

@@ -289,7 +289,7 @@
     {
       "id": "TH.17",
       "name": "Register Delegator",
-      "source": "import FlowToken from 0x7e60df042a9c0868\nimport LockedTokens from 0x95e019a17d0e23d7\n\ntransaction(id: String, amount: UFix64) {\n\n    let holderRef: \u0026LockedTokens.TokenHolder\n\n    let vaultRef: \u0026FlowToken.Vault\n\n    prepare(account: AuthAccount) {\n        self.holderRef = account.borrow\u003c\u0026LockedTokens.TokenHolder\u003e(from: LockedTokens.TokenHolderStoragePath) \n            ?? panic(\"TokenHolder is not saved at specified path\")\n\n        self.vaultRef = account.borrow\u003c\u0026FlowToken.Vault\u003e(from: /storage/flowTokenVault)\n            ?? panic(\"Could not borrow flow token vault reference\")\n    }\n\n    execute {\n        let lockedBalance = self.holderRef.getLockedAccountBalance()\n\n        if amount \u003c= lockedBalance {\n\n            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)\n\n        } else if ((amount - lockedBalance) \u003c= self.vaultRef.balance) {\n\n            self.holderRef.deposit(from: \u003c-self.vaultRef.withdraw(amount: amount - lockedBalance))\n\n            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)\n\n        } else {\n            panic(\"Not enough tokens to stake!\")\n        }\n    }\n}\n",
+      "source": "import FlowToken from 0x7e60df042a9c0868\nimport LockedTokens from 0x95e019a17d0e23d7\nimport FlowIDTableStaking from 0x9eca2b38b18b5dfe\n\ntransaction(id: String, amount: UFix64) {\n\n    let holderRef: \u0026LockedTokens.TokenHolder\n\n    let vaultRef: \u0026FlowToken.Vault\n\n    prepare(account: AuthAccount) {\n        self.holderRef = account.borrow\u003c\u0026LockedTokens.TokenHolder\u003e(from: LockedTokens.TokenHolderStoragePath) \n            ?? panic(\"TokenHolder is not saved at specified path\")\n\n        self.vaultRef = account.borrow\u003c\u0026FlowToken.Vault\u003e(from: /storage/flowTokenVault)\n            ?? panic(\"Could not borrow flow token vault reference\")\n    }\n\n    execute {\n        let lockedBalance = self.holderRef.getLockedAccountBalance()\n\n        if amount \u003c= lockedBalance {\n\n            self.holderRef.createNodeDelegator(nodeID: id)\n\n            let stakerProxy = self.holderRef.borrowDelegator()\n\n            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())\n\n        } else if ((amount - lockedBalance) \u003c= self.vaultRef.balance) {\n\n            self.holderRef.deposit(from: \u003c-self.vaultRef.withdraw(amount: amount - lockedBalance))\n\n            self.holderRef.createNodeDelegator(nodeID: id)\n\n            let stakerProxy = self.holderRef.borrowDelegator()\n\n            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())\n\n        } else {\n            panic(\"Not enough tokens to stake!\")\n        }\n    }\n}\n",
       "arguments": [
         {
           "type": "String",
@@ -315,7 +315,7 @@
         }
       ],
       "network": "testnet",
-      "hash": "b11b8e3cdadeb0e505f801766c13f066bbcee1bcf39335d65f65d64f5533ca58"
+      "hash": "d2ca185d8cb711dc89186efd550b24d93f0ddec17703229df731c55fbfa40582"
     },
     {
       "id": "TH.19",

lib/go/templates/manifest.mainnet.json

@@ -0,0 +1,61 @@
+import FlowIDTableStaking from 0xIDENTITYTABLEADDRESS
+
+// This script finds all of a node's delegators who are staked above zero
+// but below the minimum of 50 FLOW and returns information about them
+
+pub struct DelegatorBelowMinInfo {
+
+    pub var totalStaked: UFix64
+    pub var totalBelowMinimumStaked: UFix64
+
+    pub var numDelegators: Int
+    pub var numDelegatorsBelowMin: Int
+
+    pub var delegatorInfoBelowMin: [FlowIDTableStaking.DelegatorInfo]
+
+    init(numDelegators: Int) {
+        self.totalStaked = 0.0
+        self.totalBelowMinimumStaked = 0.0
+        self.numDelegators = numDelegators
+        self.numDelegatorsBelowMin = 0
+        self.delegatorInfoBelowMin = []
+    }
+
+    pub fun addTotalStaked(_ stake: UFix64) {
+        self.totalStaked = self.totalStaked + stake
+    }
+
+    pub fun addBelowMinStaked(_ stake: UFix64) {
+        self.totalBelowMinimumStaked = self.totalBelowMinimumStaked + stake
+    }
+
+    pub fun addDelegatorBelowMin() {
+        self.numDelegatorsBelowMin = self.numDelegatorsBelowMin + 1
+    }
+
+    pub fun addDelegatorInfo(_ info: FlowIDTableStaking.DelegatorInfo) {
+        self.delegatorInfoBelowMin.append(info)
+    }
+}
+
+pub fun main(nodeID: String): DelegatorBelowMinInfo {
+    let nodeInfo = FlowIDTableStaking.NodeInfo(nodeID: nodeID)
+
+    let delegators = nodeInfo.delegators
+
+    let belowMinimum = DelegatorBelowMinInfo(numDelegators: delegators.length)
+
+    for delegatorID in delegators {
+        let delInfo = FlowIDTableStaking.DelegatorInfo(nodeID: nodeID, delegatorID: delegatorID)
+
+        belowMinimum.addTotalStaked(delInfo.tokensStaked)
+
+        if delInfo.tokensStaked < 50.0 && delInfo.tokensStaked > 0.0 {
+            belowMinimum.addDelegatorInfo(delInfo)
+            belowMinimum.addDelegatorBelowMin()
+            belowMinimum.addBelowMinStaked(delInfo.tokensStaked)
+        }
+    }
+
+    return belowMinimum
+}

lib/go/templates/manifest.testnet.json

@@ -1,5 +1,6 @@
 import FlowToken from 0xFLOWTOKENADDRESS
 import LockedTokens from 0xLOCKEDTOKENADDRESS
+import FlowIDTableStaking from 0xIDENTITYTABLEADDRESS
 
 transaction(id: String, amount: UFix64) {
 
@@ -20,13 +21,21 @@ transaction(id: String, amount: UFix64) {
 
         if amount <= lockedBalance {
 
-            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)
+            self.holderRef.createNodeDelegator(nodeID: id)
+
+            let stakerProxy = self.holderRef.borrowDelegator()
+
+            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())
 
         } else if ((amount - lockedBalance) <= self.vaultRef.balance) {
 
             self.holderRef.deposit(from: <-self.vaultRef.withdraw(amount: amount - lockedBalance))
 
-            self.holderRef.createNodeDelegator(nodeID: id, amount: amount)
+            self.holderRef.createNodeDelegator(nodeID: id)
+
+            let stakerProxy = self.holderRef.borrowDelegator()
+
+            stakerProxy.delegateNewTokens(amount: amount - FlowIDTableStaking.getDelegatorMinimumStakeRequirement())
 
         } else {
             panic("Not enough tokens to stake!")