Support HookOnV2 (#105)

Author: tequdev

README.md

@@ -210,6 +210,9 @@ const hook = createHookPayload({
   namespace: 'hook_on_tt', // namespace (ascii)
   flags: HookFlags.hsfOverride, // HookFlags
   hookOnArray: ['Payment'] // HookOn Transactions
+  // or you can use the following fields
+  // hookOnIncomingArray: ['Payment'] // HookOnIncoming Transactions
+  // hookOnOutgoingArray: ['Invoke']  // HookOnOutgoing Transactions, needs to be different from hookOnIncomingArray.
 })
 ```
 

src/setHooks.ts

@@ -14,19 +14,41 @@ import { readHookBinaryHexFromNS, hexNamespace } from './utils'
 import { appTransaction } from './libs/xrpl-helpers/transaction'
 import { appLogger } from './libs/logger'
 
-export interface SetHookPayload {
+export interface SetHookPayloadBase {
   version?: number | null
   hookHash?: string | null
   createFile?: string | null
   namespace?: string | null
   flags?: number | 0
-  hookOnArray?: string[] | null
   hookParams?: HookParameter[] | null
   hookGrants?: HookGrant[] | null
   hookName?: string | null
   fee?: string | null
 }
 
+interface SetHookPayloadWithHookOn extends SetHookPayloadBase {
+  hookOnArray: string[]
+  hookOnIncomingArray?: never
+  hookOnOutgoingArray?: never
+}
+
+interface SetHookPayloadWithIncomingOutgoing extends SetHookPayloadBase {
+  hookOnArray?: never
+  hookOnIncomingArray: string[]
+  hookOnOutgoingArray: string[]
+}
+
+interface SetHookPayloadWithoutHookOn extends SetHookPayloadBase {
+  hookOnArray?: null
+  hookOnIncomingArray?: null
+  hookOnOutgoingArray?: null
+}
+
+export type SetHookPayload =
+  | SetHookPayloadWithHookOn
+  | SetHookPayloadWithIncomingOutgoing
+  | SetHookPayloadWithoutHookOn
+
 export function createHookPayload(payload: SetHookPayload): iHook {
   const hook: iHook = {}
   if (typeof payload.version === 'number') {
@@ -61,6 +83,16 @@ export function createHookPayload(payload: SetHookPayload): iHook {
   if (payload.hookOnArray) {
     hook.HookOn = calculateHookOn(payload.hookOnArray)
   }
+  if (payload.hookOnIncomingArray) {
+    hook.HookOnIncoming = calculateHookOn(
+      (payload as SetHookPayloadWithIncomingOutgoing).hookOnIncomingArray
+    )
+  }
+  if (payload.hookOnOutgoingArray) {
+    hook.HookOnOutgoing = calculateHookOn(
+      (payload as SetHookPayloadWithIncomingOutgoing).hookOnOutgoingArray
+    )
+  }
   if (payload.hookParams) {
     hook.HookParameters = hexHookParameters(payload.hookParams)
   }

src/types.ts

@@ -5,11 +5,10 @@ import {
 } from 'xahau/dist/npm/models/common/xahau'
 import { Client, Transaction, Wallet } from 'xahau'
 
-export type iHook = {
+interface iHookBase {
   HookHash?: string
   CreateCode?: string
   Flags?: number
-  HookOn?: string
   HookNamespace?: string
   HookApiVersion?: number
   HookParameters?: HookParameter[]
@@ -18,6 +17,29 @@ export type iHook = {
   Fee?: string
 }
 
+interface iHookWithHookOn extends iHookBase {
+  HookOn?: string
+  HookOnIncoming?: never
+  HookOnOutgoing?: never
+}
+
+interface iHookWithIncomingOutgoing extends iHookBase {
+  HookOn?: never
+  HookOnIncoming?: string
+  HookOnOutgoing?: string
+}
+
+interface iHookWithoutHookOn extends iHookBase {
+  HookOn?: undefined
+  HookOnIncoming?: undefined
+  HookOnOutgoing?: undefined
+}
+
+export type iHook =
+  | iHookWithHookOn
+  | iHookWithIncomingOutgoing
+  | iHookWithoutHookOn
+
 export type SetHookParams = {
   client: Client
   wallet: Wallet

test/integration-c/setup/setHook.test.ts

@@ -22,6 +22,7 @@ import {
   clearAllHooks,
   StateUtility,
   padHexString,
+  createHookPayload,
 } from '../../../src'
 import {
   HookDefinition as LeHookDefinition,
@@ -121,29 +122,29 @@ describe('SetHook - End to End', () => {
 
 describe('SetHook - Fields', () => {
   let testContext: XrplIntegrationTestContext
-  let Hook: iHook
 
   beforeAll(async () => {
     testContext = await setupClient(serverUrl)
   })
-  beforeEach(async () => {
-    Hook = {
-      CreateCode: readHookBinaryHexFromNS('base', 'wasm'),
-      Flags: HookFlags.hsfOverride,
-      HookOn: calculateHookOn(['Invoke']),
-      HookNamespace: hexNamespace('base'),
-      HookApiVersion: 0,
-    } as iHook
+  afterEach(async () => {
+    await clearAllHooks({
+      client: testContext.client,
+      wallet: testContext.hook1,
+    } as SetHookParams)
   })
   afterAll(async () => teardownClient(testContext))
 
   it('sethook - HookName', async () => {
     const hookWallet = testContext.hook1
     // SETHOOK IN
-    const hook = {
-      ...Hook,
-      HookName: convertStringToHex('test'),
-    } as iHook
+    const hook = createHookPayload({
+      version: 0,
+      createFile: 'base',
+      namespace: 'base',
+      flags: HookFlags.hsfOverride,
+      hookOnArray: ['Invoke'],
+      hookName: 'test',
+    })
     await setHooks({
       client: testContext.client,
       wallet: hookWallet,
@@ -200,20 +201,53 @@ describe('SetHook - Fields', () => {
         (response.meta as TransactionMetadata).HookExecutions
       ).toBeDefined()
     }
+  })
 
-    const clearHook = {
-      Flags: HookFlags.hsfNSDelete,
-      HookNamespace: hexNamespace('base'),
-    } as iHook
+  it('sethook - HookOnIncoming/Outgoing', async () => {
+    const hookWallet = testContext.hook1
+    // SETHOOK IN
+    const hook = createHookPayload({
+      version: 0,
+      createFile: 'base',
+      namespace: 'base',
+      flags: HookFlags.hsfOverride,
+      hookOnIncomingArray: ['Invoke'],
+      hookOnOutgoingArray: ['Payment'],
+    })
     await setHooks({
       client: testContext.client,
       wallet: hookWallet,
-      hooks: [{ Hook: clearHook }],
-    } as SetHookParams)
-    await clearAllHooks({
-      client: testContext.client,
-      wallet: testContext.hook1,
+      hooks: [{ Hook: hook }],
     } as SetHookParams)
+
+    createHookPayload({
+      version: 0,
+      createFile: 'base',
+      namespace: 'base',
+      flags: HookFlags.hsfOverride,
+      hookOnIncomingArray: ['Invoke'],
+      hookOnOutgoingArray: ['Payment'],
+    })
+
+    // VALIDATION
+    const hookReq: LedgerEntryRequest = {
+      command: 'ledger_entry',
+      hook: {
+        account: hookWallet.classicAddress,
+      },
+    }
+    const hookRes = await testContext.client.request(hookReq)
+    const leHook = hookRes.result.node as LeHook
+    expect(leHook.Hooks.length).toBe(1)
+    const hookObj = leHook.Hooks[0].Hook
+    const hookDefRequest: LedgerEntryRequest = {
+      command: 'ledger_entry',
+      hook_definition: hookObj.HookHash,
+    }
+    const hookDefRes = await testContext.client.request(hookDefRequest)
+    const hookDefObj = hookDefRes.result.node as LeHookDefinition
+    expect(hookDefObj.HookOnIncoming).toBe(calculateHookOn(['Invoke']))
+    expect(hookDefObj.HookOnOutgoing).toBe(calculateHookOn(['Payment']))
   })
 })