Get bound xUDT balance by btc address

[Flouse]

To get the bound xUDT balance by a BTC address in the RGB++ Assets API

Get /rgbpp/v1/address/{btc_address}/balance (Draft)

Parameters

• xUDT type_script
• btc_address

The response format will likely contain the confirmed and unconfirmed bound xUDT balance for the specified BTC address.

{
  "confirmed_balance": "1234",
  "unconfirmed_balance": "567"
}

---

requested by JoyID team @shaojunda

Related API

• https://btc-assets-api.testnet.mibao.pro/docs/static/index.html#/RGB%2B%2B/get_rgbpp_v1_address__btc_address__assets

[ahonn]

I'm not sure we can calculate the unconfirmed balance using the bounded cells. I will investigate this later.
The balance of the BTC address may have more than one token, so I think the API response data should be an array.
e.g.

z.array(
  z.object({
    name: z.string(),
    decimal: z.number(),
    symbol: z.string(),
    amount: z.string(),
  }),
)

[ahonn]

I just submitted a draft PR for this feature. After investigating, I discovered that the unique cell symbol can be duplicated, so I included the typeHash field to distinguish the tokens with the same symbol.

[Flouse]

calculate the unconfirmed balance using the bounded cells

1. Let's say BTC_UTXO_A is unconfirmed
2. Get the txid_A of BTC_UTXO_A
3. search the job in RGB++ transaction queue by txid_A
4. If job_A is found and job_A's ckbVirtualTx contains one or more xUDT cells bound to BTC_UTXO_A, then the unconfirmed balance can be calculated by the sum of the bounded xUDT data.