Merge branch 'develop'

Author: sebastianmontero

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@smontero/smartvaults-js-client",
-  "version": "0.0.62",
+  "version": "0.0.63",
   "description": "SmartVaults javascript client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -2,7 +2,7 @@ import { Authenticator, DirectPrivateKeyAuthenticator } from '@smontero/nostr-ua
 import { generatePrivateKey, Kind, Event, Filter, Sub } from 'nostr-tools'
 import { SmartVaultsKind, TagType, ProposalType, ProposalStatus, ApprovalStatus, StoreKind, AuthenticatorType, NetworkType, FiatCurrency, Magic } from './enum'
 import { NostrClient, PubPool, Store } from './service'
-import { buildEvent, filterBuilder, getTagValues, PaginationOpts, fromNostrDate, toPublished, nostrDate, isNip05Verified, type singleKindFilterParams, FilterBuilder, TimeUtil, CurrencyUtil, getTagValue, DoublyLinkedList } from './util'
+import { buildEvent, filterBuilder, getTagValues, PaginationOpts, fromNostrDate, nostrDate, isNip05Verified, type singleKindFilterParams, FilterBuilder, TimeUtil, CurrencyUtil, getTagValue, DoublyLinkedList } from './util'
 import { BasicTrxDetails, BaseOwnedSigner, BaseSharedSigner, BitcoinUtil, Contact, Policy, PublishedPolicy, TrxDetails } from './models'
 import * as SmartVaultsTypes from './types'
 import { EventKindHandlerFactory } from './event-kind-handler'
@@ -520,7 +520,7 @@ export class SmartVaults {
    * const ids = ['id1', 'id2'];
    * const policiesById = await getPoliciesById(ids);
    */
-  async getPoliciesById(ids: string[]): Promise<Map<string, PublishedPolicy>> {
+  getPoliciesById = async (ids: string[]): Promise<Map<string, PublishedPolicy>> => {
     const store = this.getStore(SmartVaultsKind.Policy)
     const missingIds = store.missing(ids)
     if (missingIds.length) {
@@ -697,6 +697,7 @@ export class SmartVaults {
           to_address,
           amount,
           psbt,
+          policy_path: policyPath,
           ...keyAgentPayment
         }
       } as SmartVaultsTypes.KeyAgentPaymentProposal;
@@ -707,7 +708,8 @@ export class SmartVaults {
           description,
           to_address,
           amount,
-          psbt
+          psbt,
+          policy_path: policyPath,
         }
       } as SmartVaultsTypes.SpendingProposal;
     }
@@ -731,15 +733,13 @@ export class SmartVaults {
 
     await this.getChat().sendMessage(msg, policy.id)
 
-    const signer = 'Unknown'
     const fee = Number(this.bitcoinUtil.getFee(psbt))
     const utxo = this.bitcoinUtil.getPsbtUtxos(psbt)
     const [amountFiat, feeFiat] = await this.bitcoinExchangeRate.convertToFiat([amount, fee])
     const bitcoinExchangeRate = await this.bitcoinExchangeRate.getExchangeRate()
     const activeFiatCurrency = this.bitcoinExchangeRate.getActiveFiatCurrency()
     const status = ProposalStatus.Unsigned
     const commonProps = {
-      signer,
       amountFiat,
       fee,
       feeFiat,
@@ -752,17 +752,20 @@ export class SmartVaults {
       activeFiatCurrency,
     }
 
+    const ownedSigners = await this.getOwnedSigners()
     let publishedProposal: SmartVaultsTypes.PublishedSpendingProposal | SmartVaultsTypes.PublishedKeyAgentPaymentProposal
     if (keyAgentPayment) {
       publishedProposal = {
         ...proposalContent[ProposalType.KeyAgentPayment],
         ...commonProps,
+        signers: await policy.getExpectedSigners(proposalContent[ProposalType.KeyAgentPayment], ownedSigners),
         type: ProposalType.KeyAgentPayment,
       } as SmartVaultsTypes.PublishedKeyAgentPaymentProposal
     } else {
       publishedProposal = {
         ...proposalContent[ProposalType.Spending],
         ...commonProps,
+        signers: await policy.getExpectedSigners(proposalContent[ProposalType.Spending], ownedSigners),
         type: ProposalType.Spending,
       } as SmartVaultsTypes.PublishedSpendingProposal
     }
@@ -1964,7 +1967,7 @@ export class SmartVaults {
     if (!sharedKeyAuthenticator) {
       throw new Error(`Shared key for policy with id ${policy_id} not found`)
     }
-    const policy = toPublished(await sharedKeyAuthenticator.decryptObj(policyEvent.content), policyEvent)
+    const policy = (await this.getPoliciesById([policy_id])).get(policy_id)!
     const type = ProposalType.ProofOfReserve
     //proposal = policy.proof_of_reserve(wallet,message)
     const proposal: SmartVaultsTypes.ProofOfReserveProposal = {
@@ -1994,10 +1997,11 @@ export class SmartVaults {
     await this.getChat().sendMessage(msg, policy.id)
     const proposal_id = proposalEvent.id
     const status = ProposalStatus.Unsigned
-    const signer = 'Unknown'
+    const ownedSigners = await this.getOwnedSigners()
+    const signers: string[] = await policy.getExpectedSigners(proposal[type], ownedSigners)
     const fee = this.bitcoinUtil.getFee(psbt)
     const utxos = this.bitcoinUtil.getPsbtUtxos(psbt)
-    return { ...proposal[type], proposal_id, type, status, signer, fee, utxos, policy_id, createdAt }
+    return { ...proposal[type], proposal_id, type, status, signers, fee, utxos, policy_id, createdAt }
 
   }
 

src/SmartVaults.ts

@@ -55,6 +55,7 @@ export class EventKindHandlerFactory {
       const deleteSignerOfferings = this.smartVaults.deleteSignerOfferings
       const getPolicyMembers = this.smartVaults.getPolicyMembers
       const saveTransactionMetadata = this.smartVaults.saveTransactionMetadata
+      const getPoliciesById = this.smartVaults.getPoliciesById
       const eventsStore = stores.get(StoreKind.Events)!
       const completedProposalsStore = stores.get(SmartVaultsKind.CompletedProposal)!
       const proposalsStore = stores.get(SmartVaultsKind.Proposal)!
@@ -68,7 +69,7 @@ export class EventKindHandlerFactory {
             getSharedKeysById, getCompletedProposalsByPolicyId, getProposalsByPolicyId, getApprovalsByPolicyId, getSharedSigners, getOwnedSigners, getTransactionMetadataByPolicyId, saveTransactionMetadata))
           break
         case SmartVaultsKind.Proposal:
-          this.handlers.set(eventKind, new ProposalHandler(stores.get(eventKind)!, eventsStore, approvalsStore, nostrClient, bitcoinUtil, authenticator, getSharedKeysById, checkPsbts, getOwnedSigners, getApprovalsByProposalId))
+          this.handlers.set(eventKind, new ProposalHandler(stores.get(eventKind)!, eventsStore, approvalsStore, nostrClient, bitcoinUtil, authenticator, getSharedKeysById, checkPsbts, getOwnedSigners, getApprovalsByProposalId, getPoliciesById))
           break
         case SmartVaultsKind.ApprovedProposal:
           this.handlers.set(eventKind, new ApprovalsHandler(stores.get(eventKind)!, eventsStore, nostrClient, authenticator, getSharedKeysById))

src/event-kind-handler/EventKindHandlerFactory.ts

@@ -4,8 +4,9 @@ import { type SpendingProposal, type PublishedSpendingProposal, type PublishedPr
 import { type Store, type NostrClient } from '../service'
 import { getTagValues, fromNostrDate, buildEvent, BitcoinExchangeRate } from '../util'
 import { EventKindHandler } from './EventKindHandler'
-import { type BitcoinUtil } from '../models'
+import { type PublishedPolicy, type BitcoinUtil } from '../models'
 import { type Authenticator } from '@smontero/nostr-ual'
+
 export class ProposalHandler extends EventKindHandler {
   private readonly store: Store
   private readonly eventsStore: Store
@@ -18,9 +19,18 @@ export class ProposalHandler extends EventKindHandler {
   private readonly getOwnedSigners: () => Promise<PublishedOwnedSigner[]>
   private readonly getApprovalsByProposalId: (proposal_ids?: string[] | string) => Promise<Map<string, Array<PublishedApprovedProposal>>>
   private readonly bitcoinExchangeRate: BitcoinExchangeRate = BitcoinExchangeRate.getInstance();
-  constructor(store: Store, eventsStore: Store, approvalsStore: Store, nostrClient: NostrClient, bitcoinUtil: BitcoinUtil, authenticator: Authenticator, getSharedKeysById: (ids: string[]) => Promise<Map<string, SharedKeyAuthenticator>>, checkPsbts: (proposalId: string) => Promise<boolean>,
+  private readonly getPoliciesById: (policy_ids: string[]) => Promise<Map<string, PublishedPolicy>>
+  constructor(
+    store: Store,
+    eventsStore: Store,
+    approvalsStore: Store,
+    nostrClient: NostrClient,
+    bitcoinUtil: BitcoinUtil,
+    authenticator: Authenticator,
+    getSharedKeysById: (ids: string[]) => Promise<Map<string, SharedKeyAuthenticator>>, checkPsbts: (proposalId: string) => Promise<boolean>,
     getOwnedSigners: () => Promise<Array<PublishedOwnedSigner>>,
-    getApprovalsByProposalId: (proposal_ids?: string[] | string) => Promise<Map<string, Array<PublishedApprovedProposal>>>) {
+    getApprovalsByProposalId: (proposal_ids?: string[] | string) => Promise<Map<string, Array<PublishedApprovedProposal>>>,
+    getPoliciesById: (policy_ids: string[]) => Promise<Map<string, PublishedPolicy>>) {
     super()
     this.store = store
     this.eventsStore = eventsStore
@@ -32,15 +42,7 @@ export class ProposalHandler extends EventKindHandler {
     this.checkPsbts = checkPsbts
     this.getOwnedSigners = getOwnedSigners
     this.getApprovalsByProposalId = getApprovalsByProposalId
-  }
-
-  private searchSignerInDescriptor(fingerprints: string[], descriptor: string): string | null {
-    for (const fingerprint of fingerprints) {
-      if (descriptor.includes(fingerprint)) {
-        return fingerprint
-      }
-    }
-    return null
+    this.getPoliciesById = getPoliciesById
   }
 
   protected async _handle<K extends number>(proposalEvents: Array<Event<K>>): Promise<Array<ActivePublishedProposal | PublishedKeyAgentPaymentProposal>> {
@@ -52,18 +54,14 @@ export class ProposalHandler extends EventKindHandler {
       this.checkPsbts(proposalId).then(status => ({ proposalId, status: status ? ProposalStatus.Signed : ProposalStatus.Unsigned }))
     );
 
-    const [statusResults, signers] = await Promise.all([
-      Promise.all(statusPromises),
-      this.getOwnedSigners()
-    ]);
+    const [statusResults, ownedSigners] = await Promise.all([await Promise.all(statusPromises), this.getOwnedSigners()])
 
     const bitcoinExchangeRate = await this.bitcoinExchangeRate.getExchangeRate();
     const activeFiatCurrency = this.bitcoinExchangeRate.getActiveFiatCurrency();
     const proposalsStatusMap = new Map(statusResults.map(res => [res.proposalId, res.status]));
 
     const decryptedProposals: Array<ActivePublishedProposal | PublishedKeyAgentPaymentProposal> = []
     const rawEvents: Array<Event<K>> = []
-    const fingerprints: string[] = signers.map(signer => signer.fingerprint)
 
     const decryptPromises: Promise<any>[] = proposalEvents.map(async (proposalEvent) => {
       const storedProposal: PublishedSpendingProposal | PublishedKeyAgentPaymentProposal = this.store.get(proposalEvent.id, 'proposal_id')
@@ -112,8 +110,8 @@ export class ProposalHandler extends EventKindHandler {
         const type = Object.keys(decryptedProposalObj)[0] as ProposalType;
         const proposalContent = decryptedProposalObj[type]
         const createdAt = fromNostrDate(proposalEvent.created_at)
-        const signerResult: string | null = this.searchSignerInDescriptor(fingerprints, proposalContent.descriptor)
-        const signer = signerResult ?? 'Unknown'
+        const policy = (await this.getPoliciesById([policyId])).get(policyId)
+        const signers = await policy?.getExpectedSigners(proposalContent, ownedSigners) || []
         const psbt = proposalContent.psbt
         const utxos = this.bitcoinUtil.getPsbtUtxos(psbt)
         const fee = Number(this.bitcoinUtil.getFee(psbt))
@@ -122,7 +120,7 @@ export class ProposalHandler extends EventKindHandler {
         let publishedProposal: ActivePublishedProposal;
         const commonProps = {
           type,
-          signer,
+          signers,
           fee,
           utxos,
           createdAt,

src/event-kind-handler/ProposalHandler.ts

@@ -9,7 +9,7 @@ import { DirectPrivateKeyAuthenticator } from '@smontero/nostr-ual'
 import { Keys, Store } from '../service'
 import { fromNostrDate } from '../util'
 import { SmartVaults } from '../SmartVaults'
-import { LabeledUtxo } from '../types'
+import { LabeledUtxo, PublishedOwnedSigner } from '../types'
 
 describe('PublishedPolicy', () => {
   let policyContent: Policy
@@ -190,8 +190,7 @@ describe('PublishedPolicy', () => {
       wallet.sync.mockResolvedValue()
       const expected = { amount: 3000, psbt: "psbt2" }
       wallet.build_trx.mockResolvedValue(expected)
-      let policyPath = new Map<string, Array<number>>()
-      policyPath.set("83aswe", [1])
+      let policyPath = { "83aswe": [1] }
       let utxos = ["05dce7f5440ded30bd55359d9e4f65de34fefaaef5fb16ac4cfaf72375fd204d:1", "123ce7f5440ded30bd55359d9e4f65de34fefaaef5fb16ac4cfaf72375fd204d:2"]
       let frozenUtxos = ["15dce7f5440ded30bd55359d9e4f65de34fefaaef5fb16ac4cfaf72375fd204g:3"]
       let actual = await policy.buildTrx({
@@ -511,6 +510,36 @@ describe('PublishedPolicy', () => {
     })
   })
 
+  describe('getExpectedSigners', () => {
+
+    it('should return the expected signers when theres no policy path', async () => {
+      const signer1 = { name: 'SmartVaults', description: undefined, fingerprint: 'f57a6b99', descriptor: "tr([f57a6b99/86'/1'/784923']tpubDC45v32EZGP2U4qVTK…tbexZUMtY4ubZGS74kQftEGibUxUpybMan7/0/*)#jakwhh0u", t: 'Seed' } as PublishedOwnedSigner
+      const signer2 = { name: 'SmartVaults', description: undefined, fingerprint: 'f3ab64d8', descriptor: "tr([f3ab64d8/86'/1'/784923']tpubDCh4uyVDVretfgTNka…91gN5LYtuSCbr1Vo6mzQmD49sF2vGpReZp2/0/*)#yavh9uq5", t: 'Seed' } as PublishedOwnedSigner
+      smartVaults.getOwnedSigners.mockResolvedValue([signer1, signer2])
+      jest.spyOn(policy, 'getPolicy').mockReturnValue(undefined!)
+      const proposal = { descriptor: "descriptor" + signer1.fingerprint }
+      const actual = await policy.getExpectedSigners(proposal, [signer1, signer2])
+      expect([signer1.fingerprint]).toEqual(actual)
+    })
+
+    it('should return the expected signers when theres policy path', async () => {
+      const signer1 = { name: 'SmartVaults', description: undefined, fingerprint: 'f57a6b99', descriptor: "tr([f57a6b99/86'/1'/784923']tpubDC45v32EZGP2U4qVTK…tbexZUMtY4ubZGS74kQftEGibUxUpybMan7/0/*)#jakwhh0u", t: 'Seed' } as PublishedOwnedSigner
+      const signer2 = { name: 'SmartVaults', description: undefined, fingerprint: 'f3ab64d8', descriptor: "tr([f3ab64d8/86'/1'/784923']tpubDCh4uyVDVretfgTNka…91gN5LYtuSCbr1Vo6mzQmD49sF2vGpReZp2/0/*)#yavh9uq5", t: 'Seed' } as PublishedOwnedSigner
+      smartVaults.getOwnedSigners.mockResolvedValue([signer1, signer2])
+      const policyPath = { "83aswe": [0], "a2A8ds": [2], "dsdnii": [0] }
+      const proposal = { descriptor: "descriptor" + signer1.fingerprint, policy_path: policyPath }
+      const policyTree = new Map<string, any>()
+      policyTree.set("id", "83aswe")
+      const lastItem = new Map<string, any>()
+      lastItem.set("id", "any")
+      lastItem.set("fingerprint", "f3ab64d8")
+      policyTree.set("items", [new Map<string, any>([["id", "a2A8ds"], ["items", [new Map(), new Map(), lastItem]]]),])
+      jest.spyOn(policy, 'getPolicy').mockReturnValue(policyTree)
+      const actual = await policy.getExpectedSigners(proposal, [signer1, signer2])
+      expect([signer2.fingerprint]).toEqual(actual)
+    })
+  })
+
   describe('Augmented transaction details', () => {
 
     let date1;

src/models/PublishedPolicy.test.ts

@@ -5,7 +5,7 @@ import { BaseOwnedSigner, PolicyPathSelector, Trx, Policy, FinalizeTrxResponse,
 import { BitcoinUtil, Wallet } from './interfaces'
 import { CurrencyUtil, PaginationOpts, TimeUtil, fromNostrDate, toPublished } from '../util'
 import { generateUiMetadata, UIMetadata, Key } from '../util/GenerateUiMetadata'
-import { LabeledUtxo, PublishedTransactionMetadata, PublishedOwnedSigner, PublishedSharedSigner, PublishedSpendingProposal, ActivePublishedProposal, TransactionMetadata } from '../types'
+import { LabeledUtxo, PublishedTransactionMetadata, PublishedOwnedSigner, PublishedSharedSigner, PublishedSpendingProposal, ActivePublishedProposal, TransactionMetadata, PolicyPath, Item } from '../types'
 import { type Store } from '../service'
 import { StringUtil } from '../util'
 import { BitcoinExchangeRate } from '../util'
@@ -194,7 +194,7 @@ export class PublishedPolicy {
     address: string,
     amount: string,
     feeRate: string,
-    policyPath?: Map<string, Array<number>>,
+    policyPath?: PolicyPath,
     utxos?: Array<string>,
     frozenUtxos?: Array<string>
   }): Promise<Trx> {
@@ -777,4 +777,72 @@ export class PublishedPolicy {
       return labeledAddress
     }))
   }
+
+  private addFingerprints = (item: Item, policyPath: PolicyPath, fingerprints: Set<string>) => {
+    if (item.has('fingerprint')) {
+      fingerprints.add(item.get('fingerprint'))
+    }
+    let items: Item[] = [];
+    const maybePolicyPathIndices = policyPath[item.get('id')]
+    if (maybePolicyPathIndices) {
+      for (const index of maybePolicyPathIndices) {
+        items.push(item.get('items')[index])
+      }
+    } else {
+      items = item.get('items')
+    }
+    if (!items?.length) return
+    if (items.some(item => policyPath[item.get('id')])) return
+    for (const item of items) {
+      this.addFingerprints(item, policyPath, fingerprints)
+    }
+  }
+
+  private searchSignerInDescriptor(fingerprints: string[], descriptor: string): string[] {
+    const result: string[] = []
+    for (const fingerprint of fingerprints) {
+      if (descriptor.includes(fingerprint)) {
+        result.push(fingerprint)
+      }
+    }
+    return result
+  }
+
+
+  public getExpectedSigners = async (proposal: { policy_path?: PolicyPath, descriptor: string }, signers: PublishedOwnedSigner[]): Promise<string[]> => {
+    const policyTree = this.getPolicy()
+    const policyPath = proposal.policy_path
+    const ownedFingerprints = signers.map(signer => signer.fingerprint)
+    if (!policyPath) {
+      return this.searchSignerInDescriptor(ownedFingerprints, proposal.descriptor)
+    }
+    const numOfExpectedConditions = Object.values(policyPath).reduce((acc, arr) => acc + arr.length, 0)
+    let current = policyTree
+    const pending = [current]
+    const conditions = [current]
+    let currentPendingIndex = 0
+    const fingerprints = new Set<string>()
+    while (conditions.length < numOfExpectedConditions) {
+      let current = pending[currentPendingIndex]
+      const indices = policyPath[current.get('id') as string]
+      const maybeItems = current.get('items')
+      if (!maybeItems) {
+        conditions.push(current)
+        if (current.has('fingerprint')) {
+          fingerprints.add(current.get('fingerprint'))
+        }
+      } else {
+        for (const index of indices) {
+          const item = current.get('items')[index]
+          conditions.push(item)
+          if (policyPath[item.get('id')]) {
+            pending.push(item)
+          }
+          this.addFingerprints(item, policyPath, fingerprints)
+        }
+      }
+      currentPendingIndex++
+    }
+    return Array.from(fingerprints).filter(fingerprint => ownedFingerprints.includes(fingerprint))
+  }
 }

src/models/PublishedPolicy.ts

@@ -1,5 +1,5 @@
 import { BaseOwnedSigner, Trx, FinalizeTrxResponse, UndecoratedBasicTrxDetails, UndecoratedTrxDetails, Utxo, PolicyPathSelector, PolicyPathsResult, Address } from "./types"
-import { PsbtObject } from "../types"
+import { PsbtObject, PolicyPath } from "../types"
 
 type BalancePayload = {
   confirmed: number
@@ -26,7 +26,7 @@ export interface Wallet {
   * @param {Map<string,Array<number>>} policy_path
   * @returns {Promise<any>}
   */
-  build_trx(address: string, amount: string, fee_rate: string, policy_path?: Map<string, Array<number>>, utxos?: Array<string>, frozen_utxos?: Array<string>): Promise<Trx>;
+  build_trx(address: string, amount: string, fee_rate: string, policy_path?: PolicyPath, utxos?: Array<string>, frozen_utxos?: Array<string>): Promise<Trx>;
 
   /**
   * @returns {Map<string, any>}