withdraw and get usefunds

Author: giurgiur99

src/cli.ts

@@ -414,6 +414,32 @@ export async function createCLI() {
       console.log(chalk.green('Deposit successful'));
     });
 
+  // Check escrow deposited balance
+  program
+    .command('getUserFundsEscrow')
+    .description('Get deposited token amount in escrow for user')
+    .argument('<token>', 'Address of the token to check')
+    .option('-t, --token <token>', 'Address of the token to check')
+    .action(async (token, options) => {
+      const { signer, chainId } = await initializeSigner();
+      const commands = new Commands(signer, chainId);
+      await commands.getEscrowBalance(token || options.token);
+    });
+
+  // Withdraw from escrow
+  program
+    .command('withdrawFromEscrow')
+    .description('Withdraw tokens from escrow')
+    .argument('<token>', 'Address of the token to check')
+    .argument('<amount>', 'Amount of tokens to withdraw')
+    .option('-t, --token <token>', 'Address of the token to check')
+    .option('-a, --amount <amount>', 'Amount of tokens to withdraw')
+    .action(async (token, amount, options) => {
+      const { signer, chainId } = await initializeSigner();
+      const commands = new Commands(signer, chainId);
+      await commands.withdrawFromEscrow(token || options.token, amount);
+    });
+
   // Escrow authorization command
   program
     .command('authorizeEscrow')

src/commands.ts

@@ -10,7 +10,7 @@ import {
 	getIndexingWaitSettings,
 	IndexerWaitParams,
 	fixAndParseProviderFees,
-	getConfigByChainId,
+	getConfigByChainId
 } from "./helpers.js";
 import {
 	Aquarius,
@@ -26,7 +26,8 @@ import {
 	orderAsset,
 	sendTx,
 	unitsToAmount,
-	EscrowContract
+	EscrowContract,
+	getTokenDecimals
 } from "@oceanprotocol/lib";
 import { Asset } from '@oceanprotocol/ddo-js';
 import { Signer, ethers } from "ethers";
@@ -1315,6 +1316,50 @@ export class Commands {
 		console.log(`Auth token successfully invalidated`);
 	}
 
+	public async getEscrowBalance(token: string): Promise<number> {
+		const config = await getConfigByChainId(Number(this.config.chainId));
+		const escrow = new EscrowContract(
+			ethers.utils.getAddress(config.Escrow),
+			this.signer,
+			Number(this.config.chainId)
+		);
+
+		try {
+			const balance = await escrow.getUserFunds(await this.signer.getAddress(), token);
+			const decimals = await getTokenDecimals(this.signer, token);
+
+			const sum = await balance.reduce(async (accPromise, curr) => {
+				const acc = await accPromise;
+				const amount = await unitsToAmount(this.signer, token, curr, decimals);
+				return acc + Number(amount);
+			}, Promise.resolve(0));
+
+			console.log(`Escrow user funds for token ${token}: ${sum}`);
+			return sum;
+		} catch (error) {
+			console.error("Error getting escrow balance:", error);
+		}
+	}
+
+	public async withdrawFromEscrow(token: string, amount: string): Promise<void> {
+		const config = await getConfigByChainId(Number(this.config.chainId));
+		const escrow = new EscrowContract(
+			ethers.utils.getAddress(config.Escrow),
+			this.signer,
+			Number(this.config.chainId)
+		);
+
+		const balance = await this.getEscrowBalance(token);
+		if (balance < Number(amount)) {
+			console.error(`Insufficient balance in escrow for token ${token}`);
+			return;
+		}
+
+		const withdrawTx = await escrow.withdraw([token], [amount]);
+		await withdrawTx.wait();
+		console.log(`Successfully withdrawn ${amount} ${token} from escrow`);
+	}
+
 	public async depositToEscrow(signer: Signer, token: string, amount: string, chainId: number) {
 		try {
 			const amountInUnits = await amountToUnits(signer, token, amount, 18);

src/helpers.ts

@@ -26,7 +26,7 @@ import {
 } from "@oceanprotocol/lib";
 import { homedir } from "os";
 
-const ERC20Template = readFileSync('./node_modules/@oceanprotocol/contracts/artifacts/contracts/templates/ERC20Template.sol/ERC20Template.json', 'utf8') as any;
+const ERC20Template = readFileSync('./node_modules/@oceanprotocol/contracts/artifacts/@openzeppelin/contracts/token/ERC20/ERC20.sol/ERC20.json', 'utf8') as any;
 
 export async function downloadFile(
 	url: string,

test/escrow.test.ts

@@ -36,21 +36,39 @@ describe("Ocean CLI Escrow", function () {
     it("should deposit tokens into escrow", async function () {
         const depositAmount = "1";
 
+        const initialTokenBalance = await runCommand(`npm run cli getUserFundsEscrow ${tokenAddress}`);
+        const initialTokenBalanceNumber = initialTokenBalance.split(`${tokenAddress}: `)[1].trim();
+        const numberInitialTokenBalance = Number(initialTokenBalanceNumber);
+
         const output = await runCommand(
             `npm run cli depositEscrow ${tokenAddress} ${depositAmount}`
         );
 
+        const finalTokenBalance = await runCommand(`npm run cli getUserFundsEscrow ${tokenAddress}`);
+        const finalTokenBalanceNumber = finalTokenBalance.split(`${tokenAddress}: `)[1].trim();
+        const numberFinalTokenBalance = Number(finalTokenBalanceNumber);
 
         expect(output).to.include("Deposit successful");
+        expect(numberFinalTokenBalance).to.equal(Number(depositAmount) + numberInitialTokenBalance);
+    });
+
+    it("should withdraw tokens from escrow", async function () {
+        const withdrawAmount = "1";
+        const output = await runCommand(
+            `npm run cli withdrawFromEscrow ${tokenAddress} ${withdrawAmount}`
+        );
+
+        expect(output).to.include("Successfully withdrawn");
     });
 
     it("should fail to deposit with invalid amount", async function () {
-        const invalidAmount = "10000000";
+        const invalidAmount = "1000000000000000";
 
         const output = await runCommand(
             `npm run cli depositEscrow ${tokenAddress} ${invalidAmount}`
         );
 
+
         expect(output).to.include("Deposit failed");
     });