add GetNodeV3BillingOptOutTimestamp to also retrieve the opt-out time

Author: sameh-farouk

clients/tfchain-client-go/node.go

@@ -857,28 +857,48 @@ func (s *Substrate) GetAllowedTwinAdmins() ([]AccountID, error) {
 }
 
 // IsNodeOptedOutOfV3Billing returns true if the node has opted out of v3 billing.
+// Deprecated: use GetNodeV3BillingOptOutTimestamp to also retrieve the opt-out time.
 func (s *Substrate) IsNodeOptedOutOfV3Billing(nodeID uint32) (bool, error) {
-	cl, meta, err := s.GetClient()
+	ts, err := s.GetNodeV3BillingOptOutTimestamp(nodeID)
 	if err != nil {
 		return false, err
 	}
+	return ts != nil, nil
+}
+
+// GetNodeV3BillingOptOutTimestamp returns the Unix timestamp (seconds) at which the node
+// opted out of v3 billing, or nil if the node has not opted out.
+func (s *Substrate) GetNodeV3BillingOptOutTimestamp(nodeID uint32) (*uint64, error) {
+	cl, meta, err := s.GetClient()
+	if err != nil {
+		return nil, err
+	}
 
 	bytes, err := Encode(nodeID)
 	if err != nil {
-		return false, errors.Wrap(err, "substrate: encoding error building query arguments")
+		return nil, errors.Wrap(err, "substrate: encoding error building query arguments")
 	}
 
 	key, err := types.CreateStorageKey(meta, "TfgridModule", "NodeV3BillingOptOut", bytes)
 	if err != nil {
-		return false, errors.Wrap(err, "failed to create substrate query key")
+		return nil, errors.Wrap(err, "failed to create substrate query key")
 	}
 
 	raw, err := cl.RPC.State.GetStorageRawLatest(key)
 	if err != nil {
-		return false, errors.Wrap(err, "failed to lookup node v3 billing opt-out")
+		return nil, errors.Wrap(err, "failed to lookup node v3 billing opt-out")
+	}
+
+	if len(*raw) == 0 {
+		return nil, nil
+	}
+
+	var ts uint64
+	if err := Decode(*raw, &ts); err != nil {
+		return nil, errors.Wrap(err, "failed to decode node v3 billing opt-out timestamp")
 	}
 
-	return len(*raw) > 0, nil
+	return &ts, nil
 }
 
 // SetNodeCertificate sets the node certificate type

clients/tfchain-client-js/lib/client.js

@@ -19,7 +19,7 @@ const {
 const {
   createNode, updateNode, getNode,
   getNodeIDByPubkey, deleteNode, listNodes,
-  optOutOfV3Billing, getAllowedTwinAdmins, isNodeOptedOutOfV3Billing
+  optOutOfV3Billing, getAllowedTwinAdmins, isNodeOptedOutOfV3Billing, getNodeV3BillingOptOutTimestamp
 } = require('./node')
 const { signEntityTwinID, signEntityCreation } = require('./sign')
 const { getBalance, transfer } = require('./balance')
@@ -222,6 +222,10 @@ class Client {
     return isNodeOptedOutOfV3Billing(this, nodeID)
   }
 
+  async getNodeV3BillingOptOutTimestamp(nodeID) {
+    return getNodeV3BillingOptOutTimestamp(this, nodeID)
+  }
+
   async setNodePower (nodeId, power, callback) {
     return setNodePower(this, nodeId, power, callback)
   }

clients/tfchain-client-js/lib/node.js

@@ -140,10 +140,18 @@ async function getAllowedTwinAdmins (self) {
   return result.toJSON() || []
 }
 
-// isNodeOptedOutOfV3Billing returns true if the node has opted out of v3 billing
+// isNodeOptedOutOfV3Billing returns true if the node has opted out of v3 billing.
+// Deprecated: use getNodeV3BillingOptOutTimestamp to also retrieve the opt-out time.
 async function isNodeOptedOutOfV3Billing (self, nodeID) {
+  return (await getNodeV3BillingOptOutTimestamp(self, nodeID)) !== null
+}
+
+// getNodeV3BillingOptOutTimestamp returns the Unix timestamp (seconds) at which the node
+// opted out of v3 billing, or null if the node has not opted out.
+async function getNodeV3BillingOptOutTimestamp (self, nodeID) {
   const result = await self.api.query.tfgridModule.nodeV3BillingOptOut(nodeID)
-  return !result.isNone
+  if (result.isNone) return null
+  return result.unwrap().toNumber()
 }
 
 async function validateNode (self, farmID) {
@@ -162,5 +170,6 @@ module.exports = {
   listNodes,
   optOutOfV3Billing,
   getAllowedTwinAdmins,
-  isNodeOptedOutOfV3Billing
+  isNodeOptedOutOfV3Billing,
+  getNodeV3BillingOptOutTimestamp
 }