Merge pull request #4 from ora-io/dev

Dev - Upgrade to version 0.0.8

Author: murongg

.eslintignore

@@ -0,0 +1 @@
+assets/*

.gitignore

@@ -9,3 +9,4 @@ lib-cov
 logs
 node_modules
 temp
+*.env

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ORA Protocol <https://github.com/ora-io>
+Copyright (c) 2024 ORA Protocol <https://ora.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,30 +1,11 @@
 # ORA STACK
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![bundle][bundle-src]][bundle-href]
-[![JSDocs][jsdocs-src]][jsdocs-href]
-[![License][license-src]][license-href]
-
-<!-- Badges -->
-
-[npm-version-src]: https://img.shields.io/npm/v/pkg-placeholder?style=flat&colorA=080f12&colorB=6e70d4
-[npm-version-href]: https://npmjs.com/package/pkg-placeholder
-[npm-downloads-src]: https://img.shields.io/npm/dm/pkg-placeholder?style=flat&colorA=080f12&colorB=6e70d4
-[npm-downloads-href]: https://npmjs.com/package/pkg-placeholder
-[bundle-src]: https://img.shields.io/bundlephobia/minzip/pkg-placeholder?style=flat&colorA=080f12&colorB=6e70d4&label=minzip
-[bundle-href]: https://bundlephobia.com/result?p=pkg-placeholder
-[license-src]: https://img.shields.io/github/license/murongg/pkg-placeholder.svg?style=flat&colorA=080f12&colorB=6e70d4
-[license-href]: https://github.co/pkg-placeholder/blob/main/LICENSE
-[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=6e70d4
-[jsdocs-href]: https://www.jsdocs.io/package/pkg-placeholder
-
 ## What is ORA STACK
 ORA Stack is a comprehensive framework designed for quickly setting up a web3 Oracle Service.
 
 It includes:
 - [Orap](./packages/orap/): the declarative signal-based backend framework;
-- [REK](./packages/rek/): the reliable ethereum toolkit;
+- [Reku](./packages/reku/): the reliable ethereum toolkit and utils;
 - [Utils](./packages/utils/): the common swiss-knife package.
 
 Comming soon:

assets/orap.logo.png

@@ -1,6 +1,6 @@
 {
   "name": "ora-stack",
-  "version": "0.0.0",
+  "version": "0.0.8",
   "private": true,
   "packageManager": "[email protected]",
   "description": "",
@@ -61,6 +61,7 @@
     "@types/node": "^22.1.0",
     "bumpp": "^9.4.2",
     "consola": "^3.2.3",
+    "dotenv": "^16.4.5",
     "eslint": "^8.54.0",
     "esno": "^4.7.0",
     "ethers": "^6.13.2",

assets/reku.logo.png

@@ -1,6 +1,27 @@
+<div align="center"><img src="https://github.com/ora-io/ora-stack/blob/main/assets/orap.logo.png?raw=true" alt="Orap Icon" width="200"/></div>
+
 # ORAP: Oracle Application Framework
 
-ORAP is an out of box, express style framework.
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+[![License][license-src]][license-href]
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@ora-io/orap?style=flat&colorA=080f12&colorB=6e70d4
+[npm-version-href]: https://npmjs.com/package/@ora-io/orap
+[npm-downloads-src]: https://img.shields.io/npm/dm/@ora-io/orap?style=flat&colorA=080f12&colorB=6e70d4
+[npm-downloads-href]: https://npmjs.com/package/@ora-io/orap
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/@ora-io/orap?style=flat&colorA=080f12&colorB=6e70d4&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=@ora-io/orap
+[license-src]: https://img.shields.io/badge/License-MIT-yellow.svg?style=flat&colorA=080f12&colorB=6e70d4
+[license-href]: https://github.com/ora-io/ora-stack/blob/main/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=6e70d4
+[jsdocs-href]: https://www.jsdocs.io/package/@ora-io/orap
+
+ORAP is a declarative framework for building oracle services, handy to use out of the box.
 
 ## Usage
 ```ts
@@ -20,7 +41,7 @@ const eventSignalParam = {
 const handle = (...args: any) => { console.log('handle', args) }
 
 orap.event(eventSignalParam, handle)
-  .crosscheck({ intervalMsMin: 1000, batchBlocksCount: 1, blockIntervalMs: 12000 })
+  .crosscheck({ pollingInterval: 1000, batchBlocksCount: 1, blockInterval: 12000 })
 
 orap.listen(
   { wsProvider: 'wss://127.0.0.1', httpProvider: 'http://127.0.0.1' },
@@ -54,6 +75,6 @@ etc.
 
 ### EventSignal
 - define event listener as simple as: `orap.event({address:"0x", abi:"", eventName: "Transfer"}, handleSignal)`
-- provide crosschecker by `rek`, available config please checkout `AutoCrossCheckParam` in `rek`
+- provide crosschecker by `reku`, available config please checkout `AutoCrossCheckParam` in `reku`
 - currently one and only one crosschecker is set to each event signal
 - store: provide 2 options: use memory or redis, checkout `orap/store`

package.json

@@ -0,0 +1,62 @@
+import type { EventLog } from 'ethers'
+import { redisStore } from '@ora-io/utils'
+import type { ListenOptions } from '../../index'
+import { Orap, StoreManager } from '../../index'
+import { config, logger } from './config'
+import ABI from './erc20.abi.json'
+import { TransferTask } from './taskTransfer'
+
+// new orap
+const orap = new Orap()
+// set to app specific logger
+orap.setLogger(logger)
+
+let store: any
+let sm: any
+
+export function startDemo(options: ListenOptions, storeConfig?: any) {
+  store = redisStore(storeConfig) // use redis
+  // store = memoryStore(storeConfig); // use memory
+  sm = new StoreManager(store)
+
+  const eventSignalParam = {
+    address: config.MAINNET_USDT_ADDR,
+    abi: ABI,
+    eventName: config.TRANSFER_EVENT_NAME,
+  }
+
+  orap.event(eventSignalParam, handleSignal)
+    .crosscheck({
+      store,
+      storeKeyPrefix: 'ora-stack:orap:demo:cc:',
+      storeTtl: config.CROSSCHECKER_CACHE_TTL,
+      pollingInterval: 3000,
+      batchBlocksCount: 1,
+      blockInterval: 12000,
+      delayBlockFromLatest: 1,
+    })
+
+  // start processors
+  startProcessor()
+  // start signal listener
+  orap.listen(
+    options,
+    () => { logger.log('listening on provider.network') },
+  )
+}
+
+async function handleSignal(from: any, to: any, amount: any, event: EventLog) {
+  logger.log('handleSignal', event.transactionHash)
+  const task = new TransferTask(event.transactionHash, from, to, amount)
+  await task.save(sm)
+}
+
+// TODO: make the following DBApp?
+async function startProcessor() {
+  while (true) {
+    const task = await TransferTask.load(sm)
+    await task.handle()
+    // await task.remove(sm) // delete task from store when finished
+    await task.done(sm) // save task in store when finished
+  }
+}

packages/orap/README.md

@@ -0,0 +1,12 @@
+import { Logger } from '@ora-io/utils'
+
+export const config = {
+  MAINNET_USDT_ADDR: '0xdAC17F958D2ee523a2206206994597C13D831ec7',
+  TRANSFER_EVENT_NAME: 'Transfer',
+  TASK_TTL: 60000,
+  TASK_DONE_TTL: 60000,
+  CROSSCHECKER_CACHE_TTL: 60000,
+}
+
+const logLevel = 'debug'
+export const logger = new Logger(logLevel, '[orap-mock-demo]')