Added <outputAddresses> post data variable option

.githooks/pre-commit

@@ -1,2 +1,2 @@
 #!/bin/sh
-npx lint-staged
+yarn lint-staged

.github/coding-instructions.md

@@ -9,6 +9,7 @@ When writing tests, follow these guidelines to ensure consistency and maintainab
  - **Make tests resilient to refactoring**: Tests should pass even if internal implementation changes, as long as the behavior remains the same.
  - Never make up new functions just to make tests pass. Always build tests based on the functions that already exist. If a function needs to be updated/revised/refactored, that is also OK.
  - Do not just add a 'markTestSkipped' on tests that look difficult to write. Instead, explain the problem and ask for some additional context before trying again.
+ - Make sure new tests added into the "integration-tests" directory are actually integration tests.
 
 General guidlines:
 - Never edit files that are git ignored.

components/Paybutton/PaybuttonTrigger.tsx

@@ -213,6 +213,7 @@ export default ({ paybuttonId, emailCredits }: IProps): JSX.Element => {
                   <div>&lt;opReturn&gt;</div>
                   <div>&lt;signature&gt;</div>
                   <div>&lt;inputAddresses&gt;</div>
+                  <div>&lt;outputAddresses&gt;</div>
                   <div>&lt;value&gt;</div>
 
                 </div>

constants/index.ts

@@ -247,6 +247,7 @@ export const TRIGGER_POST_VARIABLES = [
   '<timestamp>',
   '<txId>',
   '<inputAddresses>',
+  '<outputAddresses>',
   '<value>'
 ]
 

package.json

@@ -19,7 +19,8 @@
     "ci:integration:test": "yarn pretest && dotenv -e .env.test -- ts-node -O '{\"module\":\"commonjs\"}' node_modules/jest/bin/jest.js tests/integration-tests --forceExit",
     "tarDebug": "tar cf debug.tar logs/ paybutton-config.json .env*",
     "updateAllPrices": "./scripts/update-all-prices.sh",
-    "updateAllPriceConnections": "./scripts/update-all-price-connections.sh"
+    "updateAllPriceConnections": "./scripts/update-all-price-connections.sh",
+    "lint-staged": "lint-staged"
   },
   "dependencies": {
     "@emotion/react": "^11.8.2",
@@ -99,8 +100,8 @@
     "chronik-client-cashtokens/ecashaddrjs": "^2.0.0"
   },
   "lint-staged": {
-    "*.ts?(x)": [
-      "yarn eslint --fix"
+    "*.{ts,tsx}": [
+      "node ./node_modules/eslint/bin/eslint.js --fix"
     ]
   }
 }

services/chronikService.ts

@@ -387,22 +387,47 @@ export class ChronikBlockchainClient {
     }
   }
 
-  private getSortedInputAddresses (transaction: Tx): string[] {
+  private getSortedInputAddresses (transaction: Tx): Array<{address: string, amount: Prisma.Decimal}> {
     const addressSatsMap = new Map<string, bigint>()
-
     transaction.inputs.forEach((inp) => {
       const address = outputScriptToAddress(this.networkSlug, inp.outputScript)
       if (address !== undefined && address !== '') {
         const currentValue = addressSatsMap.get(address) ?? 0n
         addressSatsMap.set(address, currentValue + inp.sats)
       }
     })
-
+    const unitDivisor = this.networkId === XEC_NETWORK_ID
+      ? 1e2
+      : (this.networkId === BCH_NETWORK_ID ? 1e8 : 1)
     const sortedInputAddresses = Array.from(addressSatsMap.entries())
       .sort(([, valueA], [, valueB]) => Number(valueB - valueA))
-      .map(([address]) => address)
+    return sortedInputAddresses.map(([address, sats]) => {
+      const decimal = new Prisma.Decimal(sats.toString())
+      const amount = decimal.dividedBy(unitDivisor)
+      return { address, amount }
+    })
+  }
 
-    return sortedInputAddresses
+  private getSortedOutputAddresses (transaction: Tx): Array<{address: string, amount: Prisma.Decimal}> {
+    const addressSatsMap = new Map<string, bigint>()
+    transaction.outputs.forEach((out) => {
+      const address = outputScriptToAddress(this.networkSlug, out.outputScript)
+      if (address !== undefined && address !== '') {
+        const currentValue = addressSatsMap.get(address) ?? 0n
+        addressSatsMap.set(address, currentValue + out.sats)
+      }
+    })
+    const unitDivisor = this.networkId === XEC_NETWORK_ID
+      ? 1e2
+      : (this.networkId === BCH_NETWORK_ID ? 1e8 : 1)
+    const sortedOutputAddresses = Array.from(addressSatsMap.entries())
+      .sort(([, valueA], [, valueB]) => Number(valueB - valueA))
+      .map(([address, sats]) => {
+        const decimal = new Prisma.Decimal(sats.toString())
+        const amount = decimal.dividedBy(unitDivisor)
+        return { address, amount }
+      })
+    return sortedOutputAddresses
   }
 
   public async waitForSyncing (txId: string, addressStringArray: string[]): Promise<void> {
@@ -449,10 +474,11 @@ export class ChronikBlockchainClient {
         const addressesWithTransactions = await this.getAddressesForTransaction(transaction)
         await this.waitForSyncing(msg.txid, addressesWithTransactions.map(obj => obj.address.address))
         const inputAddresses = this.getSortedInputAddresses(transaction)
+        const outputAddresses = this.getSortedOutputAddresses(transaction)
         for (const addressWithTransaction of addressesWithTransactions) {
           const { created, tx } = await upsertTransaction(addressWithTransaction.transaction)
           if (tx !== undefined) {
-            const broadcastTxData = this.broadcastIncomingTx(addressWithTransaction.address.address, tx, inputAddresses)
+            const broadcastTxData = this.broadcastIncomingTx(addressWithTransaction.address.address, tx, inputAddresses, outputAddresses)
             if (created) { // only execute trigger for newly added txs
               await executeAddressTriggers(broadcastTxData, tx.address.networkId)
             }
@@ -476,11 +502,11 @@ export class ChronikBlockchainClient {
     }
   }
 
-  private broadcastIncomingTx (addressString: string, createdTx: TransactionWithAddressAndPrices, inputAddresses: string[]): BroadcastTxData {
+  private broadcastIncomingTx (addressString: string, createdTx: TransactionWithAddressAndPrices, inputAddresses: Array<{address: string, amount: Prisma.Decimal}>, outputAddresses: Array<{address: string, amount: Prisma.Decimal}>): BroadcastTxData {
     const broadcastTxData: BroadcastTxData = {} as BroadcastTxData
     broadcastTxData.address = addressString
     broadcastTxData.messageType = 'NewTx'
-    const newSimplifiedTransaction = getSimplifiedTrasaction(createdTx, inputAddresses)
+    const newSimplifiedTransaction = getSimplifiedTrasaction(createdTx, inputAddresses, outputAddresses)
     broadcastTxData.txs = [newSimplifiedTransaction]
     try { // emit broadcast for both unconfirmed and confirmed txs
       this.wsEndpoint.emit(SOCKET_MESSAGES.TXS_BROADCAST, broadcastTxData)
@@ -504,11 +530,12 @@ export class ChronikBlockchainClient {
     for (const transaction of blockTxsToSync) {
       const addressesWithTransactions = await this.getAddressesForTransaction(transaction)
       const inputAddresses = this.getSortedInputAddresses(transaction)
+      const outputAddresses = this.getSortedOutputAddresses(transaction)
 
       for (const addressWithTransaction of addressesWithTransactions) {
         const { created, tx } = await upsertTransaction(addressWithTransaction.transaction)
         if (tx !== undefined) {
-          const broadcastTxData = this.broadcastIncomingTx(addressWithTransaction.address.address, tx, inputAddresses)
+          const broadcastTxData = this.broadcastIncomingTx(addressWithTransaction.address.address, tx, inputAddresses, outputAddresses)
           if (created) { // only execute trigger for newly added txs
             await executeAddressTriggers(broadcastTxData, tx.address.networkId)
           }

services/transactionService.ts

@@ -41,7 +41,7 @@ export function getSimplifiedTransactions (transactionsToPersist: TransactionWit
   return simplifiedTransactions
 }
 
-export function getSimplifiedTrasaction (tx: TransactionWithAddressAndPrices, inputAddresses?: string[]): SimplifiedTransaction {
+export function getSimplifiedTrasaction (tx: TransactionWithAddressAndPrices, inputAddresses?: Array<{address: string, amount: Prisma.Decimal}>, outputAddresses?: Array<{address: string, amount: Prisma.Decimal}>): SimplifiedTransaction {
   const {
     hash,
     amount,
@@ -63,6 +63,7 @@ export function getSimplifiedTrasaction (tx: TransactionWithAddressAndPrices, in
     message: parsedOpReturn?.message ?? '',
     rawMessage: parsedOpReturn?.rawMessage ?? '',
     inputAddresses: inputAddresses ?? [],
+    outputAddresses: outputAddresses ?? [],
     prices: tx.prices
   }
 

services/triggerService.ts

@@ -246,7 +246,8 @@ export async function executeAddressTriggers (broadcastTxData: BroadcastTxData,
       paymentId,
       message,
       rawMessage,
-      inputAddresses
+      inputAddresses,
+      outputAddresses
     } = tx
     const values = getTransactionValue(tx)
     const addressTriggers = await fetchTriggersForAddress(address)
@@ -258,6 +259,14 @@ export async function executeAddressTriggers (broadcastTxData: BroadcastTxData,
     await Promise.all(posterTriggers.map(async (trigger) => {
       const userProfile = await fetchUserFromTriggerId(trigger.id)
       const quoteSlug = SUPPORTED_QUOTES_FROM_ID[userProfile.preferredCurrencyId]
+      // We ensure that the primary address (<address> variable) is the first element in the outputAddresses since this is likely more useful for apps using the data than it would be if it was in a random order.
+      let reorderedOutputAddresses = outputAddresses
+      if (Array.isArray(outputAddresses)) {
+        const primary = reorderedOutputAddresses.find(oa => oa.address === address)
+        if (primary !== undefined) {
+          reorderedOutputAddresses = [primary, ...reorderedOutputAddresses.filter(o => o.address !== address)]
+        }
+      }
       const postDataParameters: PostDataParameters = {
         amount,
         currency,
@@ -273,6 +282,7 @@ export async function executeAddressTriggers (broadcastTxData: BroadcastTxData,
             }
           : EMPTY_OP_RETURN,
         inputAddresses,
+        outputAddresses: reorderedOutputAddresses,
         value: values[quoteSlug].toString()
       }
 
@@ -395,20 +405,46 @@ export interface PostDataParameters {
   buttonName: string
   address: string
   opReturn: OpReturnData
-  inputAddresses?: string[]
+  inputAddresses?: Array<{address: string, amount: Prisma.Decimal}>
+  outputAddresses?: Array<{address: string, amount: Prisma.Decimal}>
   value: string
 }
 
 async function postDataForTrigger (trigger: TriggerWithPaybutton, postDataParameters: PostDataParameters): Promise<void> {
   const actionType: TriggerLogActionType = 'PostData'
   let logData!: PostDataTriggerLog | PostDataTriggerLogError
   let isError = false
+
+  // Validate JSON first before attempting network request
+  let parsedPostDataParameters: any
   try {
-    const parsedPostDataParameters = parseTriggerPostData({
+    parsedPostDataParameters = parseTriggerPostData({
       userId: trigger.paybutton.providerUserId,
       postData: trigger.postData,
       postDataParameters
     })
+  } catch (jsonErr: any) {
+    isError = true
+    logData = {
+      errorName: jsonErr.name ?? 'JSON_VALIDATION_ERROR',
+      errorMessage: jsonErr.message ?? 'Invalid JSON in trigger post data',
+      errorStack: jsonErr.stack ?? '',
+      triggerPostData: trigger.postData,
+      triggerPostURL: trigger.postURL
+    }
+    await prisma.triggerLog.create({
+      data: {
+        triggerId: trigger.id,
+        isError,
+        actionType,
+        data: JSON.stringify(logData)
+      }
+    })
+    console.error(`[ERROR] Invalid trigger data in DB for trigger ${trigger.id} (should never happen)`)
+    return
+  }
+
+  try {
     const response = await axios.post(
       trigger.postURL,
       parsedPostDataParameters,

tests/unittests/transactionService.test.ts

@@ -166,3 +166,28 @@ describe('Fetch transactions by paybuttonId', () => {
     }
   })
 })
+
+describe('Address object arrays (input/output) integration', () => {
+  it('getSimplifiedTrasaction returns provided input/output address objects untouched', () => {
+    const tx: any = {
+      hash: 'hash1',
+      amount: new Prisma.Decimal(5),
+      confirmed: true,
+      opReturn: '',
+      address: { address: 'ecash:qqprimaryaddressxxxxxxxxxxxxxxxxxxxxx' },
+      timestamp: 1700000000,
+      prices: mockedTransaction.prices
+    }
+    const inputs = [
+      { address: 'ecash:qqinput1', amount: new Prisma.Decimal(1.23) },
+      { address: 'ecash:qqinput2', amount: new Prisma.Decimal(4.56) }
+    ]
+    const outputs = [
+      { address: 'ecash:qqout1', amount: new Prisma.Decimal(7.89) },
+      { address: 'ecash:qqout2', amount: new Prisma.Decimal(0.12) }
+    ]
+    const simplified = transactionService.getSimplifiedTrasaction(tx, inputs, outputs)
+    expect(simplified.inputAddresses).toEqual(inputs)
+    expect(simplified.outputAddresses).toEqual(outputs)
+  })
+})