Merge pull request #25 from ora-io/dev

murongg · web-flow · commit 718f5803c083 · 2024-11-13T17:10:52.000+08:00
Dev
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,6 @@ lib-cov
 logs
 node_modules
 temp
-*.env
+*.env
+
+packages/orap/examples/testDemo/*
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ora-stack",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "private": true,
   "packageManager": "pnpm@9.7.0",
   "description": "",
diff --git a/packages/orap/README.md b/packages/orap/README.md
@@ -92,7 +92,7 @@ const handle2 = (...args: any[]) => {
 
 // define event signal with crosscheck, and customized cacheable tasks
 // note: use redis as the cache layer
-orap.event(eventSignalParam)
+orap.event('contract address', 'contract abi', 'event name')
   .crosscheck(ccOptions)
   // add a task
   .task()
@@ -122,9 +122,11 @@ orap.listen(
 
 Each `new Orap()` starts a `Orap Flow`
 
-**.event(eventSignalParam, handlFn)**
-- `eventSignalParam`: defines an event signal and enters an Event Flow
-- `handlFn`: customized hook on new event received. 
+**.event(address, abi, eventName, handleFn)**
+- `address`: defines the contract address
+- `abi`: defines the contract abi
+- `eventName`: defines the event name
+- `handleFn`: customized hook on new event received. 
   - `return true` to continue the rest of processes
   - `return false` to hijack the rest of processes
 
@@ -147,9 +149,9 @@ Each `.event(...)` starts an `Event Flow`
 - add a task for this event type
 - starts a `Task Flow`
 
-**.handle(handlFn)**
-- same as `.event(.., handlFn)`
-- `handlFn`: customized hook on new event received. 
+**.handle(handleFn)**
+- same as `.event(.., handleFn)`
+- `handleFn`: customized hook on new event received. 
   - `return true` to continue the rest of processes
   - `return false` to hijack the rest of processes
 
@@ -303,7 +305,7 @@ NOTE: handle is a middleware that can be flexibly placed at any position within
      httpProvider: new ethers.JsonRpcProvider('http://127.0.0.1')
    }
    
-   orap.event(eventSignalParam)
+   orap.event(eventSignalParam.address, eventSignalParam.abi, eventSignalParam.eventName)
      // add a task
      .task()
      .cache(sm)
@@ -353,7 +355,31 @@ const providers = {
   httpProvider: new ethers.JsonRpcProvider('http://127.0.0.1')
 }
 
-orap.event(eventSignalParam)
+orap.event(eventSignalParam.address, eventSignalParam.abi, eventSignalParam.eventName)
+  // add a task
+  .task()
+  .cache(sm)
+  .prefix('ora-stack:orap:demo:TransferTask:', 'ora-stack:orap:demo:Done-TransferTask:')
+  .ttl({ taskTtl: 120000, doneTtl: 60000 })
+  .use(async (...args) => {
+    const { next } = getMiddlewareContext(...args)
+    console.log(1)
+    await next()
+  })
+  .handle(handleTask)
+  .use(async (...args) => {
+    const { next } = getMiddlewareContext(...args)
+    console.log(3)
+    await next()
+  })
+  .use(async (...args) => {
+    const { next } = getMiddlewareContext(...args)
+    console.log(4)
+  })
+  .use(async (...args) => {
+    const { next } = getMiddlewareContext(...args)
+    console.log(5)
+  })
 // add a task
   .task()
   .cache(sm)
@@ -414,7 +440,7 @@ const eventSignalParam = {
 
 const handle = (...args: any) => { console.log('handle', args) }
 
-orap.event(eventSignalParam, handle)
+orap.event(eventSignalParam.address, eventSignalParam.abi, eventSignalParam.eventName, handle)
   .crosscheck({ pollingInterval: 1000, batchBlocksCount: 1, blockInterval: 12000 })
 
 orap.listen(
@@ -479,7 +505,7 @@ All events that arrive the oracle service and trigger following actions are defi
 etc.
 
 **EventSignal**
-- define event listener as simple as: `orap.event({address:"0x", abi:"", eventName: "Transfer"}, handleSignal)`
+- define event listener as simple as: `orap.event(address:"0x", abi:"", eventName: "Transfer", handleSignal)`
 - natively integrate `crosschecker` features from [@ora-io/reku](https://github.com/ora-io/ora-stack/blob/main/packages/reku/), available config please check out `AutoCrossCheckParam` in `reku`
 - each event signal only accept at most one crosschecker.
 - `callback`: the user provided handle function to handle the new signals.
diff --git a/packages/orap/examples/declarativeDemo/app.ts b/packages/orap/examples/declarativeDemo/app.ts
@@ -24,7 +24,7 @@ export function startDemo(options: ListenOptions, storeConfig?: any) {
 
   const toKey: ToKeyFn = (from: string, _to: string, _amount: number) => `${from}_${randomStr(4)}`
 
-  orap.event(eventSignalParam)
+  orap.event(eventSignalParam.address, eventSignalParam.abi, eventSignalParam.eventName)
     .crosscheck({
       store,
       storeKeyPrefix: 'ora-stack:orap:demo:cc:',
@@ -43,7 +43,7 @@ export function startDemo(options: ListenOptions, storeConfig?: any) {
     .key(toKey)
     .prefix('ora-stack:orap:demo:TransferTask:', 'ora-stack:orap:demo:Done-TransferTask:')
     .ttl({ taskTtl: 120000, doneTtl: 60000 })
-    .use(CheckTransactionStatus)
+    .use(CheckTransactionStatus(options.wsProvider))
     .handle(handleTask)
     // add another task
     .another()
diff --git a/packages/orap/package.json b/packages/orap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@ora-io/orap",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "packageManager": "pnpm@8.10.5",
   "description": "",
   "author": "Norman (nom4dv3), MuRong",
diff --git a/packages/orap/src/flow/orap.ts b/packages/orap/src/flow/orap.ts
@@ -1,5 +1,6 @@
 import type { Providers } from '@ora-io/reku'
-import type { Fn } from '@ora-io/utils'
+import type { ContractAddress, Fn } from '@ora-io/utils'
+import { isAddressable } from 'ethers'
 import type { Interface, InterfaceAbi } from 'ethers'
 import { OrapVerse } from '../verse/orap'
 import type { EventSignalRegisterParams } from '../signal'
@@ -27,12 +28,11 @@ export class OrapFlow implements Flow {
   }
 
   event(params: EventSignalRegisterParams, handler?: HandleFn): EventFlow
-  event(params: string, abi: Interface | InterfaceAbi | HandleFn, eventName: string, handler?: HandleFn): EventFlow
-  event(params: EventSignalRegisterParams | string, abi?: Interface | InterfaceAbi | HandleFn, eventName?: string, handler?: HandleFn): EventFlow {
-    if (typeof params === 'string')
+  event(address: ContractAddress, abi: Interface | InterfaceAbi | HandleFn, eventName: string, handler?: HandleFn): EventFlow
+  event(params: EventSignalRegisterParams | ContractAddress, abi?: Interface | InterfaceAbi | HandleFn, eventName?: string, handler?: HandleFn): EventFlow {
+    if (typeof params === 'string' || isAddressable(params))
       params = { address: params, abi: abi as Interface | InterfaceAbi, eventName: eventName as string }
-    else
-      handler = abi as HandleFn
+    else handler = abi as HandleFn
 
     const eventFlow = new EventFlow(this, params, handler)
     this.subflows.event.push(eventFlow)
diff --git a/packages/orap/src/flow/task.ts b/packages/orap/src/flow/task.ts
@@ -1,3 +1,4 @@
+import type { Milliseconds } from '@ora-io/utils'
 import { alphabetHex, memoryStore, randomStr } from '@ora-io/utils'
 import type { Context, TaskRaplized } from '../task'
 import { StoreManager } from '../store'
@@ -15,15 +16,15 @@ const defaultHandleFn: HandleFn = () => {
 }
 
 const defaultToKeyFn: ToKeyFn = _ => randomStr(8, alphabetHex)
-export interface TaskFlowTTL { taskTtl: number; doneTtl: number }
+export interface TaskFlowTTL { taskTtl: Milliseconds; doneTtl: Milliseconds }
 
 // TODO: add 'Failed-Task:' ?
 export class TaskFlow implements Flow {
   sm: StoreManager = new StoreManager(memoryStore())
   taskPrefix: Prefix = 'Task:'
   donePrefix: Prefix = 'Done-Task:'
-  taskTtl?: number
-  doneTtl?: number
+  taskTtl?: Milliseconds
+  doneTtl?: Milliseconds
   toKeyFn: ToKeyFn = defaultToKeyFn
   handleFn: HandleFn = defaultHandleFn
   successFn: HandleResultFn = defaultSuccessFn
@@ -60,10 +61,10 @@ export class TaskFlow implements Flow {
     return this
   }
 
-  ttl(TTLs: number): this
+  ttl(TTLs: Milliseconds): this
   ttl(TTLs: TaskFlowTTL): this
-  ttl(taskTtl: number, doneTtl: number): this
-  ttl(TTLs: TaskFlowTTL | number, doneTtl?: number): this {
+  ttl(taskTtl: Milliseconds, doneTtl: Milliseconds): this
+  ttl(TTLs: TaskFlowTTL | Milliseconds, doneTtl?: Milliseconds): this {
     if (typeof TTLs === 'number') {
       this.taskTtl = TTLs
       this.doneTtl = doneTtl ?? TTLs
diff --git a/packages/orap/src/signal/event.ts b/packages/orap/src/signal/event.ts
@@ -2,10 +2,11 @@ import type { EventFragment, Interface, InterfaceAbi, Log } from 'ethers'
 import { ContractEventPayload, ContractUnknownEventPayload, ethers } from 'ethers'
 import { AutoCrossChecker, ONE_MINUTE_MS, RekuProviderManager } from '@ora-io/reku'
 import type { AutoCrossCheckParam, Providers } from '@ora-io/reku'
+import type { ContractAddress } from '@ora-io/utils'
 import type { Signal } from './interface'
 
 export interface EventSignalRegisterParams {
-  address: string
+  address: ContractAddress
   abi: Interface | InterfaceAbi
   eventName: string
   // esig?: string,
diff --git a/packages/orap/src/task/storable.ts b/packages/orap/src/task/storable.ts
@@ -1,4 +1,4 @@
-import type { Awaitable, Constructor } from '@ora-io/utils'
+import type { Awaitable, Constructor, Milliseconds } from '@ora-io/utils'
 import type { StoreManager } from '../store/storemanager'
 import type { Context } from './context'
 import { TaskBase } from './base'
@@ -9,8 +9,8 @@ export abstract class TaskStorable extends TaskBase {
   // overwrite these for store key customize
   static readonly taskPrefix: string = 'Task:'
   static readonly taskPrefixDone: string = 'Done-Task:'
-  static readonly taskTtl: number | undefined = undefined
-  static readonly taskTtlDone: number | undefined = undefined
+  static readonly taskTtl: Milliseconds | undefined = undefined
+  static readonly taskTtlDone: Milliseconds | undefined = undefined
 
   getTaskPrefix(_context?: Context): Awaitable<string> {
     return (this.constructor as TypeofTaskStorable).taskPrefix
@@ -20,19 +20,19 @@ export abstract class TaskStorable extends TaskBase {
     return (this.constructor as TypeofTaskStorable).taskPrefixDone
   }
 
-  get taskTtl(): number | undefined {
+  get taskTtl(): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtl
   }
 
-  get taskTtlDone(): number | undefined {
+  get taskTtlDone(): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtlDone
   }
 
-  getTaskTtl(_context?: Context): number | undefined {
+  getTaskTtl(_context?: Context): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtl
   }
 
-  getTaskTtlDone(_context?: Context): number | undefined {
+  getTaskTtlDone(_context?: Context): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtlDone
   }
 
diff --git a/packages/orap/src/task/verse.test.ts b/packages/orap/src/task/verse.test.ts
@@ -77,7 +77,7 @@ describe('TaskRaplized', () => {
     taskRaplized.eventLog = eventLog
     await taskRaplized.handle()
     await sleep(0)
-    expect(taskFlow.handleFn).toHaveBeenCalledWith(...eventLog, taskRaplized, expect.any(Function))
+    expect(taskFlow.handleFn).toHaveBeenCalledWith(...eventLog, expect.any(Function), taskRaplized)
     expect(taskFlow.successFn).toHaveBeenCalledWith(taskRaplized)
   })
 
@@ -91,7 +91,7 @@ describe('TaskRaplized', () => {
     taskRaplized.eventLog = eventLog
     await taskRaplized.handle()
     await sleep(0)
-    expect(taskFlow.handleFn).toHaveBeenCalledWith(...eventLog, taskRaplized, expect.any(Function))
+    expect(taskFlow.handleFn).toHaveBeenCalledWith(...eventLog, expect.any(Function), taskRaplized)
     expect(taskFlow.failFn).toHaveBeenCalledWith(taskRaplized)
   })
 
diff --git a/packages/orap/src/task/verse.ts b/packages/orap/src/task/verse.ts
@@ -1,3 +1,4 @@
+import type { Milliseconds } from '@ora-io/utils'
 import { composeFns, isJsonString, isString, stripPrefix } from '@ora-io/utils'
 import type { TaskFlow } from '../flow'
 import { HandleSuccessMiddleware } from '../middlewares/HandleSuccessMiddleware'
@@ -28,11 +29,11 @@ export class TaskRaplized extends TaskStorable {
       : await this.flow.donePrefix(this.flow.ctx)
   }
 
-  get taskTtl(): number | undefined {
+  get taskTtl(): Milliseconds | undefined {
     return this.flow.taskTtl
   }
 
-  get taskTtlDone(): number | undefined {
+  get taskTtlDone(): Milliseconds | undefined {
     return this.flow.doneTtl
   }
 
diff --git a/packages/orap/src/utils.ts b/packages/orap/src/utils.ts
@@ -8,8 +8,8 @@ function checkIsTaskRaplized(task: any): task is TaskRaplized {
 export function getMiddlewareContext(...args: any[]) {
   if (args.length && Array.isArray(args[0])) {
     const newArgs = args[0]
-    const next = newArgs.at(-1) as NextFunction
-    const task = newArgs.at(-2) as TaskRaplized
+    const next = newArgs.at(-2) as NextFunction
+    const task = newArgs.at(-1) as TaskRaplized
     const isTaskRaplized = checkIsTaskRaplized(task)
 
     if (typeof next === 'function' && isTaskRaplized) {
@@ -20,8 +20,8 @@ export function getMiddlewareContext(...args: any[]) {
     }
   }
 
-  const next = args.at(-1) as NextFunction
-  const task = args.at(-2) as TaskRaplized
+  const next = args.at(-2) as NextFunction
+  const task = args.at(-1) as TaskRaplized
   const isTaskRaplized = checkIsTaskRaplized(task)
 
   if (typeof next !== 'function' || !isTaskRaplized)
diff --git a/packages/orap/src/verse/task.ts b/packages/orap/src/verse/task.ts
@@ -1,3 +1,4 @@
+import { sleep } from '@murongg/utils'
 import type { TaskFlow } from '../flow/task'
 import { TaskRaplized } from '../task/verse'
 import type { Verse } from './interface'
@@ -41,6 +42,9 @@ export class TaskVerse implements Verse {
         await task.loadByKey(key)
         await task.handle()
       }
+
+      // sleep for 1 second for avoiding too many requests and ensure the task is finished
+      await sleep(1000)
       // get all task keys again
       keys = await this.flow.sm.keys(`${prefix}*`)
     }
diff --git a/packages/reku/package.json b/packages/reku/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@ora-io/reku",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "packageManager": "pnpm@8.10.5",
   "description": "",
   "author": "Norman (nom4dv3), MuRong",
diff --git a/packages/reku/src/event/crosschecker/interface.ts b/packages/reku/src/event/crosschecker/interface.ts
@@ -1,12 +1,12 @@
-import type { Awaitable, Milliseconds, Store } from '@ora-io/utils'
+import type { Awaitable, ContractAddress, Milliseconds, Store } from '@ora-io/utils'
 import type { ethers } from 'ethers'
 
 export type FnOnMissingLog = (log: ethers.Log) => Awaitable<void>
 
 export interface SimpleLog { transactionHash: string; index?: number }
 
 export interface LogFilterParam {
-  address: string
+  address: ContractAddress
   topics: string[]
   fromBlock?: number
   toBlock?: number
diff --git a/packages/reku/src/provider/contract.ts b/packages/reku/src/provider/contract.ts
@@ -1,12 +1,12 @@
-import type { Fn } from '@ora-io/utils'
+import type { ContractAddress, Fn } from '@ora-io/utils'
 import type { Interface, InterfaceAbi } from 'ethers'
 import { ethers } from 'ethers'
 
 export class ContractManager {
   private _contract?: ethers.Contract
   private _listeners: Map<ethers.ContractEventName, Fn> = new Map()
 
-  constructor(public address: string, public abi: Interface | InterfaceAbi, public provider: ethers.JsonRpcProvider | ethers.WebSocketProvider) {
+  constructor(public address: ContractAddress, public abi: Interface | InterfaceAbi, public provider: ethers.JsonRpcProvider | ethers.WebSocketProvider) {
     this._contract = new ethers.Contract(address, abi, provider)
   }
 
diff --git a/packages/reku/src/provider/provider.ts b/packages/reku/src/provider/provider.ts
diff --git a/packages/utils/package.json b/packages/utils/package.json
diff --git a/packages/utils/src/common/fn.ts b/packages/utils/src/common/fn.ts
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
diff --git a/packages/utils/src/store/index.ts b/packages/utils/src/store/index.ts
diff --git a/packages/utils/src/types/index.ts b/packages/utils/src/types/index.ts
diff --git a/packages/utils/src/types/w3.ts b/packages/utils/src/types/w3.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ora-stack",`
`3`		`- "version": "0.2.2",`
	`3`	`+ "version": "0.2.4",`
`4`	`4`	`"private": true,`
`5`	`5`	`"packageManager": "[email protected]",`
`6`	`6`	`"description": "",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@ora-io/orap",`
`3`	`3`	`"type": "module",`
`4`		`- "version": "0.2.2",`
	`4`	`+ "version": "0.2.4",`
`5`	`5`	`"packageManager": "[email protected]",`
`6`	`6`	`"description": "",`
`7`	`7`	`"author": "Norman (nom4dv3), MuRong",`