Addressing the comments on the PR as per the conversations

Signed-off-by: Dhinakaran Vinayagamurthy <[email protected]>

Author: dhinakaran2705

core/network/besu/contracts/interop/manageAsset.sol

@@ -22,12 +22,10 @@ contract InteroperationBaseClassERC20 {
 		uint8 status;
 	}
 
-	uint8 public constant UNUSED = 0;
-	uint8 public constant LOCKED = 1;
-	uint8 public constant CLAIMED = 2;
-	uint8 public constant UNLOCKED = 3;
+	uint8 constant UNUSED = 0;
+	uint8 constant LOCKED = 1;
 
-	event NewLock(
+	event Lock(
 		address indexed sender,
 		address indexed receiver,
 		address assetContract,
@@ -98,7 +96,7 @@ contract InteroperationBaseClassERC20 {
 			LOCKED
 		);
 
-		emit NewLock(
+		emit Lock(
 			sender,
 			receiver,
 			assetContract,
@@ -119,10 +117,9 @@ contract InteroperationBaseClassERC20 {
 
 		// Check the validity of the claim
 		require(c.status == LOCKED, "lockContract is not active");
-		require(c.expirationTime > block.timestamp, "lockContract has expired");
+		require(block.timestamp < c.expirationTime, "lockContract has expired");
 		require(c.hashLock == sha256(abi.encodePacked(preimage)),"Invalid preimage, its hash does not equal the hashLock");
 
-		c.status = CLAIMED;
 		bool transferStatus = ERC20(c.assetContract).transfer(c.receiver, c.amount);
 		require(transferStatus == true, "ERC20 transfer failed from the lockContract to the receiver");
 
@@ -138,7 +135,7 @@ contract InteroperationBaseClassERC20 {
 	}
 
 
-	// Unlocking and reclaiming a locked asset for the sender after the expiration time. Can be called by anyone.
+	// Unlocking and reclaiming a locked asset for the sender after the expiration time. Can be called by anyone, not just the sender.
 	function unlockFungibleAsset(bytes32 lockContractId)
 		external
 		returns (bool)
@@ -150,7 +147,6 @@ contract InteroperationBaseClassERC20 {
 		require(c.sender != address(0), "Sender address is invalid");
 		require(block.timestamp >= c.expirationTime, "Lock contract has expired");
 
-		c.status = UNLOCKED;
 		bool transferStatus = ERC20(c.assetContract).transfer(c.sender, c.amount);
 		require(transferStatus == true, "ERC20 transfer failed from the lockContract back to the sender");
 
@@ -163,4 +159,20 @@ contract InteroperationBaseClassERC20 {
 		return true;
 	}
 
+	// Function to check if there is an active contract with the input lockContractId.
+	function isFungibleAssetLocked(bytes32 lockContractId)
+		external
+		returns (bool)
+	{
+		LockContract storage c = lockContracts[lockContractId];
+		
+		bool lockContractStatus;
+		if ( c.status == LOCKED ){
+			lockContractStatus = true;
+		} else {
+			lockContractStatus = false;
+		}
+
+		return lockContractStatus;
+	}
 }

samples/besu/simpleasset/.gitignore

@@ -0,0 +1,4 @@
+build
+node_modules
+contracts/manageAsset.sol
+package-lock.json

samples/besu/simpleasset/Makefile

@@ -1,7 +1,18 @@
+.PHONY: deploy-contracts
 deploy-contracts: deploy-contract-network1 deploy-contract-network2
 
+.PHONY: deploy-contract-network1
 deploy-contract-network1:
 	BESU_NETWORK_HOST=localhost BESU_NETWORK_PORT=8545 npm run deploy-contract
 
+.PHONY: deploy-contract-network2
 deploy-contract-network2:
 	BESU_NETWORK_HOST=localhost BESU_NETWORK_PORT=9544 npm run deploy-contract
+
+.PHONY: clean-run
+clean-run:
+	npm run clean-run
+
+.PHONY: clean
+clean:
+	npm run clean

samples/besu/simpleasset/app/AssetExchangeERC20.js

@@ -32,8 +32,8 @@ async function getContractInstance(provider, pathToJson){
 	var contractName = contract(JSON.parse(jsonFileContents))
 	contractName.setProvider(provider)
 	var instance = await contractName.deployed().catch(function () {
-                console.log("Failed getting the contractName!");
-                })
+		console.log("Failed getting the contractName!");
+	})
 
 	return instance
 }
@@ -42,32 +42,32 @@ async function getContractInstance(provider, pathToJson){
 // Initialization of the parameters
 async function init(provider1, provider2, contractOwner1, contractOwner2, Alice1, Bob2, tokenSupply, senderInitialBalance) {
 
-    	interopContract1 = await getContractInstance(provider1,'../build/contracts/InteroperationBaseClassERC20.json').catch(function () {
-                console.log("Failed getting interopContract1!");
-                })
-    	interopContract2 = await getContractInstance(provider2,'../build/contracts/InteroperationBaseClassERC20.json').catch(function () {
-                console.log("Failed getting interopContract2!");
-                })
+	interopContract1 = await getContractInstance(provider1,'../build/contracts/InteroperationBaseClassERC20.json').catch(function () {
+		console.log("Failed getting interopContract1!");
+	})
+	interopContract2 = await getContractInstance(provider2,'../build/contracts/InteroperationBaseClassERC20.json').catch(function () {
+		console.log("Failed getting interopContract2!");
+	})
 
 
 	AliceERC20 = await getContractInstance(provider1, '../build/contracts/AliceERC20.json').catch(function () {
-                console.log("Failed getting AliceERC20 token contract!");
-                })
+		console.log("Failed getting AliceERC20 token contract!");
+	})
 	BobERC20 = await getContractInstance(provider2, '../build/contracts/BobERC20.json').catch(function () {
-                console.log("Failed getting BobERC20 token contract!");
-                })
-
-	// Issue AliceERC20 tokens to Alice in Network 1 and BobERC20 tokens to Bob in Network 2
-	// SUFFICIENT TO RUN THIS ONCE. Comment it out after the first run unless more tokens have to issued to Alice and/or Bob.
-	///*
-    	await AliceERC20.transfer(Alice1, senderInitialBalance, {from: contractOwner1}).catch(function () {
-                console.log("AliceERC20 transfer threw an error; Probably the token supply is used up!");
-                })
-    	await BobERC20.transfer(Bob2, senderInitialBalance, {from: contractOwner2}).catch(function () {
-                console.log("BobERC20 transfer threw an error; Probably the token supply is used up!");
-                })
-	//*/
-
+		console.log("Failed getting BobERC20 token contract!");
+	})
+
+	// Issue AliceERC20 tokens to Alice in Network 1 and BobERC20 tokens 
+    // to Bob in Network 2. A minimal number of tokens equal to the 
+    // number of token being exchanged is issued to Alice and Bob to 
+    // ensure that the exchange in this test application does not fail 
+    // due to insufficient funds.
+	await AliceERC20.transfer(Alice1, senderInitialBalance, {from: contractOwner1}).catch(function () {
+		console.log("AliceERC20 transfer threw an error; Probably the token supply is used up!");
+	})
+	await BobERC20.transfer(Bob2, senderInitialBalance, {from: contractOwner2}).catch(function () {
+		console.log("BobERC20 transfer threw an error; Probably the token supply is used up!");
+	})
 }
 
 
@@ -77,11 +77,12 @@ async function init(provider1, provider2, contractOwner1, contractOwner2, Alice1
 // used when locking it
 async function claimToken(interopContract, lockContractId, recipient, preimage) {
 	console.log("\n Claiming %s using preimage: %o", lockContractId, preimage)
-    	var claimStatus = await interopContract.claimFungibleAsset(lockContractId, preimage, {
-      		from: recipient
-    	}).catch(function () {
-     		console.log("claimFungibleAsset threw an error");
-		})
+	var claimStatus = await interopContract.claimFungibleAsset(lockContractId, preimage, {
+		from: recipient
+    }).catch(function () {
+		console.log("claimFungibleAsset threw an error");
+		claimStatus = false
+	})
 
 	return claimStatus
 }
@@ -90,11 +91,12 @@ async function claimToken(interopContract, lockContractId, recipient, preimage)
 // Unlock function of a locked fungible asset/token 
 async function unlockToken(interopContract, lockContractId, sender) {
 
-      	var unlockStatus = await interopContract.unlockFungibleAsset(lockContractId, {
+	var unlockStatus = await interopContract.unlockFungibleAsset(lockContractId, {
         	from: sender
-      	}).catch(function () {
+	}).catch(function () {
 		console.log("unlockFungibleAsset threw an error");
-		})
+		unlockStatus = false
+	})
 
 	return unlockStatus
 }
@@ -105,13 +107,15 @@ async function unlockToken(interopContract, lockContractId, sender) {
 // for 'recipient' using the contract constructs of 'interopContract'
 // with hashLock and timeLock providing the conditions for claiming/unlocking
 async function lockToken(sender, recipient, tokenContract, tokenAmount, interopContract, hashLock, timeLock) {
-    	// initiator of the swap has to first designate the swap contract as a spender of his/her money
-    	// with allowance matching the swap amount
-    	await tokenContract.approve(interopContract.address, tokenAmount, {from: sender}).catch(function () {
-                console.log("Token approval failed!!!");
-                })
+
+	// initiator of the swap has to first designate the swap contract as a spender of his/her money
+	// with allowance matching the swap amount
+	await tokenContract.approve(interopContract.address, tokenAmount, {from: sender}).catch(function () {
+		console.log("Token approval failed!!!");
+		return false
+	})
 
-	return interopContract.lockFungibleAsset(
+	var lockStatus = interopContract.lockFungibleAsset(
       		recipient,
 	      	tokenContract.address,
       		tokenAmount,
@@ -120,12 +124,19 @@ async function lockToken(sender, recipient, tokenContract, tokenAmount, interopC
 	      	{
         		from: sender
 	      	}
-    	)
+    ).catch(function () {
+ 		console.log("lockFungibleAsset threw an error");
+		lockStatus = false
+	})
+
+	return lockStatus
 }
 
 
-// A function to obtain and print the account balances of a pair of accounts in the two participating networks.
-// Designed for printing the account balances of the sender and recipient at various stages of the exchange.
+// A function to obtain and print the account balances of a pair 
+// of accounts in the two participating networks.
+// Designed for printing the account balances of the sender and 
+// recipient at various stages of the exchange.
 async function getBalances(Alice1, Bob1, Alice2, Bob2) {
 
 	var AliceAliceERC20Balance = await AliceERC20.balanceOf(Alice1)
@@ -173,37 +184,46 @@ async function main() {
 
 	// Initialization
 	const tokenSupply = 1000
-	const senderInitialBalance=100
+	const tokenAmount = 10 // Number of tokens to be exchanged
+	const senderInitialBalance = tokenAmount
 
 	await init(provider1, provider2, contractOwner1, contractOwner2, Alice1, Bob2, tokenSupply, senderInitialBalance)
 
 	console.log("\n Balances after init():")
 	await getBalances(Alice1, Bob1, Alice2, Bob2)
 
-    	//hashPair = newSecretHashPair()
 	preimage = crypto.randomBytes(32) // to sample a preimage for the hash
 	hash = crypto.createHash('sha256').update(preimage).digest()
 	console.log("Hash: ", hash)
 
-	let tokenAmount=10
 	let timeOut = 15
-    	let timeLockSeconds = Math.floor(Date.now() / 1000) + 2*timeOut
+    let timeLockSeconds = Math.floor(Date.now() / 1000) + 2*timeOut
 
 	// Creating a HTLC contract for Alice locking her AliceERC20 tokens for Bob
  	let lockTx1 = await lockToken(Alice1, Bob1, AliceERC20, tokenAmount, interopContract1, hash, timeLockSeconds)
-    	let lockContractId1 = lockTx1.logs[0].args.lockContractId
+    if (!lockTx1) {
+        console.log("\n !!! Locking of Alice's tokens failed in Netowrk 1. Aborting here !!!")
+        return
+    }
+	let lockContractId1 = lockTx1.logs[0].args.lockContractId
 	console.log("lockContractID1: ", lockContractId1)
 
 	console.log("\n Balances after Alice locks her tokens in Network 1:")
 	await getBalances(Alice1, Bob1, Alice2, Bob2)
 
-	// After he observes this lockContract created in Network 1, Bob creates a similar contract
-	// in Network 2 using the same hash to transfer the agreed upon amount of BobERC20 to Alice.
-	// Bob sets the timeLock such that he will have enough time to claim Alice's tokens in 
-	// Network 1 after she claims Bob's tokens in Network 2.
-    	timeLockSeconds = Math.floor(Date.now() / 1000) + timeOut
-    	let lockTx2 = await lockToken(Bob2, Alice2, BobERC20, tokenAmount, interopContract2, hash, timeLockSeconds)
-    	let lockContractId2 = lockTx2.logs[0].args.lockContractId
+	// After he observes this lockContract created in Network 1, 
+    // Bob creates a similar contract in Network 2 using the same 
+    // hash to transfer the agreed upon amount of BobERC20 to Alice.
+	// Bob sets the timeLock such that he will have enough time to 
+    // claim Alice's tokens in Network 1 after she claims Bob's 
+    // tokens in Network 2.
+	timeLockSeconds = Math.floor(Date.now() / 1000) + timeOut
+	let lockTx2 = await lockToken(Bob2, Alice2, BobERC20, tokenAmount, interopContract2, hash, timeLockSeconds)
+    if (!lockTx2) {
+        console.log("\n !!! Locking of Bob's tokens failed in Netowrk 2. Aborting here !!!")
+        return
+    }
+	let lockContractId2 = lockTx2.logs[0].args.lockContractId
 	console.log("lockContractID2: ", lockContractId2)
 
 	console.log("\n Balances after creating Bob locks his tokens in Network 2:")

samples/besu/simpleasset/get-network-details.js

@@ -57,8 +57,11 @@ async function main() {
 			str = "\t\t\tfrom: \""+accounts[0]+"\","
 		}
 
+		if(!str.startsWith("}")) {
+			str = str + "\n"
+		}
+
 		truffleConfigFileString += str
-		truffleConfigFileString += "\n"
 	}
 
 	// Writing the updated content to truffle-config

samples/besu/simpleasset/package.json

@@ -2,7 +2,6 @@
   "name": "sample-besu-app",
   "version": "0.1.0",
   "description": "Sample Besu Application for Demonstrating Interoperation With Other Networks",
-  "main": "truffle.js",
   "license": "Apache-2.0",
   "repository": "hyperledger-labs/weaver-dlt-interoperability/samples/besu/simpleasset",
   "bugs": {
@@ -13,13 +12,9 @@
     "test": "test"
   },
   "scripts": {
-    "ganache-start": "ganache-cli --networkId 4447 --port 7545",
-    "lint": "solium -d contracts/",
     "copy-interop-contracts": "cp ../../../core/network/besu/contracts/interop/manageAsset.sol contracts/",
     "update-truffle-config": "node get-network-details.js",
     "deploy-contract": "npm run copy-interop-contracts && npm install && npm run update-truffle-config && truffle compile && truffle migrate",
-    "ethereum-htlc": "truffle compile",
-    "test": "truffle test",
     "clean-run": "rm -rf package-lock.json build",
     "clean": "rm -rf node_modules package-lock.json build"
   },
@@ -41,9 +36,6 @@
     "solc": "^0.8.8"
   },
   "devDependencies": {
-    "eslint": "^7.5.0",
-    "ethlint": "^1.2.5",
-    "truffle": "^5.4.15",
-    "truffle-assertions": "^0.9.2"
+    "truffle": "^5.4.15"
   }
 }