feat: query cw20 token metadata

Author: o-az

typescript-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unionlabs/client",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "homepage": "https://union.build",
   "description": "Union Labs cross-chain transfers client",
   "type": "module",

typescript-sdk/playground/cw20-fetch-balance.ts

@@ -0,0 +1,13 @@
+import { queryCosmosCW20AddressBalance } from "#mod.ts"
+
+const balance = await queryCosmosCW20AddressBalance({
+  address: "bbn1xe0rnlh3u05qkwytkwmyzl86a0mvpwfxgf2t7u",
+  contractAddress: "bbn192gwgengt32um4qshvhg5f3prtey2g6xmyrmkd87xvy59elaw5vs504zeg",
+  chainId: "bbn-test-5"
+})
+
+if (balance.isErr()) {
+  console.error(balance.error)
+} else {
+  console.info(balance.value)
+}

typescript-sdk/playground/cw20-fetch-metadata.ts

@@ -0,0 +1,12 @@
+import { queryCosmosC20TokenMetadata } from "#mod.ts"
+
+const metadata = await queryCosmosC20TokenMetadata({
+  contractAddress: "bbn192gwgengt32um4qshvhg5f3prtey2g6xmyrmkd87xvy59elaw5vs504zeg",
+  chainId: "bbn-test-5"
+})
+
+if (metadata.isErr()) {
+  console.error(metadata.error)
+} else {
+  console.info(metadata.value)
+}

typescript-sdk/src/mod.ts

@@ -45,6 +45,8 @@ export {
 export {
   getCosmosHeight,
   queryContractState,
+  queryCosmosCW20AddressBalance,
+  queryCosmosC20TokenMetadata,
   getCosmosTransactionReceipt,
   getAptosAccountTransactions,
   getCosmosAccountTransactions

typescript-sdk/src/query/on-chain.ts

@@ -1,6 +1,9 @@
 import { ofetch } from "ofetch"
 import type { Prettify } from "../types.ts"
 import { Base64, Hex, Json } from "ox"
+import { ResultAsync, err, ok, type Result } from "neverthrow"
+import { CosmWasmClient } from "@cosmjs/cosmwasm-stargate"
+import { cosmosRpcs, type CosmosChainId } from "#cosmos/client.ts"
 
 type rpcUrlArgument = { rpcUrl: string }
 export type RpcQueryPath = "height" | "block" | "transaction" | "net_info" | "health"
@@ -36,6 +39,88 @@ type CosmosTransactionReceipt = {
   }
 }
 
+/**
+ * get the balance of a given address for a given cw20 contract
+ * @example
+ * ```ts
+ * const balance = await getCosmosCW20AddressBalance({
+ *   chainId: "bbn-test-5",
+ *   address: "bbn1xe0rnlh3u05qkwytkwmyzl86a0mvpwfxgf2t7u",
+ *   contractAddress: "bbn192gwgengt32um4qshvhg5f3prtey2g6xmyrmkd87xvy59elaw5vs504zeg",
+ * })
+ */
+export async function queryCosmosCW20AddressBalance({
+  address,
+  contractAddress,
+  chainId
+}: {
+  address: string
+  contractAddress: string
+  chainId: CosmosChainId
+}): Promise<Result<string, Error>> {
+  let rpc = cosmosRpcs[chainId] // as is valid bc of the check in the if statement.
+  let publicClient = await ResultAsync.fromPromise(CosmWasmClient.connect(rpc), error => {
+    return new Error(`failed to create public cosmwasm client with rpc ${rpc}`, { cause: error })
+  })
+  if (publicClient.isErr()) return err(publicClient.error)
+
+  let client = publicClient.value
+  const balance = ResultAsync.fromPromise(
+    client.queryContractSmart(contractAddress, { balance: { address } }),
+    error => {
+      return new Error(`failed to query balance for contract ${contractAddress}`, { cause: error })
+    }
+  )
+
+  return balance.andThen(balance => ok(balance.balance))
+}
+
+/**
+ * get the metadata of a given cw20 contract
+ * @example
+ * ```ts
+ * const metadata = await queryCosmosC20TokenMetadata({
+ *   contractAddress: "bbn192gwgengt32um4qshvhg5f3prtey2g6xmyrmkd87xvy59elaw5vs504zeg",
+ *   chainId: "bbn-test-5"
+ * })
+ * ```
+ */
+export async function queryCosmosC20TokenMetadata({
+  contractAddress,
+  chainId
+}: {
+  contractAddress: string
+  chainId: CosmosChainId
+}): Promise<
+  Result<
+    {
+      name: string
+      symbol: string
+      decimals: number
+      total_supply: string
+    },
+    Error
+  >
+> {
+  let rpc = cosmosRpcs[chainId] // as is valid bc of the check in the if statement.
+  let publicClient = await ResultAsync.fromPromise(CosmWasmClient.connect(rpc), error => {
+    return new Error(`failed to create public cosmwasm client with rpc ${rpc}`, { cause: error })
+  })
+  if (publicClient.isErr()) return err(publicClient.error)
+  let client = publicClient.value
+  const response = ResultAsync.fromPromise(
+    client.queryContractSmart(contractAddress, {
+      token_info: {}
+    }),
+    error => {
+      return new Error(`failed to query token info for contract ${contractAddress}`, {
+        cause: error
+      })
+    }
+  )
+  return response
+}
+
 const CW20_PREFIXES = [
   "\u0000\x07",
   "\u0000\x08",