feat: #1989: subaccount filter in ownedPositionIds

.changeset/lucky-snails-clean.md

@@ -0,0 +1,11 @@
+---
+'@penumbra-zone/storage': major
+'@penumbra-zone/protobuf': minor
+'@penumbra-zone/services': minor
+'@penumbra-zone/types': minor
+---
+
+- storage: add subaccount filter to `getOwnedPositionIds` method
+- protobuf: sync latest changes in penumbra protobufs
+- services: add subaccount filter to `ownedPositionIds` method in ViewService
+- types: update indexedDB schema

packages/protobuf/package.json

@@ -16,7 +16,7 @@
     "gen:ibc": "buf generate buf.build/cosmos/ibc:7ab44ae956a0488ea04e04511efa5f70",
     "gen:ics23": "buf generate buf.build/cosmos/ics23:55085f7c710a45f58fa09947208eb70b",
     "gen:noble": "buf generate buf.build/noble-assets/forwarding:5a8609a6772d417584a9c60cd8b80881",
-    "gen:penumbra": "buf generate buf.build/penumbra-zone/penumbra:0a56a4f32c244e7eb277e02f6e85afbd",
+    "gen:penumbra": "buf generate buf.build/penumbra-zone/penumbra:649f1d61327144cb9a7e15c7ad210dcb",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "lint:strict": "tsc --noEmit && eslint src --max-warnings 0",

packages/services/src/view-service/owned-position-ids.ts

@@ -9,7 +9,8 @@ export const ownedPositionIds: Impl['ownedPositionIds'] = async function* (req,
   for await (const positionId of indexedDb.getOwnedPositionIds(
     req.positionState,
     req.tradingPair,
+    req.subaccount,
   )) {
-    yield { positionId: positionId };
+    yield { positionId: positionId, subaccount: req.subaccount };
   }
 };

packages/storage/src/indexed-db/index.ts

@@ -570,6 +570,7 @@ export class IndexedDb implements IndexedDbInterface {
   async *getOwnedPositionIds(
     positionState: PositionState | undefined,
     tradingPair: TradingPair | undefined,
+    subaccount: AddressIndex | undefined,
   ) {
     yield* new ReadableStream({
       start: async cont => {
@@ -578,7 +579,10 @@ export class IndexedDb implements IndexedDbInterface {
           const position = Position.fromJson(cursor.value.position);
           if (
             (!positionState || positionState.equals(position.state)) &&
-            (!tradingPair || tradingPair.equals(position.phi?.pair))
+            (!tradingPair || tradingPair.equals(position.phi?.pair)) &&
+            (!subaccount ||
+              (cursor.value.subaccount &&
+                subaccount.equals(AddressIndex.fromJson(cursor.value.subaccount))))
           ) {
             cont.enqueue(PositionId.fromJson(cursor.value.id));
           }
@@ -589,16 +593,25 @@ export class IndexedDb implements IndexedDbInterface {
     });
   }
 
-  async addPosition(positionId: PositionId, position: Position): Promise<void> {
+  async addPosition(
+    positionId: PositionId,
+    position: Position,
+    subaccount?: AddressIndex,
+  ): Promise<void> {
     assertPositionId(positionId);
     const positionRecord = {
       id: positionId.toJson() as Jsonified<PositionId>,
       position: position.toJson() as Jsonified<Position>,
+      subaccount: subaccount && (subaccount.toJson() as Jsonified<AddressIndex>),
     };
     await this.u.update({ table: 'POSITIONS', value: positionRecord });
   }
 
-  async updatePosition(positionId: PositionId, newState: PositionState): Promise<void> {
+  async updatePosition(
+    positionId: PositionId,
+    newState: PositionState,
+    subaccount?: AddressIndex,
+  ): Promise<void> {
     assertPositionId(positionId);
     const key = uint8ArrayToBase64(positionId.inner);
     const positionRecord = await this.db.get('POSITIONS', key);
@@ -615,6 +628,7 @@ export class IndexedDb implements IndexedDbInterface {
       value: {
         id: positionId.toJson() as Jsonified<PositionId>,
         position: position.toJson() as Jsonified<Position>,
+        subaccount: subaccount ? (subaccount.toJson() as Jsonified<AddressIndex>) : undefined,
       },
     });
   }

packages/storage/src/indexed-db/indexed-db.test-data.ts

@@ -11,6 +11,7 @@ import { Transaction } from '@penumbra-zone/protobuf/penumbra/core/transaction/v
 import type { ScanBlockResult } from '@penumbra-zone/types/state-commitment-tree';
 import { base64ToUint8Array } from '@penumbra-zone/types/base64';
 import { StateCommitment } from '@penumbra-zone/protobuf/penumbra/crypto/tct/v1/tct_pb';
+import { AddressIndex } from '@penumbra-zone/protobuf/penumbra/core/keys/v1/keys_pb';
 
 const hash3312332298 = base64ToUint8Array('JbOzRkf0VKm4eIM0DS27N5igX8jxvPhAMpBWSr2bj/Q=');
 
@@ -717,3 +718,6 @@ export const epoch3 = new Epoch({
   index: 3n,
   startHeight: 300n,
 });
+
+export const mainAccount = new AddressIndex({ account: 0 });
+export const firstSubaccount = new AddressIndex({ account: 1 });

packages/storage/src/indexed-db/indexed-db.test.ts

@@ -28,6 +28,8 @@ import {
   tradingPairGmGn,
   transaction,
   transactionId,
+  mainAccount,
+  firstSubaccount,
 } from './indexed-db.test-data.js';
 import { AddressIndex, WalletId } from '@penumbra-zone/protobuf/penumbra/core/keys/v1/keys_pb';
 import {
@@ -493,16 +495,26 @@ describe('IndexedDb', () => {
   });
 
   describe('positions', () => {
+    it('returns empty array for zero positions', async () => {
+      const db = await IndexedDb.initialize({ ...generateInitialProps() });
+
+      const ownedPositions: PositionId[] = [];
+      for await (const positionId of db.getOwnedPositionIds(undefined, undefined, undefined)) {
+        ownedPositions.push(positionId as PositionId);
+      }
+      expect(ownedPositions.length).toBe(0);
+    });
+
     it('position should be added and their state should change', async () => {
       const db = await IndexedDb.initialize({ ...generateInitialProps() });
 
-      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy);
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
       await db.updatePosition(
         positionIdGmPenumbraBuy,
         new PositionState({ state: PositionState_PositionStateEnum.CLOSED }),
       );
       const ownedPositions: PositionId[] = [];
-      for await (const positionId of db.getOwnedPositionIds(undefined, undefined)) {
+      for await (const positionId of db.getOwnedPositionIds(undefined, undefined, undefined)) {
         ownedPositions.push(positionId as PositionId);
       }
       expect(ownedPositions.length).toBe(1);
@@ -521,27 +533,28 @@ describe('IndexedDb', () => {
 
     it('should get all position ids', async () => {
       const db = await IndexedDb.initialize({ ...generateInitialProps() });
-      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy);
-      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell);
-      await db.addPosition(positionIdGmGnSell, positionGmGnSell);
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
+      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell, mainAccount);
+      await db.addPosition(positionIdGmGnSell, positionGmGnSell, firstSubaccount);
 
       const ownedPositions: PositionId[] = [];
-      for await (const positionId of db.getOwnedPositionIds(undefined, undefined)) {
+      for await (const positionId of db.getOwnedPositionIds(undefined, undefined, undefined)) {
         ownedPositions.push(positionId as PositionId);
       }
       expect(ownedPositions.length).toBe(3);
     });
 
     it('should get all position with given position state', async () => {
       const db = await IndexedDb.initialize({ ...generateInitialProps() });
-      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy);
-      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell);
-      await db.addPosition(positionIdGmGnSell, positionGmGnSell);
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
+      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell, mainAccount);
+      await db.addPosition(positionIdGmGnSell, positionGmGnSell, firstSubaccount);
 
       const ownedPositions: PositionId[] = [];
       for await (const positionId of db.getOwnedPositionIds(
         new PositionState({ state: PositionState_PositionStateEnum.CLOSED }),
         undefined,
+        undefined,
       )) {
         ownedPositions.push(positionId as PositionId);
       }
@@ -550,16 +563,52 @@ describe('IndexedDb', () => {
 
     it('should get all position with given trading pair', async () => {
       const db = await IndexedDb.initialize({ ...generateInitialProps() });
-      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy);
-      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell);
-      await db.addPosition(positionIdGmGnSell, positionGmGnSell);
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
+      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell, mainAccount);
+      await db.addPosition(positionIdGmGnSell, positionGmGnSell, firstSubaccount);
 
       const ownedPositions: PositionId[] = [];
-      for await (const positionId of db.getOwnedPositionIds(undefined, tradingPairGmGn)) {
+      for await (const positionId of db.getOwnedPositionIds(
+        undefined,
+        tradingPairGmGn,
+        undefined,
+      )) {
         ownedPositions.push(positionId as PositionId);
       }
       expect(ownedPositions.length).toBe(1);
     });
+
+    it('should get all position with given subaccount index', async () => {
+      const db = await IndexedDb.initialize({ ...generateInitialProps() });
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
+      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell, mainAccount);
+      await db.addPosition(positionIdGmGnSell, positionGmGnSell, firstSubaccount);
+
+      const ownedPositions: PositionId[] = [];
+      for await (const positionId of db.getOwnedPositionIds(undefined, undefined, mainAccount)) {
+        ownedPositions.push(positionId as PositionId);
+      }
+      expect(ownedPositions.length).toBe(2);
+    });
+
+    it('should filter positions correctly when all filters applied together', async () => {
+      const db = await IndexedDb.initialize({ ...generateInitialProps() });
+      await db.addPosition(positionIdGmPenumbraBuy, positionGmPenumbraBuy, mainAccount);
+      await db.addPosition(positionIdGnPenumbraSell, positionGnPenumbraSell, mainAccount);
+      await db.addPosition(positionIdGmGnSell, positionGmGnSell, firstSubaccount);
+
+      const ownedPositions: PositionId[] = [];
+      for await (const positionId of db.getOwnedPositionIds(
+        new PositionState({ state: PositionState_PositionStateEnum.CLOSED }),
+        tradingPairGmGn,
+        firstSubaccount,
+      )) {
+        ownedPositions.push(positionId as PositionId);
+      }
+
+      expect(ownedPositions.length).toBe(1);
+      expect(ownedPositions[0]?.equals(positionIdGmGnSell)).toBeTruthy();
+    });
   });
 
   describe('prices', () => {

packages/types/src/indexed-db.ts

@@ -97,9 +97,14 @@ export interface IndexedDbInterface {
   getOwnedPositionIds(
     positionState: PositionState | undefined,
     tradingPair: TradingPair | undefined,
+    subaccount: AddressIndex | undefined,
   ): AsyncGenerator<PositionId, void>;
-  addPosition(positionId: PositionId, position: Position): Promise<void>;
-  updatePosition(positionId: PositionId, newState: PositionState): Promise<void>;
+  addPosition(positionId: PositionId, position: Position, subaccount?: AddressIndex): Promise<void>;
+  updatePosition(
+    positionId: PositionId,
+    newState: PositionState,
+    subaccount?: AddressIndex,
+  ): Promise<void>;
   addEpoch(startHeight: bigint): Promise<void>;
   getEpochByHeight(height: bigint): Promise<Epoch | undefined>;
   upsertValidatorInfo(validatorInfo: ValidatorInfo): Promise<void>;
@@ -297,6 +302,7 @@ export interface PenumbraDb extends DBSchema {
 export interface PositionRecord {
   id: Jsonified<PositionId>; // PositionId (must be JsonValue because ['id']['inner'] is a key )
   position: Jsonified<Position>; // Position
+  subaccount?: Jsonified<AddressIndex>; // Position AddressIndex
 }
 
 export type Tables = Record<string, StoreNames<PenumbraDb>>;