Merge pull request #2241 from hirosystems/develop

Cut release `v8.8.0-beta.2`

Author: zone117x

src/api/routes/v2/addresses.ts

@@ -264,5 +264,50 @@ export const AddressRoutesV2: FastifyPluginAsync<
     }
   );
 
+  fastify.get(
+    '/:principal/balances/ft/:token',
+    {
+      preHandler: handleChainTipCache, // TODO: use handlePrincipalCache once it's optimized
+      schema: {
+        operationId: 'get_principal_ft_balance',
+        summary: 'Get principal FT balance',
+        description: `Retrieves a specific fungible-token balance for a given principal.`,
+        tags: ['Accounts'],
+        params: Type.Object({
+          principal: PrincipalSchema,
+          token: Type.String({
+            description: 'fungible token identifier',
+            examples: [
+              'SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token',
+              'SP3Y2ZSH8P7D50B0VBTSX11S7XSG24M1VB9YFQA4K.token-aeusdc::aeUSDC',
+            ],
+          }),
+        }),
+        response: {
+          200: Type.Object({
+            balance: Type.String(),
+          }),
+        },
+      },
+    },
+    async (req, reply) => {
+      const stxAddress = req.params.principal;
+      validatePrincipal(stxAddress);
+      const result = await fastify.db.sqlTransaction(async sql => {
+        const ftBalanceResult = await fastify.db.v2.getFtHolderBalance({
+          sql,
+          stxAddress,
+          token: req.params.token,
+        });
+        const balance = ftBalanceResult.found ? ftBalanceResult.result.balance : 0n;
+        const result = {
+          balance: balance.toString(),
+        };
+        return result;
+      });
+      await reply.send(result);
+    }
+  );
+
   await Promise.resolve();
 };

src/datastore/pg-store-v2.ts

@@ -1054,6 +1054,26 @@ export class PgStoreV2 extends BasePgStoreModule {
     };
   }
 
+  async getFtHolderBalance(args: {
+    sql: PgSqlClient;
+    stxAddress: string;
+    token: string;
+  }): Promise<FoundOrNot<{ balance: bigint }>> {
+    const [result] = await args.sql<{ balance: string }[]>`
+      SELECT token, balance FROM ft_balances
+      WHERE address = ${args.stxAddress}
+        AND token = ${args.token}
+      LIMIT 1
+    `;
+    if (!result) {
+      return { found: false };
+    }
+    return {
+      found: true,
+      result: { balance: BigInt(result.balance) },
+    };
+  }
+
   async getStxPoxLockedAtBlock({
     sql,
     stxAddress,

tests/api/address.test.ts

@@ -1686,6 +1686,27 @@ describe('address tests', () => {
       results: [{ token: 'gox', balance: '585' }],
     });
 
+    const fetchAddrV2BalanceFt1 = await supertest(api.server).get(
+      `/extended/v2/addresses/${testContractAddr}/balances/ft/bux`
+    );
+    expect(fetchAddrV2BalanceFt1.status).toBe(200);
+    expect(fetchAddrV2BalanceFt1.type).toBe('application/json');
+    expect(fetchAddrV2BalanceFt1.body).toEqual({ balance: '375' });
+
+    const fetchAddrV2BalanceFt2 = await supertest(api.server).get(
+      `/extended/v2/addresses/${testContractAddr}/balances/ft/gox`
+    );
+    expect(fetchAddrV2BalanceFt2.status).toBe(200);
+    expect(fetchAddrV2BalanceFt2.type).toBe('application/json');
+    expect(fetchAddrV2BalanceFt2.body).toEqual({ balance: '585' });
+
+    const fetchAddrV2BalanceFt3 = await supertest(api.server).get(
+      `/extended/v2/addresses/${testContractAddr}/balances/ft/none`
+    );
+    expect(fetchAddrV2BalanceFt3.status).toBe(200);
+    expect(fetchAddrV2BalanceFt3.type).toBe('application/json');
+    expect(fetchAddrV2BalanceFt3.body).toEqual({ balance: '0' });
+
     const tokenLocked: DbTokenOfferingLocked = {
       address: testContractAddr,
       value: BigInt(4139391122),