Refactor token balance query (#229)

* Refactor token balance query.

* Update dependency.

Author: silathdiir

.github/workflows/integration-test.yml

@@ -126,4 +126,5 @@ jobs:
           cd ./examples/js/
           npx ts-node get_l2_block_by_id.ts
           npx ts-node get_token_balance.ts
+          npx ts-node rest_get_token_balance.ts
           npx ts-node rest_get_l2_blocks.ts

Cargo.lock

@@ -42,7 +42,9 @@ async function mainTest() {
   await sleep(1000);
   await kafkaProducer.Stop();
 
-  await getTokenBalanceTest();
+  await testGetTokenBalanceByTokenId();
+  await testGetTokenBalanceByTokenName();
+
   await getL2BlockTest();
 }
 
@@ -64,14 +66,26 @@ async function depositBalance() {
   ]);
 }
 
-async function getTokenBalanceTest() {
-  // const res = await grpcClient.tokenBalanceQuery(userId, tokenId, "", "");
-  const res = await grpcClient.tokenBalanceQuery(userId, 999, "", "ETH"); // test ignoring token_id by providing token_name
+async function testGetTokenBalanceByTokenId() {
+  console.log("testGetTokenBalanceByTokenId Begin");
+
+  const res = await grpcClient.tokenBalanceQuery(userId, tokenId, null, null);
+  assert.equal(res["balance"], "3.0000");
+  assert.equal(res["balance_raw"], "30000");
+  assert.equal(res["precision"], 4);
+
+  console.log("testGetTokenBalanceByTokenId End");
+}
+
+async function testGetTokenBalanceByTokenName() {
+  console.log("testGetTokenBalanceByTokenName Begin");
+
+  const res = await grpcClient.tokenBalanceQuery(userId, null, null, "ETH");
   assert.equal(res["balance"], "3.0000");
   assert.equal(res["balance_raw"], "30000");
   assert.equal(res["precision"], 4);
 
-  console.log("getTokenBalanceTest passed");
+  console.log("testGetTokenBalanceByTokenName End");
 }
 
 async function getL2BlockTest() {

examples/js/get_token_balance.ts

@@ -22,6 +22,24 @@ class Client {
       throw new Error(`request failed with ${resp.status} ${resp.statusText}`);
     }
   }
+
+  async tokenBalanceQuery(accountId, tokenId, tokenAddress, tokenName) {
+    let params = null;
+    if (tokenId != null) {
+      params = `token_id=${tokenId}`;
+    } else if (tokenAddress != null) {
+      params = `token_address=${tokenAddress}`;
+    } else if (tokenName != null) {
+      params = `token_name=${tokenName}`;
+    }
+
+    let resp = await this.client.get(`/token_balance/${accountId}?${params}`);
+    if (resp.status === 200) {
+      return resp.data;
+    } else {
+      throw new Error(`request failed with ${resp.status} ${resp.statusText}`);
+    }
+  }
 }
 
 let restClient = new Client();

examples/js/rest_client.ts

@@ -0,0 +1,46 @@
+// This test must be run after `get_token_balance.ts`. Since the test cases use
+// the previous build Kafka data.
+
+import { restClient } from "./rest_client";
+import { strict as assert } from "assert";
+
+const tokenId = 0;
+const userId = 3;
+
+async function main() {
+  try {
+    await mainTest();
+  } catch (error) {
+    console.error("Caught error:", error);
+    process.exit(1);
+  }
+}
+
+async function mainTest() {
+  await testGetTokenBalanceByTokenId();
+  await testGetTokenBalanceByTokenName();
+}
+
+async function testGetTokenBalanceByTokenId() {
+  console.log("testGetTokenBalanceByTokenId Begin");
+
+  const res = await restClient.tokenBalanceQuery(userId, tokenId, null, null);
+  assert.equal(res["balance"], "3.0000");
+  assert.equal(res["balance_raw"], "30000");
+  assert.equal(res["precision"], 4);
+
+  console.log("testGetTokenBalanceByTokenId End");
+}
+
+async function testGetTokenBalanceByTokenName() {
+  console.log("testGetTokenBalanceByTokenName Begin");
+
+  const res = await restClient.tokenBalanceQuery(userId, null, null, "ETH");
+  assert.equal(res["balance"], "3.0000");
+  assert.equal(res["balance_raw"], "30000");
+  assert.equal(res["precision"], 4);
+
+  console.log("testGetTokenBalanceByTokenName End");
+}
+
+main();

examples/js/rest_get_token_balance.ts

@@ -194,12 +194,17 @@ impl Controller {
     }
 
     pub fn token_balance_query(&self, request: TokenBalanceQueryRequest) -> Result<TokenBalanceQueryResponse, Status> {
-        let token_id = if !request.token_address.is_empty() {
+        let token_id = if let Some(token_id) = request.token_id {
+            token_id
+        } else if let Some(_token_address) = request.token_address {
             unimplemented!()
-        } else if !request.token_name.is_empty() {
-            get_token_id_by_name(&request.token_name)
+        } else if let Some(token_name) = request.token_name {
+            get_token_id_by_name(&token_name)
         } else {
-            request.token_id
+            return Err(Status::new(
+                Code::InvalidArgument,
+                "Must specify one of token_id, token_address or token_name",
+            ));
         };
 
         let balance = self.state.read().unwrap().get_token_balance(request.account_id, token_id);